diff --git a/MES_Wind/bin/Debug/DotSpatial.Analysis.pdb b/MES_Wind/bin/Debug/DotSpatial.Analysis.pdb
deleted file mode 100644
index 8ab00c4608cae242e5935950afd56b126d88141c..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/DotSpatial.Analysis.pdb and /dev/null differ
diff --git a/MES_Wind/bin/Debug/DotSpatial.Analysis.xml b/MES_Wind/bin/Debug/DotSpatial.Analysis.xml
deleted file mode 100644
index 5c89db7b83749a0b071d23541e0f639da76a79c3..0000000000000000000000000000000000000000
--- a/MES_Wind/bin/Debug/DotSpatial.Analysis.xml
+++ /dev/null
@@ -1,478 +0,0 @@
-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>DotSpatial.Analysis</name>
- </assembly>
- <members>
- <member name="T:DotSpatial.Analysis.Border">
- <summary>
- Used to represent a line segment.
- </summary>
- </member>
- <member name="P:DotSpatial.Analysis.Border.X1">
- <summary>
- Gets or sets the x1.
- </summary>
- <value>
- The x1.
- </value>
- </member>
- <member name="P:DotSpatial.Analysis.Border.X2">
- <summary>
- Gets or sets the x2.
- </summary>
- <value>
- The x2.
- </value>
- </member>
- <member name="P:DotSpatial.Analysis.Border.M">
- <summary>
- Gets or sets the M.
- </summary>
- <value>
- The M.
- </value>
- </member>
- <member name="P:DotSpatial.Analysis.Border.Q">
- <summary>
- Gets or sets the Q.
- </summary>
- <value>
- The Q.
- </value>
- </member>
- <member name="T:DotSpatial.Analysis.Buffer">
- <summary>
- A class that makes adding a buffer to a feature set very simpple.
- </summary>
- </member>
- <member name="M:DotSpatial.Analysis.Buffer.AddBuffer(DotSpatial.Data.IFeatureSet,System.Double,DotSpatial.Data.IFeatureSet,DotSpatial.Data.ICancelProgressHandler)">
- <summary>
- A static function to compute the buffer and return the result to the Execute function.
- </summary>
- <param name="inputFeatures">The feature set that will be buffered.</param>
- <param name="bufferDistance">The distance of the buffer.</param>
- <param name="outputFeatures">The resulting feature set that will show the buffer.</param>
- <param name="cancelProgressHandler">Optional parameter to report progress and cancel if needed.</param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Analysis.Overlay">
- <summary>
- A class for supporting methods to generate random points.
- </summary>
- </member>
- <member name="M:DotSpatial.Analysis.Overlay.EraseFeatures(DotSpatial.Data.IFeatureSet,DotSpatial.Data.IFeatureSet,DotSpatial.Data.ICancelProgressHandler)">
- <summary>
- Erase features from one feature set where they are intersected by another feature set.
- </summary>
- <param name="TargetFeatures">Features which will be erased in part or whole.</param>
- <param name="SourceFeatures">Features which represent areas to erase.</param>
- <param name="cancelProgressHandler">Optional parameter to report progress and cancel entire process if needed.</param>
- <returns>A point feature set with the randomly created features.</returns>
- </member>
- <member name="M:DotSpatial.Analysis.Overlay.AppendFeatures(DotSpatial.Data.FeatureSet,DotSpatial.Data.FeatureSet)">
- <summary>
- Add the features from SourceFeatures to the TargetFeatures feature set.
- </summary>
- <param name="TargetFeatures">Feature set to which features will be added.</param>
- <param name="SourceFeatures">Source of features to add to the target feature set. </param>
- <returns>A point feature set with the randomly created features.</returns>
- </member>
- <member name="T:DotSpatial.Analysis.RandomGeometry">
- <summary>
- A class for supporting methods to generate random points.
- </summary>
- </member>
- <member name="M:DotSpatial.Analysis.RandomGeometry.RandomPoints(DotSpatial.Data.IFeatureSet,System.Int32,DotSpatial.Data.IFeatureSet,DotSpatial.Data.ICancelProgressHandler)">
- <summary>
- Creates a specified number of random point features inside multiple polygon features in a feature set.
- </summary>
- <param name="ConstrainingFeatures">Random points will be generated inside all features in this feature set.</param>
- <param name="NumberOfPoints">The number of points to be randomly generated.</param>
- <param name="fsOut">FeatureSet, the points should be added to.</param>
- <param name="cancelProgressHandler">Optional parameter to report progress and cancel entire process if needed.</param>
- <returns>A point feature set with the randomly created features.</returns>
- </member>
- <member name="M:DotSpatial.Analysis.RandomGeometry.RandomPoints(DotSpatial.Data.Feature,System.Int32)">
- <summary>
- Creates a specified number of random point features inside a single polygon feature.
- </summary>
- <param name="ConstrainingFeature">Random points will be generated inside this polygon feature.</param>
- <param name="NumberOfPoints">The number of points to be randomly generated.</param>
- <returns>A point feature set with the randomly created features.</returns>
- </member>
- <member name="T:DotSpatial.Analysis.ClipRaster">
- <summary>
- Clip input raster with polygon.
- </summary>
- </member>
- <member name="M:DotSpatial.Analysis.ClipRaster.GetXStart(DotSpatial.Data.IFeature,DotSpatial.Data.IRaster)">
- <summary>
- Finds the X-coordinate of the first scanline
- </summary>
- <param name="polygon">The polygon</param>
- <param name="inputRaster">The input raster</param>
- <returns>the X-coordinate of the first scanline</returns>
- </member>
- <member name="M:DotSpatial.Analysis.ClipRaster.GetStartColumn(DotSpatial.Data.IFeature,DotSpatial.Data.IRaster)">
- <summary>
- Finds the first raster column corresponding to the left-most edge of the poly
- </summary>
- <param name="polygon">the polygon</param>
- <param name="inputRaster">the input raster</param>
- <returns>The raster column corresponding to the left-most edge of the poly
- (if raster starts before left edge of the poly)
- or the first raster column (if raster starts after left edge of the poly)</returns>
- <remarks>If the poly sits to the left of the raster then the first column of the raster is returned.</remarks>
- </member>
- <member name="M:DotSpatial.Analysis.ClipRaster.GetEndColumn(DotSpatial.Data.IFeature,DotSpatial.Data.IRaster)">
- <summary>
- Finds the last raster column corresponding to the right-most edge of the poly
- </summary>
- <param name="polygon">the polygon</param>
- <param name="inputRaster">the input raster</param>
- <returns>The raster column corresponding to the right-most edge of the poly
- (if raster ends after the right edge of the poly)
- or the last raster column (if raster ends before right edge of the poly)</returns>
- </member>
- <member name="M:DotSpatial.Analysis.ClipRaster.ClipRasterWithPolygon(System.String,DotSpatial.Data.IFeature,System.String,DotSpatial.Data.ICancelProgressHandler)">
- <summary>
- Clips a raster with a polygon feature
- </summary>
- <param name="inputFileName">The input raster file</param>
- <param name="polygon">The clipping polygon feature</param>
- <param name="outputFileName">The output raster file</param>
- <param name="cancelProgressHandler">Progress handler for reporting progress status and cancelling the operation</param>
- <returns>The output clipped raster object</returns>
- </member>
- <member name="M:DotSpatial.Analysis.ClipRaster.ClipRasterWithPolygon(DotSpatial.Data.IFeature,DotSpatial.Data.IRaster,System.String,DotSpatial.Data.ICancelProgressHandler)">
- <summary>
- Clips a raster with a polygon feature
- </summary>
- <param name="polygon">The clipping polygon feature</param>
- <param name="input">The input raster object</param>
- <param name="outputFileName">the output raster file name</param>
- <param name="cancelProgressHandler">Progress handler for reporting progress status and cancelling the operation</param>
- <remarks>We assume there is only one part in the polygon.
- Traverses the raster with a vertical scan line from left to right, bottom to top</remarks>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Analysis.ClipRaster.ParseIntersections(System.Collections.Generic.List{System.Double},System.Double,System.Int32,DotSpatial.Data.IRaster,DotSpatial.Data.IRaster)">
- <summary>
- Parses the intersections. Moves bottom to top.
- </summary>
- <param name="intersections">The intersections.</param>
- <param name="xCurrent">The x current.</param>
- <param name="column">The column.</param>
- <param name="output">The output.</param>
- <param name="input">The input.</param>
- </member>
- <member name="M:DotSpatial.Analysis.ClipRaster.GetYIntersections(System.Collections.Generic.IEnumerable{DotSpatial.Analysis.Border},System.Double)">
- <summary>
- Gets the Y intersections.
- </summary>
- <param name="borders">The borders.</param>
- <param name="x">The line-scan x-value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Analysis.ClipRaster.GetBorders(DotSpatial.Data.IFeature)">
- <summary>
- Gets the borders of the specified feature except vertical lines.
- </summary>
- <param name="feature">The feature.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Analysis.ClipRaster.FirstColumnToProcess(System.Double,System.Double,System.Double)">
- <summary>
- Finds the x-coordinate of the first raster column to process
- </summary>
- <param name="xMinPolygon">The lowest left coordinate of the polygon.</param>
- <param name="xMinRaster">The lowest left coordinate of the raster.</param>
- <param name="cellWidth">Size of the cell.</param>
- </member>
- <member name="M:DotSpatial.Analysis.ClipRaster.ColumnIndexToProcess(System.Double,System.Double,System.Double)">
- <summary>
- Finds the index of the first raster column to process
- </summary>
- <param name="xMinPolygon">The lowest left coordinate of the polygon.</param>
- <param name="xMinRaster">The lowest left coordinate of the raster.</param>
- <param name="cellWidth">Size of the cell.</param>
- </member>
- <member name="M:DotSpatial.Analysis.ClipRaster.RowIndexToProcess(System.Double,System.Double,System.Double)">
- <summary>
- Finds the index of the first raster row to process
- </summary>
- <param name="yMinPolygon">The lowest left coordinate of the polygon.</param>
- <param name="yMinRaster">The lowest left coordinate of the raster.</param>
- <param name="cellHeight">Size of the cell.</param>
- </member>
- <member name="M:DotSpatial.Analysis.ClipRaster.FirstRowToProcess(System.Double,System.Double,System.Double)">
- <summary>
- Finds the y-coordinate of the first raster row to process
- </summary>
- <param name="yMinPolygon">The lowest left coordinate of the polygon.</param>
- <param name="yMinRaster">The lowest left coordinate of the raster.</param>
- <param name="cellHeight">Size of the cell.</param>
- </member>
- <member name="T:DotSpatial.Analysis.FileLogger">
- <summary>
- Initializes a new instance of the FileLogger class which is an implementation of ILogger designed to save content to a file.
- </summary>
- </member>
- <member name="M:DotSpatial.Analysis.FileLogger.Exception(System.Exception)">
- <summary>
- An exception was thrown, so this will post the stack trace and message to debug.
- </summary>
- <param name="ex">The exception to log.</param>
- </member>
- <member name="M:DotSpatial.Analysis.FileLogger.PublicMethodEntered(System.String,System.Collections.Generic.IEnumerable{System.String})">
- <summary>
- This handles the situation where a public method has been entered.
- </summary>
- <param name="methodName">The method name.</param>
- <param name="parameters">The list of parameters.</param>
- </member>
- <member name="M:DotSpatial.Analysis.FileLogger.PublicMethodLeft(System.String)">
- <summary>
- This handles the situation where a public method has been left.
- </summary>
- <param name="methodName">The method name of the function being left.</param>
- </member>
- <member name="M:DotSpatial.Analysis.FileLogger.Status(System.String)">
- <summary>
- Handles the situation where a status message has been posted.
- </summary>
- <param name="message">The status message text.</param>
- </member>
- <member name="M:DotSpatial.Analysis.FileLogger.Progress(System.String,System.Int32,System.String)">
- <summary>
- This is not really used because this saves data to a file.
- </summary>
- <param name="key">A basic string to help categorize the message, usually just the message with no percentage information.</param>
- <param name="percent">The string percent to appear in a progress message.</param>
- <param name="message">The string message combining both the key and the percent information.</param>
- </member>
- <member name="M:DotSpatial.Analysis.FileLogger.MessageBoxShown(System.String,System.Windows.Forms.DialogResult)">
- <summary>
- Handles the situation where a simple message box where only a message was specified
- was shown to the user. It also shows the result that the user pressed.
- </summary>
- <param name="messageText">The message text.</param>
- <param name="result">The boolean result.</param>
- </member>
- <member name="M:DotSpatial.Analysis.FileLogger.InputBoxShown(System.String,System.Windows.Forms.DialogResult,System.String)">
- <summary>
- This method allows the logger to receive information about input boxes that were shown
- as well as the values entered into them and the result.
- </summary>
- <param name="messageText">The string message that appeared on the input box.</param>
- <param name="result">The System.Windows.Forms.DialogResult describing if the value was cancelled.</param>
- <param name="value">The string containing the value entered.</param>
- </member>
- <member name="P:DotSpatial.Analysis.FileLogger.DebugFile">
- <summary>
- Gets or sets the string file to append debug messages to.
- </summary>
- </member>
- <member name="P:DotSpatial.Analysis.FileLogger.Description">
- <summary>
- Gets a description of this logger.
- </summary>
- </member>
- <member name="P:DotSpatial.Analysis.FileLogger.Key">
- <summary>
- Gets or sets the integer key that allows us to retrieve this logger from the Manager when we wish to remove it.
- </summary>
- </member>
- <member name="T:DotSpatial.Analysis.RasterBin">
- <summary>
- A class for creating "ranges" of raster values.
- </summary>
- </member>
- <member name="M:DotSpatial.Analysis.RasterBin.#ctor">
- <summary>
- Initializes a new instance of the RasterBin class.
- </summary>
- </member>
- <member name="M:DotSpatial.Analysis.RasterBin.BinRaster(DotSpatial.Data.IRaster,System.String,DotSpatial.Data.ICancelProgressHandler)">
- <summary>
- This uses the BaseValue and BinSize properties in order to categorize the values
- according to the source. The cells in the bin will receive a value that is equal
- to the midpoint between the range. So a range from 0 to 10 will all have the value
- of 5. Values with no data continue to be marked as NoData.
- </summary>
- <param name="source">The source raster.</param>
- <param name="destName">The output filename.</param>
- <param name="progressHandler">The progress handler for messages.</param>
- <returns>The IRaster of binned values from the original source.</returns>
- </member>
- <member name="P:DotSpatial.Analysis.RasterBin.BaseValue">
- <summary>
- Gets or sets the "origin" of the bins. Bins may occur above or below this,
- in increments of "BinSize". The default is 0.
- </summary>
- </member>
- <member name="P:DotSpatial.Analysis.RasterBin.BinSize">
- <summary>
- Gets or sets the double value separating the bins for the raster. The default is 10.
- </summary>
- </member>
- <member name="T:DotSpatial.Analysis.ResampleCells">
- <summary>
- This class resamples the given raster cells.
- </summary>
- </member>
- <member name="M:DotSpatial.Analysis.ResampleCells.Resample(DotSpatial.Data.IRaster,System.Double,System.Double,System.String)">
- <summary>
- This will resample the cells.
- If the cell size is zero, this will default to the shorter of the width or height
- divided by 256.
- </summary>
- <param name="input1">The input raster.</param>
- <param name="cellHeight">The new cell height.</param>
- <param name="cellWidth">The new cell width.</param>
- <param name="outputFileName">The destination file name.</param>
- <returns>Resampled raster name.</returns>
- </member>
- <member name="M:DotSpatial.Analysis.ResampleCells.Resample(DotSpatial.Data.IRaster,System.Double,System.Double,System.String,DotSpatial.Data.IProgressHandler)">
- <summary>
- This will resample the cells.
- If the cell size is zero, this will default to the shorter of the width or height
- divided by 256.
- </summary>
- <param name="input1">the input raster.</param>
- <param name="cellHeight">The new cell height or null.</param>
- <param name="cellWidth">The new cell width or null.</param>
- <param name="outputFileName">The string name of the output raster.</param>
- <param name="progressHandler">An interface for handling the progress messages.</param>
- <returns>The resampled raster.</returns>
- </member>
- <member name="T:DotSpatial.Analysis.Slope">
- <summary>
- A class for supporting methods to calculate the slope.
- </summary>
- </member>
- <member name="M:DotSpatial.Analysis.Slope.GetSlope(DotSpatial.Data.IRaster,System.Double,System.Boolean,DotSpatial.Data.ICancelProgressHandler)">
- <summary>
- Executes the slope generation raster.
- </summary>
- <param name="raster">The input altitude raster.</param>
- <param name="inZFactor">The double precision multiplicative scaling factor for elevation values.</param>
- <param name="slopeInPercent">A boolean parameter that clarifies the nature of the slope values. If this is true, the values represent percent slope.</param>
- <param name="cancelProgressHandler">The progress handler.</param>
- <returns>The output slope raster, or null if the process was unsuccessful.</returns>
- </member>
- <member name="T:DotSpatial.Analysis.VectorToRaster">
- <summary>
- VectorToRaster uses the help of GDI+ to create a bitmap, draws the features to
- the bitmap, and then converts the color coded cells to a raster format.
- This is limited to bitmaps that are within the 8, 000 x 8, 0000 size limits.
- </summary>
- </member>
- <member name="M:DotSpatial.Analysis.VectorToRaster.ToRaster(DotSpatial.Data.IFeatureSet,System.Double,System.String,System.String)">
- <summary>
- Creates a new raster with the specified cell size. If the cell size
- is zero, this will default to the shorter of the width or height
- divided by 256. If the cell size produces a raster that is greater
- than 8, 000 pixels in either dimension, it will be re-sized to
- create an 8, 000 length or width raster.
- </summary>
- <param name="fs">The featureset to convert to a raster.</param>
- <param name="cellSize">The double extent of the cell.</param>
- <param name="fieldName">The integer field index of the file.</param>
- <param name="outputFileName">The fileName of the raster to create.</param>
- <returns>The resulting IRaster generated by the ToRaster operation.</returns>
- </member>
- <member name="M:DotSpatial.Analysis.VectorToRaster.ToRaster(DotSpatial.Data.IFeatureSet,System.Double,System.String,System.String,System.String,System.String[],DotSpatial.Data.IProgressHandler)">
- <summary>
- Creates a new raster with the specified cell size. If the cell size
- is zero, this will default to the shorter of the width or height
- divided by 256. If the cell size produces a raster that is greater
- than 8, 000 pixels in either dimension, it will be re-sized to
- create an 8, 000 length or width raster.
- </summary>
- <param name="fs">The featureset to convert to a raster.</param>
- <param name="cellSize">The double extent of the cell.</param>
- <param name="fieldName">The integer field index of the file.</param>
- <param name="outputFileName">The fileName of the raster to create.</param>
- <param name="driverCode">The optional GDAL driver code to use if using GDAL
- for a format that is not discernable from the file extension. An empty string
- is usually perfectly acceptable here.</param>
- <param name="options">For GDAL rasters, they can be created with optional parameters
- passed in as a string array. In most cases an empty string is perfectly acceptable.</param>
- <param name="progressHandler">An interface for handling the progress messages.</param>
- <returns>Generates a raster from the vectors.</returns>
- </member>
- <member name="M:DotSpatial.Analysis.VectorToRaster.ToRaster(DotSpatial.Data.IFeatureSet,DotSpatial.Data.Extent,System.Double,System.String,System.String,System.String,System.String[],DotSpatial.Data.IProgressHandler)">
- <summary>
- Creates a new raster with the specified cell size. If the cell size
- is zero, this will default to the shorter of the width or height
- divided by 256. If the cell size produces a raster that is greater
- than 8, 000 pixels in either dimension, it will be re-sized to
- create an 8, 000 length or width raster.
- </summary>
- <param name="fs">The featureset to convert to a raster.</param>
- <param name="extent">Force the raster to this specified extent.</param>
- <param name="cellSize">The double extent of the cell.</param>
- <param name="fieldName">The integer field index of the file.</param>
- <param name="outputFileName">The fileName of the raster to create.</param>
- <param name="driverCode">The optional GDAL driver code to use if using GDAL
- for a format that is not discernable from the file extension. An empty string
- is usually perfectly acceptable here.</param>
- <param name="options">For GDAL rasters, they can be created with optional parameters
- passed in as a string array. In most cases an empty string is perfectly acceptable.</param>
- <param name="progressHandler">An interface for handling the progress messages.</param>
- <returns>Generates a raster from the vectors.</returns>
- </member>
- <member name="T:DotSpatial.Analysis.Voronoi">
- <summary>
- This class provides an application programming interface to access the Voronoi calculations that are wrapped by a tool.
- </summary>
- </member>
- <member name="M:DotSpatial.Analysis.Voronoi.DelaunayLines(DotSpatial.Data.IFeatureSet)">
- <summary>
- The Voronoi Graph calculation creates a delaunay tesselation where
- each point is effectively converted into triangles.
- </summary>
- <param name="points">The points to use for creating the tesselation.</param>
- <returns>The generated line featureset.</returns>
- </member>
- <member name="M:DotSpatial.Analysis.Voronoi.VoronoiLines(DotSpatial.Data.IFeatureSet)">
- <summary>
- The Voronoi Graph calculation creates the lines that form a voronoi diagram.
- </summary>
- <param name="points">The points to use for creating the tesselation.</param>
- <returns>An IFeatureSet that is the resulting set of lines in the diagram.</returns>
- </member>
- <member name="M:DotSpatial.Analysis.Voronoi.VoronoiPolygons(DotSpatial.Data.IFeatureSet,System.Boolean)">
- <summary>
- The Voronoi Graph calculation creates the lines that form a voronoi diagram.
- </summary>
- <param name="points">The points to use for creating the tesselation.</param>
- <param name="cropToExtent">The normal polygons have sharp angles that extend like stars.
- Cropping will ensure that the original featureset extent plus a small extra buffer amount
- is the outer extent of the polygons. Errors seem to occur if the exact extent is used.</param>
- <returns>The IFeatureSet containing the lines that were formed in the diagram.</returns>
- </member>
- <member name="M:DotSpatial.Analysis.Voronoi.VoronoiPolygons(DotSpatial.Data.IFeatureSet,DotSpatial.Data.IFeatureSet,System.Boolean)">
- <summary>
- The Voronoi Graph calculation creates the lines that form a voronoi diagram.
- </summary>
- <param name="points">The points to use for creating the tesselation.</param>
- <param name="result">The output featureset.</param>
- <param name="cropToExtent">The normal polygons have sharp angles that extend like stars.
- Cropping will ensure that the original featureset extent plus a small extra buffer amount
- is the outer extent of the polygons. Errors seem to occur if the exact extent is used.</param>
- </member>
- <member name="M:DotSpatial.Analysis.Voronoi.HandleBoundaries(DotSpatial.Topology.Voronoi.VoronoiGraph,DotSpatial.Topology.IEnvelope)">
- <summary>
- The original algorithm simply allows edges that have one defined point and
- another "NAN" point. Simply excluding the not a number coordinates fails
- to preserve the known direction of the ray. We only need to extend this
- long enough to encounter the bounding box, not infinity.
- </summary>
- <param name="graph">The VoronoiGraph with the edge list.</param>
- <param name="bounds">The polygon bounding the datapoints.</param>
- </member>
- </members>
-</doc>
diff --git a/MES_Wind/bin/Debug/DotSpatial.Compatibility.pdb b/MES_Wind/bin/Debug/DotSpatial.Compatibility.pdb
deleted file mode 100644
index 84d242e23235847673ad004c66e865ba3beb5f78..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/DotSpatial.Compatibility.pdb and /dev/null differ
diff --git a/MES_Wind/bin/Debug/DotSpatial.Compatibility.xml b/MES_Wind/bin/Debug/DotSpatial.Compatibility.xml
deleted file mode 100644
index 5f8c70cee10236d1d6ad0efa88b9a9b3010e58ef..0000000000000000000000000000000000000000
--- a/MES_Wind/bin/Debug/DotSpatial.Compatibility.xml
+++ /dev/null
@@ -1,3147 +0,0 @@
-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>DotSpatial.Compatibility</name>
- </assembly>
- <members>
- <member name="T:DotSpatial.Compatibility.AppInfo">
- <summary>
- AppInfo
- </summary>
- </member>
- <member name="T:DotSpatial.Compatibility.IAppInfo">
- <summary>
- AppInfo
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IAppInfo.ApplicationName">
- <summary>
- The name of the main application.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IAppInfo.DefaultDir">
- <summary>
- The default directory for file dialogs
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IAppInfo.FormIcon">
- <summary>
- The icon to be displayed as the default form icon
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IAppInfo.HelpFilePath">
- <summary>
- The path to the help file to be displayed from the Help menu.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IAppInfo.ShowWelcomeScreen">
- <summary>
- Whether or not to show a welcome screen (overriding the Splash Screen)
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IAppInfo.SplashPicture">
- <summary>
- The image to be displayed on the splash screen.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IAppInfo.SplashTime">
- <summary>
- How long the splash screen should be displayed
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IAppInfo.URL">
- <summary>
- The URL to be displayed on the Help->About dialog.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IAppInfo.UseSplashScreen">
- <summary>
- Whether to display a splash screen on starting the application
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IAppInfo.WelcomePlugin">
- <summary>
- The name of the plugin responsible for displaying a custom welcome screen
- in response to the WELCOME_SCREEN message.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.AppInfo.ApplicationName">
- <summary>
- The name of the main application.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.AppInfo.DefaultDir">
- <summary>
- The default directory for file dialogs
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.AppInfo.FormIcon">
- <summary>
- The icon to be displayed as the default form icon
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.AppInfo.HelpFilePath">
- <summary>
- The path to the help file to be displayed from the Help menu.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.AppInfo.ShowWelcomeScreen">
- <summary>
- Whether or not to show a welcome screen (overriding the Splash Screen)
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.AppInfo.SplashPicture">
- <summary>
- The image to be displayed on the splash screen.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.AppInfo.SplashTime">
- <summary>
- How long the splash screen should be displayed
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.AppInfo.URL">
- <summary>
- The URL to be displayed on the Help->About dialog.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.AppInfo.UseSplashScreen">
- <summary>
- Whether to display a splash screen on starting the application
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.AppInfo.WelcomePlugin">
- <summary>
- The name of the plugin responsible for displaying a custom welcome screen
- in response to the WELCOME_SCREEN message.
- </summary>
- </member>
- <member name="T:DotSpatial.Compatibility.ClickLocation">
- <summary>
- Location of a click event within the legend.
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.ClickLocation.None">
- <summary>The user clicked outside of any group or layer.</summary>
- </member>
- <member name="F:DotSpatial.Compatibility.ClickLocation.Layer">
- <summary>The user clicked on a layer.</summary>
- </member>
- <member name="F:DotSpatial.Compatibility.ClickLocation.Group">
- <summary>The user clicked on a group.</summary>
- </member>
- <member name="T:DotSpatial.Compatibility.CursorMode">
- <summary>
- CursorModes
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.CursorMode.cmNone">
- <summary>
- No built in behavior
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.CursorMode.cmPan">
- <summary>
- Left click to Pan
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.CursorMode.cmSelection">
- <summary>
- Select
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.CursorMode.cmZoomIn">
- <summary>
- Left click to zoom in
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.CursorMode.cmZoomOut">
- <summary>
- Right click to zoom in
- </summary>
- </member>
- <member name="T:DotSpatial.Compatibility.HJustification">
- <summary>
- HJustification
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.HJustification.Center">
- <summary>
- The item is centered
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.HJustification.Left">
- <summary>
- The item is justified to the left
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.HJustification.Right">
- <summary>
- The item is justified to the right
- </summary>
- </member>
- <member name="T:DotSpatial.Compatibility.IComboBoxItem">
- <summary>
- Object given back when a ComboBox is added to the Toolbar.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IComboBoxItem.Items">
- <summary>
- Returns a collection of items
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IComboBoxItem.Cursor">
- <summary>
- Gets/Sets the cursor
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IComboBoxItem.Description">
- <summary>
- Gets/Sets the description for the control (used when the user customizes the Toolbar)
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IComboBoxItem.DropDownStyle">
- <summary>
- Gets/Sets the style of the combo box
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IComboBoxItem.Enabled">
- <summary>
- Gets/Sets the enabled state of the ComboBoxItem
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IComboBoxItem.Name">
- <summary>
- Gets the name of the ComboBoxItem object
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IComboBoxItem.SelectedIndex">
- <summary>
- Gets/Sets the zero based index of the selected item
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IComboBoxItem.SelectedItem">
- <summary>
- Gets/Sets the selected object
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IComboBoxItem.SelectedText">
- <summary>
- Gets/Sets the selected item text
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IComboBoxItem.SelectionLength">
- <summary>
- Gets/Sets the length of the highlighted text
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IComboBoxItem.SelectionStart">
- <summary>
- Gets/Sets the start index of the highlighted text
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IComboBoxItem.Text">
- <summary>
- Gets/Sets the text for this object
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IComboBoxItem.Tooltip">
- <summary>
- Gets/Sets the tooltip text for the control
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IComboBoxItem.Width">
- <summary>
- Gets/Sets the width of the control
- </summary>
- </member>
- <member name="T:DotSpatial.Compatibility.IdentifiedShapes">
- <summary>
- This interface is used to access the list of shapes that were found during an Identify function call.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IdentifiedShapes.Count">
- <summary>
- Returns the number of shapes that were identified.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IdentifiedShapes.Item(System.Int32)">
- <summary>
- Returns the shape index of an identified that is stored at the position
- specified by the Index parameter.
- </summary>
- </member>
- <member name="T:DotSpatial.Compatibility.IDraw">
- <summary>
- The draw interface is used to add custom drawing to the DotSpatial view.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IDraw.ClearDrawing(System.Int32)">
- <summary>
- Clears all custom drawing on the specified drawing layer.
- </summary>
- <param name="drawHandle">Handle of the drawing layer to clear.</param>
- <remarks>Clearing a single drawing (using the drawing handle) is faster than clearing all drawings.</remarks>
- </member>
- <member name="M:DotSpatial.Compatibility.IDraw.ClearDrawings">
- <summary>
- Clears all custom drawings on all drawing layers.
- </summary>
- <remarks>Clearing a single drawing (using the drawing handle) is faster than clearing all drawings.</remarks>
- </member>
- <member name="M:DotSpatial.Compatibility.IDraw.DrawCircle(System.Double,System.Double,System.Double,System.Drawing.Color,System.Boolean)">
- <summary>
- Draws a circle on the current drawing layer.
- </summary>
- <param name="x">X coordinate of the center of the circle.</param>
- <param name="y">Y coordinate of the center of the circle.</param>
- <param name="pixelRadius">Radius of the circle in pixels.</param>
- <param name="color">Color to use when drawing the circle.</param>
- <param name="fillCircle">Specifies whether or not the circle is drawn filled.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IDraw.DrawLine(System.Double,System.Double,System.Double,System.Double,System.Int32,System.Drawing.Color)">
- <summary>
- Draws a line on the current drawing layer.
- </summary>
- <param name="x1">First x coordinate.</param>
- <param name="y1">First y coordinate.</param>
- <param name="x2">Second x coordinate.</param>
- <param name="y2">Second y coordinate.</param>
- <param name="pixelWidth">Width of the line in pixels</param>
- <param name="color">Color to draw the line with.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IDraw.DrawPoint(System.Double,System.Double,System.Int32,System.Drawing.Color)">
- <summary>
- Draws a point on the current drawing layer.
- </summary>
- <param name="x">X coordinate.</param>
- <param name="y">Y coordinate.</param>
- <param name="pixelSize">Size of the point in pixels.</param>
- <param name="color">Color to draw the point with.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IDraw.DrawPolygon(System.Double[],System.Double[],System.Drawing.Color,System.Boolean)">
- <summary>
- Draws a polygon on the current drawing layer.
- </summary>
- <param name="x">Array of x points for the polygon.</param>
- <param name="y">Array of y points for the polygon.</param>
- <param name="color">Color to draw the polygon with.</param>
- <param name="fillPolygon">Specifies whether or not to fill the polygon.</param>
- <remarks>The points in a polygon should be defined in a clockwise order and have no
- crossing lines if they are to be filled. The first and last point should be the same.</remarks>
- </member>
- <member name="M:DotSpatial.Compatibility.IDraw.NewDrawing(DotSpatial.Compatibility.ReferenceType)">
- <summary>
- Creates a new drawing layer.
- </summary>
- <param name="projection">Specifies whether to use screen coordinates or projected map coordinates.</param>
- <returns>Returns a drawing handle. You should save this handle if you wish to clear this drawing later.</returns>
- <remarks>The concept of drawing layers is only partially implemented in this version of the MapWinGIS, which is used
- by the DotSpatial. There is only one active drawing layer, which is the most recently created one. There is no
- way to access any other drawing layers other than the current one.</remarks>
- </member>
- <member name="P:DotSpatial.Compatibility.IDraw.DoubleBuffer">
- <summary>
- Specifies whether or not to use double buffering. Double buffering makes the drawing of the
- custom drawings smoother (not flickering). It is recommended that you use double buffering.
- </summary>
- </member>
- <member name="T:DotSpatial.Compatibility.IIdentifiedLayers">
- <summary>
- IdentifiedLayers is used to access the list of layers that contained any
- information gathered during an Identify function call.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IIdentifiedLayers.Count">
- <summary>
- Returns the number of layers that had information from the Identify function call.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IIdentifiedLayers.Item(System.Int32)">
- <summary>
- Returns an <c>IdentifiedShapes</c> object containing inforamtion about shapes that were
- identified during the Identify function call.
- </summary>
- </member>
- <member name="T:DotSpatial.Compatibility.ILayerOld">
- <summary>
- Layer
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.ILayerOld.AddLabel(System.String,System.Drawing.Color,System.Double,System.Double,DotSpatial.Compatibility.HJustification)">
- <summary>
- Adds a label to this layer.
- </summary>
- <param name="text">The text of the label.</param>
- <param name="textColor">The color of the label text.</param>
- <param name="xPos">X position in projected map units.</param>
- <param name="yPos">Y position in projected map units.</param>
- <param name="justification">Text justification. Can be hjCenter, hjLeft or hjRight.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.ILayerOld.AddLabelEx(System.String,System.Drawing.Color,System.Double,System.Double,DotSpatial.Compatibility.HJustification,System.Double)">
- The following function was added for plug-in 3.1 version compatibility
- <summary>
- Adds an extended label to this layer.
- </summary>
- <param name="text">The text of the label.</param>
- <param name="textColor">The color of the label text.</param>
- <param name="xPos">X position in projected map units.</param>
- <param name="yPos">Y position in projected map units.</param>
- <param name="justification">Text justification. Can be hjCenter, hjLeft or hjRight.</param>
- <param name="rotation">The rotation angle for the label.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.ILayerOld.ClearLabels">
- <summary>
- Clears all labels for this layer.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.ILayerOld.ClearUDPointImageList">
- <summary>
- Clears out the list of images to be used by the tkImageList point type.
- See also UserPointImageListAdd, UserPointImageListItem, UserPointImageListCount,
- and (on the shape interface) ShapePointImageListID.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.ILayerOld.Font(System.String,System.Int32)">
- <summary>
- Sets the font to use for all labels on this layer.
- </summary>
- <param name="fontName">Name of the font or font family. Example: "Arial"</param>
- <param name="fontSize">Size of the font.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.ILayerOld.GetObject">
- <summary>
- Gets the underlying MapWinGIS object for this layer. The object can be either a
- <c>MapWinGIS.Shapefile</c> or a <c>MapWinGIS.Image</c>. If the layer is a grid layer the
- <c>MapWinGIS.Grid</c> object can be retrieved using the <c>GetGridObject</c> method.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.ILayerOld.GetUserFillStipple(System.Int32)">
- <summary>
- Gets a single row in the user defined line stipple. There are 32 rows in a fill stipple
- (0-31). Each row is defined the same way as a <c>UserLineStipple</c>.
- </summary>
- <param name="row">The index of the row to get. Must be between 0 and 31 inclusive.</param>
- <returns>A single stipple row.</returns>
- </member>
- <member name="M:DotSpatial.Compatibility.ILayerOld.HideVertices">
- <summary>
- Hides all vertices in the shapefile. Only applies to line and polygon shapefiles.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.ILayerOld.LoadShapeLayerProps">
- <summary>
- Loads the shapefile rendering properties from a .mwsr file whose base fileName matches the shapefile.
- If the file isn't found, false is returned.
- Function call is ignored and returns false if the layer is a grid.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.ILayerOld.LoadShapeLayerProps(System.String)">
- <summary>
- Loads the shapefile rendering properties from the specified fileName.
- Function call is ignored and returns false if the layer is a grid.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.ILayerOld.MoveTo(System.Int32,System.Int32)">
- <summary>
- Moves this layer to a new position in the layer list. The highest position is the topmost layer
- in the display.
- </summary>
- <param name="newPosition">The new position.</param>
- <param name="targetGroup">The group to put this layer in.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.ILayerOld.SaveShapeLayerProps">
- <summary>
- Saves the shapefile rendering properties to a .mwsr file whose base fileName matches the shapefile.
- Function call is ignored and returns false if the layer is a grid.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.ILayerOld.SaveShapeLayerProps(System.String)">
- <summary>
- Saves the shapefile rendering properties to the specified fileName.
- Function call is ignored if the layer is a grid.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.ILayerOld.SetUserFillStipple(System.Int32,System.Int32)">
- <summary>
- Sets a single row in the user defined line stipple. There are 32 rows in a fill stipple
- (0-31). Each row is defined the same way as a <c>UserLineStipple</c>.
- </summary>
- <param name="row">The index of the row to set. Must be between 0 and 31 inclusive.</param>
- <param name="value">The row value to set in the fill stipple.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.ILayerOld.UpdateLabelInfo">
- <summary>
- Updates the label information file stored for this layer.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.ILayerOld.UserPointImageListAdd(System.Drawing.Image)">
- <summary>
- Adds an image to the list of point images used by the tkImageList point type.
- See also UserPointImageListItem, UserPointImageListCount, ClearUDPointImageList,
- and (on the shape interface) ShapePointImageListID.
- </summary>
- <param name="newValue">The new image to add.</param>
- <returns>The index for this image, to be passed to ShapePointImageListID or other functions.</returns>
- </member>
- <member name="M:DotSpatial.Compatibility.ILayerOld.UserPointImageListCount">
- <summary>
- Gets the count of images from the list of images to be used by the tkImageList point type.
- See also UserPointImageListAdd, UserPointImageListItem, ClearUDPointImageList,
- and (on the shape interface) ShapePointImageListID.
- </summary>
- <returns>The count of items in the image list.</returns>
- </member>
- <member name="M:DotSpatial.Compatibility.ILayerOld.UserPointImageListItem(System.Int64)">
- <summary>
- Gets an image from the list of images to be used by the tkImageList point type.
- See also UserPointImageListAdd, UserPointImageListCount, ClearUDPointImageList,
- and (on the shape interface) ShapePointImageListID.
- </summary>
- <param name="imageIndex">The image index to retrieve.</param>
- <returns>The index associated with this index; or null/nothing if nonexistant.</returns>
- </member>
- <member name="M:DotSpatial.Compatibility.ILayerOld.ZoomTo">
- <summary>
- Zooms the display to this layer, taking into acount the <c>View.ExtentPad</c>.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.ILayerOld.ShowVertices(System.Drawing.Color,System.Int32)">
- <summary>
- Shows all vertices for the entire shapefile. Applies only to line and polygon shapefiles.
- </summary>
- <param name="color">The color to draw vertices with.</param>
- <param name="vertexSize">The size of each vertex.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.ILayerOld.ToString">
- <summary>
- Returns information about the given layer in a human-readible string.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayerOld.GetGridObject">
- <summary>
- Returns the <c>MapWinGIS.Grid</c> object associated with the layer. If the layer is not a
- grid layer, "Nothing" will be returned.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayerOld.SkipOverDuringSave">
- <summary>
- Indicates whether to skip over the layer when saving a project.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayerOld.Color">
- <summary>
- Gets or sets the color of this shapefile. Applies only to shapefiles. Setting the color of the
- shapefile will clear any selected shapes and will also reset each individual shape to the same color.
- The coloring scheme will also be overriden.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayerOld.ColoringScheme">
- <summary>
- Gets or sets the coloring scheme. The <c>Shapefile</c> and <c>Grid</c> objects each have
- their own coloring scheme object. It is important to cast the <c>ColoringScheme</c> to the
- proper type.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayerOld.DrawFill">
- <summary>
- Gets or sets whether or not to draw the fill for a polygon shapefile.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayerOld.DynamicVisibilityExtents">
- <summary>
- Gets or sets the extents where the layer changes from visible to not visible or vice versa.
-
- If the map is zoomed beyond these extents, the layer is invisible until the map is zoomed to
- be within these extents.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayerOld.Expanded">
- <summary>
- Gets or sets whether the layer's coloring scheme is expanded in the legend.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayerOld.Extents">
- <summary>
- Returns the extents of this layer.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayerOld.FileName">
- <summary>
- Returns the fileName of this layer. If the layer is memory-based only it may not have a valid fileName.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayerOld.FillStipple">
- <summary>
- Gets or sets the stipple pattern to use for the entire shapefile.
-
- The valid values for this property are:
- <list type="bullet">
- <item>Custom</item>
- <item>DashDotDash</item>
- <item>Dashed</item>
- <item>Dotted</item>
- <item>None</item>
- </list>
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayerOld.GlobalPosition">
- <summary>
- Gets or sets the position of the layer without respect to any group.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayerOld.GroupHandle">
- <summary>
- Gets or sets the handle of the group that this layer belongs to.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayerOld.GroupPosition">
- <summary>
- Gets or sets the position of the layer within a group.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayerOld.Handle">
- <summary>
- Returns the layer handle of this layer. The DotSpatial automatically sets the <c>LayerHandle</c> for the layer, and it cannot be reset.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayerOld.HideFromLegend">
- <summary>
- Indicates whether to skip over the layer when drawing the legend.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayerOld.Icon">
- <summary>
- Gets or sets the icon to use in the legend for this layer.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayerOld.ImageTransparentColor">
- <summary>
- Gets or sets the color that represents transparent in an <c>Image</c> layer.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayerOld.LabelsOffset">
- The following label properties were added for plug-in 3.1 version compatibility
- <summary>
- Determines the distance from the label point to the text for the label in pixels.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayerOld.LabelsScale">
- <summary>
- Determines whether labels are scaled for this layer.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayerOld.LabelsShadow">
- <summary>
- Determines whether labels are shadowed for this layer.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayerOld.LabelsShadowColor">
- <summary>
- Determines the color of the labels shadows.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayerOld.LabelsVisible">
- <summary>
- Turns labels on or off for this layer.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayerOld.LayerType">
- <summary>
- Returns the type of this layer. Valid values are:
- <list type="bullet">
- <item>Grid</item>
- <item>Image</item>
- <item>Invalid</item>
- <item>LineShapefile</item>
- <item>PointShapefile</item>
- <item>PolygonShapefile</item>
- </list>
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayerOld.LineOrPointSize">
- <summary>
- Gets or sets the line or point size. If the <c>PointType</c> is <c>ptUserDefined</c> then the
- size of the user defined point will be multiplied by the <c>LineOrPointSize</c>. For all other
- points and for lines, the <c>LineOrPointSize</c> is represented in pixels.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayerOld.LineSeparationFactor">
- The following was added for plug-in 3.1 version compatibility
- <summary>
- Sets the width between lines for multiple-line drawing styles (e.g, doublesolid).
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayerOld.LineStipple">
- <summary>
- Gets or sets the stipple pattern to use for the entire shapefile.
-
- The valid values for this property are:
- <list type="bullet">
- <item>Custom</item>
- <item>DashDotDash</item>
- <item>Dashed</item>
- <item>Dotted</item>
- <item>None</item>
- </list>
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayerOld.Projection">
- <summary>
- Returns or sets the projection of this layer.
- Projections must be / will be in PROJ4 format.
- If no projection is present, "" will be returned.
- If an invalid projection is provided, it's not guaranteed to be saved!
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayerOld.Name">
- <summary>
- Gets or sets the layer name.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayerOld.OutlineColor">
- <summary>
- Gets or sets the outline color for this layer. Only applies to polygon shapefile layers.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayerOld.PointImageScheme">
- <summary>
- Gets or sets the Point Image Scheme object for a given point layer. To be used from DotSpatial only
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayerOld.PointType">
- <summary>
- Gets or sets the point type for this shapefile.
-
- The valid values for this property are:
- <list type="bullet">
- <item>ptCircle</item>
- <item>ptDiamond</item>
- <item>ptSquare</item>
- <item>ptTriangleDown</item>
- <item>ptTriangleLeft</item>
- <item>ptTriangleRight</item>
- <item>ptTriangleUp</item>
- <item>ptUserDefined</item>
- </list>
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayerOld.Shapes">
- <summary>
- This property gives access to all shapes in the layer. Only applies to shapefile layers.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayerOld.Tag">
- <summary>
- Gets or sets the tag for this layer. The tag is simply a string that can be used by the
- programmer to store any information desired.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayerOld.UseDynamicVisibility">
- <summary>
- Specifies whether or not to use <c>DynamicVisibility</c>.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayerOld.UseLabelCollision">
- <summary>
- Determines whether MapWinGIS ocx will hide labels which collide with already drawn labels or not.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayerOld.UserLineStipple">
- <summary>
- Gets or sets the user defined line stipple. A line stipple is simply a 32-bit integer
- whose bits define a pattern that can be displayed on the screen. For example, the value
- 0011 0011 in binary would represent a dashed line ( -- --).
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayerOld.UserPointType">
- <summary>
- Gets or sets the user defined point image for this layer. To display the user defined point
- the layer's <c>PointType</c> must be set to <c>ptUserDefined</c>.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayerOld.UseTransparentColor">
- <summary>
- Gets or sets whether to use transparency on an <c>Image</c> layer.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayerOld.VerticesVisible">
- <summary>
- (Doesn't apply to line shapefiles)
- Indicates whether the vertices of a line or polygon are visible.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayerOld.Visible">
- <summary>
- Gets or sets whether the layer is visible.
- </summary>
- </member>
- <member name="T:DotSpatial.Compatibility.ILayers">
- <summary>
- Layers
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.ILayers.Add">
- <summary>
- Default add layer overload. Displays an open file dialog
- </summary>
- <returns>An array of <c>DotSpatial.Interfaces.Layer</c> objects.</returns>
- </member>
- <member name="M:DotSpatial.Compatibility.ILayers.Add(System.String)">
- <summary>
- Adds a layer by fileName.
- </summary>
- <returns>Returns a <c>Layer</c> object.</returns>
- </member>
- <member name="M:DotSpatial.Compatibility.ILayers.Add(System.String,System.String)">
- <summary>
- Adds a layer by fileName. The layer name is also set.
- </summary>
- <returns>Returns a <c>Layer</c> object.</returns>
- </member>
- <member name="M:DotSpatial.Compatibility.ILayers.Add(DotSpatial.Data.IImageData)">
- <summary>
- Adds an <c>Image</c> layer to the DotSpatial.
- </summary>
- <returns>Returns a <c>Layer</c> object.</returns>
- </member>
- <member name="M:DotSpatial.Compatibility.ILayers.Add(DotSpatial.Data.IImageData,System.String)">
- <summary>
- Adds an <c>Image</c> layer to the DotSpatial with the specified layer name.
- </summary>
- <returns>Returns a <c>Layer</c> object.</returns>
- </member>
- <member name="M:DotSpatial.Compatibility.ILayers.Add(DotSpatial.Data.IFeatureSet)">
- <summary>
- Adds a <c>FeatureSet</c> layer to the DotSpatial.
- </summary>
- <returns>Returns a <c>Layer</c> object.</returns>
- </member>
- <member name="M:DotSpatial.Compatibility.ILayers.Add(DotSpatial.Data.IFeatureSet,System.String)">
- <summary>
- Adds a <c>FeatureSet</c> layer to the DotSpatial with the specified layer name.
- </summary>
- <returns>Returns a <c>Layer</c> object.</returns>
- </member>
- <member name="M:DotSpatial.Compatibility.ILayers.Add(DotSpatial.Data.IFeatureSet,System.String,System.Int32,System.Int32)">
- <summary>
- Adds a <c>FeatureSet</c> layer to the DotSpatial with the specified properties.
- </summary>
- <returns>Returns a <c>Layer</c> object.</returns>
- </member>
- <member name="M:DotSpatial.Compatibility.ILayers.Add(DotSpatial.Data.IFeatureSet,System.String,System.Int32,System.Int32,System.Int32)">
- <summary>
- Adds a <c>FeatureSet</c> layer to the DotSpatial with the specified properties.
- </summary>
- <returns>Returns a <c>Layer</c> object.</returns>
- </member>
- <member name="M:DotSpatial.Compatibility.ILayers.Add(DotSpatial.Data.IRaster)">
- <summary>
- Adds a <c>Raster</c> layer to the DotSpatial.
- </summary>
- <returns>Returns a <c>Layer</c> object.</returns>
- </member>
- <member name="M:DotSpatial.Compatibility.ILayers.Add(DotSpatial.Data.IRaster,DotSpatial.Symbology.IRasterSymbolizer)">
- <summary>
- Adds a <c>Raster</c> layer to the DotSpatial, with the specified coloring scheme.
- </summary>
- <returns>Returns a <c>Layer</c> object.</returns>
- </member>
- <member name="M:DotSpatial.Compatibility.ILayers.Add(DotSpatial.Data.IRaster,System.String)">
- <summary>
- Adds a <c>Raster</c> layer to the DotSpatial with the specified layer name.
- </summary>
- <returns>Returns a <c>Layer</c> object.</returns>
- </member>
- <member name="M:DotSpatial.Compatibility.ILayers.Add(DotSpatial.Data.IRaster,DotSpatial.Symbology.IRasterSymbolizer,System.String)">
- <summary>
- Adds a <c>Rster</c> object to the DotSpatial with the specified properties.
- </summary>
- <returns>Returns a <c>Layer</c> object.</returns>
- </member>
- <member name="M:DotSpatial.Compatibility.ILayers.Add(System.String,System.String,System.Boolean)">
- <summary>
- Adds a layer by fileName. The layer name is also set, as well as the legend visibility.
- </summary>
- <returns>Returns a <c>Layer</c> object.</returns>
- </member>
- <member name="M:DotSpatial.Compatibility.ILayers.Add(System.String,System.String,System.Boolean,System.Boolean)">
- <summary>
- Adds a layer to the map, optionally placing it above the currently selected layer (otherwise at top of layer list).
- </summary>
- <param name="fileName">The name of the file to add.</param>
- <param name="layerName">The name of the layer, as displayed in the legend.</param>
- <param name="visible">Whether or not the layer is visible upon adding it.</param>
- <param name="placeAboveCurrentlySelected">Whether the layer should be placed above currently selected layer, or at top of layer list.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.ILayers.Clear">
- <summary>
- Removes all layers from the map.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.ILayers.IsValidHandle(System.Int32)">
- <summary>
- Returns true if the layer handle specified belongs to a valid layer. Drawing layers are not
- considered normal layers so this function will not return consistent results if a drawing
- layer is passed in.
- </summary>
- <param name="layerHandle">Handle of the layer to check.</param>
- <returns>True if the layer handle is valid. False otherwise.</returns>
- </member>
- <member name="M:DotSpatial.Compatibility.ILayers.MoveLayer(System.Int32,System.Int32,System.Int32)">
- <summary>
- Moves a layer to another position and/or group.
- </summary>
- <param name="handle">Handle of the layer to move.</param>
- <param name="newPosition">New position in the target group.</param>
- <param name="targetGroup">Group to move the layer to.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.ILayers.RebuildGridLayer(System.Int32,DotSpatial.Data.IRaster,DotSpatial.Symbology.IRasterSymbolizer)">
- <summary>
- Rebuilds a grid layer using the specified <c>GridColorScheme</c>
- </summary>
- <param name="layerHandle">Handle of the grid layer.</param>
- <param name="gridObject">Grid object corresponding to that layer handle.</param>
- <param name="colorScheme">Coloring scheme to use when rebuilding.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Compatibility.ILayers.Remove(System.Int32)">
- <summary>
- Removes the layer from the DotSpatial.
- </summary>
- <param name="layerHandle"></param>
- </member>
- <member name="M:DotSpatial.Compatibility.ILayers.GetHandle(System.Int32)">
- <summary>
- Finds a layer handle when given the global position of a layer.
- </summary>
- <param name="globalPosition">Position in the layers list, disregarding groups.</param>
- <returns>The handle of the layer at the specified position, or -1 if no layer is found there.</returns>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayers.CurrentLayer">
- <summary>
- Gets or sets the current layer handle.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayers.Groups">
- <summary>
- Allows access to group properties in the legend.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayers.NumLayers">
- <summary>
- Returns the number of layers loaded in the DotSpatial. Drawing layers are not counted.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ILayers.Item(System.Int32)">
- <summary>
- Returns the layer object corresponding the the specified <c>LayerHandle</c>
- </summary>
- </member>
- <member name="T:DotSpatial.Compatibility.IMapWin">
- <summary>
- IMapWin
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IMapWin.ClearCustomWindowTitle">
- <summary>
- Returns dialog title for the main window to the default "project name" title.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IMapWin.GetProjectionFromUser(System.String,System.String)">
- <summary>
- Prompt the user to select a projection, and return the PROJ4 representation of this
- projection. Specify the dialog caption and an optional default projection ("" for none).
- </summary>
- <param name="dialogCaption">The text to be displayed on the dialog, e.g. "Please select a projection."</param>
- <param name="defaultProjection">The PROJ4 projection string of the projection to default to, "" for none.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Compatibility.IMapWin.Refresh">
- <summary>
- Refreshes the DotSpatial display.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IMapWin.RefreshDynamicVisibility">
- <summary>
- Refreshes Dynamic Visibility
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IMapWin.SetCustomWindowTitle(System.String)">
- <summary>
- Sets the dialog title to be displayed after the "AppInfo" name for the main window.
- Overrides the default "project name" title.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IMapWin.ShowErrorDialog(System.Exception)">
- <summary>
- Displays the DotSpatial error dialog.
- </summary>
- <param name="ex"></param>
- </member>
- <member name="M:DotSpatial.Compatibility.IMapWin.ShowErrorDialog(System.Exception,System.String)">
- <summary>
- Displays the DotSpatial error dialog, sending to a specific address.
- </summary>
- <param name="ex"></param>
- <param name="sendEmailTo"></param>
- </member>
- <member name="P:DotSpatial.Compatibility.IMapWin.GetOCX">
- <summary>
- Returns the underlying MapWinGIS activex control for advanced operations.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IMapWin.ApplicationInfo">
- <summary>
- Provides control over application-level settings like the app name.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IMapWin.DisplayFullProjectPath">
- <summary>
- Specify whether the full project path should be specified rather than just fileName, in title bar for main window.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IMapWin.LastError">
- <summary>
- Gets the last error message set. Note: This error message could have been set at any time.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IMapWin.Layers">
- <summary>
- Returns the <c>Layers</c> object that handles layers.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IMapWin.Menus">
- <summary>
- Returns the <c>Menus</c> object that manages the menus.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IMapWin.Plugins">
- <summary>
- Returns the <c>Plugins</c> object that manages plugins.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IMapWin.PreviewMap">
- <summary>
- Returns the <c>PreviewMap</c> object that manages the preview map.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IMapWin.Project">
- <summary>
- Provides control over project and configuration files.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IMapWin.Reports">
- <summary>
- Provides access to report generation methods and properties.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IMapWin.StatusBar">
- <summary>
- Returns the <c>StausBar</c> object that manages the status bar.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IMapWin.Toolbar">
- <summary>
- Returns the <c>Toolbar</c> object that manages toolbars.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IMapWin.UiPanel">
- <summary>
- Provides access to the user panel in the lower right of the DotSpatial form.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IMapWin.UserInteraction">
- <summary>
- User-interactive functions. Used to prompt users to enter things, or otherwise prompt users.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IMapWin.View">
- <summary>
- Returns the <c>View</c> object that handles the map view.
- </summary>
- </member>
- <member name="T:DotSpatial.Compatibility.IMenuItem">
- <summary>
- An object that represents a menu item within the Main Menu
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IMenuItem.SubItem(System.Int32)">
- <summary>
- Gets a submenu item by its 0-based index
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IMenuItem.SubItem(System.String)">
- <summary>
- Gets a submenu item by its string name
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IMenuItem.Text">
- <summary>
- Gets/Sets the Text shown for the MenuItem
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IMenuItem.Picture">
- <summary>
- Gets/Sets the icon for the menu item
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IMenuItem.Category">
- <summary>
- Gets/Sets the category for this item (used when the user customizes the menu)
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IMenuItem.Checked">
- <summary>
- Gets/Sets the checked state of the item
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IMenuItem.Tooltip">
- <summary>
- Gets/Sets the tool tip text that will pop up for the item when a mouse over event occurs
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IMenuItem.BeginsGroup">
- <summary>
- Gets/Sets whether or not this item should draw a dividing line between itself and any
- items before this item
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IMenuItem.Cursor">
- <summary>
- Gets/Sets the cursor used when the mouse is over this control
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IMenuItem.Description">
- <summary>
- Gets/Sets the description of this menu item, used in customization of menu by the user
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IMenuItem.Displayed">
- <summary>
- Gets/Sets the Displayed state of this item
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IMenuItem.Enabled">
- <summary>
- Gets/Sets the enabled state of this item
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IMenuItem.Name">
- <summary>
- Gets the Name of this item
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IMenuItem.Visible">
- <summary>
- Gets/Sets the visibility state of this item
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IMenuItem.NumSubItems">
- <summary>
- Gets the count of the submenu items contained within this item
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IMenuItem.IsFirstVisibleSubmenuItem">
- <summary>
- Returns whether this menu item is the first visible submenu item.
- This is only valid in submenus, i.e. menus which have a parent.
- </summary>
- </member>
- <member name="T:DotSpatial.Compatibility.IMenus">
- <summary>
- Used for manipulation of the menu system for the application
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IMenus.AddMenu(System.String)">
- <summary>
- Adds a menu with the specified name
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IMenus.AddMenu(System.String,System.Drawing.Image)">
- <summary>
- Adds a menu with the specified name and icon
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IMenus.AddMenu(System.String,System.Drawing.Image,System.String)">
- <summary>
- Adds a menu with the specified name, icon and text
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IMenus.AddMenu(System.String,System.String)">
- <summary>
- Adds a menu with the specified name to the menu indicated by ParentMenu
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IMenus.AddMenu(System.String,System.String,System.Drawing.Image)">
- <summary>
- Adds a menu with the specified name and icon to the menu indicated by ParentMenu
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IMenus.AddMenu(System.String,System.String,System.Drawing.Image,System.String)">
- <summary>
- Adds a menu with the specified name, icon and text to the specified ParentMenu
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IMenus.AddMenu(System.String,System.String,System.Drawing.Image,System.String,System.String)">
- <summary>
- Adds a menu with the specified name, icon and text to the specified ParentMenu and after the specifed item
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IMenus.AddMenu(System.String,System.String,System.String,System.String)">
- <summary>
- Adds a menu with the specified name and text to the specified ParentMenu and before the specifed item
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IMenus.Remove(System.String)">
- <summary>
- Removes a MenuItem
- </summary>
- <param name="name">Name of the item to remove</param>
- <returns>true on success, false otherwise</returns>
- </member>
- <member name="P:DotSpatial.Compatibility.IMenus.Item(System.String)">
- <summary>
- Gets a MenuItem by its name
- </summary>
- </member>
- <member name="T:DotSpatial.Compatibility.IPlugin">
- <summary>
- During the Initialize method, the
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IPlugin.Initialize(DotSpatial.Compatibility.IMapWin,System.Int32)">
- <summary>
- This method is called by the DotSpatial when the plugin is loaded.
- </summary>
- <param name="mapWin">The <c>IMapWin</c> interface to use when interacting with the DotSpatial.</param>
- <param name="parentHandle">The windows handle of the DotSpatial form. This can be used to make the DotSpatial the parent of any forms in the plugin.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IPlugin.ItemClicked(System.String,System.Boolean@)">
- <summary>
- This method is called by the DotSpatial when a toolbar or menu item is clicked.
- </summary>
- <param name="itemName">Name of the item that was clicked.</param>
- <param name="handled">Set this parameter to true if your plugin handles this so that no other plugins recieve this message.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IPlugin.LayersAdded(DotSpatial.Compatibility.ILayerOld[])">
- <summary>
- This method is called by the DotSpatial when one or more layer(s) is/are added.
- </summary>
- <param name="layers">An array of <c>Layer</c> objects that were added.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IPlugin.LayersCleared">
- <summary>
- This method is called by the DotSpatial when all layers are cleared from the map.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IPlugin.LayerRemoved(System.Int32)">
- <summary>
- This method is called by the DotSpatial when a layer is removed from the map.
- </summary>
- <param name="handle">Handle of the layer that was removed.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IPlugin.LayerSelected(System.Int32)">
- <summary>
- This method is called by the DotSpatial when a layer is selected in code or by the legend.
- </summary>
- <param name="handle">Handle of the newly selected layer.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IPlugin.LegendDoubleClick(System.Int32,DotSpatial.Compatibility.ClickLocation,System.Boolean@)">
- <summary>
- This method is called by the DotSpatial when the user double-clicks on the legend.
- </summary>
- <param name="handle">Handle of the layer or group that was double-clicked</param>
- <param name="location">Location that was clicked. Either a layer or a group.</param>
- <param name="handled">Set this parameter to true if your plugin handles this so that no other plugins recieve this message.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IPlugin.LegendMouseDown(System.Int32,System.Int32,DotSpatial.Compatibility.ClickLocation,System.Boolean@)">
- <summary>
- This method is called by the DotSpatial when the user presses a mouse button on the legend.
- </summary>
- <param name="handle">Handle of the layer or group that was under the cursor.</param>
- <param name="button">The mouse button that was pressed. You can use the <c>vb6Buttons</c> enumeration to determine which button was pressed.</param>
- <param name="location">Location that was clicked. Either a layer or a group</param>
- <param name="handled">Set this parameter to true if your plugin handles this so that no other plugins recieve this message.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IPlugin.LegendMouseUp(System.Int32,System.Int32,DotSpatial.Compatibility.ClickLocation,System.Boolean@)">
- <summary>
- This method is called by the DotSpatial when the user releases a mouse button on the legend.
- </summary>
- <param name="handle">Handle of the layer or group that was under the cursor.</param>
- <param name="button">The mouse button that was released. You can use the <c>vb6Buttons</c> enumeration to determine which button it was.</param>
- <param name="location">Location that was clicked. Either a layer or a group</param>
- <param name="handled">Set this parameter to true if your plugin handles this so that no other plugins recieve this message.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IPlugin.MapExtentsChanged">
- <summary>
- This method is called by the DotSpatial when the extents of the map have changed.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IPlugin.MapMouseDown(System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean@)">
- <summary>
- This method is called by the DotSpatial when the user presses a mouse button over the map.
- </summary>
- <param name="button">The button that was pressed. These values can be compared to the <c>vb6Butttons</c> enumerations.</param>
- <param name="shift">This value represents the state of the <c>ctrl</c>, <c>alt</c> and <c>shift</c> keyboard buttons. The values use VB6 values.</param>
- <param name="x">The x coordinate in pixels.</param>
- <param name="y">The y coordinate in pixels.</param>
- <param name="handled">Set this parameter to true if your plugin handles this so that no other plugins recieve this message.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IPlugin.MapMouseMove(System.Int32,System.Int32,System.Boolean@)">
- <summary>
- This method is called by the DotSpatial when the user moves the mouse over the map display.
- </summary>
- <param name="screenX">The x coordinate in pixels.</param>
- <param name="screenY">The y coordinate in pixels.</param>
- <param name="handled">Set this parameter to true if your plugin handles this so that no other plugins recieve this message.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IPlugin.MapMouseUp(System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean@)">
- <summary>
- This method is called by the DotSpatial when the user releases a mouse button over the map.
- </summary>
- <param name="button">The button that was released. These values can be compared to the <c>vb6Butttons</c> enumerations.</param>
- <param name="shift">This value represents the state of the <c>ctrl</c>, <c>alt</c> and <c>shift</c> keyboard buttons. The values use VB6 values.</param>
- <param name="x">The x coordinate in pixels.</param>
- <param name="y">The y coordinate in pixels.</param>
- <param name="handled">Set this parameter to true if your plugin handles this so that no other plugins recieve this message.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IPlugin.MapDragFinished(System.Drawing.Rectangle,System.Boolean@)">
- <summary>
- This method is called by the DotSpatial when the user completes a dragging operation on the map.
- </summary>
- <param name="bounds">The rectangle that was selected, in pixel coordinates.</param>
- <param name="handled">Set this parameter to true if your plugin handles this so that no other plugins recieve this message.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IPlugin.ProjectLoading(System.String,System.String)">
- <summary>
- This method is called by the DotSpatial when a project is being loaded.
- </summary>
- <param name="projectFile">Filename of the project file.</param>
- <param name="settingsString">Settings string for this plugin from the project file.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IPlugin.ProjectSaving(System.String,System.String@)">
- <summary>
- This method is called by the DotSpatial when a project is being saved.
- </summary>
- <param name="projectFile">Filename of the project file.</param>
- <param name="settingsString">Reference parameter. Set this value in order to save your plugin's settings string in the project file.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IPlugin.Terminate">
- <summary>
- This method is called by the DotSpatial when the plugin is unloaded.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IPlugin.ShapesSelected(System.Int32,DotSpatial.Compatibility.ISelectInfo)">
- <summary>
- This method is called by the DotSpatial when shapes are selected by the user.
- </summary>
- <param name="handle">Handle of the shapefile layer that was selected on.</param>
- <param name="selectInfo">The <c>SelectInfo</c> object containing information about the selected shapes.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IPlugin.Message(System.String,System.Boolean@)">
- <summary>
- This message is relayed by the DotSpatial when another plugin broadcasts a message. Messages can be used to send messages between plugins.
- </summary>
- <param name="msg">The message being relayed.</param>
- <param name="handled">Set this parameter to true if your plugin handles this so that no other plugins recieve this message.</param>
- </member>
- <member name="P:DotSpatial.Compatibility.IPlugin.Author">
- <summary>
- Author of the plugin.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IPlugin.Description">
- <summary>
- Short description of the plugin.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IPlugin.SerialNumber">
- <summary>
- Plugin serial number. NO LONGER NEEDED; kept for backward compatibility.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IPlugin.Name">
- <summary>
- Name of the plugin.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IPlugin.BuildDate">
- <summary>
- Build date.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IPlugin.Version">
- <summary>
- Plugin version.
- </summary>
- </member>
- <member name="T:DotSpatial.Compatibility.IPlugins">
- <summary>
- Interface for manipulating plugins of the IPlugin type.
- This differs from "CondensedPlugins" in that the Item ([]) property returns IPlugin
- instead of IPluginDetails. The original "Plugins" (this one) cannot be changed without breaking
- the backward compatibility of the interface.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IPlugins.Clear">
- <summary>
- clears all plugins from the list of available plugins, but doesn't unload loaded plugins
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IPlugins.AddFromFile(System.String)">
- <summary>
- Add a plugin from a file
- </summary>
- <param name="path">path to the plugin</param>
- <returns>true on success, false on failure</returns>
- </member>
- <member name="M:DotSpatial.Compatibility.IPlugins.AddFromDir(System.String)">
- <summary>
- Adds any compatible plugins from a directory(recursive into subdirs)
- </summary>
- <param name="path">path to the directory</param>
- <returns>true on success, false otherwise</returns>
- </member>
- <member name="M:DotSpatial.Compatibility.IPlugins.LoadFromObject(DotSpatial.Compatibility.IPlugin,System.String,System.String)">
- <summary>
- Loads a plugin from an instance of an object
- </summary>
- <param name="plugin">the Plugin object to load</param>
- <param name="pluginKey">The Key by which this plugin can be identified at a later time</param>
- <param name="settingsString">A string that contains any settings that should be passed to the plugin after it is loaded into the system</param>
- <returns>true on success, false otherwise</returns>
- </member>
- <member name="M:DotSpatial.Compatibility.IPlugins.LoadFromObject(DotSpatial.Compatibility.IPlugin,System.String)">
- <summary>
- Loads a plugin from an instance of an object
- </summary>
- <param name="plugin">the Plugin object to load</param>
- <param name="pluginKey">The Key by which this plugin can be identified at a later time</param>
- <returns>true on success, false otherwise</returns>
- </member>
- <member name="M:DotSpatial.Compatibility.IPlugins.StartPlugin(System.String)">
- <summary>
- Starts (loads) a specified plugin
- </summary>
- <param name="key">Identifying key for the plugin to start</param>
- <returns>true on success, false otherwise</returns>
- </member>
- <member name="M:DotSpatial.Compatibility.IPlugins.StopPlugin(System.String)">
- <summary>
- Stops (unloads) a specified plugin
- </summary>
- <param name="key">Identifying key for the plugin to stop</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IPlugins.Remove(System.Object)">
- <summary>
- Removes a plugin from the list of available plugins and unloads the plugin if loaded
- </summary>
- <param name="indexOrKey">0-based integer index or string key for the plugin to remove</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IPlugins.PluginIsLoaded(System.String)">
- <summary>
- Checks to see if a plugin is currently loaded (running)
- </summary>
- <param name="key">Unique key identifying the plugin</param>
- <returns>true if loaded, false otherwise</returns>
- </member>
- <member name="M:DotSpatial.Compatibility.IPlugins.ShowPluginDialog">
- <summary>
- Shows the dialog for loading/starting/stopping plugins
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IPlugins.BroadcastMessage(System.String)">
- <summary>
- Sends a broadcast message to all loaded plugins
- </summary>
- <param name="message">The message that should be sent</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IPlugins.GetPluginKey(System.String)">
- <summary>
- Returns the key belonging to a plugin with the given name. An empty string is returned if the name is not found.
- </summary>
- <param name="pluginName">The name of the plugin</param>
- </member>
- <member name="P:DotSpatial.Compatibility.IPlugins.Count">
- <summary>
- number of available plugins
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IPlugins.Item(System.Int32)">
- <summary>
- Gets an IPlugin object from the list of all loaded plugins
- <param name="index">0-based index into the list of plugins</param>
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IPlugins.PluginFolder">
- <summary>
- Gets or Sets the default folder where plugins are loaded from
- </summary>
- </member>
- <member name="T:DotSpatial.Compatibility.IPreviewMap">
- <summary>
- Interface for manipulating the PreviewMap
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IPreviewMap.GetPictureFromMap">
- <summary>
- Tells the PreviewMap to rebuild itself by getting new data from the main view
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IPreviewMap.Update">
- <summary>
- Tells the PreviewMap to rebuild itself by getting new data from the main view (current extents).
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IPreviewMap.Update(DotSpatial.Compatibility.PreviewExtentMode)">
- <summary>
- Tells the PreviewMap to rebuild itself by getting new data from the main view.
- <param name="updateExtents">Update from full extent or current view?</param>
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IPreviewMap.GetPictureFromFile(System.String)">
- <summary>
- Loads a picture into the PreviewMap from a specified file
- </summary>
- <param name="fileName">The path to the file to load</param>
- <returns>true on success, false on failure</returns>
- </member>
- <member name="P:DotSpatial.Compatibility.IPreviewMap.BackColor">
- <summary>
- Gets/Sets the back color
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IPreviewMap.Picture">
- <summary>
- Gets/Sets the Picture to be displayed
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IPreviewMap.LocatorBoxColor">
- <summary>
- Gets/Sets the color used for the LocatorBox
- </summary>
- </member>
- <member name="T:DotSpatial.Compatibility.IProject">
- <summary>
- Project
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IProject.Load(System.String)">
- <summary>
- Loads a project file.
- </summary>
- <param name="fileName">Filename of the project to load.</param>
- <returns>Returns true if successful.</returns>
- </member>
- <member name="M:DotSpatial.Compatibility.IProject.LoadIntoCurrentProject(System.String)">
- <summary>
- Loads a project file into the current project as a subgroup.
- </summary>
- <param name="fileName">Filename of the project to load.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IProject.Save(System.String)">
- <summary>
- Saves the current project.
- </summary>
- <param name="fileName">Filename to save the project as.</param>
- <returns>Returns true if successful.</returns>
- </member>
- <member name="M:DotSpatial.Compatibility.IProject.SaveConfig(System.String)">
- <summary>
- Saves the current configuration to a configuration file.
- </summary>
- <param name="fileName">The fileName to save the configuration as.</param>
- <returns>Returns true if successful.</returns>
- </member>
- <member name="P:DotSpatial.Compatibility.IProject.ConfigFileName">
- <summary>
- Returns the fileName of the configuration file that was used to load the current DotSpatial project.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IProject.ConfigLoaded">
- <summary>
- Returns whether the configuration file specified by the project has been loaded.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IProject.FileName">
- <summary>
- Returns the fileName of the current project.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IProject.MapUnits">
- <summary>
- Return or set the current map units, in the format
- "Meters", "Feet", etc
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IProject.MapUnitsAlternate">
- <summary>
- Return or set the current alternate display units, in the format
- "Meters", "Feet", etc
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IProject.Modified">
- <summary>
- Gets or sets the project modified flag.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IProject.ProjectProjection">
- <summary>
- Return or set the current project projection, in the format
- "+proj=tmerc +ellps=WGS84 etc etc +datum=WGS84"
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IProject.RecentProjects">
- <summary>
- Returns an ArrayList of the recent projects (the full path to the projects)
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IProject.SaveShapeSettings">
- <summary>
- Gets or sets the option to save shape-level formatting.
- </summary>
- </member>
- <member name="T:DotSpatial.Compatibility.IReports">
- <summary>
- Reports
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IReports.GetLegendLayerSnapshot(System.Int32,System.Int32)">
- <summary>
- Similar to <c>GetLegendSnapshot</c> except that only one layer is considered.
- </summary>
- <param name="layerHandle">Handle of the layer to take a snapshot of.</param>
- <param name="imgWidth">Maximum width of the image. The height of the image depends on the coloring scheme of the layer.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IReports.GetLegendSnapshot(System.Boolean,System.Int32)">
- <summary>
- Returns an image of the legend.
- </summary>
- <param name="visibleLayersOnly">Specifies that only the visible layers are part of the snapshot.</param>
- <param name="imgWidth">Maximum width of the image. The height of the image depends on the number of layers loaded.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IReports.GetNorthArrow">
- <summary>
- Returns an image of a north arrow.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IReports.GetScaleBar(DotSpatial.Compatibility.UnitsOfMeasure,DotSpatial.Compatibility.UnitsOfMeasure,System.Int32)">
- <summary>
- Returns an image that represents an accurate scale bar.
- </summary>
- <param name="mapUnits">You must specify what the map units are.</param>
- <param name="scalebarUnits">The unit of measurement to display on the scale bar. This function can convert the map units to any other unit.</param>
- <param name="maxWidth">Maximum width of the scale bar image.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IReports.GetScaleBar(System.String,System.String,System.Int32)">
- <summary>
- Returns an image that represents an accurate scale bar.
- </summary>
- <param name="mapUnits">You must specify what the map units are.</param>
- <param name="scalebarUnits">The unit of measurement to display on the scale bar. This function can convert the map units to any other unit.</param>
- <param name="maxWidth">Maximum width of the scale bar image.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IReports.GetScreenPicture(DotSpatial.Topology.Envelope)">
- <summary>
- Returns a <c>MapWinGIS.Image</c> of the view at the specified extents.
- </summary>
- <param name="boundBox">The area that you wish to take the picture of. Uses projected map units.</param>
- </member>
- <member name="T:DotSpatial.Compatibility.ISelectedShape">
- <summary>
- The <c>SelectedShape</c> interface is used to access information about a shape that is selected in the DotSpatial.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.ISelectedShape.Add(System.Int32,System.Drawing.Color)">
- <summary>
- Initializes all information in the <c>SelectedShape</c> object then highlights the shape on the map.
- </summary>
- <param name="shapeIndex">Index of the shape in the shapefile.</param>
- <param name="selectColor">Color to use when highlighting the shape.</param>
- </member>
- <member name="P:DotSpatial.Compatibility.ISelectedShape.Extents">
- <summary>
- Returns the extents of this selected shape.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ISelectedShape.ShapeIndex">
- <summary>
- Returns the shape index of this selected shape.
- </summary>
- </member>
- <member name="T:DotSpatial.Compatibility.ISelectInfo">
- <summary>
- This interface is used to manage and access all selected shapes.
- </summary>
- <remarks>All selection is done only to the selected layer. The selected layer handle can be accessed using the <c>LayerHandle</c> property.</remarks>
- </member>
- <member name="M:DotSpatial.Compatibility.ISelectInfo.AddSelectedShape(DotSpatial.Compatibility.ISelectedShape)">
- <summary>
- Adds a <c>SelectedShape</c> object to the managed collection of all selected shapes.
- </summary>
- <param name="newShape">The <c>SelectedShape</c> object to add.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.ISelectInfo.AddByIndex(System.Int32,System.Drawing.Color)">
- <summary>
- Adds a new <c>SelectedShape</c> to the collection from the provided shape index.
- </summary>
- <param name="shapeIndex">The index of the shape to add.</param>
- <param name="selectColor">The color to use when highlighting the shape.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.ISelectInfo.ClearSelectedShapes">
- <summary>
- Clears the list of selected shapes, returning each selected shape to it's original color.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.ISelectInfo.RemoveSelectedShape(System.Int32)">
- <summary>
- Removes a <c>SelectedShape</c> from the collection, reverting it to it's original color.
- </summary>
- <param name="listIndex">Index in the collection of the <c>SelectedShape</c>.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.ISelectInfo.RemoveByShapeIndex(System.Int32)">
- <summary>
- Removes a <c>SelectedShape</c> from the collection, reverting it to it's original color.
- </summary>
- <param name="shapeIndex">The shape index of the <c>SelectedShape</c> to remove.</param>
- </member>
- <member name="P:DotSpatial.Compatibility.ISelectInfo.LayerHandle">
- <summary>
- Returns the LayerHandle of the selected layer.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ISelectInfo.NumSelected">
- <summary>
- Returns the number of shapes that are currently selected.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ISelectInfo.SelectBounds">
- <summary>
- Returns the total extents of all selected shapes.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.ISelectInfo.Item(System.Int32)">
- <summary>
- Returns the <c>SelectedShape</c> at the specified index.
- </summary>
- </member>
- <member name="T:DotSpatial.Compatibility.IStatusBar">
- <summary>
- Used to manipulate the status bar at the bottom of Mapwindow.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IStatusBar.AddPanel">
- <summary>
- Adds a new panel to the status bar. This function has been deprecated. Please use the
- <c>AddPanel(Text)</c> overload.
- </summary>
- <returns>The StatusBarItem that was just added</returns>
- </member>
- <member name="M:DotSpatial.Compatibility.IStatusBar.AddPanel(System.Int32)">
- <summary>
- Adds a new panel to the status bar. This function has been deprecated. Please use the
- <c>AddPanel(Text)</c> overload.
- </summary>
- <param name="insertAt">The index at which the panel should be added</param>
- <returns>The StatusBarItem that was just added</returns>
- </member>
- <member name="M:DotSpatial.Compatibility.IStatusBar.AddPanel(System.String,System.Int32,System.Int32,System.Windows.Forms.StatusBarPanelAutoSize)">
- <summary>
- This is the preferred method to use to add a statusbar panel.
- </summary>
- <param name="text">Text to display in the panel.</param>
- <param name="position">Position to insert panel at.</param>
- <param name="width">Width of the panel in pixels.</param>
- <param name="autoSize">Panel <c>AutoSize</c> property.</param>
- <returns>A <c>StatusBarPanel</c> object.</returns>
- </member>
- <member name="M:DotSpatial.Compatibility.IStatusBar.RemovePanel(System.Int32)">
- <summary>
- Removes the specified Panel. There must always be one panel. If you remove the last panel, the <c>DotSpatial</c> will automatically add one.
- </summary>
- <param name="index">Zero-Based index of the panel to be removed</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IStatusBar.RemovePanel(System.Windows.Forms.StatusBarPanel@)">
- <summary>
- Removes the panel object specified. There must always be one panel. If you remove the last panel, the <c>DotSpatial</c> will automatically add one.
- </summary>
- <param name="panel"><c>StatusBarPanel</c> to remove.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IStatusBar.ResizeProgressBar">
- <summary>
- This function makes the progress bar fit into the last panel of the status bar. Call this function whenever you change the size of ANY panel in the status bar. You do not need to call this on <c>AddPanel</c> or <c>RemovePanel</c>.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IStatusBar.Enabled">
- <summary>
- Gets/Sets the enabled state of the StatusBar
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IStatusBar.ShowProgressBar">
- <summary>
- Gets/Sets whether or not the StatusBar's ProgressBar should be shown
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IStatusBar.ProgressBarValue">
- <summary>
- Gets/Sets the value of the StatusBar's ProgressBar
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IStatusBar.Item(System.Int32)">
- <summary>
- Iterator for all panels within the StatusBar
- </summary>
- <param name="index">Index of the StatusBarItem to retrieve</param>
- </member>
- <member name="P:DotSpatial.Compatibility.IStatusBar.NumPanels">
- <summary>
- Returns the number of panels in the <c>StatusBar</c>.
- </summary>
- <returns>Number of panels in the <c>StatusBar</c>.</returns>
- </member>
- <member name="T:DotSpatial.Compatibility.IStatusBarItem">
- <summary>
- The object given back when a panel is added to the status bar. This object can
- be used to
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IStatusBarItem.Alignment">
- <summary>
- Gets/Sets the Alignment of the text
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IStatusBarItem.AutoSize">
- <summary>
- Gets/Sets whether or not this StatusBarItem should auto size itself
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IStatusBarItem.MinWidth">
- <summary>
- Gets/Sets the minimum allowed width for this StatusBarItem
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IStatusBarItem.Text">
- <summary>
- Gets/Sets the Text within the StatusBarItem
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IStatusBarItem.Width">
- <summary>
- Gets/Sets the width of the StatusBarItem
- </summary>
- </member>
- <member name="T:DotSpatial.Compatibility.IToolbar">
- <summary>
- Used to add/remove Toolbars, buttons, combo boxes, etc. to/from the application
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IToolbar.AddToolbar(System.String)">
- <summary>
- Adds a Toolbar group to the Main Toolbar
- </summary>
- <param name="name">The name to give to the Toolbar item</param>
- <returns>true on success, false on failure</returns>
- </member>
- <member name="M:DotSpatial.Compatibility.IToolbar.AddButton(System.String)">
- <summary>
- Adds a button to a specified to the default Toolbar
- </summary>
- <param name="name">The name to give to the new ToolbarButton</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IToolbar.AddButton(System.String,System.Boolean)">
- <summary>
- Adds a button to a specified to the default Toolbar
- </summary>
- <param name="name">The name to give to the new ToolbarButton</param>
- <param name="isDropDown">Should this button support drop-down items?</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IToolbar.AddButton(System.String,System.String,System.Boolean)">
- <summary>
- Adds a button to a specified to the default Toolbar
- </summary>
- <param name="name">The name to give to the new ToolbarButton</param>
- /// <param name="toolbar">The name of the Toolbar to which this ToolbarButton should belong (if null or empty, then the default Toolbar will be used</param>
- <param name="isDropDown">Should this button support drop-down items?</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IToolbar.AddButtonDropDownSeparator(System.String,System.String,System.String)">
- <summary>
- Adds a separator to a toolstrip dropdown button.
- </summary>
- <param name="name">The name to give to the new separator.</param>
- <param name="toolbar">The name of the Toolbar to which this separator should belong (if null or empty, then the default Toolbar will be used.</param>
- <param name="parentButton">The name of the ToolbarButton to which this new separator should be added as a subitem.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IToolbar.AddButton(System.String,System.Object)">
- <summary>
- Adds a button to a specified to the default Toolbar
- </summary>
- <param name="name">The name to give to the new ToolbarButton</param>
- <param name="picture">The Icon/Bitmap to use as a picture on the ToolbarButton face</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IToolbar.AddButton(System.String,System.Object,System.String)">
- <summary>
- Adds a button to a specified to the default Toolbar
- </summary>
- <param name="name">The name to give to the new ToolbarButton</param>
- <param name="picture">The Icon/Bitmap to use as a picture on the ToolbarButton face</param>
- <param name="text">The text name for the ToolbarButton. This is the text the user will see if customizing the Toolbar</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IToolbar.AddButton(System.String,System.String,System.String,System.String)">
- <summary>
- Adds a button to a specified to the specified Toolbar.
- </summary>
- <param name="name">The name to give to the new ToolbarButton.</param>
- <param name="toolbar">The name of the Toolbar to which this ToolbarButton should belong (if null or empty, then the default Toolbar will be used.</param>
- <param name="parentButton">The name of the ToolbarButton to which this new ToolbarButton should be added as a subitem.</param>
- <param name="after">The name of the ToolbarButton after which this new ToolbarButton should be added.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IToolbar.AddComboBox(System.String,System.String,System.String)">
- <summary>
- Adds a ComboBoxItem to a specified to the default Toolbar.
- </summary>
- <param name="name">The name to give to the new ComboBoxItem.</param>
- <param name="toolbar">The name of the Toolbar to which this ToolbarButton should belong.</param>
- <param name="after">The name of the ToolbarButton/ComboBoxItem afterwhich this new item should be added.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IToolbar.ButtonItem(System.String)">
- <summary>
- returns the specified ToolbarButton (null on failure)
- </summary>
- <param name="name">The name of the ToolbarButton to retrieve</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IToolbar.ComboBoxItem(System.String)">
- <summary>
- returns the specified ComboBoxItem
- </summary>
- <param name="name">Name of the item to retrieve</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IToolbar.NumToolbarButtons(System.String)">
- <summary>
- Returns the number of buttons on the specified toolbar, or 0 if the toolbar can't be found.
- </summary>
- <param name="toolbarName">The name of the toolbar.</param>
- <returns>The number of buttons on the toolbar.</returns>
- </member>
- <member name="M:DotSpatial.Compatibility.IToolbar.PressToolbarButton(System.String)">
- <summary>
- Presses the specified ToolBar button (if it's enabled) as if a user
- had pressed it.
- </summary>
- <param name="name">The name of the toolbar button to press.</param>
- <returns>true on success, false on failure (i.e. bad toolbar button name)</returns>
- </member>
- <member name="M:DotSpatial.Compatibility.IToolbar.RemoveToolbar(System.String)">
- <summary>
- Removes the specified Toolbar and any ToolbarButton/ComboBoxItems contained within the control
- </summary>
- <param name="name">The name of the Toolbar to be removed</param>
- <returns>true on success, false on failure</returns>
- </member>
- <member name="M:DotSpatial.Compatibility.IToolbar.RemoveButton(System.String)">
- <summary>
- Removes the specified ToolbarButton item
- </summary>
- <param name="name">The name of the ToolbarButton to be removed</param>
- <returns>true on success, false on failure</returns>
- </member>
- <member name="M:DotSpatial.Compatibility.IToolbar.RemoveComboBox(System.String)">
- <summary>
- Removes the specified ComboBoxItem
- </summary>
- <param name="name">The name of the ComboBoxItem to be removed</param>
- <returns>true on success, false on failure</returns>
- </member>
- <member name="T:DotSpatial.Compatibility.IToolbarButton">
- <summary>
- Object given back when a button is added to a Toolbar. This
- object can then be used to manipulate (change properties) for the button.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IToolbarButton.SubItem(System.Int32)">
- <summary>
- Returns the Subitem with the specified zero-based index (null if out of range)
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IToolbarButton.SubItem(System.String)">
- <summary>
- returns the Subitem with the specified name (null if it doesn't exist)
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IToolbarButton.BeginsGroup">
- <summary>
- Gets/Sets a flag indicating that this item starts a new group by drawing a seperator line if necessary
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IToolbarButton.Category">
- <summary>
- Gets/Sets the Category for this ToolbarButton item (used when user is customizing the Toolbar)
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IToolbarButton.Cursor">
- <summary>
- Gets/Sets the Cursor for this control
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IToolbarButton.Description">
- <summary>
- Gets/Sets the description for the control (used when the user customizes the Toolbar)
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IToolbarButton.Displayed">
- <summary>
- Gets/Sets a flag marking whether or not this ToolbarButton is displayed
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IToolbarButton.Enabled">
- <summary>
- Gets/Sets the enabled state
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IToolbarButton.Name">
- <summary>
- Gets the name of the ToolbarButton item
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IToolbarButton.NumSubItems">
- <summary>
- Gets the number of subitems
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IToolbarButton.Picture">
- <summary>
- Gets/Sets the picture for the ToolbarButton
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IToolbarButton.Pressed">
- <summary>
- Gets/Sets the pressed state of the ToolbarButton
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IToolbarButton.Text">
- <summary>
- Gets/Sets the Text/Caption of the ToolbarButton
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IToolbarButton.Tooltip">
- <summary>
- Gets/Sets the tooltip text for the control
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IToolbarButton.Visible">
- <summary>
- Gets/Sets the visibility of the ToolbarButton
- </summary>
- </member>
- <member name="T:DotSpatial.Compatibility.OnPanelClose">
- <summary>
- A function that is called upon close of a panel. The
- name (caption) of the closed panel is passed into the
- OnPanelClose function.
- </summary>
- </member>
- <member name="T:DotSpatial.Compatibility.IUIPanel">
- <summary>
- UiPanel
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IUIPanel.AddOnCloseHandler(System.String,DotSpatial.Compatibility.OnPanelClose)">
- <summary>
- Adds a function (onCloseFunction) which
- is called when the panel specified by caption is closed.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IUIPanel.CreatePanel(System.String,DotSpatial.Compatibility.SpatialDockStyle)">
- <summary>
- Returns a Panel that can be used to add dockable content to DotSpatial.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IUIPanel.CreatePanel(System.String,System.Windows.Forms.DockStyle)">
- <summary>
- Returns a Panel that can be used to add dockable content to DotSpatial.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IUIPanel.DeletePanel(System.String)">
- <summary>
- Deletes the specified panel.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IUIPanel.SetPanelVisible(System.String,System.Boolean)">
- <summary>
- Hides or shows a panel without necessarily deleting it.
- </summary>
- </member>
- <member name="T:DotSpatial.Compatibility.IUserInteraction">
- <summary>
- UserInteraction
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IUserInteraction.GetProjectionFromUser(System.String,System.String)">
- <summary>
- Prompt the user to select a projection, and return the PROJ4 representation of this
- projection. Specify the dialog caption and an optional default projection ("" for none).
- </summary>
- <param name="dialogCaption">The text to be displayed on the dialog, e.g. "Please select a projection."</param>
- <param name="defaultProjection">The PROJ4 projection string of the projection to default to, "" for none.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Compatibility.IUserInteraction.GetColorRamp(System.Drawing.Color,System.Drawing.Color,System.Drawing.Color@,System.Drawing.Color@)">
- <summary>
- Retrieve a color ramp, defined by a start and end color, from the user.
- </summary>
- <param name="suggestedStart">The start color to initialize the dialog with.</param>
- <param name="suggestedEnd">The end color to initialize the dialog with.</param>
- <param name="selectedStart">The start color that the user selected.</param>
- <param name="selectedEnd">The end color that the user selected.</param>
- <returns>Boolean, true if the effort was successful.</returns>
- </member>
- <member name="T:DotSpatial.Compatibility.IViewOld">
- <summary>
- The View interface is used to manipulate or work with the main DotSpatial display.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IViewOld.ClearSelectedShapes">
- <summary>
- Clears all selected shapes from the DotSpatial, reverting them to their original colors.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IViewOld.Identify(System.Double,System.Double,System.Double)">
- <summary>
- Queries all of the active shapefile layers for any within the specified tolerance of the given point.
- </summary>
- <param name="projX">The x coordinate, in projected map units, of the point to query.</param>
- <param name="projY">The y coordinate, in projected map units, of the point to query.</param>
- <param name="tolerance">Tolerance is the distance, in projected map units, around the point to include in the query.</param>
- <returns>Returns an <c>IdentifiedLayers</c> object containing query results.</returns>
- </member>
- <member name="M:DotSpatial.Compatibility.IViewOld.LockLegend">
- <summary>
- Prevents the legend from showing any changes made to it until the <c>UnlockLegend</c> function is called.
- The legend maintains a count of the number of locks it has, only redrawing if there are no locks.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IViewOld.UnlockLegend">
- <summary>
- Unlocking the Legend allows it to redraw and update the view to reflect any changes that were made.
- The legend maintains a count of the number of locks it has, only redrawing if there are no locks.
- There can never be a negative number of locks.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IViewOld.LockMap">
- <summary>
- Prevents the map from updating due to any changes made to the layers that are loaded until the <c>UnlockMap</c> function is called.
- The map maintains a count of the number of locks it has, only redrawing if there are no locks.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IViewOld.UnlockMap">
- <summary>
- Allows the map to redraw entirely when changes are made.
- The map maintains a count of the number of locks it has, only redrawing if there are no locks.
- There can never be a negative number of locks.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IViewOld.PixelToProj(System.Double,System.Double,System.Double@,System.Double@)">
- <summary>
- Converts a point in pixel coordinates to a point in projected map units.
- </summary>
- <param name="pixelX">X coordinate of the original point in pixels.</param>
- <param name="pixelY">Y coordinate of the original point in pixels.</param>
- <param name="projX">ByRef. X coordinate of the projected point.</param>
- <param name="projY">ByRef. Y coordinate of the projected point.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IViewOld.ProjToPixel(System.Double,System.Double,System.Double@,System.Double@)">
- <summary>
- Converts a point in projected map units to a point in screen coordinates.
- </summary>
- <param name="projX">X coordinate of the projected map point.</param>
- <param name="projY">Y coordinate of the projected map point.</param>
- <param name="pixelX">ByRef. X coordinate of the screen point in pixels.</param>
- <param name="pixelY">ByRef. Y coordinate of the screen point in pixels.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IViewOld.Redraw">
- <summary>
- Forces the map to redraw. This function has no effect if the map is locked.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IViewOld.ShowToolTip(System.String,System.Int32)">
- <summary>
- Shows a tooltip under the cursor on the map.
- </summary>
- <param name="text">The text to display in the tooltip.</param>
- <param name="milliseconds">Number of milliseconds before the tooltip automatically disappears.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IViewOld.ZoomToMaxExtents">
- <summary>
- Zooms the view to the maximum extents of all the loaded and visible layers.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IViewOld.ZoomIn(System.Double)">
- <summary>
- Zooms the display in by the given factor.
- </summary>
- <param name="percent">The percentage to zoom by.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IViewOld.ZoomOut(System.Double)">
- <summary>
- Zooms the display out by the given factor.
- </summary>
- <param name="percent">The percentage to zoom by.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IViewOld.ZoomToPrev">
- <summary>
- Zooms to the previous extent.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.IViewOld.Snapshot(DotSpatial.Topology.IEnvelope)">
- <summary>
- Takes a snapshot of the currently visible layers at the extents specified.
- </summary>
- <param name="bounds">The area to take the snapshot of.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IViewOld.LabelsRelabel(System.Int32)">
- <summary>
- Triggers reloading of field values for the given layer. No action will occur if the layer handle is invalid, not a shapefile, or has no labels.
- </summary>
- <param name="layerHandle"></param>
- </member>
- <member name="M:DotSpatial.Compatibility.IViewOld.LabelsEdit(System.Int32)">
- <summary>
- Displays the label editor form for the specified layer. No action will occur if the layer handle is invalid or not a shapefile.
- </summary>
- <param name="layerHandle"></param>
- </member>
- <member name="M:DotSpatial.Compatibility.IViewOld.Select(System.Int32,System.Int32,System.Boolean)">
- <summary>
- Selects shapes in the mapwindow from the specified point. The tolerance used is the global
- tolerance set through the <c>View.SelectionTolerance</c>. This function uses the same selection
- routines that are called when a user selects with a mouse.
- </summary>
- <param name="screenX">The x coordinate in pixels of the location to select.</param>
- <param name="screenY">The y coordinate in pixels of the location to select.</param>
- <param name="clearOldSelection">Specifies whether to clear all previously selected shapes or not.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.IViewOld.Select(System.Drawing.Rectangle,System.Boolean)">
- <summary>
- Selects shapes in the mapwindow from the specified rectangle. This function uses the
- same selection routines that are called when a user selects with a mouse.
- </summary>
- <param name="screenBounds">The rectangle to select shapes with. This rectangle must be in screen (pixel) coordinates.</param>
- <param name="clearOldSelection">Specifies whether to clear all previously selected shapes or not.</param>
- </member>
- <member name="P:DotSpatial.Compatibility.IViewOld.PreviewVisible">
- <summary>
- Determines whether the preview map panel is visible.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IViewOld.LegendVisible">
- <summary>
- Determines whether the legend panel is visible.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IViewOld.BackColor">
- <summary>
- Gets or sets the background color of the map.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IViewOld.CursorMode">
- <summary>
- Gets or sets the current cursor mode. The cursor mode can be any of the following:
- <list type="bullet">
- <item>None</item>
- <item>Pan</item>
- <item>Selection</item>
- <item>ZoomIn</item>
- <item>ZoomOut</item>
- </list>
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IViewOld.Draw">
- <summary>
- Returns a <c>DotSpatial.Interfaces.Draw</c> interface used to add custom drawing to the map.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IViewOld.ExtentPad">
- <summary>
- Gets or sets the amount to pad around the extents when calling <c>ZoomToMaxExtents</c>,
- <c>ZoomToLayer</c>, and <c>ZoomToShape</c>.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IViewOld.Extents">
- <summary>
- Gets or sets the map's current extents.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IViewOld.MapCursor">
- <summary>
- Gets or sets the cursor to use on the map. The enumeration can be any of the following:
- <list type="bullet">
- <item>crsrAppStarting</item>
- <item>crsrArrow</item>
- <item>crsrCross</item>
- <item>crsrHelp</item>
- <item>crsrIBeam</item>
- <item>crsrMapDefault</item>
- <item>crsrNo</item>
- <item>crsrSizeAll</item>
- <item>crsrSizeNESW</item>
- <item>crsrSizeNS</item>
- <item>crsrSizeNWSE</item>
- <item>crsrSizeWE</item>
- <item>crsrUpArrow</item>
- <item>crsrUserDefined</item>
- <item>crsrWait</item>
- </list>
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IViewOld.HandleFileDrop">
- <summary>
- Indicates that the map should handle file drag-drop events (as opposed to firing a message indicating file(s) were dropped).
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IViewOld.MapState">
- <summary>
- Gets or sets the <c>MapState</c> string which describes in a single string the entire
- map state, including layers and coloring schemes.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IViewOld.SelectedShapes">
- <summary>
- Returns a <c>SelectInfo</c> object containing information about all shapes that are currently selected.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IViewOld.LabelsUseProjectLevel">
- <summary>
- Determines whether labels are loaded from and saved to a project-specific label file or from a shapefile-specific label file. Using a project-level label file will create a new subdirectory with the project's name.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IViewOld.SelectionPersistence">
- <summary>
- Gets or sets whether selection should be persistent. If selection is persistent, previously selected
- shapes are not cleared before selecting the new shapes. When selection is persistent you must select
- nothing to clear the selection. The default value for this property is false. When selection is not
- persistent, all selected shapes are cleared between selection routines unless the user is holding down
- a control or shift key.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IViewOld.SelectionTolerance">
- <summary>
- The tolerance, in projected map units, to use for selection.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IViewOld.SelectMethod">
- <summary>
- Gets or sets the selection method to use.
- <list type="bullet">
- <item>Inclusion</item>
- <item>Intersection</item>
- </list>
- Inclusion means that the entire shape must be within the selection bounds in order to select
- the shape. Intersection means that only a portion of the shape must be within the selection
- bounds in order for the shape to be selected.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IViewOld.SelectColor">
- <summary>
- Gets or sets the color used to indicate a selected shape.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IViewOld.Tag">
- <summary>
- Gets or sets a tag for the map. The tag is a string variable that can be used by a developer
- to store any information they desire.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IViewOld.UserCursorHandle">
- <summary>
- Gets or sets the handle of the cursor to use when the <c>CursorMode</c> is <c>cmUserDefined</c>.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.IViewOld.ZoomPercent">
- <summary>
- Gets or sets the default zoom percentage to use when interacting with the map using a mouse.
- </summary>
- </member>
- <member name="T:DotSpatial.Compatibility.LayerType">
- <summary>
- LayerType
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.LayerType.Grid">
- <summary>
- Raster Layer
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.LayerType.Image">
- <summary>
- Image Layer
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.LayerType.Invalid">
- <summary>
- Not a valid layer format
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.LayerType.LineShapefile">
- <summary>
- Line FeatureSet Layer
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.LayerType.PointShapefile">
- <summary>
- Point FeatureSet Layer
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.LayerType.PolygonShapefile">
- <summary>
- Polygon FeatureSet Layer
- </summary>
- </member>
- <member name="T:DotSpatial.Compatibility.LegacyPluginManager">
- <summary>
- PluginManager for dealing with additional plugins
- </summary>
- <summary>
- The Designer for hte Legacy Plugin Manager class
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.LegacyPluginManager.#ctor">
- <summary>
- Constructor for Plugin Manager
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.LegacyPluginManager.#ctor(System.ComponentModel.IContainer)">
- <summary>
- Constructor for Plugin Manager
- </summary>
- <param name="container">A Container</param>
- </member>
- <member name="M:DotSpatial.Compatibility.LegacyPluginManager.AddPluginMenu">
- <summary>
- Checks the dlls in the Plugins folder or any subfolder and
- adds a new checked menu item for each one that it finds.
- This can also be controlled using the PluginMenuIsVisible property.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.LegacyPluginManager.RemovePluginMenu">
- <summary>
- Looks for a menu named Plug-ins and removes it.
- Control this through the PluginMenuIsVisible property.
- This can also be controlled using the PluginMenuIsVisible property.
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.LegacyPluginManager.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.LegacyPluginManager.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.LegacyPluginManager.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.LegacyPluginManager.Legend">
- <summary>
- Gets or sets the Legend associated with this plugin manager
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.LegacyPluginManager.Map">
- <summary>
- Gets or sets the Map associated with this plugin manager
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.LegacyPluginManager.MapMenuStrip">
- <summary>
- Gets or sets the MapMenuStrip associated with this plugin manager
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.LegacyPluginManager.MapToolstrip">
- <summary>
- Gets or sets the MapToolStrip associated with this plugin manager
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.LegacyPluginManager.PreviewMap">
- <summary>
- Gets or sets the Preview Map associated with this plugin manager
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.LegacyPluginManager.PluginMenuIsVisible">
- <summary>
- Controls whether or not a Plugin menu will be added to the MapMenuStrip
- specified by this Plugin Manager
- </summary>
- </member>
- <member name="T:DotSpatial.Compatibility.MapCursorMode">
- <summary>
- MapCursorModes
- </summary>
- <item>AppStarting</item>
- <item>Arrow</item>
- <item>Cross</item>
- <item>Help</item>
- <item>IBeam</item>
- <item>MapDefault</item>
- <item>No</item>
- <item>SizeAll</item>
- <item>SizeNESW</item>
- <item>SizeNS</item>
- <item>SizeNWSE</item>
- <item>SizeWE</item>
- <item>UpArrow</item>
- <item>UserDefined</item>
- <item>Wait</item>
- </member>
- <member name="F:DotSpatial.Compatibility.MapCursorMode.AppStarting">
- <summary>
- App starting icon
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.MapCursorMode.Arrow">
- <summary>
- typical white arrow with black border
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.MapCursorMode.Cross">
- <summary>
- A right angle cross
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.MapCursorMode.Help">
- <summary>
- Question mark
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.MapCursorMode.IBeam">
- <summary>
- An IBeam like for editing text
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.MapCursorMode.MapDefault">
- <summary>
- An arrow
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.MapCursorMode.No">
- <summary>
- A circle with a diagonal line
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.MapCursorMode.SizeAll">
- <summary>
- Arrows pointing north, south, east and west
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.MapCursorMode.SizeNESW">
- <summary>
- A diagonal line with arrows pointing northeast and southwest
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.MapCursorMode.SizeNS">
- <summary>
- A vertical line with arrows up and down
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.MapCursorMode.SizeNWSE">
- <summary>
- A diagonal line with arrows pointing northwest and southeast
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.MapCursorMode.SizeWE">
- <summary>
- A horizontal line with arrows pointing west and east
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.MapCursorMode.UpArrow">
- <summary>
- An up pointed arrow
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.MapCursorMode.UserDefined">
- <summary>
- Use a custom icon
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.MapCursorMode.Wait">
- <summary>
- Windows wait cursor (varies from system to system)
- </summary>
- </member>
- <member name="T:DotSpatial.Compatibility.MapWin">
- <summary>
- MapWin
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.MapWin.#ctor">
- <summary>
- Constructs a new empty instance of this interface wrapper that is mostly used
- for backwards compatibility.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.MapWin.#ctor(DotSpatial.Controls.IBasicMap,DotSpatial.Controls.ILegend,System.Windows.Forms.Form,System.Windows.Forms.MenuStrip)">
- <summary>
- Constructs a new instance of a MapWin interface where the Map, Legend, Form and MenuStrip
- are all specified.
- </summary>
- <param name="inMap">Any valid implementation of IBasicMap</param>
- <param name="inLegend">Any valid implementation of ILegend</param>
- <param name="inMainForm">Any valid windows Form</param>
- <param name="inMenuStrip">Any valid windows MenuStrip</param>
- </member>
- <member name="M:DotSpatial.Compatibility.MapWin.ClearCustomWindowTitle">
- <summary>
- Returns dialog title for the main window to the default "project name" title.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.MapWin.GetProjectionFromUser(System.String,System.String)">
- <summary>
- Prompt the user to select a projection, and return the PROJ4 representation of this
- projection. Specify the dialog caption and an optional default projection ("" for none).
- </summary>
- <param name="dialogCaption">The text to be displayed on the dialog, e.g. "Please select a projection."</param>
- <param name="defaultProjection">The PROJ4 projection string of the projection to default to, "" for none.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Compatibility.MapWin.Refresh">
- <summary>
- Refreshes the DotSpatial display.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.MapWin.RefreshDynamicVisibility">
- <summary>
- Refreshes Dynamic Visibility
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.MapWin.SetCustomWindowTitle(System.String)">
- <summary>
- Sets the dialog title to be displayed after the "AppInfo" name for the main window.
- Overrides the default "project name" title.
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.MapWin.ShowErrorDialog(System.Exception)">
- <summary>
- Displays the DotSpatial error dialog.
- </summary>
- <param name="ex"></param>
- </member>
- <member name="M:DotSpatial.Compatibility.MapWin.ShowErrorDialog(System.Exception,System.String)">
- <summary>
- Displays the DotSpatial error dialog, sending to a specific address.
- </summary>
- <param name="ex"></param>
- <param name="sendEmailTo"></param>
- </member>
- <member name="P:DotSpatial.Compatibility.MapWin.GetOCX">
- <summary>
- In The new context, this return whatever the BasicMap is.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.MapWin.ApplicationInfo">
- <summary>
- Provides control over application-level settings like the app name.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.MapWin.DisplayFullProjectPath">
- <summary>
- Specify whether the full project path should be specified rather than just fileName, in title bar for main window.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.MapWin.LastError">
- <summary>
- Gets the last error message set. Note: This error message could have been set at any time.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.MapWin.Layers">
- <summary>
- Returns the <c>Layers</c> object that handles layers.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.MapWin.Menus">
- <summary>
- Returns the <c>Menus</c> object that manages the menus.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.MapWin.Plugins">
- <summary>
- Returns the <c>Plugins</c> object that manages plugins.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.MapWin.PreviewMap">
- <summary>
- Returns the <c>PreviewMap</c> object that manages the preview map.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.MapWin.Project">
- <summary>
- Provides control over project and configuration files.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.MapWin.Reports">
- <summary>
- Provides access to report generation methods and properties.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.MapWin.StatusBar">
- <summary>
- Returns the <c>StausBar</c> object that manages the status bar.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.MapWin.Toolbar">
- <summary>
- Returns the <c>Toolbar</c> object that manages toolbars.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.MapWin.UiPanel">
- <summary>
- Provides access to the user panel in the lower right of the DotSpatial form.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.MapWin.UserInteraction">
- <summary>
- User-interactive functions. Used to prompt users to enter things, or otherwise prompt users.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.MapWin.View">
- <summary>
- Returns the <c>View</c> object that handles the map view.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.MapWin.Map">
- <summary>
- Gets or sets the basic map for this MapWin
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.MapWin.Legend">
- <summary>
- Gets or sets the legend to use for this MapWin
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.MapWin.MainForm">
- <summary>
- Gets or sets the main form to use for this MapWin
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.MapWin.MenuStrip">
- <summary>
- Gets or sets the menu strip to use for this MapWin
- </summary>
- </member>
- <member name="T:DotSpatial.Compatibility.MenuItem">
- <summary>
- MenuItem
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.MenuItem.#ctor(System.Windows.Forms.ToolStripMenuItem)">
- <summary>
- Creates a new instance of MenuItem
- </summary>
- <param name="inMenuItem">The ToolStripMenuItem to wrap with this item</param>
- </member>
- <member name="M:DotSpatial.Compatibility.MenuItem.SubItem(System.Int32)">
- <summary>
- Gets a submenu item by its 0-based index
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.MenuItem.SubItem(System.String)">
- <summary>
- Gets a submenu item by its string name
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.MenuItem.Text">
- <summary>
- Gets/Sets the Text shown for the MenuItem
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.MenuItem.Picture">
- <summary>
- Gets/Sets the icon for the menu item
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.MenuItem.Category">
- <summary>
- Gets/Sets the category for this item (used when the user customizes the menu)
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.MenuItem.Checked">
- <summary>
- Gets/Sets the checked state of the item
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.MenuItem.Tooltip">
- <summary>
- Gets/Sets the tool tip text that will pop up for the item when a mouse over event occurs
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.MenuItem.BeginsGroup">
- <summary>
- Gets/Sets whether or not this item should draw a dividing line between itself and any
- items before this item
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.MenuItem.Cursor">
- <summary>
- Gets/Sets the cursor used when the mouse is over this control
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.MenuItem.Description">
- <summary>
- Gets/Sets the description of this menu item, used in customization of menu by the user
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.MenuItem.Displayed">
- <summary>
- Gets/Sets the Displayed state of this item
- ... Side Note
- ... I have no idea what this is supposed to do, so it is redundant with visible for now
- and possibly should be made obsolete.
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.MenuItem.Enabled">
- <summary>
- Gets/Sets the enabled state of this item
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.MenuItem.Name">
- <summary>
- Gets the Name of this item
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.MenuItem.Visible">
- <summary>
- Gets/Sets the visibility state of this item
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.MenuItem.NumSubItems">
- <summary>
- Gets the count of the submenu items contained within this item
- </summary>
- </member>
- <member name="P:DotSpatial.Compatibility.MenuItem.IsFirstVisibleSubmenuItem">
- <summary>
- Returns whether this menu item is the first visible submenu item.
- This is only valid in submenus, i.e. menus which have a parent.
- </summary>
- </member>
- <member name="T:DotSpatial.Compatibility.Menus">
- <summary>
- Menus
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.Menus.#ctor(System.Windows.Forms.MenuStrip)">
- <summary>
- Creates a new instance of Menus
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.Menus.AddMenu(System.String)">
- <summary>
- Adds a menu with the specified name and uses the name as the text.
- </summary>
- <param name="name">The string name of the menu item to add.</param>
- </member>
- <member name="M:DotSpatial.Compatibility.Menus.AddMenu(System.String,System.Drawing.Image)">
- <summary>
- Adds a menu with the specified name and image, and uses the name as the text.
- </summary>
- <param name="name">the string name of the menu item and text</param>
- <param name="picture">The image to associate with the menu item</param>
- </member>
- <member name="M:DotSpatial.Compatibility.Menus.AddMenu(System.String,System.Drawing.Image,System.String)">
- <summary>
- Adds a menu with the specified name, icon and text
- </summary>
- <param name="name">The name to use to identify this item later</param>
- <param name="picture">An image to associate with this item</param>
- <param name="text">The string text to appear for this item</param>
- </member>
- <member name="M:DotSpatial.Compatibility.Menus.AddMenu(System.String,System.String)">
- <summary>
- Adds a menu with the specified name to the menu indicated by ParentMenu
- </summary>
- <param name="name">The string name to use</param>
- <param name="parentMenu">The string name of the parent to add the menu to</param>
- </member>
- <member name="M:DotSpatial.Compatibility.Menus.AddMenu(System.String,System.String,System.Drawing.Image)">
- <summary>
- Adds a menu with the specified name and icon to the menu indicated by ParentMenu
- </summary>
- <param name="name">the name to use as a key to identify this item and as text</param>
- <param name="parentMenu">the parent menu item</param>
- <param name="picture">The image to use for this item</param>
- </member>
- <member name="M:DotSpatial.Compatibility.Menus.AddMenu(System.String,System.String,System.Drawing.Image,System.String)">
- <summary>
- Adds a menu with the specified name, icon and text to the specified ParentMenu
- </summary>
- <param name="name">The string name to use as a key for this item</param>
- <param name="parentMenu">The name of the parent menu to add this new item to</param>
- <param name="picture">The picture to add for this item</param>
- <param name="text">The string text to add for this item</param>
- </member>
- <member name="M:DotSpatial.Compatibility.Menus.AddMenu(System.String,System.String,System.Drawing.Image,System.String,System.String)">
- <summary>
- Adds a menu with the specified name, icon and text to the specified ParentMenu and after the specifed item
- </summary>
- <param name="name">The string name to use as a key for this item</param>
- <param name="parentMenu">The name of the parent menu to add this new item to</param>
- <param name="picture">The picture to add for this item</param>
- <param name="text">The string text to add for this item</param>
- <param name="after">The name of the sibling menu item to add this item directly after</param>
- </member>
- <member name="M:DotSpatial.Compatibility.Menus.AddMenu(System.String,System.String,System.String,System.String)">
- <summary>
- Adds a menu with the specified name and text to the specified ParentMenu and before the specifed item
- </summary>
- <param name="name">The string name to use as a key for this item</param>
- <param name="parentMenu">The name of the parent menu to add this new item to</param>
- <param name="text">The string text to add for this item</param>
- <param name="before">The name of the sibling to insert this menu item on top of</param>
- </member>
- <member name="M:DotSpatial.Compatibility.Menus.Remove(System.String)">
- <summary>
- Removes a MenuItem
- </summary>
- <param name="name">Name of the item to remove</param>
- <returns>true on success, false otherwise</returns>
- </member>
- <member name="P:DotSpatial.Compatibility.Menus.Item(System.String)">
- <summary>
- Gets a MenuItem by its name
- </summary>
- </member>
- <member name="T:DotSpatial.Compatibility.PointType">
- <summary>
- PointTypes
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.PointType.Circle">
- <summary>
- Circular points
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.PointType.Diamond">
- <summary>
- Diamond
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.PointType.Square">
- <summary>
- Square
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.PointType.TriangleDown">
- <summary>
- Triangle pointed down
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.PointType.TriangleLeft">
- <summary>
- Triangle pointed left
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.PointType.TriangleRight">
- <summary>
- Triangle pointed right
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.PointType.TriangleUp">
- <summary>
- Triangle pointed up
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.PointType.UserDefined">
- <summary>
- User defined
- </summary>
- </member>
- <member name="T:DotSpatial.Compatibility.PreviewExtentMode">
- <summary>
- Enumeration of possible preview map update types.
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.PreviewExtentMode.FullExtents">
- <summary>
- Update using full exents.
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.PreviewExtentMode.CurrentMapView">
- <summary>
- Update using current map view.
- </summary>
- </member>
- <member name="T:DotSpatial.Compatibility.ReferenceType">
- <summary>
- ReferenceTypes
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.ReferenceType.Screen">
- <summary>
- The coordinates are drawn in screen coordinates on the layer, and stay fixed as the map
- zooms and pans
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.ReferenceType.Geographic">
- <summary>
- The drawing layer is geographically referenced and will move with the other spatially
- referenced map content.
- </summary>
- </member>
- <member name="T:DotSpatial.Compatibility.SelectMode">
- <summary>
- Gets or sets the selection method to use.
- <list type="bullet">
- <item>Inclusion</item>
- <item>Intersection</item>
- </list>
- Inclusion means that the entire shape must be within the selection bounds in order to select
- the shape. Intersection means that only a portion of the shape must be within the selection
- bounds in order for the shape to be selected.
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.SelectMode.Inclusion">
- <summary>
- The entire contents of the potentially selected item must fall withing the specified extents
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.SelectMode.Intersection">
- <summary>
- The item will be selected if any of the contents of the potentially selected item can be found
- in the specified extents.
- </summary>
- </member>
- <member name="T:DotSpatial.Compatibility.SpatialDockStyle">
- <summary>
- Docking styles for DotSpatial UIPanels
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.SpatialDockStyle.None">
- <summary>Floating</summary>
- </member>
- <member name="F:DotSpatial.Compatibility.SpatialDockStyle.Left">
- <summary>Dock Left</summary>
- </member>
- <member name="F:DotSpatial.Compatibility.SpatialDockStyle.Right">
- <summary>Dock Right</summary>
- </member>
- <member name="F:DotSpatial.Compatibility.SpatialDockStyle.Top">
- <summary>Dock Top</summary>
- </member>
- <member name="F:DotSpatial.Compatibility.SpatialDockStyle.Bottom">
- <summary>Dock Bottom</summary>
- </member>
- <member name="F:DotSpatial.Compatibility.SpatialDockStyle.LeftAutoHide">
- <summary>Dock Left Autohidden</summary>
- </member>
- <member name="F:DotSpatial.Compatibility.SpatialDockStyle.RightAutoHide">
- <summary>Dock Right Autohidden</summary>
- </member>
- <member name="F:DotSpatial.Compatibility.SpatialDockStyle.TopAutoHide">
- <summary>Dock Top Autohidden</summary>
- </member>
- <member name="F:DotSpatial.Compatibility.SpatialDockStyle.BottomAutoHide">
- <summary>Dock Bottom Autohidden</summary>
- </member>
- <member name="T:DotSpatial.Compatibility.Stipple">
- <summary>
- FillStipple
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.Stipple.Custom">
- <summary>
- Use a custom stipple pattern
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.Stipple.DashDotDash">
- <summary>
- A dashes and dots
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.Stipple.Dashed">
- <summary>
- Dashes only
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.Stipple.Dotted">
- <summary>
- Dots only
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.Stipple.None">
- <summary>
- No stipple pattern should be used
- </summary>
- </member>
- <member name="T:DotSpatial.Compatibility.UnitsOfMeasure">
- <summary>
- UnitOfMeasure
- </summary>
- </member>
- <member name="F:DotSpatial.Compatibility.UnitsOfMeasure.DecimalDegrees">
- <summary>The units are in decimal degrees.</summary>
- </member>
- <member name="F:DotSpatial.Compatibility.UnitsOfMeasure.Millimeters">
- <summary>The units are in millimeters.</summary>
- </member>
- <member name="F:DotSpatial.Compatibility.UnitsOfMeasure.Centimeters">
- <summary>The units are in centimeters.</summary>
- </member>
- <member name="F:DotSpatial.Compatibility.UnitsOfMeasure.Inches">
- <summary>The units are in inches.</summary>
- </member>
- <member name="F:DotSpatial.Compatibility.UnitsOfMeasure.Feet">
- <summary>The units are in feet.</summary>
- </member>
- <member name="F:DotSpatial.Compatibility.UnitsOfMeasure.Yards">
- <summary>The units are in Yards.</summary>
- </member>
- <member name="F:DotSpatial.Compatibility.UnitsOfMeasure.Meters">
- <summary>The units are in meters.</summary>
- </member>
- <member name="F:DotSpatial.Compatibility.UnitsOfMeasure.Miles">
- <summary>The units are in miles.</summary>
- </member>
- <member name="F:DotSpatial.Compatibility.UnitsOfMeasure.Kilometers">
- <summary>The units are in kilometers.</summary>
- </member>
- <member name="F:DotSpatial.Compatibility.UnitsOfMeasure.NauticalMiles">
- <summary>The units are in nautical miles.</summary>
- </member>
- <member name="F:DotSpatial.Compatibility.UnitsOfMeasure.Acres">
- <summary>The units are in acres.</summary>
- </member>
- <member name="F:DotSpatial.Compatibility.UnitsOfMeasure.Hectares">
- <summary>The units are in hectares.</summary>
- </member>
- <member name="F:DotSpatial.Compatibility.UnitsOfMeasure.Unknown">
- <summary>The units are unknown.</summary>
- </member>
- <member name="T:DotSpatial.Compatibility.UserInteraction">
- <summary>
- UserInteraction
- </summary>
- </member>
- <member name="M:DotSpatial.Compatibility.UserInteraction.GetProjectionFromUser(System.String,System.String)">
- <summary>
- Prompt the user to select a projection, and return the PROJ4 representation of this
- projection. Specify the dialog caption and an optional default projection ("" for none).
- </summary>
- <param name="dialogCaption">The text to be displayed on the dialog, e.g. "Please select a projection."</param>
- <param name="defaultProjection">The PROJ4 projection string of the projection to default to, "" for none.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Compatibility.UserInteraction.GetColorRamp(System.Drawing.Color,System.Drawing.Color,System.Drawing.Color@,System.Drawing.Color@)">
- <summary>
- Retrieve a color ramp, defined by a start and end color, from the user.
- </summary>
- <param name="suggestedStart">The start color to initialize the dialog with.</param>
- <param name="suggestedEnd">The end color to initialize the dialog with.</param>
- <param name="selectedStart">The start color that the user selected.</param>
- <param name="selectedEnd">The end color that the user selected.</param>
- <returns>Boolean, true if the method was successful.</returns>
- </member>
- </members>
-</doc>
diff --git a/MES_Wind/bin/Debug/DotSpatial.Controls.pdb b/MES_Wind/bin/Debug/DotSpatial.Controls.pdb
deleted file mode 100644
index 8a9af8b892211a1ea89657f9c3430e11889e22e8..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/DotSpatial.Controls.pdb and /dev/null differ
diff --git a/MES_Wind/bin/Debug/DotSpatial.Controls.xml b/MES_Wind/bin/Debug/DotSpatial.Controls.xml
deleted file mode 100644
index 46b9e609d8722dcb42e5ff8142d15c876185be54..0000000000000000000000000000000000000000
--- a/MES_Wind/bin/Debug/DotSpatial.Controls.xml
+++ /dev/null
@@ -1,11147 +0,0 @@
-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>DotSpatial.Controls</name>
- </assembly>
- <members>
- <member name="T:DotSpatial.Controls.DatelineCrossingMap">
- <summary>
- Based on Ted's original idea in https://dotspatial.codeplex.com/discussions/232535 discussion thread,
- a second frame is added to complement the main frame to handle dateline crossing.
- First the main frame is normalized so that its left edge is in range [-180..180] and its width is bound to 360 but
- retain its aspect ratio.
- After the normalization, if main frame's right edge > 180 which indicates dateline crossing, then the main frame is clipped
- to 180 degrees, and the secondary frame takes over, shifted to -180 degrees to the required width.
- </summary>
- <remarks>Dateline crossing map works correctly only with WGS84 datum Mercator projection.</remarks>
- </member>
- <member name="T:DotSpatial.Controls.Map">
- <summary>
- The Map Control for 2D applications.
- </summary>
- <summary>
- A Map Component that can be dropped on a form
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.IMap">
- <summary>
- This map draws geographic coordinates directly to pixel coordinates
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.IBasicMap">
- <summary>
- IBasicMap
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.IMapView">
- <summary>
- IClient
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.IMapView.PixelToProj(System.Drawing.Point)">
- <summary>
- Converts a single point location into an equivalent geographic coordinate
- </summary>
- <param name="position">The client coordinate relative to the map control</param>
- <returns>The geographic ICoordinate interface</returns>
- </member>
- <member name="M:DotSpatial.Controls.IMapView.PixelToProj(System.Drawing.Rectangle)">
- <summary>
- Converts a rectangle in pixel coordinates relative to the map control into
- a geographic envelope.
- </summary>
- <param name="rect">The rectangle to convert</param>
- <returns>An IEnvelope interface</returns>
- </member>
- <member name="M:DotSpatial.Controls.IMapView.ProjToPixel(DotSpatial.Topology.Coordinate)">
- <summary>
- Converts a single geographic location into the equivalent point on the
- screen relative to the top left corner of the map.
- </summary>
- <param name="location">The geographic position to transform</param>
- <returns>A Point with the new location.</returns>
- </member>
- <member name="M:DotSpatial.Controls.IMapView.ProjToPixel(DotSpatial.Data.Extent)">
- <summary>
- Converts a single geographic envelope into an equivalent Rectangle
- as it would be drawn on the screen.
- </summary>
- <param name="env">The geographic IEnvelope</param>
- <returns>A Rectangle</returns>
- </member>
- <member name="P:DotSpatial.Controls.IMapView.ViewExtents">
- <summary>
- Gets or sets the geographic extents to show in the view.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.IBasicMap.AddLayer">
- <summary>
- Adds a new layer to the map using an open file dialog.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.IBasicMap.PointToScreen(System.Drawing.Point)">
- <summary>
- Converts a point from client coordinates to screen coordinates.
- </summary>
- <param name="position">The client location.</param>
- <returns>A Point in screen coordinates</returns>
- </member>
- <member name="M:DotSpatial.Controls.IBasicMap.PointToClient(System.Drawing.Point)">
- <summary>
- Converst a point from screen coordinates to client coordinates
- </summary>
- <param name="position">The Point representing the screen position</param>
- <returns>The Point</returns>
- </member>
- <member name="M:DotSpatial.Controls.IBasicMap.Invalidate">
- <summary>
- Invalidates the entire Map control, forcing it to redraw itself from the back buffer stencils.
- This is good for drawing on top of the map, or when a layer is visible or not. If you need
- to change the colorscheme as well
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.IBasicMap.Invalidate(System.Drawing.Rectangle)">
- <summary>
- Invalidates the specified clipRectangle so that only that small region needs
- to redraw itself.
- </summary>
- <param name="clipRectangle"></param>
- </member>
- <member name="M:DotSpatial.Controls.IBasicMap.RefreshMap(System.Drawing.Rectangle)">
- <summary>
- Instructs the map to update the specified clipRectangle by drawing it to the back buffer.
- </summary>
- <param name="clipRectangle"></param>
- </member>
- <member name="M:DotSpatial.Controls.IBasicMap.ZoomToMaxExtent">
- <summary>
- Instructs the map to change the perspective to include the entire drawing content, and
- in the case of 3D maps, changes the perspective to look from directly overhead.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.IBasicMap.GetMaxExtent(System.Boolean)">
- <summary>
- // Added by Eric Hullinger 12/28/2012 for use in preventing zooming out too far.
- Gets the MaxExtents of current Map.
- </summary>
- <param name="expand">Indicates whether the extent should be expanded by 10% to satisfy issue 84 (Expand target envelope by 10%). </param>
- </member>
- <member name="M:DotSpatial.Controls.IBasicMap.ClearLayers">
- <summary>
- Instructs the map to clear the layers.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.IBasicMap.GetLayers">
- <summary>
- returns a functional list of the ILayer members. This list will be
- separate from the actual list stored, but contains a shallow copy
- of the members, so the layers themselves can be accessed directly.
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Controls.IBasicMap.Bounds">
- <summary>
- Gets the bounding rectangle representing this map in screen coordinates
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IBasicMap.BufferedImage">
- <summary>
- Gets an image that has been buffered
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IBasicMap.ClientRectangle">
- <summary>
- Gets the client rectangle of the map control
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IBasicMap.FunctionMode">
- <summary>
- Gets or sets the current tool mode. This rapidly enables or disables specific tools to give
- a combination of functionality. Selecting None will disable all the tools, which can be
- enabled manually by enabling the specific tool in the GeoTools dictionary.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IBasicMap.Extent">
- <summary>
- Gets the geographic bounds of all of the different data layers currently visible on the map.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IBasicMap.Height">
- <summary>
- Gets the height of the control
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IBasicMap.IsBusy">
- <summary>
- Gets or sets a boolean that indicates whether a map-function is currently interacting with the map.
- If this is true, then any tool-tip like popups or other mechanisms that require lots of re-drawing
- should suspend themselves to prevent conflict. Setting this actually increments an internal integer,
- so when that integer is 0, the map is "Not" busy, but multiple busy processes can work independently.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IBasicMap.IsZoomedToMaxExtent">
- <summary>
- Indicates whether the Map is Zoomed out to full extent or not.
- Added 1/3/2013 by Eric Hullinger
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IBasicMap.Left">
- <summary>
- Gets the screen coordinates of the
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IBasicMap.Legend">
- <summary>
- Gets the legend, if any, associated with this map control.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IBasicMap.MapFrame">
- <summary>
- A MapFrame
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IBasicMap.Top">
- <summary>
- Gets the screen coordinates of the top of this control
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IBasicMap.Width">
- <summary>
- Gets the width of the control
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IBasicMap.ZoomOutFartherThanMaxExtent">
- <summary>
- This allows to zoom out farther than the extent of the map. This is useful if we have only layers with small extents and want to look at them from farther out.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.IMap.ActivateMapFunction(DotSpatial.Controls.IMapFunction)">
- <summary>
- If the specified function is already in the list of functions, this will properly test the yield style of various
- map functions that are currently on and then activate the function. If this function is not in the list, then
- it will add it to the list. If you need to control the position, then insert the function before using this
- method to activate. Be warned that calling "Activate" directly on your function will activate your function
- but not disable any other functions. You can set "Map.FunctionMode = FunctionModes.None" first, and then
- specifically activate the function that you want.
- </summary>
- <param name="function">The MapFunction to activate, or add.</param>
- </member>
- <member name="M:DotSpatial.Controls.IMap.AddLayers">
- <summary>
- Adds a new layer to the map by using an open file dialog
- </summary>
- <returns>An IMapLayer that represents the layer in the map.</returns>
- </member>
- <member name="M:DotSpatial.Controls.IMap.AddLayer(System.String)">
- <summary>
- Creates a new layer from the specified fileName and adds it to the map.
- </summary>
- <param name="fileName">The string fileName to add to the map</param>
- <returns>The newly created IMapLayer</returns>
- </member>
- <member name="M:DotSpatial.Controls.IMap.AddLayer">
- <summary>
- Uses the file dialog to allow selection of a fileName for opening the
- new layer, but does not allow multiple files to be added at once.
- </summary>
- <returns>The newly opened IMapLayer</returns>
- </member>
- <member name="M:DotSpatial.Controls.IMap.AddLabels(DotSpatial.Symbology.IFeatureLayer,System.String,System.String,DotSpatial.Symbology.ILabelSymbolizer,System.String)">
- <summary>
- This will add a new label category that will only apply to the specified filter expression. This will not remove any existing categories.
- </summary>
- <param name="featureLayer">The feature layer that the labels should be applied to</param>
- <param name="expression">The string expression where field names are in square brackets</param>
- <param name="filterExpression">The string filter expression that controls which features are labeled. Field names are in square brackets, strings in single quotes.</param>
- <param name="symbolizer">The label symbolizer that controls the basic appearance of the labels in this category.</param>
- <param name="name">The name of the category.</param>
- </member>
- <member name="M:DotSpatial.Controls.IMap.AddLabels(DotSpatial.Symbology.IFeatureLayer,System.String,System.String,DotSpatial.Symbology.ILabelSymbolizer,System.Double)">
- <summary>
- This will add a new label category that will only apply to the specified filter expression. This will not remove any existing categories.
- </summary>
- <param name="featureLayer">The feature layer that the labels should be applied to</param>
- <param name="expression">The string expression where field names are in square brackets</param>
- <param name="filterExpression">The string filter expression that controls which features are labeled. Field names are in square brackets, strings in single quotes.</param>
- <param name="symbolizer">The label symbolizer that controls the basic appearance of the labels in this category.</param>
- <param name="width">A geographic width, so that if the map is zoomed to a geographic width smaller than this value, labels should appear.</param>
- </member>
- <member name="M:DotSpatial.Controls.IMap.GetImageLayers">
- <summary>
- Gets the subset of layers that are specifically raster layers, allowing
- you to control their symbology.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.IMap.GetRasterLayers">
- <summary>
- Gets the subset of layers that are specifically raster layers, allowing
- you to control their symbology.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.IMap.GetLineLayers">
- <summary>
- Gets a list of just the line layers (and not the general layers)
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.IMap.GetPolygonLayers">
- <summary>
- Gets a list of just the polygon layers (and not the general layers)
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.IMap.GetPointLayers">
- <summary>
- Gets a list of just the point layers (and not the general layers)
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.IMap.GetFeatureLayers">
- <summary>
- Gets a list of just the feature layers regardless of whether they are lines, points, or polygons
- </summary>
- <returns>An array of IMapFeatureLayers</returns>
- </member>
- <member name="M:DotSpatial.Controls.IMap.AddRasterLayers">
- <summary>
- Allows a multi-select file dialog to add raster layers, applying a
- filter so that only supported raster formats will appear.
- </summary>
- <returns>A list of the IMapRasterLayers that were opened.</returns>
- </member>
- <member name="M:DotSpatial.Controls.IMap.AddRasterLayer">
- <summary>
- Allows an open file dialog without multi-select enabled to add a single
- raster to the map as a layer, and returns the added layer.
- </summary>
- <returns>The IMapRasterLayer that was added</returns>
- </member>
- <member name="M:DotSpatial.Controls.IMap.AddFeatureLayers">
- <summary>
- Allows a mult-select open file dialog to specify several fileNames to add.
- Only files with supported vector extensions will be shown.
- </summary>
- <returns>The list of added MapFeatureLayers</returns>
- </member>
- <member name="M:DotSpatial.Controls.IMap.AddFeatureLayer">
- <summary>
- Allows an open file dialog without multi-select enabled to add a single
- raster tot he map as a layer, and returns the added layer.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.IMap.AddImageLayers">
- <summary>
- Allows a mult-select open file dialog to specify several fileNames to add.
- Only files with supported image extensions will be shown.
- </summary>
- <returns>The list of added MapImageLayers</returns>
- </member>
- <member name="M:DotSpatial.Controls.IMap.AddImageLayer">
- <summary>
- Allows an open dialog without multi-select to specify a single fileName
- to be added to the map as a new layer and returns the newly added layer.
- </summary>
- <returns>The layer that was added to the map.</returns>
- </member>
- <member name="M:DotSpatial.Controls.IMap.GetMapFunction(System.String)">
- <summary>
- Gets the MapFunction based on the string name
- </summary>
- <param name="name">The string name to find</param>
- <returns>The MapFunction with the specified name</returns>
- </member>
- <member name="M:DotSpatial.Controls.IMap.Refresh">
- <summary>
- This causes all of the datalayers to re-draw themselves to the buffer, rather than just drawing
- the buffer itself like what happens during "Invalidate"
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.IMap.ResetBuffer">
- <summary>
- This can be called any time, and is currently being used to capture
- the end of a resize event when the actual data should be updated.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.IMap.SaveLayer">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.IMap.ZoomIn">
- <summary>
- Zooms in one notch, so that the scale becomes larger and the features become larger.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.IMap.ZoomOut">
- <summary>
- Zooms out one notch so that the scale becomes smaller and the features become smaller.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.IMap.ZoomToNext">
- <summary>
- Zooms to the next extent of the map
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.IMap.ZoomToPrevious">
- <summary>
- Zooms to the previous extent of the map
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.IMap.LayerAdded">
- <summary>
- Occurs after a layer has been added to the mapframe, or any of the child groups of that mapframe.
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.IMap.FinishedRefresh">
- <summary>
- Occurs after the map is refreshed
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.IMap.Resized">
- <summary>
- Occurs after the map is resized
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.IMap.FunctionModeChanged">
- <summary>
- Occurs when the map function mode is changed
- for example when function mode is changed from 'zoom' to 'select'
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IMap.CollectAfterDraw">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IMap.Cursor">
- <summary>
- Gets or sets the Cursor. This will be changed as the cursor mode changes.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IMap.MapFunctions">
- <summary>
- Gets or sets the dictionary of tools built into this project
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IMap.CollisionDetection">
- <summary>
- If this is true, then point layers in the map will only draw points that are
- more than 50% revealed. This should increase drawing speed for layers that have
- a large number of points.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IMap.MapFrame">
- <summary>
- Returns a MapFrame
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IMap.Layers">
- <summary>
- The layers for this map
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IMap.ProgressHandler">
- <summary>
- Gets or sets the progress handler for this component.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IMap.Projection">
- <summary>
- Gets or sets the projection. This should reflect the projection of the first data layer loaded.
- Loading subsequent, but non-matching projections should throw an alert, and allow reprojection.
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.Map._lastMinExtent">
- <summary>
- This is used to remember the last minimal extent that was set by OnViewExtentsChanged.
- It's used to stop a loop that starts if MapFrame.ResetAspectRatio makes the minExt smaller than 1e-7.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Map.#ctor">
- <summary>
- Creates a new instance of a map component that can be dropped on a form.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Map.OnLoad(System.EventArgs)">
- <summary>
- Handles the resizing in the case where the map uses docking, and therefore
- needs to be updated whenever the form changes size.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.Map.OnDragEnter(System.Windows.Forms.DragEventArgs)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Controls.Map.OnDragDrop(System.Windows.Forms.DragEventArgs)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Controls.Map.AddLabels(DotSpatial.Symbology.IFeatureLayer,System.String,System.String,DotSpatial.Symbology.ILabelSymbolizer,System.String)">
- <summary>
- This will add a new label category that will only apply to the specified filter expression.
- This will not remove any existing categories.
- </summary>
- <param name="featureLayer">The feature layer that the labels should be applied to</param>
- <param name="expression">The string expression where field names are in square brackets</param>
- <param name="filterExpression">The string filter expression that controls which features are labeled.
- Field names are in square brackets, strings in single quotes.</param>
- <param name="symbolizer">The label symbolizer that controls the basic appearance of the labels in this
- category.</param>
- <param name="name">The name of the category.</param>
- </member>
- <member name="M:DotSpatial.Controls.Map.AddLabels(DotSpatial.Symbology.IFeatureLayer,System.String,System.String,DotSpatial.Symbology.ILabelSymbolizer,System.Double)">
- <summary>
- This will add a new label category that will only apply to the specified filter expression. This will
- not remove any existing categories.
- </summary>
- <param name="featureLayer">The feature layer that the labels should be applied to</param>
- <param name="expression">The string expression where field names are in square brackets</param>
- <param name="filterExpression">The string filter expression that controls which features are labeled.
- Field names are in square brackets, strings in single quotes.</param>
- <param name="symbolizer">The label symbolizer that controls the basic appearance of the labels in this
- category.</param>
- <param name="width">A geographic width, so that if the map is zoomed to a geographic width smaller than
- this value, labels should appear.</param>
- </member>
- <member name="M:DotSpatial.Controls.Map.GetImageLayers">
- <summary>
- Gets the subset of layers that are specifically raster layers, allowing
- you to control their symbology.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.Map.GetRasterLayers">
- <summary>
- Gets the subset of layers that are specifically raster layers, allowing
- you to control their symbology.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.Map.GetLineLayers">
- <summary>
- Gets a list of just the line layers (and not the general layers)
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.Map.GetPolygonLayers">
- <summary>
- Gets a list of just the line layers (and not the general layers)
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.Map.GetPointLayers">
- <summary>
- Gets a list of just the line layers (and not the general layers)
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.Map.GetFeatureLayers">
- <summary>
- Gets a list of just the feature layers regardless of whether they are lines, points, or polygons
- </summary>
- <returns>An array of IMapFeatureLayers</returns>
- </member>
- <member name="M:DotSpatial.Controls.Map.GetMapFunction(System.String)">
- <summary>
- Gets the MapFunction based on the string name
- </summary>
- <param name="name">The string name to find</param>
- <returns>The MapFunction with the specified name</returns>
- </member>
- <member name="M:DotSpatial.Controls.Map.ClearSelection(DotSpatial.Topology.IEnvelope@)">
- <summary>
- Removes any members from existing in the selected state
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Map.Select(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IEnvelope,DotSpatial.Symbology.SelectionMode,DotSpatial.Topology.IEnvelope@)">
- <summary>
- Adds any members found in the specified region to the selected state as long as SelectionEnabled is set to true.
- </summary>
- <param name="tolerant">The geographic region where selection occurs that is tolerant for point or linestrings.</param>
- <param name="strict">The tight envelope to use for polygons.</param>
- <param name="mode">The selection mode.</param>
- <param name="affectedArea">The envelope affected area.</param>
- <returns>Boolean, true if any members were added to the selection.</returns>
- </member>
- <member name="M:DotSpatial.Controls.Map.InvertSelection(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IEnvelope,DotSpatial.Symbology.SelectionMode,DotSpatial.Topology.IEnvelope@)">
- <summary>
- Inverts the selected state of any members in the specified region.
- </summary>
- <param name="tolerant">The geographic region where selection occurs that is tolerant for point or linestrings.</param>
- <param name="strict">The tight envelope to use for polygons.</param>
- <param name="mode">The selection mode determining how to test for intersection.</param>
- <param name="affectedArea">The geographic region encapsulating the changed members.</param>
- <returns>boolean, true if members were changed by the selection process.</returns>
- </member>
- <member name="M:DotSpatial.Controls.Map.UnSelect(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IEnvelope,DotSpatial.Symbology.SelectionMode,DotSpatial.Topology.IEnvelope@)">
- <summary>
- Adds any members found in the specified region to the selected state as long as SelectionEnabled is set to true.
- </summary>
- <param name="tolerant">The geographic region where selection occurs that is tolerant for point or linestrings.</param>
- <param name="strict">The tight envelope to use for polygons.</param>
- <param name="mode">The selection mode.</param>
- <param name="affectedArea">The envelope affected area.</param>
- <returns>Boolean, true if any members were added to the selection.</returns>
- </member>
- <member name="M:DotSpatial.Controls.Map.AddLayers">
- <summary>
- Allows the user to add a new layer to the map using an open file dialog to choose a layer file.
- Multi-select is an option, so this return a list with all the layers.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Map.AddLayer(System.String)">
- <summary>
- Adds the fileName as a new layer to the map, returning the new layer.
- </summary>
- <param name="fileName">The string fileName of the layer to add</param>
- <returns>The IMapLayer added to the file.</returns>
- </member>
- <member name="M:DotSpatial.Controls.Map.DotSpatial#Controls#IBasicMap#AddLayer">
- <summary>
- This is so that if you have a basic map interface you can still prompt
- to add a layer, you just won't get an IMapLayer back.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Map.AddLayer">
- <summary>
- Uses the file dialog to allow selection of a fileName for opening the
- new layer, but does not allow multiple files to be added at once.
- </summary>
- <returns>The newly opened IMapLayer</returns>
- </member>
- <member name="M:DotSpatial.Controls.Map.AddRasterLayers">
- <summary>
- Allows a multi-select file dialog to add raster layers, applying a
- filter so that only supported raster formats will appear.
- </summary>
- <returns>A list of the IMapRasterLayers that were opened.</returns>
- </member>
- <member name="M:DotSpatial.Controls.Map.AddRasterLayer">
- <summary>
- Allows an open file dialog without multi-select enabled to add a single
- raster to the map as a layer, and returns the added layer.
- </summary>
- <returns>The IMapRasterLayer that was added, or null.</returns>
- </member>
- <member name="M:DotSpatial.Controls.Map.AddFeatureLayers">
- <summary>
- Allows a mult-select open file dialog to specify several fileNames to add.
- Only files with supported vector extensions will be shown.
- </summary>
- <returns>The list of added MapFeatureLayers</returns>
- </member>
- <member name="M:DotSpatial.Controls.Map.AddFeatureLayer">
- <summary>
- Allows an open file dialog without multi-select enabled to add a single
- raster tot he map as a layer, and returns the added layer.
- </summary>
- <returns>The IMapFeatureLayer that was added, or null.</returns>
- </member>
- <member name="M:DotSpatial.Controls.Map.AddImageLayers">
- <summary>
- Allows a mult-select open file dialog to specify several fileNames to add.
- Only files with supported image extensions will be shown.
- </summary>
- <returns>The list of added MapImageLayers</returns>
- </member>
- <member name="M:DotSpatial.Controls.Map.AddImageLayer">
- <summary>
- Allows an open dialog without multi-select to specify a single fileName
- to be added to the map as a new layer and returns the newly added layer.
- </summary>
- <returns>The layer that was added to the map, or null.</returns>
- </member>
- <member name="M:DotSpatial.Controls.Map.ResetBuffer">
- <summary>
- This can be called any time, and is currently being used to capture
- the end of a resize event when the actual data should be updated.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Map.SaveLayer">
- <summary>
- Saves the dataset belonging to the layer.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Map.ZoomToMaxExtent">
- <summary>
- Instructs the map to change the perspective to include the entire drawing content, and
- in the case of 3D maps, changes the perspective to look from directly overhead.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Map.GetMaxExtent(System.Boolean)">
- <summary>
- Gets the MaxExtent Window of the current Map.
- </summary>
- <param name="expand">Indicates whether the extent should be expanded by 10% to satisfy issue 84 (Expand target envelope by 10%). </param>
- </member>
- <member name="M:DotSpatial.Controls.Map.AddLabels(DotSpatial.Symbology.IFeatureLayer,System.String,System.Drawing.Font,System.Drawing.Color)">
- <summary>
- This activates the labels for the specified feature layer that will be the specified expression
- where field names are in square brackets like "[Name]: [Value]". This will label all the features,
- and remove any previous labeling.
- </summary>
- <param name="featureLayer">The FeatureLayer to apply the labels to.</param>
- <param name="expression">The string label expression to use where field names are in square brackets like
- [Name]</param>
- <param name="font">The font to use for these labels</param>
- <param name="fontColor">The color for the labels</param>
- </member>
- <member name="M:DotSpatial.Controls.Map.ClearLabels(DotSpatial.Symbology.IFeatureLayer)">
- <summary>
- Removes any existing label categories
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Map.Print(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Instead of using the usual buffers, this bypasses any buffering and instructs the layers
- to draw directly to the specified target rectangle on the graphics object. This is useful
- for doing vector drawing on much larger pages. The result will be centered in the
- specified target rectangle bounds.
- </summary>
- <param name="device">The graphics device to print to</param>
- <param name="targetRectangle">the rectangle where the map content should be drawn.</param>
- </member>
- <member name="M:DotSpatial.Controls.Map.Print(System.Drawing.Graphics,System.Drawing.Rectangle,DotSpatial.Data.Extent)">
- <summary>
- Instead of using the usual buffers, this bypasses any buffering and instructs the layers
- to draw directly to the specified target rectangle on the graphics object. This is useful
- for doing vector drawing on much larger pages. The result will be centered in the
- specified target rectangle bounds.
- </summary>
- <param name="device">The graphics device to print to</param>
- <param name="targetRectangle">the rectangle where the map content should be drawn.</param>
- <param name="targetEnvelope">the extents to print in the target rectangle</param>
- </member>
- <member name="M:DotSpatial.Controls.Map.ClearLayers">
- <summary>
- Instructs the map to clear the layers.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Map.ActivateMapFunction(DotSpatial.Controls.IMapFunction)">
- <summary>
- If the specified function is already in the list of functions, this will properly test the yield style of various
- map functions that are currently on and then activate the function. If this function is not in the list, then
- it will add it to the list. If you need to control the position, then insert the function before using this
- method to activate. Be warned that calling "Activate" directly on your function will activate your function
- but not disable any other functions. You can set "Map.FunctionMode = FunctionModes.None" first, and then
- specifically activate the function that you want.
- </summary>
- <param name="function">The MapFunction to activate, or add.</param>
- </member>
- <member name="M:DotSpatial.Controls.Map.GetLayers">
- <summary>
- returns a functional list of the ILayer members. This list will be
- separate from the actual list stored, but contains a shallow copy
- of the members, so the layers themselves can be accessed directly.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.Map.OnExcludeMapFrame(DotSpatial.Controls.IMapFrame)">
- <summary>
- Handles removing event handlers for the map frame
- </summary>
- <param name="mapFrame"></param>
- </member>
- <member name="M:DotSpatial.Controls.Map.OnIncludeMapFrame(DotSpatial.Controls.IMapFrame)">
- <summary>
- Handles adding new event handlers to the map frame
- </summary>
- <param name="mapFrame"></param>
- </member>
- <member name="M:DotSpatial.Controls.Map.OnLayerAdded(System.Object,DotSpatial.Symbology.LayerEventArgs)">
- <summary>
- Fires the LayerAdded event
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Map.OnSelectionChanged">
- <summary>
- Occurs after the selection is updated on all the layers
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Map.GetAllLayers">
- <summary>
- Gets all layers of the map including layers which are nested
- within groups. The group objects themselves are not included in this list,
- but all FeatureLayers, RasterLayers, ImageLayers and other layers are included.
- </summary>
- <returns>The list of the layers</returns>
- </member>
- <member name="M:DotSpatial.Controls.Map.GetAllGroups">
- <summary>
- Gets all map groups in the map including the nested groups
- </summary>
- <returns>the list of the groups</returns>
- </member>
- <member name="M:DotSpatial.Controls.Map.Refresh">
- <summary>
- This causes all of the data layers to re-draw themselves to the buffer, rather than just drawing
- the buffer itself like what happens during "Invalidate"
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Map.RefreshMap(System.Drawing.Rectangle)">
- <summary>
- Instructs the map to update the specified clipRectangle by drawing it to the back buffer.
- </summary>
- <param name="clipRectangle"></param>
- </member>
- <member name="M:DotSpatial.Controls.Map.PixelToProj(System.Drawing.Point)">
- <summary>
- Converts a single point location into an equivalent geographic coordinate
- </summary>
- <param name="position">The client coordinate relative to the map control</param>
- <returns>The geographic ICoordinate interface</returns>
- </member>
- <member name="M:DotSpatial.Controls.Map.PixelToProj(System.Drawing.Rectangle)">
- <summary>
- Converts a rectangle in pixel coordinates relative to the map control into
- a geographic envelope.
- </summary>
- <param name="rect">The rectangle to convert</param>
- <returns>An IEnvelope interface</returns>
- </member>
- <member name="M:DotSpatial.Controls.Map.ProjToPixel(DotSpatial.Topology.Coordinate)">
- <summary>
- Converts a single geographic location into the equivalent point on the
- screen relative to the top left corner of the map.
- </summary>
- <param name="location">The geographic position to transform</param>
- <returns>A Point with the new location.</returns>
- </member>
- <member name="M:DotSpatial.Controls.Map.ProjToPixel(DotSpatial.Data.Extent)">
- <summary>
- Converts a single geographic envelope into an equivalent Rectangle
- as it would be drawn on the screen.
- </summary>
- <param name="env">The geographic IEnvelope</param>
- <returns>A Rectangle</returns>
- </member>
- <member name="M:DotSpatial.Controls.Map.ZoomIn">
- <summary>
- Zooms in one notch, so that the scale becomes larger and the features become larger.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Map.ZoomOut">
- <summary>
- Zooms out one notch so that the scale becomes smaller and the features become smaller.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Map.ZoomToNext">
- <summary>
- Zooms to the next extent
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Map.ZoomToPrevious">
- <summary>
- Zooms to the previous extent
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Map.OnPaintBackground(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Occurs when this control tries to paint the background.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.Map.OnPaint(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Perform custom drawing
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.Map.SnapShot">
- <summary>
- Captures an image of whatever the contents of the back buffer would be at the size of the screen.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.Map.SnapShot(System.Int32)">
- <summary>
- Creates a snapshot that is scaled to fit to a bitmap of the specified width.
- </summary>
- <param name="width">The width of the desired bitmap</param>
- <returns>A bitmap with the specified width</returns>
- </member>
- <member name="M:DotSpatial.Controls.Map.OnMouseDoubleClick(System.Windows.Forms.MouseEventArgs)">
- <summary>
- Fires the DoMouseDoubleClick method on the ActiveTools
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.Map.OnMouseDown(System.Windows.Forms.MouseEventArgs)">
- <summary>
- Fires the OnMouseDown event on the Active Tools
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.Map.OnMouseUp(System.Windows.Forms.MouseEventArgs)">
- <summary>
- Fires the OnMouseUp event on the Active Tools
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.Map.OnMouseMove(System.Windows.Forms.MouseEventArgs)">
- <summary>
- Fires the OnMouseMove event on the Active Tools
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.Map.OnMouseWheel(System.Windows.Forms.MouseEventArgs)">
- <summary>
- Fires the OnMouseWheel event for the active tools
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.Map.OnProjectionChanged">
- <summary>
- Fires the ProjectionChanged event.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Map.OnViewExtentsChanged(System.Object,DotSpatial.Data.ExtentArgs)">
- <summary>
- Fires the ViewExtentsChanged event. Corrects the ViewExtent if it is smaller than 1e-7. If ZoomOutFartherThanMaxExtent is set, it corrects the
- ViewExtent if it is bigger then 1e+9. Otherwise it corrects the ViewExtent if it is bigger than the Maps extent + 10%.
- </summary>
- <param name="sender"></param>
- <param name="args"></param>
- </member>
- <member name="M:DotSpatial.Controls.Map.OnFunctionModeChanged(System.Object,System.EventArgs)">
- <summary>
- Fires the FunctionModeChanged event.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Map.OnResized">
- <summary>
- Occurs after this object has been resized.
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.Map.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Map.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Controls.Map.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.Map.FinishedRefresh">
- <summary>
- Occurs after the map refreshes the image
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.Map.FunctionModeChanged">
- <summary>
- Occurs when the map function mode has changed
- </summary>
- <remarks>Example of changing the function mode
- is changing from zoom mode to select mode.</remarks>
- </member>
- <member name="E:DotSpatial.Controls.Map.Resized">
- <summary>
- Occurs after a resize event
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.Map.SelectionChanged">
- <summary>
- Occurs after the selection has changed for all the layers
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.Map.LayerAdded">
- <summary>
- Occurs after a layer has been added to the mapframe, or any of the child groups of that mapframe.
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.Map.GeoMouseMove">
- <summary>
- Public event advertising the mouse movement
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.Map.ViewExtentsChanged">
- <summary>
- Fires after the view extents have been altered and the map has redrawn to the new extents.
- This is an echo of the MapFrame.ViewExtentsChanged, so you only want one handler.
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.Map.ProjectionChanged">
- <summary>
- Occurs after the projection of the map has been changed
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Map.ExtendBuffer">
- <summary>
- Gets or sets a boolean that indicates whether or not
- the drawing layers should cache off-screen data to
- the buffer. Panning will be much more elegant,
- but zooming, selecting and resizing will take a
- performance penalty.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Map.ProjectionEsriString">
- <summary>
- Gets or sets the Projection Esri string of the map. This property is used for serializing
- the projection string to the project file.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Map.ProjectionModeReproject">
- <summary>
- Gets or sets a PromptMode enumeration that controls how users are prompted before adding layers
- that have a coordinate system that is different from the map.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Map.ProjectionModeDefine">
- <summary>
- Gets or sets a PromptMode enumeration that controls how users are prompted before adding layers
- that have a coordinate system that is different from the map.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Map.RedrawLayersWhileResizing">
- <summary>
- Gets or sets a value indicating whether layers should draw during the actual resize itself. The
- normal behavior is to draw the existing image buffer in the new size and position which is much
- faster for large datasets, but is not as visually appealing if you only work with small datasets.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Map.Cursor">
- <summary>
- Cursor hiding from designer
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Map.SelectionEnabled">
- <summary>
- Gets or sets a boolean indicating whether or not the sel
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Map.CollectAfterDraw">
- <summary>
- Gets or sets a boolean that indicates whether the Garbage collector should collect after drawing.
- This can be disabled for fast-action panning, but should normally be enabled.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Map.MapFunctions">
- <summary>
- Gets or sets the dictionary of tools built into this project
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Map.FunctionMode">
- <summary>
- Gets or sets the current tool mode. This rapidly enables or disables specific tools to give
- a combination of functionality. Selecting None will disable all the tools, which can be
- enabled manually by enabling the specific tool in the GeoTools dictionary.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Map.IsBusy">
- <summary>
- Gets or sets a boolean that indicates whether a map-function is currently interacting with the map.
- If this is true, then any tool-tip like popups or other mechanisms that require lots of re-drawing
- should suspend themselves to prevent conflict. Setting this actually increments an internal integer,
- so when that integer is 0, the map is "Not" busy, but multiple busy processess can work independantly.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Map.IsZoomedToMaxExtent">
- <summary>
- If true then the map is zoomed to its full extents
- Added by Eric Hullinger 1/3/2013
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Map.BufferedImage">
- <summary>
- Gets or sets the back buffer. The back buffer should be in Format32bbpArgb bitmap.
- If it is not, then the image on the back buffer will be copied from the supplied image.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Map.CollisionDetection">
- <summary>
- If this is true, then point layers in the map will only draw points that are
- more than 50% revealed. This should increase drawing speed for layers that have
- a large number of points.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Map.Extent">
- <summary>
- Gets the geographic bounds of all of the different data layers currently visible on the map.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Map.ViewExtents">
- <summary>
- Gets or sets the geographic extents to show in the view.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Map.MapFrame">
- <summary>
- Gets or sets the MapFrame that should be displayed in this map.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Map.Layers">
- <summary>
- Gets or sets the collection of layers
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Map.Projection">
- <summary>
- Gets or sets the projection. This should reflect the projection of the first data layer loaded.
- Loading subsequent, but non-matching projections should throw an alert, and allow reprojection.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Map.Legend">
- <summary>
- Gets or sets the legend to use when showing the layers from this map
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Map.ProgressHandler">
- <summary>
- Gets or sets the progress handler for this component.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Map.ZoomOutFartherThanMaxExtent">
- <summary>
- This allows to zoom out farther than the extent of the map. This is useful if we have only layers with small extents and want to look at them from farther out.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.DatelineCrossingExtentExtension">
- <summary>
- Extension of Extent class to deal with dateline crossing
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.DefaultMenuBars.AddLayer_Click(System.Object,System.EventArgs)">
- <summary>
- Add Data to the Map
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.DefaultMenuBars.IdentifierTool_Click(System.Object,System.EventArgs)">
- <summary>
- Identifier Tool
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.DefaultMenuBars.Options_Click(System.Object,System.EventArgs)">
- <summary>
- Shows the options dialog.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.DefaultMenuBars.PanTool_Click(System.Object,System.EventArgs)">
- <summary>
- Set the function mode to pan so user can move it with a mouse.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.DefaultMenuBars.PrintLayout_Click(System.Object,System.EventArgs)">
- <summary>
- Handles the Click event of the PrintLayout control.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">The <see cref="T:System.EventArgs"/> instance containing the event data.</param>
- </member>
- <member name="M:DotSpatial.Controls.DefaultMenuBars.RemoveLayer_Click(System.Object,System.EventArgs)">
- <summary>
- Remove currently selected layer from the Map
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.DefaultMenuBars.SelectionTool_Click(System.Object,System.EventArgs)">
- <summary>
- Select or deselect Features
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.DefaultMenuBars.DeselectAll_Click(System.Object,System.EventArgs)">
- <summary>
- Deselect all features in all layers
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.DefaultMenuBars.ZoomIn_Click(System.Object,System.EventArgs)">
- <summary>
- Zoom In
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.DefaultMenuBars.ZoomNext_Click(System.Object,System.EventArgs)">
- <summary>
- Zoom to previous extent
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.DefaultMenuBars.ZoomOut_Click(System.Object,System.EventArgs)">
- <summary>
- Zoom Out
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.DefaultMenuBars.ZoomPrevious_Click(System.Object,System.EventArgs)">
- <summary>
- Zoom to previous extent
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.DefaultMenuBars.ZoomToLayer_Click(System.Object,System.EventArgs)">
- <summary>
- Zoom to the currently selected layer
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.DefaultMenuBars.ZoomToMaxExtents_Click(System.Object,System.EventArgs)">
- <summary>
- Zoom to maximum extents
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">The <see cref="T:System.EventArgs"/> instance containing the event data.</param>
- </member>
- <member name="T:DotSpatial.Controls.DefaultRequiredImports.DefaultRequiredImportAttribute">
- <summary>
- Special marker for default required imports
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.DefaultRequiredImports.DockManager">
- <summary>
- Default Dock Manager. It will used when no custom implementation of IDockManager where found.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.Docking.IDockManager">
- <summary>
- An interface that allows plugins to add controls which are managed by the application as forms or docking panels.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Docking.IDockManager.Add(DotSpatial.Controls.Docking.DockablePanel)">
- <summary>
- Adds the specified panel.
- </summary>
- <param name="panel">
- The panel.
- </param>
- </member>
- <member name="M:DotSpatial.Controls.Docking.IDockManager.Remove(System.String)">
- <summary>
- Removes the specified panel.
- </summary>
- <param name="key">
- The key.
- </param>
- </member>
- <member name="M:DotSpatial.Controls.Docking.IDockManager.ResetLayout">
- <summary>
- Resets the layout of the dock panels to a developer specified location.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Docking.IDockManager.SelectPanel(System.String)">
- <summary>
- Activates and selects the panel.
- </summary>
- <param name="key">
- The key.
- </param>
- </member>
- <member name="M:DotSpatial.Controls.Docking.IDockManager.HidePanel(System.String)">
- <summary>
- Hides the panel. A subsequent call to SelectPanel will show this panel in the same place it was when hidden.
- </summary>
- <param name="key">The key.</param>
- </member>
- <member name="M:DotSpatial.Controls.Docking.IDockManager.ShowPanel(System.String)">
- <summary>
- Shows the panel but does not select it.
- </summary>
- <param name="key">The key.</param>
- </member>
- <member name="E:DotSpatial.Controls.Docking.IDockManager.ActivePanelChanged">
- <summary>
- Occurs when the active panel is changed, meaning a difference panel is activated.
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.Docking.IDockManager.PanelClosed">
- <summary>
- Occurs when a panel is closed, which means the panel can still be activated or removed.
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.Docking.IDockManager.PanelAdded">
- <summary>
- Occurs after a panel is added.
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.Docking.IDockManager.PanelRemoved">
- <summary>
- Occurs after a panel is removed.
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.Docking.IDockManager.PanelHidden">
- <summary>
- Occurs when a panel is hidden.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.DefaultRequiredImports.HeaderControl">
- <summary>
- Default Header control. It will used when no custom implementation of IHeaderControl where found.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.Header.MenuBarHeaderControl">
- <summary>
- Implementation of toolbar header.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.Header.HeaderControl">
- <summary>
- HeaderControl which takes care of implementing RemoveItems.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.Header.IHeaderControl">
- <summary>
- By using this interface, the developers can create a button, menu, ribbon tab. etc
- without considering whether the user interface is ribbon style or standard toolbar
- style
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Header.IHeaderControl.Add(DotSpatial.Controls.Header.HeaderItem)">
- <summary>
- This will add a new item that will appear on the standard toolbar or ribbon control.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Header.IHeaderControl.Remove(System.String)">
- <summary>
- Remove item from the standard toolbar or ribbon control
- </summary>
- <param name="key">The string itemName to remove from the standard toolbar or ribbon control</param>
- </member>
- <member name="M:DotSpatial.Controls.Header.IHeaderControl.RemoveAll">
- <summary>
- Removes all items the plugin created.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Header.IHeaderControl.SelectRoot(System.String)">
- <summary>
- Selects the root, making it the active root.
- </summary>
- <param name="key">The key.</param>
- </member>
- <member name="E:DotSpatial.Controls.Header.IHeaderControl.RootItemSelected">
- <summary>
- This event occurs when a root item is selected
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.Header.HeaderControl.HomeRootItemKey">
- <summary>
- The key of the home root item.
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.Header.HeaderControl.ApplicationMenuKey">
- <summary>
- The key of the Application Menu item.
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.Header.HeaderControl.HeaderHelpItemKey">
- <summary>
- Used as the group caption for icons that should appear near the ribbon
- maximize/minimize chevron.
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.Header.HeaderControl.ExtensionsRootKey">
- <summary>
- A key to use for the root container of any extensions that do not provider a root key.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Header.HeaderControl.RemoveAll">
- <summary>
- Removes all items the plugin created by calling Remove() individually for each.
- </summary>
- <remarks>Should only be called by the plugin (from the plugin assembly).</remarks>
- </member>
- <member name="M:DotSpatial.Controls.Header.HeaderControl.Add(DotSpatial.Controls.Header.HeaderItem)">
- <summary>
- This will add a new item that will appear on the standard toolbar or ribbon control.
- </summary>
- <remarks>Should only be called by the plugin (from the plugin assembly).</remarks>
- </member>
- <member name="M:DotSpatial.Controls.Header.HeaderControl.Remove(System.String)">
- <summary>
- Remove item from the standard toolbar or ribbon control. Also removes groups or parents when all
- items have been removed from them.
- </summary>
- <param name="key">The string itemName to remove from the standard toolbar or ribbon control</param>
- <remarks>
- If passed a root item the behavior is not defined. The root item should never be empty because
- it will be removed when all of its child items are removed.
- </remarks>
- </member>
- <member name="M:DotSpatial.Controls.Header.HeaderControl.SelectRoot(System.String)">
- <summary>
- Selects the root, making it the active root.
- </summary>
- <param name="key">The key.</param>
- </member>
- <member name="M:DotSpatial.Controls.Header.HeaderControl.Add(DotSpatial.Controls.Header.SimpleActionItem)">
- <summary>
- Adds the specified item.
- </summary>
- <param name="item">The item.</param>
- </member>
- <member name="M:DotSpatial.Controls.Header.HeaderControl.Add(DotSpatial.Controls.Header.MenuContainerItem)">
- <summary>
- Adds the menu container item.
- </summary>
- <param name="item">The item.</param>
- </member>
- <member name="M:DotSpatial.Controls.Header.HeaderControl.Add(DotSpatial.Controls.Header.RootItem)">
- <summary>
- Adds the specified root item.
- </summary>
- <param name="item">The root item.</param>
- <remarks>The RootItem should not be visible until it contains other items.</remarks>
- </member>
- <member name="M:DotSpatial.Controls.Header.HeaderControl.Add(DotSpatial.Controls.Header.DropDownActionItem)">
- <summary>
- Adds a combo box style item
- </summary>
- <param name="item">The item.</param>
- </member>
- <member name="M:DotSpatial.Controls.Header.HeaderControl.Add(DotSpatial.Controls.Header.SeparatorItem)">
- <summary>
- Adds a visible separator.
- </summary>
- <param name="item">The item.</param>
- </member>
- <member name="M:DotSpatial.Controls.Header.HeaderControl.Add(DotSpatial.Controls.Header.TextEntryActionItem)">
- <summary>
- Adds the specified textbox item.
- </summary>
- <param name="item">The item.</param>
- </member>
- <member name="M:DotSpatial.Controls.Header.HeaderControl.RecordItemAdd(DotSpatial.Controls.Header.HeaderItem,System.String)">
- <summary>
- Adds the item to dictionary so that it can be removed later.
- </summary>
- <param name="item">Item to add.</param>
- <param name="assemblyFullName">Full name of the assembly.</param>
- </member>
- <member name="M:DotSpatial.Controls.Header.HeaderControl.GetHeaderItemByKey(System.String)">
- <summary>
- Gets header item by key
- </summary>
- <param name="key">Key</param>
- <returns>Header item or null if not found.</returns>
- </member>
- <member name="M:DotSpatial.Controls.Header.HeaderControl.OnRootItemSelected(System.String)">
- <summary>
- Occurs when a root item is selected by the user.
- This event also occurs after the SelectRoot method is called.
- </summary>
- <param name="key">The key of the new selected root item</param>
- </member>
- <member name="E:DotSpatial.Controls.Header.HeaderControl.RootItemSelected">
- <summary>
- Occurs when a root item is selected
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Header.MenuBarHeaderControl.Add(DotSpatial.Controls.Header.MenuContainerItem)">
- <summary>
- Adds the item.
- </summary>
- <param name="item">
- The item.
- </param>
- </member>
- <member name="M:DotSpatial.Controls.Header.MenuBarHeaderControl.Add(DotSpatial.Controls.Header.SeparatorItem)">
- <summary>
- Adds the separator.
- </summary>
- <param name="item">The item.</param>
- </member>
- <member name="M:DotSpatial.Controls.Header.MenuBarHeaderControl.Add(DotSpatial.Controls.Header.RootItem)">
- <summary>
- Adds the specified root item.
- </summary>
- <param name="item">
- The root item.
- </param>
- <remarks>
- </remarks>
- </member>
- <member name="M:DotSpatial.Controls.Header.MenuBarHeaderControl.Add(DotSpatial.Controls.Header.SimpleActionItem)">
- <summary>
- This will add a new item that will appear on the standard toolbar or ribbon control.
- </summary>
- <param name="item">
- The item.
- </param>
- <remarks>
- </remarks>
- </member>
- <member name="M:DotSpatial.Controls.Header.MenuBarHeaderControl.Add(DotSpatial.Controls.Header.DropDownActionItem)">
- <summary>
- Adds a combo box style item
- </summary>
- <param name="item">The item.</param>
- </member>
- <member name="M:DotSpatial.Controls.Header.MenuBarHeaderControl.Add(DotSpatial.Controls.Header.TextEntryActionItem)">
- <summary>
- Adds the specified textbox item.
- </summary>
- <param name="item">The item.</param>
- </member>
- <member name="M:DotSpatial.Controls.Header.MenuBarHeaderControl.Initialize(System.Windows.Forms.ToolStripPanel,System.Windows.Forms.MenuStrip)">
- <summary>
- Initializes the specified container.
- </summary>
- <param name="toolStripPanel">The tool strip panel.</param>
- <param name="menuStrip">Menu strip.</param>
- </member>
- <member name="M:DotSpatial.Controls.Header.MenuBarHeaderControl.LoadToolstrips">
- <summary>
- Loads the toolstrips in the order, that was saved on the last exit.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Header.MenuBarHeaderControl.Remove(System.String)">
- <summary>
- Remove item from the standard toolbar or ribbon control
- </summary>
- <param name="key">
- The string itemName to remove from the standard toolbar or ribbon control
- </param>
- <remarks>
- </remarks>
- </member>
- <member name="M:DotSpatial.Controls.Header.MenuBarHeaderControl.SelectRoot(System.String)">
- <summary>
- Selects the root. (Does nothing.)
- </summary>
- <param name="key">The key.</param>
- </member>
- <member name="M:DotSpatial.Controls.Header.MenuBarHeaderControl.IsForMenuStrip(DotSpatial.Controls.Header.SimpleActionItem)">
- <summary>
- Determines whether [is for tool strip] being that it has an icon. Otherwise it should go on a menu.
- </summary>
- <param name="item">
- The item.
- </param>
- <returns>
- <c>true</c> if [is for tool strip] [the specified item]; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:DotSpatial.Controls.Header.MenuBarHeaderControl.LoadToolstripPositions">
- <summary>
- Loads the saved toolstrippositions from file.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Header.MenuBarHeaderControl.RememberLayout(System.Object,System.EventArgs)">
- <summary>
- When the user moves toolstrips, the new position gets remembered for saving.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Header.MenuBarHeaderControl.GetMenuBarHeaderControlConfigPath">
- <summary>
- Gets the path to the MenuBarHeaderControl.config-file in which the toolstrip-order is saved.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Header.MenuBarHeaderControl.SaveToolstripPositions(System.Object,System.EventArgs)">
- <summary>
- Saves the toolstrips positions so that the user doesn't have to reorder them on next start.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Header.MenuBarHeaderControl.AddToolStrip(System.String)">
- <summary>
- Adds a toolstrip with the given name to the _strips-List. If the toolbars were already loaded it is added to the _tsPanel as well.
- </summary>
- <param name="groupName">Name of the toolstrip that will be added.</param>
- <returns>ToolStrip that was created.</returns>
- </member>
- <member name="M:DotSpatial.Controls.Header.MenuBarHeaderControl.EnsureExtensionsTabExists">
- <summary>
- Ensure the extensions tab exists.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Header.MenuBarHeaderControl.EnsureNonNullRoot(DotSpatial.Controls.Header.ActionItem)">
- <summary>
- Make sure the root key is present or use a default.
- </summary>
- <param name="item">
- </param>
- </member>
- <member name="M:DotSpatial.Controls.Header.MenuBarHeaderControl.UncheckButtonsExcept(System.Windows.Forms.ToolStripButton)">
- <summary>
- Unchecks all toolstrip buttons except the current button
- </summary>
- <param name="checkedButton">
- The toolstrip button which should
- stay checked
- </param>
- </member>
- <member name="P:DotSpatial.Controls.Header.MenuBarHeaderControl.IgnoreToolstripPositionSaving">
- <summary>
- If set the userdefined toolstrip-order won't be saved/loaded;
- </summary>
- <remarks>Enables the user to ignore Toolstrippositionsaving (e.g. in DesignMode)</remarks>
- </member>
- <member name="T:DotSpatial.Controls.DefaultRequiredImports.StatusControl">
- <summary>
- Default Status Control. It will used when no custom implementation of IStatusControl where found.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.Header.IStatusControl">
- <summary>
- Used to display status information.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Header.IStatusControl.Add(DotSpatial.Controls.Header.StatusPanel)">
- <summary>
- Adds the specified panel.
- </summary>
- <param name="panel">The panel.</param>
- </member>
- <member name="M:DotSpatial.Controls.Header.IStatusControl.Remove(DotSpatial.Controls.Header.StatusPanel)">
- <summary>
- Removes the specified panel.
- </summary>
- <param name="panel">The panel.</param>
- </member>
- <member name="T:DotSpatial.Controls.Docking.DockablePanelEventArgs">
- <summary>
- The active panel changed event args.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Docking.DockablePanelEventArgs.#ctor(System.String)">
- <summary>
- Initializes a new instance of the ActivePanelChangedEventArgs class.
- </summary>
- <param name="activePanelKey">
- The active Panel Key.
- </param>
- </member>
- <member name="P:DotSpatial.Controls.Docking.DockablePanelEventArgs.ActivePanelKey">
- <summary>
- Gets or sets the active panel key.
- </summary>
- <value>
- The active panel key.
- </value>
- </member>
- <member name="T:DotSpatial.Controls.Docking.DockablePanel">
- <summary>
- Named DockablePanel to avoid the name conflict with DockPanel in WPF and most control libraries.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Docking.DockablePanel.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Controls.Docking.DockablePanel"/> class.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Docking.DockablePanel.#ctor(System.String,System.String,System.Windows.Forms.Control,System.Windows.Forms.DockStyle)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Controls.Docking.DockablePanel"/> class.
- </summary>
- <param name="key">The key.</param>
- <param name="caption">The caption.</param>
- <param name="innerControl">The inner control.</param>
- <param name="dock">The dock.</param>
- </member>
- <member name="M:DotSpatial.Controls.Docking.DockablePanel.OnPropertyChanged(System.ComponentModel.PropertyChangedEventArgs)">
- <summary>
- Triggers the PropertyChanged event.
- </summary>
- <param name="ea">
- The ea.
- </param>
- </member>
- <member name="E:DotSpatial.Controls.Docking.DockablePanel.PropertyChanged">
- <summary>
- Occurs when a property value changes.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Docking.DockablePanel.Caption">
- <summary>
- Gets or sets the caption of the panel and any tab button.
- </summary>
- <value>
- The caption.
- </value>
- </member>
- <member name="P:DotSpatial.Controls.Docking.DockablePanel.Dock">
- <summary>
- Gets or sets The dock location.
- </summary>
- <value>
- The dock location.
- </value>
- </member>
- <member name="P:DotSpatial.Controls.Docking.DockablePanel.InnerControl">
- <summary>
- Gets or sets the InnerControl.
- </summary>
- <value>
- The InnerControl.
- </value>
- </member>
- <member name="P:DotSpatial.Controls.Docking.DockablePanel.Key">
- <summary>
- Gets or sets the key.
- </summary>
- <value>The unique identifier.</value>
- </member>
- <member name="P:DotSpatial.Controls.Docking.DockablePanel.SmallImage">
- <summary>
- Gets or sets the small image.
- </summary>
- <value>The small image.</value>
- </member>
- <member name="P:DotSpatial.Controls.Docking.DockablePanel.DefaultSortOrder">
- <summary>
- Gets or sets the sort order. Lower values will suggest that an item should appear further left in a LeftToRight environment. Or higher up in a top to bottom environment.
- </summary>
- <remarks>Use a multiple of 100 or so to allow other developers some 'space' to place their panels.</remarks>
- <value>
- The sort order.
- </value>
- </member>
- <member name="T:DotSpatial.Controls.Extension">
- <summary>
- A provider is the base class that enables plug-ins to work with the Application Manager.
- This is true whether it is a plug-in or a data provider or some other extension.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Extension.Activate">
- <summary>
- Activates this provider
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Extension.Deactivate">
- <summary>
- Deactivates this provider
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Extension.IsActive">
- <summary>
- Gets or sets a boolean that is true if the extension is active and running.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Extension.DeactivationAllowed">
- <summary>
- Gets a value indicating whether [deactivation is allowed].
- </summary>
- <value>
- <c>true</c> if [deactivation is allowed]; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:DotSpatial.Controls.Extension.Priority">
- <summary>
- Specifies the activation priority order
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Extension.App">
- <summary>
- Gets the AppManager that is responsible for activating and deactivating plugins as well as coordinating
- all of the other properties.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.FeatureIdentifier">
- <summary>
- Feature Identifier form used to display output from MapFunctionIdentify.
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.FeatureIdentifier.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.FeatureIdentifier.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Controls.FeatureIdentifier.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.FeatureIdentifier.#ctor">
- <summary>
- Creates a new instance of FeatureIdentifier
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.FeatureIdentifier.Clear">
- <summary>
- Clears the items in the tree
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.FeatureIdentifier.Add(DotSpatial.Symbology.IFeatureLayer,DotSpatial.Data.Extent)">
- <summary>
- Adds a new node to the tree view with the layer name
- </summary>
- <param name="layer"></param>
- <param name="bounds"></param>
- </member>
- <member name="M:DotSpatial.Controls.FeatureIdentifier.Add(DotSpatial.Controls.IMapRasterLayer,DotSpatial.Data.Extent)">
- <summary>
- Adds a new node to the tree view with the layer name
- </summary>
- <param name="layer">The layer.</param>
- <param name="bounds">The bounds.</param>
- </member>
- <member name="M:DotSpatial.Controls.FeatureIdentifier.ReSelect">
- <summary>
- Re-selects the same layer that was being investigated before.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.Header.StatusPanel">
- <summary>
- The StatusPanel class allows adding user-defined status panels to the
- status bar
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Header.StatusPanel.#ctor">
- <summary>
- Initializes a new instance of the StatusPanel class.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Header.StatusPanel.OnPropertyChanged(System.String)">
- <summary>
- Triggers the PropertyChanged event.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Header.StatusPanel.Caption">
- <summary>
- Gets or sets the caption.
- </summary>
- <value>
- The caption.
- </value>
- </member>
- <member name="P:DotSpatial.Controls.Header.StatusPanel.Width">
- <summary>
- Gets or sets the width.
- </summary>
- <value>
- The width.
- </value>
- </member>
- <member name="P:DotSpatial.Controls.Header.StatusPanel.Key">
- <summary>
- Gets or sets the key.
- </summary>
- <value>
- The key.
- </value>
- </member>
- <member name="E:DotSpatial.Controls.Header.StatusPanel.PropertyChanged">
- <summary>
- Occurs when a property value changes.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Header.ProgressStatusPanel.Percent">
- <summary>
- Gets or sets the progress percent.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.IFeatureLayerExtensions.AddLabels(DotSpatial.Symbology.IFeatureLayer,System.String,System.Drawing.Font,System.Drawing.Color)">
- <summary>
- This activates the labels for the specified feature layer that will be the specified expression
- where field names are in square brackets like "[Name]: [Value]". This will label all the features,
- and remove any previous labeling.
- </summary>
- <param name="featureLayer">The FeatureLayer to apply the labels to.</param>
- <param name="expression">The string label expression to use where field names are in square brackets like
- [Name]</param>
- <param name="font">The font to use for these labels</param>
- <param name="fontColor">The color for the labels</param>
- </member>
- <member name="M:DotSpatial.Controls.IFeatureLayerExtensions.AddLabels(DotSpatial.Symbology.IFeatureLayer,System.String,System.String,DotSpatial.Symbology.ILabelSymbolizer,System.String)">
- <summary>
- This will add a new label category that will only apply to the specified filter expression.
- This will not remove any existing categories.
- </summary>
- <param name="featureLayer">The feature layer that the labels should be applied to</param>
- <param name="expression">The string expression where field names are in square brackets</param>
- <param name="filterExpression">The string filter expression that controls which features are labeled.
- Field names are in square brackets, strings in single quotes.</param>
- <param name="symbolizer">The label symbolizer that controls the basic appearance of the labels in this
- category.</param>
- <param name="name">The name of the category.</param>
- </member>
- <member name="M:DotSpatial.Controls.IFeatureLayerExtensions.AddLabels(DotSpatial.Symbology.IFeatureLayer,System.String,System.String,DotSpatial.Symbology.ILabelSymbolizer,System.Double)">
- <summary>
- This will add a new label category that will only apply to the specified filter expression. This will
- not remove any existing categories.
- </summary>
- <param name="featureLayer">The feature layer that the labels should be applied to</param>
- <param name="expression">The string expression where field names are in square brackets</param>
- <param name="filterExpression">The string filter expression that controls which features are labeled.
- Field names are in square brackets, strings in single quotes.</param>
- <param name="symbolizer">The label symbolizer that controls the basic appearance of the labels in this
- category.</param>
- <param name="width">A geographic width, so that if the map is zoomed to a geographic width smaller than
- this value, labels should appear.</param>
- </member>
- <member name="M:DotSpatial.Controls.IFeatureLayerExtensions.ClearLabels(DotSpatial.Symbology.IFeatureLayer)">
- <summary>
- Removes any existing label categories
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.OptionsForm.btOk_Click(System.Object,System.EventArgs)">
- <summary>
- Saves the changed settings.
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.OptionsForm.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.OptionsForm.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Controls.OptionsForm.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.Extensions.PackageManager">
- <summary>
- The PackageManager performs file based operations on packages.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Extensions.PackageManager.MarkPackageForRemoval(DotSpatial.Controls.AppManager,System.String)">
- <summary>
- Marks the package for removal.
- </summary>
- <param name="appManager">The app manager.</param>
- <param name="path">The path.</param>
- </member>
- <member name="M:DotSpatial.Controls.Extensions.PackageManager.MarkExtensionForRemoval(DotSpatial.Controls.AppManager,System.String)">
- <summary>
- Marks the extension for removal. This will leave any dependencies.
- </summary>
- <param name="appManager">The AppManager.</param>
- <param name="path">Name of the file.</param>
- </member>
- <member name="M:DotSpatial.Controls.Extensions.PackageManager.EnsureDeactivated(DotSpatial.Controls.AppManager,System.String)">
- <summary>
- Ensures the extension is deactivated.
- </summary>
- <param name="appManager">The AppManager.</param>
- <param name="extensionName">Name of the extension.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.Extensions.PackageManager.RemovePendingPackagesAndExtensions">
- <summary>
- Removes the pending packages and extensions.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Extensions.PackageManager.TryDeleteAllPackages">
- <summary>
- Deletes everything in the DotSpatial.Controls.AppManager.AbsolutePathToExtensions folder.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Extensions.PackageManager.DeleteDirectory(System.String)">
- <summary>
- Deletes the directory and any files, recursively.
- </summary>
- <param name="path">The path.</param>
- </member>
- <member name="T:DotSpatial.Controls.ShowExtensionsDialog">
- <summary>
- A list of options for enabling Apps.
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.ShowExtensionsDialog.Default">
- <summary>
- The "Extensions" menu item will appear on the HeaderControl. Clicking it launches the AppDialog.
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.ShowExtensionsDialog.MapGlyph">
- <summary>
- A "plugin" glyph will appear suspended in the lower right corner of the map. Clicking it launches
- the AppDialog.
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.ShowExtensionsDialog.None">
- <summary>
- The AppDialog will button not be shown. This allows the application developer to provide a custom implementation.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.ShowExtensionsDialogMode">
- <summary>
- A list of options for enabling Apps.
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.ShowExtensionsDialogMode.Default">
- <summary>
- The "Extensions" menu item will appear on the HeaderControl. Clicking it launches the AppDialog.
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.ShowExtensionsDialogMode.MapGlyph">
- <summary>
- A "plugin" glyph will appear suspended in the lower right corner of the map. Clicking it launches
- the AppDialog.
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.ShowExtensionsDialogMode.None">
- <summary>
- The AppDialog will button not be shown. This allows the application developer to provide a custom implementation.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.AppManager">
- <summary>
- A component that manages the loading of extensions (including data providers), and helps with file serialization.
- </summary>
- <remarks>Will soon be responsible for tools and layer providers, too.</remarks>
- </member>
- <member name="F:DotSpatial.Controls.AppManager.PackageDirectory">
- <summary>
- Name of the folder where packages reside.
- Found within the Extensions Directory.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.AppManager.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Controls.AppManager"/> class.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.AppManager.ActivateExtensionsExclusively(System.String[])">
- <summary>
- Activates the extensions passed in and deactivates the rest.
- If null is passed in, all extensions are deactivated.
- Only affects extensions where DeactivationAllowed is true.
- </summary>
- <param name="names">The names.</param>
- </member>
- <member name="M:DotSpatial.Controls.AppManager.EnsureRequiredImportsAreAvailable">
- <summary>
- Ensures the required imports are available for IExtension implementors. We guarantee DockManager, HeaderControl and ProgressHandler
- are available when an IExtension loads, so that the developer of an IExtension doesn't need to check to see whether they are null.
- We make sure these are available before activating an IExtension.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.AppManager.GetExtension(System.String)">
- <summary>
- Gets the extension.
- </summary>
- <param name="assemblyTitle">The assembly title.</param>
- <returns>
- Null if the extension is not present.
- </returns>
- </member>
- <member name="M:DotSpatial.Controls.AppManager.GetExtension(System.String,System.String)">
- <summary>
- Gets the extension.
- </summary>
- <param name="assemblyTitle">The assembly title.</param>
- <param name="version">The version.</param>
- <returns>
- Null if the extension is not present.
- </returns>
- </member>
- <member name="M:DotSpatial.Controls.AppManager.LoadExtensions">
- <summary>
- Loads Extensions using MEF and then activates them.
- Should only be called once on startup.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.AppManager.OnExtensionsActivated(System.EventArgs)">
- <summary>
- Triggers the ExtensionsActivated event.
- </summary>
- <param name="ea">
- The ea.
- </param>
- </member>
- <member name="M:DotSpatial.Controls.AppManager.RefreshExtensions">
- <summary>
- Refreshes the extensions - activating any newly discovered ones.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.AppManager.UpdateProgress(System.String)">
- <summary>
- Updates the ProgressHandler.
- </summary>
- <param name="msg">The message.</param>
- </member>
- <member name="M:DotSpatial.Controls.AppManager.AppLoadExtensions">
- <summary>
- Catalogs all extensions and then composes their parts.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.AppManager.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">
- true if managed resources should be disposed; otherwise, false.
- </param>
- </member>
- <member name="M:DotSpatial.Controls.AppManager.CurrentDomain_AssemblyResolve(System.Object,System.ResolveEventArgs)">
- <summary>
- Looks for the assembly in a path like Extensions\Packages\
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.AppManager.GetDirectoriesNestedOneLevel">
- <summary>
- Gets the directories in Directories and those nested one level deep.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.AppManager.GetPackageExtensionPaths(System.String)">
- <summary>
- Gets the paths of dlls for extensions that were downloaded as packages.
- </summary>
- <param name="absolutePathToExtensions">The absolute path to extensions.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.AppManager.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.AppManager.ExtensionsActivated">
- <summary>
- Occurs when all plugins are loaded.
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.AppManager.ExtensionsActivating">
- <summary>
- Occurs just before starting to activate extensions.
- Use this event to run a custom task before extensions
- are activated.
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.AppManager.SatisfyImportsExtensionsActivated">
- <summary>
- Occurs after the extensions that are of type
- SatisfyImportsExtensions have been activated. At this stage
- the DockManager, ProgressHandler and HeaderControl are available.
- Use this event to add custom items to the DockManager, ProgressHandler
- or HeaderControl before other extensions are activated.
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.AppManager.HeaderControlChanged">
- <summary>
- Occurs when HeaderControl changed.
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.AppManager.MapChanged">
- <summary>
- Occurs when Map Changed
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.AppManager.AbsolutePathToExtensions">
- <summary>
- A known directory from where extensions will be loaded, in addition to the configurable Directories list.
- Assemblies placed directly in this directory will not be loaded, but rather those nested inside of a folder
- more than one level deep.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.AppManager.Catalog">
- <summary>
- Gets the catalog containing all off the know extensions. Add any additional extensions to Catalog.Catalogs.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.AppManager.CompositionContainer">
- <summary>
- Gets or sets the composition container.
- </summary>
- <value>
- The composition container.
- </value>
- </member>
- <member name="P:DotSpatial.Controls.AppManager.Directories">
- <summary>
- Gets or sets the list of string paths (relative to this one) to search for plugins.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.AppManager.DockManager">
- <summary>
- Gets or sets the dock manager that is being used to storing dock panels. You can leave this empty to use default dock manager.
- </summary>
- <value>
- The dock manager.
- </value>
- </member>
- <member name="P:DotSpatial.Controls.AppManager.Extensions">
- <summary>
- Gets the extensions.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.AppManager.HeaderControl">
- <summary>
- Gets or sets the header control
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.AppManager.Legend">
- <summary>
- Gets or sets the Legend (Table of Contents) associated with the plugin manager
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.AppManager.Map">
- <summary>
- Gets or sets the Map associated with the plugin manager
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.AppManager.ProgressHandler">
- <summary>
- Gets or sets the progress handler that is being used to display status messages.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.AppManager.SerializationManager">
- <summary>
- Gets or sets the serialization manager.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.AppManager.ShowExtensionsDialog">
- <summary>
- Gets or sets the method for enabling extension Apps.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.AppManager.ShowExtensionsDialogMode">
- <summary>
- Gets or sets the method for enabling extension Apps.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.AppManager.UseBaseDirectoryForExtensionsDirectory">
- <summary>
- Gets or sets a value indicating whether extensions should be placed in AppDomain.CurrentDomain.BaseDirectory.
- </summary>
- <value>
- <c>true</c> if extensions should be placed in AppDomain.CurrentDomain.BaseDirectory; otherwise, extensions will be placed in a user profile folder based on the entry assembly name.
- This must be set before calling LoadExtensions();
- </value>
- </member>
- <member name="T:DotSpatial.Controls.CohenSutherland">
- <summary>
- CohenSutherland Line(string) clipping algorithm
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.CohenSutherland.ClipLine(System.Double@,System.Double@,System.Double@,System.Double@,System.Double,System.Double,System.Double,System.Double)">
- <summary>
- Clip a line segment. Coordinates are modified in place.
- </summary>
- <param name="x1"></param>
- <param name="y1"></param>
- <param name="x2"></param>
- <param name="y2"></param>
- <param name="xmin"></param>
- <param name="ymin"></param>
- <param name="xmax"></param>
- <param name="ymax"></param>
- <returns>
- Clip status indicating how the line was clipped.
- </returns>
- </member>
- <member name="M:DotSpatial.Controls.CohenSutherland.ClipLinestring(System.Collections.Generic.List{System.Double[]},System.Double,System.Double,System.Double,System.Double)">
- <summary>
- Clip a linestring
- </summary>
- <param name="linestring"></param>
- <param name="xmin"></param>
- <param name="ymin"></param>
- <param name="xmax"></param>
- <param name="ymax"></param>
- <returns>
- List of clipped linestrings.
- </returns>
- </member>
- <member name="T:DotSpatial.Controls.CohenSutherland.LineClipStatus">
- <summary>
- Result of individual line segment clip
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.CohenSutherland.LineClipStatus.Unknown">
- <summary>
- Initial untested value
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.CohenSutherland.LineClipStatus.Inside">
- <summary>
- Line is completely inside the clip area
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.CohenSutherland.LineClipStatus.Outside">
- <summary>
- Line is completely outside the clip area
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.CohenSutherland.LineClipStatus.ClippedFirst">
- <summary>
- Line was partially contained and first vertex was clipped
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.CohenSutherland.LineClipStatus.ClippedLast">
- <summary>
- Line was partially contained and last vertex was clipped
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.Header.ActionItem">
- <summary>
- An interactive element.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.Header.GroupedItem">
- <summary>
- A visually distinguished container of <see cref="T:DotSpatial.Controls.Header.ActionItem"/> instances that are Grouped inside of <see cref="T:DotSpatial.Controls.Header.RootItem"/>s.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.Header.HeaderItem">
- <summary>
- An item that has a visible presence in the <see cref="T:DotSpatial.Controls.Header.HeaderControl"/>
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Header.HeaderItem.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Controls.Header.HeaderItem"/> class.
- </summary>
- <param name="key">The key.</param>
- </member>
- <member name="M:DotSpatial.Controls.Header.HeaderItem.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Controls.Header.HeaderItem"/> class.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Header.HeaderItem.OnPropertyChanged(System.String)">
- <summary>
- Triggers the PropertyChanged event.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Header.HeaderItem.Key">
- <summary>
- Gets or sets the key.
- </summary>
- <value>The unique identifier.</value>
- </member>
- <member name="E:DotSpatial.Controls.Header.HeaderItem.PropertyChanged">
- <summary>
- Occurs when a property value changes.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Header.GroupedItem.#ctor">
- <summary>
- Initializes a new instance of the GroupItem class.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Header.GroupedItem.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the HeaderItem class.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Header.GroupedItem.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Controls.Header.GroupedItem"/> class.
- </summary>
- <param name="key">The key.</param>
- </member>
- <member name="P:DotSpatial.Controls.Header.GroupedItem.GroupCaption">
- <summary>
- Gets or sets the group. This is a logical unit.
- </summary>
- <value>The group.</value>
- </member>
- <member name="P:DotSpatial.Controls.Header.GroupedItem.RootKey">
- <summary>
- Gets or sets the root key.
- </summary>
- <value>The root key.</value>
- </member>
- <member name="M:DotSpatial.Controls.Header.ActionItem.#ctor">
- <summary>
- Initializes a new instance of the ActionItem class.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Header.ActionItem.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Controls.Header.ActionItem"/> class.
- </summary>
- <param name="key">The key.</param>
- </member>
- <member name="M:DotSpatial.Controls.Header.ActionItem.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the ActionItem class.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Header.ActionItem.Caption">
- <summary>
- Gets or sets the caption.
- </summary>
- <value>The caption.</value>
- </member>
- <member name="P:DotSpatial.Controls.Header.ActionItem.ToolTipText">
- <summary>
- Gets or sets the simple tool tip.
- </summary>
- <value>The simple tool tip.</value>
- </member>
- <member name="P:DotSpatial.Controls.Header.ActionItem.Enabled">
- <summary>
- Gets or sets a value indicating whether this <see cref="T:DotSpatial.Controls.Header.ActionItem"/> is enabled.
- </summary>
- <value>
- <c>true</c> if enabled; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:DotSpatial.Controls.Header.ActionItem.Visible">
- <summary>
- Gets or sets a value indicating whether this <see cref="T:DotSpatial.Controls.Header.ActionItem"/> is visible.
- </summary>
- <value>
- <c>true</c> if visible; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="T:DotSpatial.Controls.Header.DropDownActionItem">
- <summary>
- A dropdown (combo box) style item.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Header.DropDownActionItem.#ctor">
- <summary>
- Initializes a new instance of the DropDownActionItem class.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Header.DropDownActionItem.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the DropDownActionItem class.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Header.DropDownActionItem.OnSelectedValueChanged(DotSpatial.Controls.Header.SelectedValueChangedEventArgs)">
- <summary>
- Triggers the SelectedValueChanged event.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Header.DropDownActionItem.AllowEditingText">
- <summary>
- Gets or sets a value indicating whether the user may enter their own value into the dropdown.
- </summary>
- <value>
- <c>true</c> if [allow editing text]; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:DotSpatial.Controls.Header.DropDownActionItem.Items">
- <summary>
- Gets the items contained in the dropdown. Changes are not supported after the item is added to the header control.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Header.DropDownActionItem.MultiSelect">
- <summary>
- Gets or sets a value indicating whether the user is selecting multiple elements from the dropdownlist or not.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Header.DropDownActionItem.FontColor">
- <summary>
- Gets or sets a value indicating the color of the text in the dropdownbox
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Header.DropDownActionItem.DisplayText">
- <summary>
- Gets or sets a value indicating the display text in the dropdownbox
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Header.DropDownActionItem.Width">
- <summary>
- Gets or sets the width of the item displayed in the header control.
- </summary>
- <value>
- The width.
- </value>
- </member>
- <member name="P:DotSpatial.Controls.Header.DropDownActionItem.NullValuePrompt">
- <summary>
- Gets or sets the text displayed grayed out (as a watermark) when the editor doesn't have focus, and its edit value is null.
- </summary>
- <value>
- The prompt.
- </value>
- </member>
- <member name="P:DotSpatial.Controls.Header.DropDownActionItem.SelectedItem">
- <summary>
- Gets or sets the selected item.
- </summary>
- <value>
- The selected item.
- </value>
- </member>
- <member name="E:DotSpatial.Controls.Header.DropDownActionItem.SelectedValueChanged">
- <summary>
- Gets or sets an event handler fired on selected value changed.
- </summary>
- <value>
- The on selected value changed.
- </value>
- </member>
- <member name="T:DotSpatial.Controls.Header.MenuContainerItem">
- <summary>
- A container of other <see cref="T:DotSpatial.Controls.Header.ActionItem"/> instances.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Header.MenuContainerItem.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Controls.Header.MenuContainerItem"/> class.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Header.MenuContainerItem.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the MenuContainerItem class.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Header.MenuContainerItem.#ctor(System.String,System.String,System.String)">
- <summary>
- Initializes a new instance of the MenuContainerItem class.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Header.MenuContainerItem.LargeImage">
- <summary>
- Gets or sets the large image.
- </summary>
- <value>The large image.</value>
- </member>
- <member name="T:DotSpatial.Controls.Header.RootItem">
- <summary>
- An item that appears as a root-level container of other <see cref="T:DotSpatial.Controls.Header.ActionItem"/> instances.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Header.RootItem.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of RootItem MenuContainerItem class.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Header.RootItem.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:System.Object"/> class.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Header.RootItem.Caption">
- <summary>
- Gets or sets the caption.
- </summary>
- <value>The caption.</value>
- </member>
- <member name="P:DotSpatial.Controls.Header.RootItem.SortOrder">
- <summary>
- Gets or sets the sort order. Lower values will suggest that an item should appear further left in a LeftToRight environment.
- </summary>
- <remarks>Use a multiple of 10 or so to allow other developers some 'space' to place their menus.</remarks>
- <value>
- The sort order.
- </value>
- </member>
- <member name="P:DotSpatial.Controls.Header.RootItem.Visible">
- <summary>
- Gets or sets a value indicating whether this <see cref="T:DotSpatial.Controls.Header.RootItem"/> is visible.
- </summary>
- <value>
- <c>true</c> if visible; otherwise, <c>false</c>.
- </value>
- <remarks>Will generally bring this <see cref="T:DotSpatial.Controls.Header.RootItem"/> into focus when Visible is set to true.</remarks>
- </member>
- <member name="T:DotSpatial.Controls.Header.RootItemEventArgs">
- <summary>
- Information about the selected root item
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Header.RootItemEventArgs.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Controls.Header.RootItemEventArgs"/> class.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Header.RootItemEventArgs.#ctor(System.String)">
- <summary>
- Initializes a new instance of the RootItemEventArgs class.
- </summary>
- <param name="selectedKey">The key of the selected root item</param>
- </member>
- <member name="P:DotSpatial.Controls.Header.RootItemEventArgs.SelectedRootKey">
- <summary>
- Gets or sets the selected root item key.
- </summary>
- <value>
- The selected root item key
- </value>
- </member>
- <member name="T:DotSpatial.Controls.Header.SelectedValueChangedEventArgs">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Header.SelectedValueChangedEventArgs.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Controls.Header.SelectedValueChangedEventArgs"/> class.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Header.SelectedValueChangedEventArgs.#ctor(System.Object)">
- <summary>
- Initializes a new instance of the SelectedValueChangedEventArgs class.
- </summary>
- <param name="selectedItem"></param>
- </member>
- <member name="P:DotSpatial.Controls.Header.SelectedValueChangedEventArgs.SelectedItem">
- <summary>
- Gets or sets the selected item.
- </summary>
- <value>
- The selected item.
- </value>
- </member>
- <member name="T:DotSpatial.Controls.Header.SeparatorItem">
- <summary>
- A thin, typically vertical separation bar.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Header.SeparatorItem.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Controls.Header.SeparatorItem"/> class.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Header.SeparatorItem.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the SeparatorItem class.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.Header.SimpleActionItem">
- <summary>
- A simple action which is represented by a button or clickable surface.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Header.SimpleActionItem.#ctor(System.String,System.EventHandler)">
- <summary>
- Initializes a new instance of the SimpleActionItem class.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Header.SimpleActionItem.#ctor(System.String,System.String,System.EventHandler)">
- <summary>
- Initializes a new instance of the SimpleActionItem class.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Header.SimpleActionItem.#ctor(System.String,System.String,System.String,System.EventHandler)">
- <summary>
- Initializes a new instance of the SimpleActionItem class.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Header.SimpleActionItem.OnClick(System.EventArgs)">
- <summary>
- Triggers the Click event.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Header.SimpleActionItem.Toggle">
- <summary>
- Checks the button it it is unchecked and unchecks the button it if is checked.
- </summary>
- <remarks>This method has no effect if ToggleGroupKey is null.</remarks>
- </member>
- <member name="M:DotSpatial.Controls.Header.SimpleActionItem.OnToggle(System.EventArgs)">
- <summary>
- Triggers the Toggling event.
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.Header.SimpleActionItem.Click">
- <summary>
- Gets or sets the click event handler.
- </summary>
- <value>The click event handler.</value>
- </member>
- <member name="E:DotSpatial.Controls.Header.SimpleActionItem.Toggling">
- <summary>
- Thrown when the Toggle method is executed.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Header.SimpleActionItem.ShowInQuickAccessToolbar">
- <summary>
- True if an associated quick-access button is shown.
- False if the associated quick-access button is not shown.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Header.SimpleActionItem.LargeImage">
- <summary>
- Gets or sets the large image.
- </summary>
- <value>The large image.</value>
- </member>
- <member name="P:DotSpatial.Controls.Header.SimpleActionItem.MenuContainerKey">
- <summary>
- Gets or sets the menu container key.
- </summary>
- <value>The menu container key.</value>
- </member>
- <member name="P:DotSpatial.Controls.Header.SimpleActionItem.SmallImage">
- <summary>
- Gets or sets the small image.
- </summary>
- <value>The small image.</value>
- </member>
- <member name="P:DotSpatial.Controls.Header.SimpleActionItem.SortOrder">
- <summary>
- Gets or sets the sort order. Lower values will suggest that an item should appear further left in a LeftToRight environment. Or higher up in a top to bottom environment.
- </summary>
- <remarks>Use a multiple of 100 or so to allow other developers some 'space' to place their groups.</remarks>
- <value>
- The sort order.
- </value>
- </member>
- <member name="P:DotSpatial.Controls.Header.SimpleActionItem.ToggleGroupKey">
- <summary>
- Gets or sets the toggle button group key used to select what buttons should toggle each other..
- </summary>
- <value>The toggle button key.</value>
- </member>
- <member name="T:DotSpatial.Controls.Header.ToolstripPosition">
- <summary>
- Helper-Class to remember the Toolstrip-Positions to save to file on exit.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.Header.TextEntryActionItem">
- <summary>
- A textbox item
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Header.TextEntryActionItem.Width">
- <summary>
- Gets or sets the width of the item displayed in the header control.
- </summary>
- <value>
- The width.
- </value>
- </member>
- <member name="P:DotSpatial.Controls.Header.TextEntryActionItem.Text">
- <summary>
- Gets or sets the text.
- </summary>
- <value>
- The text.
- </value>
- </member>
- <member name="P:DotSpatial.Controls.Header.TextEntryActionItem.FontColor">
- <summary>
- Gets or sets a value indicating the color of the text in the dropdownbox
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.LayoutControl">
- <summary>
- The actual control controling the layout.
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.LayoutControl.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.RemoveFromLayout(DotSpatial.Controls.LayoutElement)">
- <summary>
- Removes the specified layoutElement from the layout
- </summary>
- <param name="le"></param>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.ClearLayout">
- <summary>
- Clears the the layout of all layoutElements
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.AddToSelection(DotSpatial.Controls.LayoutElement)">
- <summary>
- Adds the specified LayoutElement le to the selection
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.AddToSelection(System.Collections.Generic.List{DotSpatial.Controls.LayoutElement})">
- <summary>
- Adds the specified LayoutElement le to the selection
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.RemoveFromSelection(DotSpatial.Controls.LayoutElement)">
- <summary>
- Removes the specified layoutElement from the selection
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.ClearSelection">
- <summary>
- Clears the current selection
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.#ctor">
- <summary>
- This is the constructor, it makes a LayoutControl
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.NewLayout(System.Boolean)">
- <summary>
- Creates a new blank layout
- </summary>
- <param name="promptSave">Prompts the user if they want to save first</param>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.LoadLayout(System.Boolean,System.Boolean,System.Boolean)">
- <summary>
- Shows a load dialog box and prompts the user to open a layout file
- </summary>
- <param name="promptSave">Prompts the user if they want to save first</param>
- <param name="loadPaperSettings">Loads the paper settings (size, margins, orientation) from the layout</param>
- <param name="promptPaperMismatch">Warn the user if the paper size stored in the file doesn't exist in current printer and ask them if they want to load it anyways</param>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.LoadLayout(System.String,System.Boolean,System.Boolean)">
- <summary>
- Loads the selected layoutfile
- </summary>
- <param name="fileName">The layout file to load</param>
- <param name="loadPaperSettings">Loads the paper settings (size, margins, orientation) from the layout</param>
- <param name="promptPaperMismatch">Warn the user if the paper size stored in the file doesn't exist in current printer and ask them if they want to load it anyways</param>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.CloseLayout">
- <summary>
- Prepapres the layoutcontrol for closing, prompts the user to save if needed
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.SaveLayout(System.Boolean)">
- <summary>
- Shows a save dialog box and prompts the user to save a layout file.
- </summary>
- <param name="promptSaveAs">Show prompt dialog or not. Note that dialog will be always shown when Filename is null or empty.</param>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.SaveLayout(System.String)">
- <summary>
- Saves the layout to the specified fileName.
- If file name has .mwl extension then it will be saved as DotSpatial Layout File.
- Otherwise it will be trying to save as Bitmap.
- </summary>
- <param name="fileName">Specified file name</param>
- <exception cref="T:System.ArgumentNullException">Throws when fileName is null.</exception>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.ExportToBitmap(System.String)">
- <summary>
- Export layout to bitmap.
- </summary>
- <param name="fileName">Bitmap file name</param>
- <exception cref="T:System.ArgumentNullException">Throws when fileName is null.</exception>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.ExportToMwl(System.String)">
- <summary>
- Export layout to DotSpatial Layout File.
- </summary>
- <param name="fileName">DotSpatial Layout File</param>
- <exception cref="T:System.ArgumentNullException">Throws when fileName is null.</exception>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.AddToLayout(DotSpatial.Controls.LayoutElement)">
- <summary>
- Adds a layout element to the layout
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.ShowChoosePrinterDialog">
- <summary>
- This shows the choose printer dialog
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.ShowPageSetupDialog">
- <summary>
- This shows the pageSetup dialog
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.Print">
- <summary>
- Prints to the printer currently in PrinterSettings
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.RefreshElements">
- <summary>
- Refreshes all of the elements in the layout
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.PrintPage(System.Object,System.Drawing.Printing.PrintPageEventArgs)">
- <summary>
- This event handler is fired by the print document when it prints and draws the layout to the print document
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.DrawPage(System.Drawing.Graphics)">
- <summary>
- Draws page to layout
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.ZoomIn">
- <summary>
- Zooms into the paper
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.ZoomOut">
- <summary>
- Zooms out of the paper
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.ZoomFitToScreen">
- <summary>
- Zooms the page to fit to the screen and centers it
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.ZoomInMap(DotSpatial.Controls.LayoutMap)">
- <summary>
- Zooms the specified map element in by 10%
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.ZoomInMap">
- <summary>
- Zooms all map elements in by 10%
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.ZoomOutMap(DotSpatial.Controls.LayoutMap)">
- <summary>
- Zooms the specified map element out by 10%
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.ZoomOutMap">
- <summary>
- Zooms all map element out by 10%
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.ZoomFullExtentMap(DotSpatial.Controls.LayoutMap)">
- <summary>
- Zooms the specified map element to the full extent of its layers
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.ZoomFullExtentMap">
- <summary>
- Zooms all map elements to the full extent of their layers
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.ZoomFullViewExtentMap(DotSpatial.Controls.LayoutMap)">
- <summary>
- Zoom the specified map to the extent of the data view
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.ZoomFullViewExtentMap">
- <summary>
- Zoom all maps to the extent of their data view
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.PanMap(DotSpatial.Controls.LayoutMap,System.Single,System.Single)">
- <summary>
- Pans the map the specified amount
- </summary>
- <param name="lm">the layout map to pan</param>
- <param name="x">The distance to pan the map on x-axis in screen coord</param>
- <param name="y">The distance to pan the map on y-axis in screen coord</param>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.DeleteSelected">
- <summary>
- Deletes all of the selected elements from the model
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.InvertSelection">
- <summary>
- Inverts the selection
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.MoveSelectionUp">
- <summary>
- Moves the selection up by one
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.MoveSelectionDown">
- <summary>
- Moves the selection down by one
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.SelectAll">
- <summary>
- Selects All the elements in the layout
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.AddElementWithMouse(DotSpatial.Controls.LayoutElement)">
- <summary>
- Allows the user to click on the layout and drag a rectangle where they want to insert an element
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.CreateMapElement">
- <summary>
- Creates an instance of the MapElement and returns it
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.CreateLegendElement">
- <summary>
- Creates an instance of the LegendElement and returns it
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.CreateScaleBarElement">
- <summary>
- Creates an instance of the ScaleBarElement and returns it
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.ConvertSelectedToBitmap">
- <summary>
- Converts all of the selected layout elements to bitmaps
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.ConvertElementToBitmap(DotSpatial.Controls.LayoutElement,System.String)">
- <summary>
- Converts a selected layout element into a bitmap and saves it a the specified location removing the old element and replacing it
- </summary>
- <param name="le"></param>
- <param name="fileName"></param>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.AlignElements(System.Collections.Generic.List{DotSpatial.Controls.LayoutElement},DotSpatial.Controls.Alignment,System.Boolean)">
- <summary>
- Aligns elements with each other or with the margins
- </summary>
- <param name="elements">A list of elements to align</param>
- <param name="side">The side to align to</param>
- <param name="margin">True to align to paper margins, false to align to the most extreme element of the indicated side</param>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.MatchElementsSize(System.Collections.Generic.List{DotSpatial.Controls.LayoutElement},DotSpatial.Controls.Fit,System.Boolean)">
- <summary>
- Makes all of the input layout elements have the same width or height
- </summary>
- <param name="elements">A list of elements to resize to the max size of all elements or the margins</param>
- <param name="axis">Fit the width or the height</param>
- <param name="margin">True if use margin size false to use arges element in input list</param>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.ScreenToPaper(System.Drawing.PointF)">
- <summary>
- Converts a point in screen coordinants to paper coordinants in 1/100 of an inch
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.ScreenToPaper(System.Single,System.Single)">
- <summary>
- Converts a point in screen coordinants to paper coordinants in 1/100 of an inch
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.ScreenToPaper(System.Drawing.RectangleF)">
- <summary>
- Converts a rectangle in screen coordinants to paper coordiants in 1/100 of an inch
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.ScreenToPaper(System.Single,System.Single,System.Single,System.Single)">
- <summary>
- Converts a rectangle in screen coordinants to paper coordiants in 1/100 of an inch
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.PaperToScreen(System.Drawing.PointF)">
- <summary>
- Converts between a point in paper coordinants in 1/100th of an inch to screen coordinants
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.PaperToScreen(System.Single,System.Single)">
- <summary>
- Converts between a point in paper coordinants in 1/100th of an inch to screen coordinants
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.PaperToScreen(System.Drawing.RectangleF)">
- <summary>
- Converts between a rectangle in paper coordinants in 1/100th of an inch to screen coordinants
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.PaperToScreen(System.Single,System.Single,System.Single,System.Single)">
- <summary>
- Converts a rectangle in screen coordinants to paper coordiants in 1/100 of an inch
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.CenterPaperOnPoint(System.Drawing.PointF)">
- <summary>
- Centers the layout on a given point
- </summary>
- <param name="centerPoint">A Point on the paper to center on</param>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.UpdateScrollBars">
- <summary>
- Updates the scroll bars so the look and act right
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.IntersectElementEdge(System.Drawing.RectangleF,System.Drawing.PointF,System.Single)">
- <summary>
- Calculates which edge of a rectangle the point intersects with, within a certain limit
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.OnPaint(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Drawing code
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.OnPaintBackground(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Prevents flicker from any default on paint background operations
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.LeInvalidated(System.Object,System.EventArgs)">
- <summary>
- This gets fired when one of the layoutElements gets invalidated
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.LayoutControl_Resize(System.Object,System.EventArgs)">
- <summary>
- Fires whenever the LayoutControl is resized
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.vScrollBar_Scroll(System.Object,System.Windows.Forms.ScrollEventArgs)">
- <summary>
- This fires when the vscrollbar is moved
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.hScrollBar_Scroll(System.Object,System.Windows.Forms.ScrollEventArgs)">
- <summary>
- This fires when the hscrollbar is moved
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.LayoutControl_KeyUp(System.Object,System.Windows.Forms.KeyEventArgs)">
- <summary>
- This allows elements to be refreshed, deleted by key press.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.OnFilenameChanged(System.EventArgs)">
- <summary>
- Calls this to indicate the fileName has been changed
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.OnZoomChanged(System.EventArgs)">
- <summary>
- Calls this to indicate the zoom has been changed
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.OnSelectionChanged(System.EventArgs)">
- <summary>
- Call this to indicate the selection has changed
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.OnElementsChanged(System.EventArgs)">
- <summary>
- Call this to indicate elements were added or removed.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.LayoutControl.OnLayoutLoaded(System.EventArgs)">
- <summary>
- Call this to indicate that a layout was loaded from file.
- </summary>
- <param name="e"></param>
- </member>
- <member name="E:DotSpatial.Controls.LayoutControl.ElementsChanged">
- <summary>
- This fires after a element was added or removed.
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.LayoutControl.LayoutLoaded">
- <summary>
- This fires after a layout was loaded from file.
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.LayoutControl.SelectionChanged">
- <summary>
- This fires after the selection has changed.
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.LayoutControl.ZoomChanged">
- <summary>
- This fires when the zoom of the layout changes.
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.LayoutControl.FilenameChanged">
- <summary>
- This fires when the projects file name is changed.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutControl.SelectedLayoutElements">
- <summary>
- Gets the list of layoutElements currently selected in the project
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutControl.LayoutElements">
- <summary>
- Gets the list of layoutElements currently loaded in the project
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutControl.Filename">
- <summary>
- Gets or sets the fileName of the current project
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutControl.PrinterSettings">
- <summary>
- Gets or sets the printer settings for the layout
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutControl.LayoutMenuStrip">
- <summary>
- Gets or sets the layout menu strip to use
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutControl.LayoutPropertyGrip">
- <summary>
- Gets or sets the layoutproperty grip to use
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutControl.MapControl">
- <summary>
- Gets or sets the Map control to use
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutControl.LayoutZoomToolStrip">
- <summary>
- Gets or sets the layout tool strip to use
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutControl.LayoutListBox">
- <summary>
- Gets or sets the layout list box
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutControl.LayoutDocToolStrip">
- <summary>
- Gets or sets the LayoutDocToolStrip
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutControl.LayoutInsertToolStrip">
- <summary>
- Gets or sets the LayoutInsertToolStrip
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutControl.LayoutMapToolStrip">
- <summary>
- Gets of sets the LayoutMapToolStrip
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutControl.ShowMargin">
- <summary>
- Sets a boolean flag indicating if margins should be shown.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutControl.Zoom">
- <summary>
- Gets or sets the zoom of the paper
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutControl.DrawingQuality">
- <summary>
- Gets or sets the smoothing mode to use to draw the map
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutControl.MapPanMode">
- <summary>
- Gets or sets the map pan mode
- </summary>\
- </member>
- <member name="P:DotSpatial.Controls.LayoutControl.PaperWidth">
- <summary>
- Gets the width of the paper in 1/100 of an inch
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutControl.PaperHeight">
- <summary>
- Gets the heigh of the paper in 1/100 of an inch
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.LayoutForm">
- <summary>
- This is the primary form where the print layout content is organized before printing
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.LayoutForm.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutForm.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Controls.LayoutForm.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutForm.#ctor">
- <summary>
- Default constructor for creating a new instance of hte Layout form
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutForm.MapControl">
- <summary>
- Gets or sets the map that will be used in the layout
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutForm.LayoutControl">
- <summary>
- Gets layout control.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.LayoutInsertToolStrip">
- <summary>
- A Brian Marchioni original toolstrip... preloaded with content.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutInsertToolStrip.#ctor">
- <summary>
- Creates an instance of the toolstrip
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutInsertToolStrip.LayoutControl">
- <summary>
- The layout control associated with this toolstrip
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.MapFrameProjectionDialog">
- <summary>
- A dialog for changing the projection of the map frame.
- </summary>
- <summary>
- The Designer for the AppDialog Class
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFrameProjectionDialog.#ctor(DotSpatial.Controls.IMapFrame)">
- <summary>
- use the mapFrame with this dialog
- </summary>
- <param name="mapFrame"></param>
- </member>
- <member name="F:DotSpatial.Controls.MapFrameProjectionDialog.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFrameProjectionDialog.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Controls.MapFrameProjectionDialog.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapFrameProjectionDialog.MapFrame">
- <summary>
- Gets or sets the map frame for this dialog
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapFrameProjectionDialog.Projection">
- <summary>
- Gets or sets projection
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.GeneralTypeConverter.CanConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Type)">
- <summary>
- CanConvertTo
- </summary>
- <param name="context"></param>
- <param name="destinationType"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.GeneralTypeConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)">
- <summary>
-
- </summary>
- <param name="context"></param>
- <param name="culture"></param>
- <param name="value"></param>
- <param name="destinationType"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.GeneralTypeConverter.CanConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Type)">
- <summary>
- Can convert from
- </summary>
- <param name="context"></param>
- <param name="sourceType"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Controls.Images">
- <summary>
- A strongly-typed resource class, for looking up localized strings, etc.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.ResourceManager">
- <summary>
- Returns the cached ResourceManager instance used by this class.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.Culture">
- <summary>
- Overrides the current thread's CurrentUICulture property for all
- resource lookups using this strongly typed resource class.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.AddLayer">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.AddWebLayer">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.Angle">
- <summary>
- Looks up a localized resource of type System.Drawing.Icon similar to (Icon).
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.Apple">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.calculator">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.Checked">
- <summary>
- Looks up a localized resource of type System.Drawing.Icon similar to (Icon).
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.color_scheme">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.Copy">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.cursor_arrow_16x16">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.cursor_arrow_32x32">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.cursorHand">
- <summary>
- Looks up a localized resource of type System.Byte[].
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.cursorSelect">
- <summary>
- Looks up a localized resource of type System.Byte[].
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.cursorZoomIn">
- <summary>
- Looks up a localized resource of type System.Byte[].
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.cursorZoomIn1">
- <summary>
- Looks up a localized resource of type System.Byte[].
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.cursorZoomOut">
- <summary>
- Looks up a localized resource of type System.Byte[].
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.cursorZoomOut1">
- <summary>
- Looks up a localized resource of type System.Byte[].
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.deselect_16x16">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.deselect_32x32">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.Dice">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.Dice1">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.disk_16x16">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.disk_32x32">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.document_empty_16x16">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.document_empty_32x32">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.DotSpatialGlobe">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.DotSpatialGlobeSmall">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.down">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.DropDown">
- <summary>
- Looks up a localized resource of type System.Drawing.Icon similar to (Icon).
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.file_close">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.file_new">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.file_saveas">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.folder_16x16">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.folder_32x32">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.FolderOpen">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.HammerSmall">
- <summary>
- Looks up a localized resource of type System.Drawing.Icon similar to (Icon).
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.hand_16x16">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.hand_32x32">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.info_rhombus_16x16">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.info_rhombus_32x32">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.Label">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.layer_add">
- <summary>
- Looks up a localized resource of type System.Drawing.Icon similar to (Icon).
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.layer_add_16x16">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.layer_add_32x32">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.layer_remove_16x16">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.layer_remove_32x32">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.layer_save_16x16">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.layer_save_32x32">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.Layers">
- <summary>
- Looks up a localized resource of type System.Drawing.Icon similar to (Icon).
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.layout_delete_16x16">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.layout_delete_32x32">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.layout_zoom_full_extent">
- <summary>
- Looks up a localized resource of type System.Drawing.Icon similar to (Icon).
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.layout_zoom_in">
- <summary>
- Looks up a localized resource of type System.Drawing.Icon similar to (Icon).
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.layout_zoom_out">
- <summary>
- Looks up a localized resource of type System.Drawing.Icon similar to (Icon).
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.Legend">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.LinkData">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.map">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.MaxExtents">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.measure_16x16">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.measure_32x32">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.mnuLayerClear">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.mnuLayerClear1">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.NewModel">
- <summary>
- Looks up a localized resource of type System.Drawing.Icon similar to (Icon).
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.NewShape">
- <summary>
- Looks up a localized resource of type System.Drawing.Icon similar to (Icon).
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.NewShapefile">
- <summary>
- Looks up a localized resource of type System.Drawing.Icon similar to (Icon).
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.NorthArrow">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.PageSetup">
- <summary>
- Looks up a localized resource of type System.Drawing.Icon similar to (Icon).
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.Pan">
- <summary>
- Looks up a localized resource of type System.Drawing.Icon similar to (Icon).
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.PanMap">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.PanSimple">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.printer">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.printer_16x16">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.printer_32x32">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.printer_icon">
- <summary>
- Looks up a localized resource of type System.Drawing.Icon similar to (Icon).
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.Rectangle">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.RunModel">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.RunModel1">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.save">
- <summary>
- Looks up a localized resource of type System.Drawing.Icon similar to (Icon).
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.save_as_16x16">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.save_as_32x32">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.ScaleBar">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.select">
- <summary>
- Looks up a localized resource of type System.Drawing.Icon similar to (Icon).
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.select_16x16">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.select_32x32">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.select_all">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.select_none">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.SelectSimple">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.table_16x16">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.table_32x32">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.Table_edit">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.Table_edit1">
- <summary>
- Looks up a localized resource of type System.Drawing.Icon similar to (Icon).
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.text">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.Unchecked">
- <summary>
- Looks up a localized resource of type System.Drawing.Icon similar to (Icon).
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.up">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.zoom_16x16">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.zoom_32x32">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.zoom_coordinate_16x16">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.zoom_coordinate_32x32">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.zoom_extend_16x16">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.zoom_extend_32x32">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.zoom_full_extent">
- <summary>
- Looks up a localized resource of type System.Drawing.Icon similar to (Icon).
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.zoom_in">
- <summary>
- Looks up a localized resource of type System.Drawing.Icon similar to (Icon).
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.zoom_in_16x16">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.zoom_in_32x32">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.zoom_layer_16x16">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.zoom_layer_32x32">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.zoom_out">
- <summary>
- Looks up a localized resource of type System.Drawing.Icon similar to (Icon).
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.zoom_out_16x16">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.zoom_out_32x32">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.zoom_selection_16x16">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.zoom_selection_32x32">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.zoom_to_next">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.zoom_to_next_16">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.zoom_to_previous">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.zoom_to_previous_16">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.ZoomFullMap">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.ZoomFullView">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.ZoomInMap">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.ZoomNext">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.ZoomOutMap">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Images.ZoomPrevious">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.IUserControl">
- <summary>
- Provides an empty control that can be used to create other controls.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IUserControl.AutoSizeMode">
- <summary>
- Gets or sets how the control will resize itself.
- </summary>
- <returns>
- A value from the AutoSizeMode enumeration. The default is AutoSizeMode.GrowOnly.
- </returns>
- </member>
- <member name="P:DotSpatial.Controls.IUserControl.BorderStyle">
- <summary>
- Gets or sets the border style of the tree view control.
- </summary>
- <returns>
- One of the BorderStyle values. The default is BorderStyle.Fixed3D.
- </returns>
- <exception cref="T:System.ComponentModel.InvalidEnumArgumentException">
- InvalidEnumArgumentException: The assigned value is not one of the BorderStyle values.
- </exception>
- </member>
- <member name="E:DotSpatial.Controls.IUserControl.AutoSizeChanged">
- <summary>
- Occurs when the AutoSize changes
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.IUserControl.AutoValidateChanged">
- <summary>
- Occurs when the UserControl.AutoValidate property changes.
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.IUserControl.Load">
- <summary>
- Occurs before the control becomes visible for the first time.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.IPreviewMapHandler">
- <summary>
- The extended and complete set of events associated with the PreviewMap
- Implementing this avoids having to manually add handlers for every event.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.IPreviewMapHandler.PreviewMap_DragDrop(System.Object,System.Windows.Forms.DragEventArgs)">
- <summary>
- Occurs when a drag-and-drop operation is completed.
- </summary>
- <param name="sender">An instance of the calling object</param>
- <param name="e">A DragEventArgs with the drag parameters</param>
- </member>
- <member name="M:DotSpatial.Controls.IPreviewMapHandler.Map_ExtentsChanged(System.Object,System.EventArgs)">
- <summary>
- Occurs when the visible region being displayed on the map changes
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.IPreviewMapHandler.PreviewMap_MouseClick(System.Object,System.Windows.Forms.MouseEventArgs)">
- <summary>
- Occurs when the control is clicked by the mouse.
- </summary>
- <param name="sender">An instance of the calling object</param>
- <param name="e">A MouseEventArgs with any parameters</param>
- </member>
- <member name="M:DotSpatial.Controls.IPreviewMapHandler.PreviewMap_MouseDoubleClick(System.Object,System.Windows.Forms.MouseEventArgs)">
- <summary>
- Occurs when the control is double clicked by the mouse.
- </summary>
- <param name="sender">An instance of the calling object</param>
- <param name="e">A MouseEventArgs with any parameters</param>
- </member>
- <member name="M:DotSpatial.Controls.IPreviewMapHandler.PreviewMap_MouseDown(System.Object,System.Windows.Forms.MouseEventArgs)">
- <summary>
- Occurs when the mouse pointer is over the control and a mouse button is pressed.
- </summary>
- <param name="sender">An instance of the calling object</param>
- <param name="e">A MouseEventArgs with any parameters</param>
- </member>
- <member name="M:DotSpatial.Controls.IPreviewMapHandler.PreviewMap_MouseMove(System.Object,System.Windows.Forms.MouseEventArgs)">
- <summary>
- Occurs when the mouse pointer is moved over the control.
- </summary>
- <param name="sender">An instance of the calling object</param>
- <param name="e">A MouseEventArgs with any parameters</param>
- </member>
- <member name="M:DotSpatial.Controls.IPreviewMapHandler.PreviewMap_MouseUp(System.Object,System.Windows.Forms.MouseEventArgs)">
- <summary>
- Occurs when the mouse pointer is over the control and a mouse button is released.
- </summary>
- <param name="sender">An instance of the calling object</param>
- <param name="e">A MouseEventArgs with any parameters</param>
- </member>
- <member name="M:DotSpatial.Controls.IPreviewMapHandler.PreviewMap_MouseWheel(System.Object,System.Windows.Forms.MouseEventArgs)">
- <summary>
- Occurs when the mouse wheel moves while the control has focus.
- </summary>
- <param name="sender">An instance of the calling object</param>
- <param name="e">A MouseEventArgs with any parameters</param>
- </member>
- <member name="M:DotSpatial.Controls.IPreviewMapHandler.PreviewMap_Paint(System.Object,System.Windows.Forms.PaintEventArgs)">
- <summary>
- Occurs when the control is redrawn.
- </summary>
- <param name="sender">An instance of the calling object</param>
- <param name="e">A PaintEventArgs with any parameters</param>
- </member>
- <member name="T:DotSpatial.Controls.LayoutBitmap">
- <summary>
- The layout bitmap provides the ability to add any custom image to the layout
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.LayoutElement">
- <summary>
- The interface for all elements that can be added to the layout control
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutElement.#ctor">
- <summary>
- Creates an instance of the layout element
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutElement._background_ItemChanged(System.Object,System.EventArgs)">
- <summary>
- Fires when the background is modified
- </summary>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.LayoutElement.IntersectsWith(System.Drawing.PointF)">
- <summary>
- Returns true if the point in paper coordinants intersects with the rectangle of the element
- </summary>
- <param name="paperPoint"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.LayoutElement.IntersectsWith(System.Drawing.RectangleF)">
- <summary>
- Returns true if the rectangle in paper coordinants intersects with the rectangle of the the element
- </summary>
- <param name="paperRectangle"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.LayoutElement.Draw(System.Drawing.Graphics,System.Boolean)">
- <summary>
- This gets called to instruct the element to draw itself in the appropriate spot of the graphics object
- </summary>
- <param name="g">The graphics object to draw to</param>
- <param name="printing">If true then we a actually printing not previewing so we should make it as high quality as possible</param>
- </member>
- <member name="M:DotSpatial.Controls.LayoutElement.DrawBackground(System.Drawing.Graphics,System.Boolean)">
- <summary>
- Draws the elements background behind everything else
- </summary>
- <param name="g"></param>
- <param name="printing"></param>
- </member>
- <member name="M:DotSpatial.Controls.LayoutElement.DrawOutline(System.Drawing.Graphics,System.Boolean)">
- <summary>
- Draws the elements outline on top of everything else
- </summary>
- <param name="g"></param>
- <param name="printing"></param>
- </member>
- <member name="M:DotSpatial.Controls.LayoutElement.RefreshElement">
- <summary>
- Causes the element to be refreshed
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutElement.ToString">
- <summary>
- This returns the objects name as a string
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutElement.OnInvalidate">
- <summary>
- Call this when it needs to updated
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutElement.OnSizeChanged">
- <summary>
- Fires when the size of the element changes
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutElement.OnThumbnailChanged">
- <summary>
- Fires when the thumbnail gets modified
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutElement.UpdateThumbnail">
- <summary>
- Updates the thumbnail when needed
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.LayoutElement.Invalidated">
- <summary>
- Fires when the layout element is invalidated
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.LayoutElement.ThumbnailChanged">
- <summary>
- Fires when the preview thumbnail for this element has been updated
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.LayoutElement.SizeChanged">
- <summary>
- Fires when the size of this element has been adjusted by the user
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutElement.Background">
- <summary>
- Gets or sets the line symbolizer that draws the outline
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutElement.Name">
- <summary>
- Gets or sets the name of the element
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutElement.ThumbNail">
- <summary>
- Gets the thumbnail that appears in the LayoutListView
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutElement.Resizing">
- <summary>
- Disables updating redraw when resizing.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutElement.ResizeStyle">
- <summary>
- Indicates if this element can handle redraw events on resize
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutElement.LocationF">
- <summary>
- Gets or sets the location of the top left corner of the control in 1/100 of an inch paper coordinants
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutElement.Location">
- <summary>
- Gets or sets the location of the top left corner of the control in 1/100 of an inch paper coordinants
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutElement.Size">
- <summary>
- Gets or sets the size of the element in 1/100 of an inch paper coordinants
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutElement.Rectangle">
- <summary>
- Gets or sets the rectangle of the element in 1/100th of an inch paper coordinants
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutBitmap.#ctor">
- <summary>
- Constructor
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutBitmap.Draw(System.Drawing.Graphics,System.Boolean)">
- <summary>
- This gets called to instruct the element to draw itself in the appropriate spot of the graphics object
- </summary>
- <param name="g">The graphics object to draw to</param>
- <param name="printing">Boolean, true if this is being drawn to a print document</param>
- </member>
- <member name="P:DotSpatial.Controls.LayoutBitmap.PreserveAspectRatio">
- <summary>
- Preserves the aspect ratio if this boolean is true, otherwise it allows stretching of
- the bitmap to occur
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutBitmap.Brightness">
- <summary>
- Modifies the brightness of the bitmap relative to its original brightness +/- 255 Doesn't modify original bitmap
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutBitmap.Contrast">
- <summary>
- Modifies the contrast of the bitmap relative to its original contrast +/- 255 Doesn't modify original bitmap
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutBitmap.Filename">
- <summary>
- Gets or sets the string fileName of the bitmap to use
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutBitmap.Bitmap">
- <summary>
- Gets or sets bitmap to use
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.LayoutDocToolStrip">
- <summary>
- A Brian Marchioni original toolstrip... preloaded with content.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutDocToolStrip.#ctor">
- <summary>
- Creates an instance of the toolstrip
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutDocToolStrip.LayoutControl">
- <summary>
- The layout control associated with this toolstrip
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.MouseMode">
- <summary>
- An enumeration that defines the Mouses current behavior
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.MouseMode.Default">
- <summary>
- The cursor is currently in default mode
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.MouseMode.CreateSelection">
- <summary>
- The cursor is currently being used to create a new selection
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.MouseMode.MoveSelection">
- <summary>
- The cursor is currently is move selection mode
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.MouseMode.ResizeSelected">
- <summary>
- The cursor is in resize mode because its over the edge of a selected item
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.MouseMode.InsertNewElement">
- <summary>
- When in this mode the user can click on the map select an area and an element is inserted at that spot
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.MouseMode.StartInsertNewElement">
- <summary>
- In this mode a cross hair is shown letting the user create a new Insert rectangle
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.MouseMode.StartPanMap">
- <summary>
- Puts the mouse into a mode that allows map panning
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.MouseMode.PanMap">
- <summary>
- The mouse is actually panning a map
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.Edge">
- <summary>
- Enumerates all the possible resize direction
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.ResizeStyle">
- <summary>
- Enumarates the different ways that a a LayoutElement can handle resize events
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.ResizeStyle.HandledInternally">
- <summary>
- The resize style is determined automatically
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.ResizeStyle.StretchToFit">
- <summary>
- The element is adjusted to fit the extents even if it is distorted
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.ResizeStyle.NoScaling">
- <summary>
- No scaling occurs whatsoever, and the element is drawn at its original size
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.ScaleBarUnit">
- <summary>
- An enumeration of the possible scale bar units
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.ScaleBarUnit.Kilometers">
- <summary>
- Kilometers
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.ScaleBarUnit.Meters">
- <summary>
- Meters
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.ScaleBarUnit.Centimeters">
- <summary>
- Centimeters
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.ScaleBarUnit.Millimeters">
- <summary>
- Millimeters
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.ScaleBarUnit.Miles">
- <summary>
- Miles
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.ScaleBarUnit.Yards">
- <summary>
- Yards
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.ScaleBarUnit.Feet">
- <summary>
- Feet
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.ScaleBarUnit.Inches">
- <summary>
- Inches
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.Alignment">
- <summary>
- An enumeration of alignments used for aligning selected layout elements
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.Alignment.Left">
- <summary>
- Left
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.Alignment.Right">
- <summary>
- Right
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.Alignment.Top">
- <summary>
- Top
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.Alignment.Bottom">
- <summary>
- Bottom
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.Alignment.Horizontal">
- <summary>
- Horizontal
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.Alignment.Vertical">
- <summary>
- Vertical
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.Fit">
- <summary>
- An enumeration of resizing options used for aligning selected layout elements
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.Fit.Width">
- <summary>
- Width
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.Fit.Height">
- <summary>
- Height
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.LayoutLayerEditor">
- <summary>
- Layout Layer Editor allows the user to select which layers appear in the legend
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutLayerEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)">
- <summary>
- Edits a value based on some user input which is collected from a character control.
- </summary>
- <param name="context"></param>
- <param name="provider"></param>
- <param name="value"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.LayoutLayerEditor.GetEditStyle(System.ComponentModel.ITypeDescriptorContext)">
- <summary>
- Gets the UITypeEditorEditStyle, which in this case is drop down.
- </summary>
- <param name="context"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Controls.LayoutLayerEditor.IsDropDownResizable">
- <summary>
- Ensures that we can widen the drop-down without having to close the drop down,
- widen the control, and re-open it again.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.LayoutLegend">
- <summary>
- Draws a legend for the layout
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutLegend.LayoutControlElementsChanged(System.Object,System.EventArgs)">
- <summary>
- Updates the scale bar if the map is deleted
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutLegend.#ctor">
- <summary>
- Constructor
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutLegend.Draw(System.Drawing.Graphics,System.Boolean)">
- <summary>
- This gets called to instruct the element to draw itself in the appropriate spot of the graphics object
- </summary>
- <param name="g">The graphics object to draw to</param>
- <param name="printing">A boolean value indicating if the Draw code is being called to print</param>
- </member>
- <member name="P:DotSpatial.Controls.LayoutLegend.Map">
- <summary>
- Gets or sets the layoutmap to use to base the legend on
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutLegend.Layers">
- <summary>
- Gets or sets the layers to include in the legend
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutLegend.Font">
- <summary>
- Gets or sets the font used to draw this text
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutLegend.Color">
- <summary>
- Gets or sets the color of the text
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutLegend.NumColumns">
- <summary>
- Gets or sets the number of columns to use when rendering the legend
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutLegend.TextHint">
- <summary>
- Gets or sets the hinting used to draw the text
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutLegend.LayoutControl">
- <summary>
- Gets or sets a layout control
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.LayoutListBox">
- <summary>
- This is designed to automatically have add, subtract, up and down arrows for working with a simple collection of items.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutListBox.#ctor">
- <summary>
- Creates a new instance of the Collection Control
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutListBox.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutListBox.RefreshList">
- <summary>
- Refreshes the items in the list to accuratly reflect the current collection
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutListBox.LayoutControl">
- <summary>
- Gets or sets the layoutControl
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.LayoutMap">
- <summary>
- A layout control that draws the content from a map control so that it can be printed
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutMap.#ctor(DotSpatial.Controls.Map)">
- <summary>
- Constructor to build a new LayoutMap control with map control
- </summary>
- <exception cref="T:System.ArgumentNullException">Throws if mapControl is null.</exception>
- </member>
- <member name="M:DotSpatial.Controls.LayoutMap.OnSizeChanged">
- <summary>
- Updates the size of the control
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutMap.ZoomToFullExtent">
- <summary>
- Zooms the map to the fullextent of all available layers
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutMap.ZoomViewExtent">
- <summary>
- Zooms the map to the extent of the current view
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutMap.ZoomInMap">
- <summary>
- Zooms the map element in by 10%
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutMap.ZoomOutMap">
- <summary>
- Zooms the map element out by 10%
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutMap.PanMap(System.Double,System.Double)">
- <summary>
- Pans the map
- </summary>
- <param name="x">The amount to pan the map in the X-axis in map coord</param>
- <param name="y">The amount to pan the map in the Y-axis in map coord</param>
- </member>
- <member name="M:DotSpatial.Controls.LayoutMap.Draw(System.Drawing.Graphics,System.Boolean)">
- <summary>
- This gets called to instruct the element to draw itself in the appropriate spot of the graphics object
- </summary>
- <param name="g">The graphics object to draw to</param>
- <param name="printing">Boolean, true if the drawing is printing to an actual page</param>
- </member>
- <member name="P:DotSpatial.Controls.LayoutMap.Envelope">
- <summary>
- The geographic envelope to be shown by the layout
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutMap.MapControl">
- <summary>
- The map control that generates the printable content
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutMap.Scale">
- <summary>
- A mathematical calculation using the map
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.LayoutMapEditor">
- <summary>
- Layout Map Editor is a UIType Editor that allows selecting a new map
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutMapEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)">
- <summary>
- Edits a value based on some user input which is collected from a character control.
- </summary>
- <param name="context"></param>
- <param name="provider"></param>
- <param name="value"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.LayoutMapEditor.GetEditStyle(System.ComponentModel.ITypeDescriptorContext)">
- <summary>
- Gets the UITypeEditorEditStyle, which in this case is drop down.
- </summary>
- <param name="context"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Controls.LayoutMapEditor.IsDropDownResizable">
- <summary>
- Ensures that we can widen the drop-down without having to close the drop down,
- widen the control, and re-open it again.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.LayoutMapToolStrip">
- <summary>
- A Brian Marchioni original toolstrip... preloaded with content.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutMapToolStrip.#ctor">
- <summary>
- Creates an instance of the toolstrip
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutMapToolStrip.LayoutControl">
- <summary>
- The layout control associated with this toolstrip
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.LayoutMenuStrip">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutMenuStrip.#ctor">
- <summary>
- Creates an instance of the toolstrip
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.LayoutMenuStrip.CloseClicked">
- <summary>
- Fires when the user clicks the close button on this menu strip
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutMenuStrip.LayoutControl">
- <summary>
- The layout control associated with this toolstrip
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.LayoutNorthArrow">
- <summary>
- North Arrow control for the Layout
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutNorthArrow.#ctor">
- <summary>
- Constructor
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutNorthArrow.Draw(System.Drawing.Graphics,System.Boolean)">
- <summary>
- This gets called to instruct the element to draw itself in the appropriate spot of the graphics object
- </summary>
- <param name="g">The graphics object to draw to</param>
- <param name="printing">boolean, true if printing to the actual paper/document, false if drawing as a control</param>
- </member>
- <member name="P:DotSpatial.Controls.LayoutNorthArrow.Color">
- <summary>
- Gets or sets the color of the text
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutNorthArrow.NorthArrowStyle">
- <summary>
- Gets or sets the style of the north arrow to draw
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutNorthArrow.Rotation">
- <summary>
- Gets or sets the rotations of the north arrow
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.NorthArrowStyle">
- <summary>
- An enumeration listing the different built in styles for the north arrow
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.NorthArrowStyle.Default">
- <summary>
- A four point triangle with a circle in the middle and the letter N
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.NorthArrowStyle.BlackArrow">
- <summary>
- A black arrow pointing north
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.NorthArrowStyle.CenterStar">
- <summary>
- Compas Rose style north arrow
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.NorthArrowStyle.TriangleN">
- <summary>
- A triangle around the letter N
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.NorthArrowStyle.TriangleHat">
- <summary>
- A triangle with a hat-like adornment
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.NorthArrowStyle.ArrowN">
- <summary>
- An arrow with the letter N
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.LayoutPropertyGrid">
- <summary>
- This is a control that allows users to easilly modify the various aspects of many different layout components
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutPropertyGrid.#ctor">
- <summary>
- Creates a new instance of the Layout Property Grid
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutPropertyGrid.LayoutControlSelectionChanged(System.Object,System.EventArgs)">
- <summary>
- If the selection changes this event is called
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutPropertyGrid.LayoutControl">
- <summary>
- Gets or sets the layout control associated with this property grid
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.LayoutRectangle">
- <summary>
- A control that draws a standard colored rectangle to the print layout
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutRectangle.#ctor">
- <summary>
- Constructor
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutRectangle.Draw(System.Drawing.Graphics,System.Boolean)">
- <summary>
- Doesn't need to do anything now because the drawing code is in the background property of the base class
- </summary>
- <param name="g"></param>
- <param name="printing"></param>
- </member>
- <member name="T:DotSpatial.Controls.LayoutScaleBar">
- <summary>
- A scale bar control that can be linked to a map and provide a dynamic scale bar for the print layout
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutScaleBar.LayoutControlElementsChanged(System.Object,System.EventArgs)">
- <summary>
- Updates the scale bar if the map is deleted
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutScaleBar.#ctor">
- <summary>
- Constructor
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutScaleBar.Draw(System.Drawing.Graphics,System.Boolean)">
- <summary>
- This gets called to instruct the element to draw itself in the appropriate spot of the graphics object
- </summary>
- <param name="g">The graphics object to draw to</param>
- <param name="printing">Boolean, true if printing to an actual print document</param>
- </member>
- <member name="M:DotSpatial.Controls.LayoutScaleBar.GetConversionFactor(System.String)">
- <summary>
- Returns the conversion factor between the map units and inches
- </summary>
- <param name="mapWinUnits">A string represing the MapUnits</param>
- <returns>A double representing the conversion factor between MapUnits and inches. If something goes wrong we return 0</returns>
- </member>
- <member name="P:DotSpatial.Controls.LayoutScaleBar.Map">
- <summary>
- Gets or sets the Map control that the scale bar uses for measurement decisions
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutScaleBar.Font">
- <summary>
- Gets or sets the font used to draw this text
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutScaleBar.Color">
- <summary>
- Gets or sets the color of the text
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutScaleBar.TextHint">
- <summary>
- Gets or sets the hinting used to draw the text
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutScaleBar.NumberOfBreaks">
- <summary>
- Gets or sets the number of breaks the scale bar should have
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutScaleBar.Unit">
- <summary>
- Gets or sets the unit to use for the scale bar
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutScaleBar.BreakBeforeZero">
- <summary>
- Gets or sets a property indicating is break should be present before the 0
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutScaleBar.UnitText">
- <summary>
- Gets or sets the unit text to display after the scale bar
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutScaleBar.LayoutControl">
- <summary>
- Gets or sets a layout control
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.LayoutText">
- <summary>
- Controls a rectangle
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutText.#ctor">
- <summary>
- Constructor
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutText.Draw(System.Drawing.Graphics,System.Boolean)">
- <summary>
- This gets called to instruct the element to draw itself in the appropriate spot of the graphics object
- </summary>
- <param name="g">The graphics object to draw to</param>
- <param name="printing">Boolean, true if printing to the file</param>
- </member>
- <member name="P:DotSpatial.Controls.LayoutText.Text">
- <summary>
- Gets or sets the text thats drawn in the graphics object
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutText.ContentAlignment">
- <summary>
- Gets or sets the content alignment
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutText.Font">
- <summary>
- Gets or sets the font used to draw this text
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutText.Color">
- <summary>
- Gets or sets the color of the text
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutText.TextHint">
- <summary>
- Gets or sets the hinting used to draw the text
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.LayoutZoomToolStrip">
- <summary>
- A Brian Marchioni original toolstrip... preloaded with content.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.LayoutZoomToolStrip.#ctor">
- <summary>
- Creates an instance of the toolstrip
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LayoutZoomToolStrip.LayoutControl">
- <summary>
- The layout control associated with this toolstrip
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.DrawLegendItemArgs.#ctor(System.Drawing.Graphics,DotSpatial.Symbology.ILegendItem,System.Drawing.Rectangle,System.Drawing.PointF)">
- <summary>
- Creates a new instance of DrawLegendItemArgs
- </summary>
- <param name="g">A Graphics surface to draw on</param>
- <param name="item">The legend item to draw</param>
- <param name="clipRectangle">The bounds that drawing should occur within</param>
- <param name="topLeft">The position of the top left corner where drawing should start.</param>
- </member>
- <member name="P:DotSpatial.Controls.DrawLegendItemArgs.Item">
- <summary>
- Gets the interface for the legend item being drawn
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.DrawLegendItemArgs.ClipRectangle">
- <summary>
- Gets the rectangle that limits where drawing should occur
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.DrawLegendItemArgs.TopLeft">
- <summary>
- Gets or sets the point that is the top left position where this item should start drawing, counting indentation.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.DrawLegendItemArgs.Graphics">
- <summary>
- Gets the graphics object for drawing to
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.ILegend">
- <summary>
- The easiest way to implement this is to inherit a UserControl, and then
- implement the members specific to the legend.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.ILegend.RefreshNodes">
- <summary>
- Given the current list of Maps or 3DMaps, it
- rebuilds the treeview nodes
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.ILegend.AddMapFrame(DotSpatial.Symbology.IFrame)">
- <summary>
- Adds a map frame as a root node, and links an event handler to update
- when the mapframe triggers an ItemChanged event.
- </summary>
- <param name="mapFrame"></param>
- </member>
- <member name="M:DotSpatial.Controls.ILegend.RemoveMapFrame(DotSpatial.Symbology.IFrame,System.Boolean)">
- <summary>
- Removes the specified map frame if it is a root node.
- </summary>
- <param name="mapFrame"></param>
- <param name="preventRefresh">Boolean, if true, removing the map frame will not automatically force a refresh of the legend.</param>
- </member>
- <member name="E:DotSpatial.Controls.ILegend.OrderChanged">
- <summary>
- Occurs when the drag method is used to alter the order of layers or
- groups in the legend.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.ILegend.RootNodes">
- <summary>
- Gets or sets the list of map frames being displayed by this legend.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.ILegendHandler">
- <summary>
- The extended and complete set of events associated with the Legend.
- Implementing this avoids having to manually add handlers for every event.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.ILegendHandler.Legend_DragDrop(System.Object,System.Windows.Forms.DragEventArgs)">
- <summary>
- Occurs when a drag-and-drop operation is completed.
- </summary>
- <param name="sender">An instance of the calling object</param>
- <param name="e">A DragEventArgs with the drag parameters</param>
- </member>
- <member name="M:DotSpatial.Controls.ILegendHandler.Legend_MouseClick(System.Object,System.Windows.Forms.MouseEventArgs)">
- <summary>
- Occurs when the control is clicked by the mouse.
- </summary>
- <param name="sender">An instance of the calling object</param>
- <param name="e">A MouseEventArgs with any parameters</param>
- </member>
- <member name="M:DotSpatial.Controls.ILegendHandler.Legend_MouseDoubleClick(System.Object,System.Windows.Forms.MouseEventArgs)">
- <summary>
- Occurs when the control is double clicked by the mouse.
- </summary>
- <param name="sender">An instance of the calling object</param>
- <param name="e">A MouseEventArgs with any parameters</param>
- </member>
- <member name="M:DotSpatial.Controls.ILegendHandler.Legend_MouseDown(System.Object,System.Windows.Forms.MouseEventArgs)">
- <summary>
- Occurs when the mouse pointer is over the control and a mouse button is pressed.
- </summary>
- <param name="sender">An instance of the calling object</param>
- <param name="e">A MouseEventArgs with any parameters</param>
- </member>
- <member name="M:DotSpatial.Controls.ILegendHandler.Legend_MouseMove(System.Object,System.Windows.Forms.MouseEventArgs)">
- <summary>
- Occurs when the mouse pointer is moved over the control.
- </summary>
- <param name="sender">An instance of the calling object</param>
- <param name="e">A MouseEventArgs with any parameters</param>
- </member>
- <member name="M:DotSpatial.Controls.ILegendHandler.Legend_MouseUp(System.Object,System.Windows.Forms.MouseEventArgs)">
- <summary>
- Occurs when the mouse pointer is over the control and a mouse button is released.
- </summary>
- <param name="sender">An instance of the calling object</param>
- <param name="e">A MouseEventArgs with any parameters</param>
- </member>
- <member name="M:DotSpatial.Controls.ILegendHandler.Legend_Paint(System.Object,System.Windows.Forms.PaintEventArgs)">
- <summary>
- Occurs when the control is redrawn.
- </summary>
- <param name="sender">An instance of the calling object</param>
- <param name="e">A PaintEventArgs with any parameters</param>
- </member>
- <member name="M:DotSpatial.Controls.ILegendHandler.LegendItemAdded(System.Object,System.EventHandler)">
- <summary>
- Occurs when one or more legend items is added to the list of LegendItems
- </summary>
- <param name="sender">An instance of the calling object</param>
- <param name="e">A PaintEventArgs with any parameters</param>
- </member>
- <member name="M:DotSpatial.Controls.ILegendHandler.LegendItemsCleared(System.Object,System.EventHandler)">
- <summary>
- Occurs when all the legend items are cleared.
- </summary>
- <param name="sender">An instance of the calling object</param>
- <param name="e">A PaintEventArgs with any parameters</param>
- </member>
- <member name="M:DotSpatial.Controls.ILegendHandler.LegendItemRemoved(System.Object,System.EventHandler)">
- <summary>
- Occurs when one of the legend items in the list of LegendItems is removed
- </summary>
- <param name="sender">An instance of the calling object</param>
- <param name="e">A PaintEventArgs with any parameters</param>
- </member>
- <member name="M:DotSpatial.Controls.ILegendHandler.LegendItemSelected(System.Object,System.EventHandler)">
- <summary>
- Occurs when one of the legend items in the list of LegendItems is selected
- </summary>
- <param name="sender">An instance of the calling object</param>
- <param name="e">A PaintEventArgs with any parameters</param>
- </member>
- <member name="T:DotSpatial.Controls.Legend">
- <summary>
- Legend
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Legend.#ctor">
- <summary>
- Creates a new instance of Legend
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Legend.AddMapFrame(DotSpatial.Symbology.IFrame)">
- <summary>
- Adds a map frame as a root node, and links an event handler to update
- when the mapframe triggers an ItemChanged event.
- </summary>
- <param name="mapFrame"></param>
- </member>
- <member name="M:DotSpatial.Controls.Legend.RemoveMapFrame(DotSpatial.Symbology.IFrame,System.Boolean)">
- <summary>
- Removes the specified map frame if it is a root node.
- </summary>
- <param name="mapFrame"></param>
- <param name="preventRefresh">Boolean, if true, removing the map frame will not automatically force a refresh of the legend.</param>
- </member>
- <member name="M:DotSpatial.Controls.Legend.RefreshNodes">
- <summary>
- Given the current list of Maps or 3DMaps, it
- rebuilds the treeview nodes
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Legend.ClearSelection">
- <summary>
- Un-selectes any selected items in the legend
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Legend.OnIncludeMapFrame(DotSpatial.Symbology.IFrame)">
- <summary>
- Occurs when linking the map frame
- </summary>
- <param name="mapFrame"></param>
- </member>
- <member name="M:DotSpatial.Controls.Legend.OnExcludeMapFrame(DotSpatial.Symbology.IFrame)">
- <summary>
- Occurs when we need to no longer listen to the map frame events
- </summary>
- <param name="mapFrame"></param>
- </member>
- <member name="M:DotSpatial.Controls.Legend.OnMouseDoubleClick(System.Windows.Forms.MouseEventArgs)">
- <summary>
-
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.Legend.OnInitialize(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Extends initialize to draw "non-selected" elements.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.Legend.OnDraw(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Overrides the drawing method to account for drawing lines
- when an item is being dragged to a new position.
- </summary>
- <param name="e">A PaintEventArgs</param>
- </member>
- <member name="M:DotSpatial.Controls.Legend.OnHorizontalScroll(System.Object,System.Windows.Forms.ScrollEventArgs)">
- <summary>
- Also hides the edit box so that it doesn't seem displaced from the item
- </summary>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.Legend.OnVerticalScroll(System.Object,System.Windows.Forms.ScrollEventArgs)">
- <summary>
- Also hides the edit box so that it doesn't seme displaced from the item
- </summary>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.Legend.OnMouseDown(System.Windows.Forms.MouseEventArgs)">
- <summary>
- Handles the case where the mouse down occurs.
- </summary>
- <param name="e">A MouseEventArgs</param>
- </member>
- <member name="M:DotSpatial.Controls.Legend.OnMouseUp(System.Windows.Forms.MouseEventArgs)">
- <summary>
- Checks the Mouse Up event to see if it occurs inside a legend item.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.Legend.OnItemMouseUp(DotSpatial.Controls.ItemMouseEventArgs)">
- <summary>
- Checks for checkbox changes and fires the ItemMouseUp event.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.Legend.OnMouseMove(System.Windows.Forms.MouseEventArgs)">
- <summary>
- Performs the default handling for mouse movememnt, and decides
- whether or not to fire an ItemMouseMove event.
- </summary>
- <param name="e">A MouseEventArgs</param>
- </member>
- <member name="M:DotSpatial.Controls.Legend.OnItemMouseDown(DotSpatial.Controls.ItemMouseEventArgs)">
- <summary>
- The coordinates are in legend coordinates, but a LegendBox is provided to define the
- coordinates of the specified object.
- </summary>
- <param name="e">An ItemMouseEventArgs</param>
- </member>
- <member name="M:DotSpatial.Controls.Legend.OnItemMouseMove(DotSpatial.Controls.ItemMouseEventArgs)">
- <summary>
- Fires the ItemMouseMove Event, which handles the mouse moving over one of the legend items.
- </summary>
- <param name="e">An ItemMouseEventArgs</param>
- </member>
- <member name="M:DotSpatial.Controls.Legend.OnOrderChanged">
- <summary>
- Fires the OrderChanged Event
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Legend.AddMenuItem(System.Windows.Forms.Menu.MenuItemCollection,DotSpatial.Symbology.SymbologyMenuItem)">
- <summary>
- Recursive add method to handle nesting of menu items.
- </summary>
- <param name="parent"></param>
- <param name="mi"></param>
- </member>
- <member name="M:DotSpatial.Controls.Legend.MapFrameItemChanged(System.Object,System.EventArgs)">
- <summary>
- This isn't the best way to catch this. only items in view should
- trigger a refresh.
- </summary>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="E:DotSpatial.Controls.Legend.OrderChanged">
- <summary>
- Occurs when the drag method is used to alter the order of layers or
- groups in the legend.
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.Legend.ItemMouseDown">
- <summary>
- Occurs when a mousedown is initiated within an existing legend item
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.Legend.ExpandBoxMouseDown">
- <summary>
- Occurs when a mouse down is initiated within an expand box.
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.Legend.CheckBoxMouseUp">
- <summary>
- Occurs when a mouse up is initiated within a checkbox.
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.Legend.ItemMouseUp">
- <summary>
- Occurs when a mouse up occurs insize of a specific item.
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.Legend.ItemMouseMove">
- <summary>
- Occurs when the mouse is moving over an item.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Legend.SharedEventHandlers">
- <summary>
- Gets or sets the SharedEventHandler that is used for working with shared layer events.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Legend.Indentation">
- <summary>
- Gets or sets an integer representing how far child nodes are indented when compared to the parent nodes.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Legend.ItemHeight">
- <summary>
- This calculates a height for each item based on the height of the font.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Legend.SelectionFontColor">
- <summary>
- Gets or sets the selection font color
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Legend.SelectionHighlight">
- <summary>
- Specifies the principal color that a selected text box is highlighted with.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Legend.RootNodes">
- <summary>
- Gets or sets the list of map frames being displayed by this legend.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Legend.ProgressHandler">
- <summary>
- Gets or sets the progress handler for any progress messages like re-drawing images for rasters
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Legend.BottomBox">
- <summary>
- Retrieves the bottom box in the legend
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.ItemMouseEventArgs">
- <summary>
- ItemMouseEventArgs
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.ItemMouseEventArgs.#ctor(System.Windows.Forms.MouseButtons,System.Int32,System.Int32,System.Int32,System.Int32,DotSpatial.Controls.LegendBox)">
- <summary>
- Creates a new instance of an ItemMouseEventArgs
- </summary>
- <param name="inButton">The Mouse Buttons</param>
- <param name="inClicks">The number of clicks</param>
- <param name="inX">The X coordinate</param>
- <param name="inY">The Y coordinate</param>
- <param name="inDelta">The delta of the mouse wheel</param>
- <param name="inItemBox">A LegendBox for comparision</param>
- </member>
- <member name="M:DotSpatial.Controls.ItemMouseEventArgs.#ctor(System.Windows.Forms.MouseEventArgs,DotSpatial.Controls.LegendBox)">
- <summary>
- Creates a new instance of ItemMouseEventArgs from an existing MouseEventArgs.
- </summary>
- <param name="args">The existing arguments</param>
- <param name="inItemBox">A LegendBox for comparison</param>
- </member>
- <member name="P:DotSpatial.Controls.ItemMouseEventArgs.ItemBox">
- <summary>
- Gets the item that received the mouse down, plus the various rectangular extents encoded in the various boxes.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.LegendBox">
- <summary>
- A Legend Box encapsulates the basic drawing information for an item.
- This will not capture information about sub-items.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LegendBox.Bounds">
- <summary>
- Gets or sets the bounds for this LegendBox
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LegendBox.Item">
- <summary>
- Gets or sets the actual item that this bounds is associated with
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LegendBox.CheckBox">
- <summary>
- If this item is in checkbox mode, then this is the physical location of the checkbox
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LegendBox.ExpandBox">
- <summary>
- IF this item is a groupable item, this is the region for the expanding box for the item
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LegendBox.Textbox">
- <summary>
- Gets or sets the rectangle that corresponds with text.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LegendBox.SymbolBox">
- <summary>
- gets or sets the symbol box
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.LegendBox.Indent">
- <summary>
- Gets or sets the integer number of indentations. This should be used
- in coordination with whatever the indentation amount is for the specific legend.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.ListBoxDialog">
- <summary>
- DropDownDialog
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.ListBoxDialog.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.ListBoxDialog.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.ListBoxDialog.#ctor">
- <summary>
- Creates a new instance of DropDownDialog
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.ListBoxDialog.Clear">
- <summary>
- Clears the items from the dialog box
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.ListBoxDialog.Add(System.Object[])">
- <summary>
- Adds the array of objects to the dialog box
- </summary>
- <param name="items">The items to add</param>
- </member>
- <member name="M:DotSpatial.Controls.ListBoxDialog.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="P:DotSpatial.Controls.ListBoxDialog.SelectedItem">
- <summary>
- Gets the currently selected item in this list dialog box
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.ChunkEventArgs">
- <summary>
- ChunkEventArgs
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.ChunkEventArgs.#ctor(System.Int32,System.Int32)">
- <summary>
- Creates a new instance of ChunkEventArgs
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.ChunkEventArgs.CurrentChunk">
- <summary>
- Gets the current chunk for this event
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.ChunkEventArgs.NumChunks">
- <summary>
- Gets the number of chunks
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.ActionMode">
- <summary>
- Describe different behaviors that map functions can have when working with
- respect to other map-functions.
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.ActionMode.Prompt">
- <summary>
- Prompt the user to decide if Layers should be reprojected
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.ActionMode.Always">
- <summary>
- Always reproject layers to match the MapFrame projection
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.ActionMode.Never">
- <summary>
- Never reproject layers to match the MapFrame projection
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.ActionMode.PromptOnce">
- <summary>
- Prompt once and accept that answer for all future layers added to the map frame.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.MapFrameExt">
- <summary>
- Extension methods for accessing the layers (including nested layers) and groups (including nested groups) of the
- map frame
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFrameExt.GetAllLayers(DotSpatial.Controls.IMapFrame)">
- <summary>
- Gets all layers of the map frame including layers which are nested
- within groups. The group objects themselves are not included in this list,
- but all FeatureLayers, RasterLayers, ImageLayers and other layers are included.
- </summary>
- <returns>The list of the layers</returns>
- </member>
- <member name="M:DotSpatial.Controls.MapFrameExt.GetAllFeatureLayers(DotSpatial.Controls.IMapFrame)">
- <summary>
- Gets all feature layers of the map frame including feature layers which are nested
- within groups. The group objects themselves are not included in this list.
- </summary>
- <returns>The list of the feature layers</returns>
- </member>
- <member name="M:DotSpatial.Controls.MapFrameExt.GetAllPointLayers(DotSpatial.Controls.IMapFrame)">
- <summary>
- Gets all point layers of the map frame including point layers which are nested
- within groups. The group objects themselves are not included in this list.
- </summary>
- <returns>The list of the point layers</returns>
- </member>
- <member name="M:DotSpatial.Controls.MapFrameExt.GetAllLineLayers(DotSpatial.Controls.IMapFrame)">
- <summary>
- Gets all line layers of the map frame including line layers which are nested
- within groups. The group objects themselves are not included in this list.
- </summary>
- <returns>The list of the line layers</returns>
- </member>
- <member name="M:DotSpatial.Controls.MapFrameExt.GetAllPolygonLayers(DotSpatial.Controls.IMapFrame)">
- <summary>
- Gets all polygon layers of the map frame including polygon layers which are nested
- within groups. The group objects themselves are not included in this list.
- </summary>
- <returns>The list of the polygon layers</returns>
- </member>
- <member name="M:DotSpatial.Controls.MapFrameExt.GetAllRasterLayers(DotSpatial.Controls.IMapFrame)">
- <summary>
- Gets all raster layers of the map frame including raster layers which are nested
- within groups. The group objects themselves are not included in this list.
- </summary>
- <returns>The list of the raster layers</returns>
- </member>
- <member name="M:DotSpatial.Controls.MapFrameExt.GetAllImageLayers(DotSpatial.Controls.IMapFrame)">
- <summary>
- Gets all image layers of the map frame including image layers which are nested
- within groups. The group objects themselves are not included in this list.
- </summary>
- <returns>The list of the image layers</returns>
- </member>
- <member name="M:DotSpatial.Controls.MapFrameExt.GetAllTypeLayers``1(DotSpatial.Controls.IMapFrame)">
- <summary>
- Gets all the layers of the given type.
- </summary>
- <typeparam name="T">Type of the layers that should be included.</typeparam>
- <param name="mapFrame">mapFrame that contains the layers.</param>
- <returns>The list of the layers with the given type.</returns>
- </member>
- <member name="M:DotSpatial.Controls.MapFrameExt.GetNestedLayers``1(DotSpatial.Controls.IMapGroup,System.Collections.Generic.List{``0})">
- <summary>
- Recursively adds all the layers of the given type that are found in group to layerList.
- </summary>
- <typeparam name="T">Type of the layers that should be included.</typeparam>
- <param name="group">Group that contains the layers.</param>
- <param name="layerList">The list the layers should be added to.</param>
- </member>
- <member name="M:DotSpatial.Controls.MapFrameExt.GetAllGroups(DotSpatial.Controls.IMapFrame)">
- <summary>
- Gets all map groups in the map including the nested groups.
- </summary>
- <returns>the list of the groups</returns>
- </member>
- <member name="M:DotSpatial.Controls.MapFrameExt.GetNestedGroups(DotSpatial.Controls.IMapGroup,System.Collections.Generic.List{DotSpatial.Controls.IMapGroup})">
- <summary>
- Recursively adds all the groups to groupList.
- </summary>
- <param name="grp">Group to search through.</param>
- <param name="groupList">The list the groups should be added to.</param>
- </member>
- <member name="T:DotSpatial.Controls.MapFrameProjectionHelper">
- <summary>
- This class contains methods for re-projecting
- layers in the map frame
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFrameProjectionHelper.ReprojectMapFrame(DotSpatial.Controls.IMapFrame,System.String)">
- <summary>
- Reprojects all layers in the map frame so that they use the new
- projection Esri string
- </summary>
- <param name="mapFrame">The map frame that contains all layers that should be reprojected</param>
- <param name="newProjEsriString">The Esri WKT string of the new projection</param>
- </member>
- <member name="M:DotSpatial.Controls.MapFrameProjectionHelper.ReprojectMapFrame(DotSpatial.Controls.IMapFrame,DotSpatial.Projections.ProjectionInfo,System.Action{DotSpatial.Symbology.ILayer})">
- <summary>
- Reprojects all layers in the map frame so that they use new projection
- </summary>
- <param name="mapFrame">The map frame that contains all layers that should be reprojected</param>
- <param name="newProjection">New projection</param>
- <param name="onCantReproject">Callback when layer can't be reprojected. Maybe null.</param>
- </member>
- <member name="T:DotSpatial.Controls.MapFunctionKeyNavigation">
- <summary>
- A MapFunction that can zoom the map out based on mouse clicks.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.MapFunction">
- <summary>
- Common implementation of IMapFunction interface.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.IMapFunction">
- <summary>
- Interface for map functions.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.IMapFunction.Activate">
- <summary>
- Forces activation
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.IMapFunction.Deactivate">
- <summary>
- Forces deactivation.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.IMapFunction.Draw(DotSpatial.Controls.MapDrawArgs)">
- <summary>
- This is the method that is called by the drawPanel. The graphics coordinates are
- in pixels relative to the image being edited.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.IMapFunction.DoMouseDoubleClick(DotSpatial.Controls.GeoMouseArgs)">
- <summary>
- Forces this tool to execute whatever behavior should occur during a double click even on the panel
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.IMapFunction.DoMouseDown(DotSpatial.Controls.GeoMouseArgs)">
- <summary>
- Instructs this tool to perform any actions that should occur on the MouseDown event
- </summary>
- <param name="e">A MouseEventArgs relative to the drawing panel</param>
- </member>
- <member name="M:DotSpatial.Controls.IMapFunction.DoMouseUp(DotSpatial.Controls.GeoMouseArgs)">
- <summary>
- Instructs this tool to perform any actions that should occur on the MouseUp event
- </summary>
- <param name="e">A MouseEventArgs relative to the drawing panel</param>
- </member>
- <member name="M:DotSpatial.Controls.IMapFunction.DoMouseMove(DotSpatial.Controls.GeoMouseArgs)">
- <summary>
- Instructs this tool to perform any actions that should occur on the MouseMove event
- </summary>
- <param name="e">A MouseEventArgs relative to the drawing panel</param>
- </member>
- <member name="M:DotSpatial.Controls.IMapFunction.DoMouseWheel(DotSpatial.Controls.GeoMouseArgs)">
- <summary>
- Instructs this tool to perform any actions that should occur on the MouseWheel event
- </summary>
- <param name="e">A MouseEventArgs relative to the drawing panel</param>
- </member>
- <member name="M:DotSpatial.Controls.IMapFunction.Unload">
- <summary>
- Here, the entire plugin is unloading, so if there are any residual states
- that are not taken care of, this should remove them.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.IMapFunction.DoKeyDown(System.Windows.Forms.KeyEventArgs)">
- <summary>
- When a key is pressed while the map has the focus, this occurs.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.IMapFunction.DoKeyUp(System.Windows.Forms.KeyEventArgs)">
- <summary>
- When a key returns to the up position, this occurs.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.IMapFunction.Init(DotSpatial.Controls.IMap)">
- <summary>
- Organizes the map that this tool will work with.
- </summary>
- <param name="inMap"></param>
- </member>
- <member name="E:DotSpatial.Controls.IMapFunction.FunctionActivated">
- <summary>
- Occurs when the function is activated
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.IMapFunction.FunctionDeactivated">
- <summary>
- Occurs when the function is deactivated.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IMapFunction.CursorBitmap">
- <summary>
- This controls the cursor that this tool uses, unless the action has been cancelled by attempting
- to use the tool outside the bounds of the image.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IMapFunction.PreventBackBuffer">
- <summary>
- If this is false, then the typical contents from the map's back buffer are drawn first,
- followed by the contents of this tool.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IMapFunction.Enabled">
- <summary>
- Gets or sets a boolean that is true if this tool should be active. If it is false,
- then this tool will not be sent mouse movement information.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IMapFunction.YieldStyle">
- <summary>
- Different Pathways that allow functions to deactivate if another function that uses
- the specified UI domain activates. This allows a scrolling zoom function to stay
- active while changing between pan and select functions which use the left mouse
- button. The enumeration is flagged, and so can support multiple options.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IMapFunction.ButtonImage">
- <summary>
- Describes a button image
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IMapFunction.Map">
- <summary>
- Gets or sets the basic map that this tool interacts with. This can alternately be set using
- the Init method.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IMapFunction.Name">
- <summary>
- Gets or sets the name that attempts to identify this plugin uniquely. If the
- name is already in the tools list, this will modify the name set here by
- appending a number.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFunction.#ctor">
- <summary>
- Creates a new instance of the map function.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFunction.#ctor(DotSpatial.Controls.IMap)">
- <summary>
- Combines the constructor with an automatic call to the init method. If you use this constructor
- overload, then it is not necessary to also call the init method. The init method is supported
- because constructors cannot be specified through an interface.
- </summary>
- <param name="inMap">Any valid IMap interface</param>
- </member>
- <member name="M:DotSpatial.Controls.MapFunction.DoKeyUp(System.Windows.Forms.KeyEventArgs)">
- <summary>
- Instructs this tool to
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapFunction.DoMouseDoubleClick(DotSpatial.Controls.GeoMouseArgs)">
- <summary>
- Forces this tool to execute whatever behavior should occur during a double click even on the panel
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapFunction.DoMouseDown(DotSpatial.Controls.GeoMouseArgs)">
- <summary>
- Instructs this tool to perform any actions that should occur on the MouseDown event
- </summary>
- <param name="e">A MouseEventArgs relative to the drawing panel</param>
- </member>
- <member name="M:DotSpatial.Controls.MapFunction.DoMouseMove(DotSpatial.Controls.GeoMouseArgs)">
- <summary>
- Instructs this tool to perform any actions that should occur on the MouseMove event
- </summary>
- <param name="e">A MouseEventArgs relative to the drawing panel</param>
- </member>
- <member name="M:DotSpatial.Controls.MapFunction.DoMouseUp(DotSpatial.Controls.GeoMouseArgs)">
- <summary>
- Instructs this tool to perform any actions that should occur on the MouseUp event
- </summary>
- <param name="e">A MouseEventArgs relative to the drawing panel</param>
- </member>
- <member name="M:DotSpatial.Controls.MapFunction.DoMouseWheel(DotSpatial.Controls.GeoMouseArgs)">
- <summary>
- Instructs this tool to perform any actions that should occur on the MouseWheel event
- </summary>
- <param name="e">A MouseEventArgs relative to the drawing panel</param>
- </member>
- <member name="M:DotSpatial.Controls.MapFunction.DoKeyDown(System.Windows.Forms.KeyEventArgs)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Controls.MapFunction.Draw(DotSpatial.Controls.MapDrawArgs)">
- <summary>
- This is the method that is called by the drawPanel. The graphics coordinates are
- in pixels relative to the image being edited.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFunction.Init(DotSpatial.Controls.IMap)">
- <summary>
- Organizes the map that this tool will work with.
- </summary>
- <param name="inMap"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapFunction.Cancel">
- <summary>
- Cancels whatever drawing was being done by the tool and resets the cursor to an arrow.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFunction.GetAvailableName(System.String)">
- <summary>
- Gets an available name given the base name.
- </summary>
- <param name="baseName"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.MapFunction.OnDraw(DotSpatial.Controls.MapDrawArgs)">
- <summary>
- This allows sub-classes to customize the drawing that occurs. All drawing is done
- in the image coordinate space, where 0, 0 is the upper left corner of the image.
- </summary>
- <param name="e">A PaintEventArgs where the graphics object is already in image coordinates</param>
- </member>
- <member name="M:DotSpatial.Controls.MapFunction.OnKeyUp(System.Windows.Forms.KeyEventArgs)">
- <summary>
- Allows for inheriting tools to control KeyUp.
- </summary>
- <param name="e">A KeyEventArgs parameter</param>
- </member>
- <member name="M:DotSpatial.Controls.MapFunction.OnMouseDoubleClick(DotSpatial.Controls.GeoMouseArgs)">
- <summary>
- Allows for inheriting tools to control OnMouseDoubleClick.
- </summary>
- <param name="e">A GeoMouseArgs parameter</param>
- </member>
- <member name="M:DotSpatial.Controls.MapFunction.OnMouseDown(DotSpatial.Controls.GeoMouseArgs)">
- <summary>
- Allows for inheriting tools to control OnMouseDown.
- </summary>
- <param name="e">A GeoMouseArgs parameter</param>
- </member>
- <member name="M:DotSpatial.Controls.MapFunction.OnMouseMove(DotSpatial.Controls.GeoMouseArgs)">
- <summary>
- Allows for inheriting tools to control OnMouseMove.
- </summary>
- <param name="e">A GeoMouseArgs parameter</param>
- </member>
- <member name="M:DotSpatial.Controls.MapFunction.OnMouseUp(DotSpatial.Controls.GeoMouseArgs)">
- <summary>
- Allows for inheriting tools to control OnMouseUp.
- </summary>
- <param name="e">A GeoMouseArgs parameter</param>
- </member>
- <member name="M:DotSpatial.Controls.MapFunction.OnMouseWheel(DotSpatial.Controls.GeoMouseArgs)">
- <summary>
- Allows for inheriting tools to control OnMouseWheel.
- </summary>
- <param name="e">A GeoMouseArgs parameter</param>
- </member>
- <member name="M:DotSpatial.Controls.MapFunction.Activate">
- <summary>
- Forces activation
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFunction.Deactivate">
- <summary>
- Deactivate is like when someone clicks on a different button. It may not
- involve the whole plugin being unloaded.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFunction.Unload">
- <summary>
- Here, the entire plugin is unloading, so if there are any residual states
- that are not taken care of, this should remove them.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFunction.OnActivate">
- <summary>
- This is fired when enabled is set to true, and firing this will set enabled to true
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFunction.OnDeactivate">
- <summary>
- this is fired when enabled is set to false, and firing this will set enabled to false.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFunction.OnKeyDown(System.Windows.Forms.KeyEventArgs)">
- <summary>
- Occurs when a key is pressed
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapFunction.OnUnload">
- <summary>
- This occurs when the entire plugin is being unloaded.
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.MapFunction.FunctionActivated">
- <summary>
- Occurs when the function is activated
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.MapFunction.FunctionDeactivated">
- <summary>
- Occurs when the function is deactivated.
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.MapFunction.MouseDown">
- <summary>
- Occurs during a mouse down event
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.MapFunction.MouseMove">
- <summary>
- Occurs during a mouse move event
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.MapFunction.MouseUp">
- <summary>
- Occurs during a mouse up event
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.MapFunction.MouseWheel">
- <summary>
- Occurs during a mousewheel event
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.MapFunction.MouseDoubleClick">
- <summary>
- Occurs during a double click event
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.MapFunction.KeyUp">
- <summary>
- Occurs during a key up event
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapFunction.ButtonImage">
- <summary>
- Describes a button image
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapFunction.CursorBitmap">
- <summary>
- This controls the cursor that this tool uses, unless the action has been cancelled by attempting
- to use the tool outside the bounds of the image.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapFunction.Enabled">
- <summary>
- Gets or sets a boolean that is true if this tool should be handed drawing instructions
- from the screen.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapFunction.Map">
- <summary>
- Gets or sets the basic map that this tool interacts with. This can alternately be set using
- the Init method.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapFunction.Name">
- <summary>
- Gets or sets the name that attempts to identify this plugin uniquely. If the
- name is already in the tools list, this will modify the name stored here.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapFunction.PreventBackBuffer">
- <summary>
- If this is false, then the typical contents from the map's back buffer are drawn first,
- followed by the contents of this tool.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapFunction.YieldStyle">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Controls.MapFunctionKeyNavigation.#ctor(DotSpatial.Controls.IMap)">
- <summary>
- Creates a new instance of SelectTool
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFunctionKeyNavigation.OnKeyUp(System.Windows.Forms.KeyEventArgs)">
- <summary>
- Handles the Key Up situation
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapFunctionKeyNavigation.OnKeyDown(System.Windows.Forms.KeyEventArgs)">
- <summary>
- Handles the Key Down situation
- </summary>
- <param name="e"></param>
- </member>
- <member name="T:DotSpatial.Controls.MapLayerEnumerator">
- <summary>
- Transforms an IMapLayer enumerator into an ILayer Enumerator
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapLayerEnumerator.#ctor(System.Collections.Generic.IEnumerator{DotSpatial.Controls.IMapLayer})">
- <summary>
- Creates a new instance of the MapLayerEnumerator
- </summary>
- <param name="subEnumerator"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapLayerEnumerator.Dispose">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Controls.MapLayerEnumerator.MoveNext">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Controls.MapLayerEnumerator.Reset">
- <inheritdoc />
- </member>
- <member name="P:DotSpatial.Controls.MapLayerEnumerator.Current">
- <inheritdoc />
- </member>
- <member name="T:DotSpatial.Controls.MessageStrings">
- <summary>
- A strongly-typed resource class, for looking up localized strings, etc.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.ResourceManager">
- <summary>
- Returns the cached ResourceManager instance used by this class.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.Culture">
- <summary>
- Overrides the current thread's CurrentUICulture property for all
- resource lookups using this strongly typed resource class.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.Add_Layer">
- <summary>
- Looks up a localized string similar to Add Layer....
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.AppManager_Home">
- <summary>
- Looks up a localized string similar to Home.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.ArchiveFile">
- <summary>
- Looks up a localized string similar to Archive File.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.ArgumentCannotBeNegative_S">
- <summary>
- Looks up a localized string similar to The argument %S cannot be negative..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.ArgumentCouldNotBeCast_S1_S2">
- <summary>
- Looks up a localized string similar to The argument %S1 could not be successfully cast into %S2..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.ArgumentNull_S">
- <summary>
- Looks up a localized string similar to The argument %S was null. Try testing for the null case before calling this method..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.ArgumentOfWrongType_S1_S2">
- <summary>
- Looks up a localized string similar to The argument %S1 was incorrect for %S2..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.ArgumentOutOfRangeException_S">
- <summary>
- Looks up a localized string similar to The argument %S was outside the range of accepted values..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.bgdDataTypeError">
- <summary>
- Looks up a localized string similar to The file type was supposedly bgd, but there was a problem with reading the data type..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.BinarySupportsOneBand">
- <summary>
- Looks up a localized string similar to Binary rasters only support one band, which is the raster itself..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.ByteArrayTooSmall">
- <summary>
- Looks up a localized string similar to The specified argument byteArray was too small to contain the requested information.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.CalculatingStatistics">
- <summary>
- Looks up a localized string similar to Calculating Statistics.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.CannotCopyToSelf_S">
- <summary>
- Looks up a localized string similar to The fileName %S cannot be copied to itself..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.ClearAllDataAndStartANewMap">
- <summary>
- Looks up a localized string similar to Start a new Project?.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.ColorBreakCaptionHelp">
- <summary>
- Looks up a localized string similar to Enter the text you want to display in the legend..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.ColorBreakColorHelp">
- <summary>
- Looks up a localized string similar to Left click after selecting to edit, or right click to assign a color range..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.ColorBreakNotNumeric">
- <summary>
- Looks up a localized string similar to Raster values should be numeric and be drawn with a range like [low] - [high].
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.ColorBreakValue">
- <summary>
- Looks up a localized string similar to The value or range of values shown as [low] - [high].
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.Confirm">
- <summary>
- Looks up a localized string similar to Confirm.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.CoordinateMismatchException">
- <summary>
- Looks up a localized string similar to The number of ordinates did not match between the dimensions, so the hyperdistance cannot be accurately calculated..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.CopyingValues">
- <summary>
- Looks up a localized string similar to Copying Values.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.CopyingValues_S1_S2">
- <summary>
- Looks up a localized string similar to Copying values from %S1 to %S2.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.CopyingValuesFrom_S">
- <summary>
- Looks up a localized string similar to Copying Values from %S.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.CopyingValuesFrom_S1_To_S2">
- <summary>
- Looks up a localized string similar to Copying Values from %S1 to %S2.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.CouldNotExecuteQuery">
- <summary>
- Looks up a localized string similar to Could not execute the query..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.CouldNotFindReplace">
- <summary>
- Looks up a localized string similar to Could not find or replace items..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.CouldNotOpenTheSpecifiedMapFile">
- <summary>
- Looks up a localized string similar to Could not open the specified map file: {0}.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.CreatingShadedRelief">
- <summary>
- Looks up a localized string similar to Creating Shaded Relief.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.CreatingTexture">
- <summary>
- Looks up a localized string similar to Creating Texture.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.CurrentElementNotSpecified">
- <summary>
- Looks up a localized string similar to The current element was not defined. Before attempting to read the element, first assign the value of the current XML Element to read..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.CustomOnly">
- <summary>
- Looks up a localized string similar to In order to specify a custom filter expression, the custom mode must be selected first..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.DataExtensions">
- <summary>
- Looks up a localized string similar to Data Extensions.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.DataTypeIncorrect_S">
- <summary>
- Looks up a localized string similar to The parameter %S was not the correct datatype..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.DecimalCount">
- <summary>
- Looks up a localized string similar to The Number of digits to show after the decimal..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.DecimalCountInvalid">
- <summary>
- Looks up a localized string similar to This should be an integer from 0 to 15..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.DefaultToolproviderSettingsDialogText">
- <summary>
- Looks up a localized string similar to There are no setting for the default Tool Provider. It scans the same folders the ToolManager scans for Tool Providers.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.DefaultToolproviderSettingsDialogTitle">
- <summary>
- Looks up a localized string similar to Default Tool Provider Settings.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.Deselect">
- <summary>
- Looks up a localized string similar to Deselect All.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.DiscardChanges">
- <summary>
- Looks up a localized string similar to Discard Changes?.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.DoubleError">
- <summary>
- Looks up a localized string similar to The value entered could not be correctly parsed into a valid double precision floating point value..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.DoubleHelp">
- <summary>
- Looks up a localized string similar to Enter a double precision floating point value..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.EndOfFile">
- <summary>
- Looks up a localized string similar to Cannot read past the end of the file..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.EnterFindString">
- <summary>
- Looks up a localized string similar to Enter Find String.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.Error">
- <summary>
- Looks up a localized string similar to Error.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.ErrorWhileWhileActivating">
- <summary>
- Looks up a localized string similar to Error while activating {0}..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.Expression">
- <summary>
- Looks up a localized string similar to Expression.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.Extensions">
- <summary>
- Looks up a localized string similar to Extensions.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.FactGreaterThanZero">
- <summary>
- Looks up a localized string similar to Factorial value should be grater than 0.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.FailedToReadAPortionOfTheSpecifiedMapFile">
- <summary>
- Looks up a localized string similar to Failed to read a portion of the specified map file: {0}.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.FailedToReadTheSpecifiedMapFile">
- <summary>
- Looks up a localized string similar to Failed to read the specified map file: {0}.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.FailedToWriteTheSpecifiedMapFile">
- <summary>
- Looks up a localized string similar to Failed to write the specified map file: {0}.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.FeaturesAll">
- <summary>
- Looks up a localized string similar to All Features.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.FeaturesetInvalid">
- <summary>
- Looks up a localized string similar to The feature set is invalid..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.FeaturesetMissing">
- <summary>
- Looks up a localized string similar to No feature set is specified..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.FeaturesetValid">
- <summary>
- Looks up a localized string similar to The feature set is valid..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.FeaturesExtent">
- <summary>
- Looks up a localized string similar to All Features in View Extent.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.FeaturesSelected">
- <summary>
- Looks up a localized string similar to Selected features.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.FeatureTypeCannotChange">
- <summary>
- Looks up a localized string similar to The feature type cannot be changed here. Try creating a new feature of the appropriate type..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.FeatureTypeException">
- <summary>
- Looks up a localized string similar to The feature set selected was the incorrect type..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.FeatureTypeMismatch">
- <summary>
- Looks up a localized string similar to The FeatureType of the feature you are trying to add does not match the feature type of this featureset..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.FeatureTypeNotLine">
- <summary>
- Looks up a localized string similar to The FeatureType specified was not the line feature type..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.FeatureTypeNotPoint">
- <summary>
- Looks up a localized string similar to The FeatureType specified was not the point feature type. .
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.FeatureTypeNotPolygon">
- <summary>
- Looks up a localized string similar to The FeatureType specified was not the polygon feature type..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.FeaturetypeUnspecified">
- <summary>
- Looks up a localized string similar to The FeatureType was not specified. Please specify a featuretype before attempting to call this method..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.FieldImportFailed">
- <summary>
- Looks up a localized string similar to Could not import column fields..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.FieldNotNumeric">
- <summary>
- Looks up a localized string similar to The specified field is not a numeric field and so the "EqualBreaks" option is not supported..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.File">
- <summary>
- Looks up a localized string similar to File.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.File_Exit">
- <summary>
- Looks up a localized string similar to Exit.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.File_New">
- <summary>
- Looks up a localized string similar to New.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.File_Open">
- <summary>
- Looks up a localized string similar to Open....
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.File_Options">
- <summary>
- Looks up a localized string similar to Options.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.File_Print">
- <summary>
- Looks up a localized string similar to Print Layout....
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.File_Reset_Layout">
- <summary>
- Looks up a localized string similar to Reset Window Layout.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.File_Save">
- <summary>
- Looks up a localized string similar to Save.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.File_SaveAs">
- <summary>
- Looks up a localized string similar to Save As....
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.FileExists_S">
- <summary>
- Looks up a localized string similar to The fileName %S already exists. Do you wish to overwrite it?.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.FileNewToolTip">
- <summary>
- Looks up a localized string similar to Clears the current map. The user is prompted to save any changes to the current map project..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.FileNotFound_S">
- <summary>
- Looks up a localized string similar to The fileName %S was not found..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.FileNotLines_S">
- <summary>
- Looks up a localized string similar to The fileName %S contains a feature type other than lines..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.FileNotPoints_S">
- <summary>
- Looks up a localized string similar to The fileName %S contains a feature type other than points..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.FileOpenToolTip">
- <summary>
- Looks up a localized string similar to Clears the current map and shows an ‘Open’ window that allows the user to navigate to a previously saved map..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.FileSaveAsToolTip">
- <summary>
- Looks up a localized string similar to Allows the user to save the project..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.FileSaveToolTip">
- <summary>
- Looks up a localized string similar to Allows the user to name the file and location where the map is to be saved on their computer..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.FileTooLarge">
- <summary>
- Looks up a localized string similar to The file was too large to fit into memory all at once. Try using a DataSource instead..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.FileTypeNotSupported">
- <summary>
- Looks up a localized string similar to The specified file type is not supported..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.Find">
- <summary>
- Looks up a localized string similar to Find.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.FindToolByName">
- <summary>
- Looks up a localized string similar to Find Tool.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.Home">
- <summary>
- Looks up a localized string similar to Map.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.Identify">
- <summary>
- Looks up a localized string similar to Identify.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.ImplementedInSubclass">
- <summary>
- Looks up a localized string similar to This property or method is overrided in a subclass and should not be used directly..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.IncompatibleDestinationField">
- <summary>
- Looks up a localized string similar to The destination field data type is incompatible (double or string or integer).
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.IndexingErrorIn_S">
- <summary>
- Looks up a localized string similar to There was an error while attempting to index %S.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.Input">
- <summary>
- Looks up a localized string similar to Input.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.InsufficientDimensions_S">
- <summary>
- Looks up a localized string similar to The number of dimensions in %S is insufficient for this calculation..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.InvalidDouble">
- <summary>
- Looks up a localized string similar to The value is invalid, it must be a decimal between %min and %max.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.InvalidInteger">
- <summary>
- Looks up a localized string similar to The value is invalid, it must be an integer between %min and %max.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.InvalidNumberFormat">
- <summary>
- Looks up a localized string similar to The value entered was not understood. Please use either numbers or syntax 'start - end', e.g. '1-5'.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.KeyDuplicateException">
- <summary>
- Looks up a localized string similar to The specified key already exists in the tree..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.KeyMissingException">
- <summary>
- Looks up a localized string similar to The specified key could not be found in the tree..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.KeySizeException">
- <summary>
- Looks up a localized string similar to The size of the key did not match the size of the tree..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.Layers_Group">
- <summary>
- Looks up a localized string similar to Layers.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutCmnuBottom">
- <summary>
- Looks up a localized string similar to Align Bottom.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutCmnuHeight">
- <summary>
- Looks up a localized string similar to Fit to Height.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutCmnuHor">
- <summary>
- Looks up a localized string similar to Align Horizontal.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutCmnuLeft">
- <summary>
- Looks up a localized string similar to Align Left.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutCmnuMargAlign">
- <summary>
- Looks up a localized string similar to Margin Alignment.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutCmnuMarginFit">
- <summary>
- Looks up a localized string similar to Margin Fit.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutCmnuRight">
- <summary>
- Looks up a localized string similar to Align Right.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutCmnuSelectionAlignment">
- <summary>
- Looks up a localized string similar to Selection Alignment.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutCmnuSelectionFit">
- <summary>
- Looks up a localized string similar to Selection Fit.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutCmnuTop">
- <summary>
- Looks up a localized string similar to Align top.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutCmnuVert">
- <summary>
- Looks up a localized string similar to Align Vertical.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutCmnuWidth">
- <summary>
- Looks up a localized string similar to Fit to Width.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutErrorLoad">
- <summary>
- Looks up a localized string similar to Error opening layout file: .
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutErrorSave">
- <summary>
- Looks up a localized string similar to Error saving layout file:.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutFormTitle">
- <summary>
- Looks up a localized string similar to DotSpatial Print Layout.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutInsertMenuStripLegend">
- <summary>
- Looks up a localized string similar to Insert legend.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutInsertMenuStripScaleBar">
- <summary>
- Looks up a localized string similar to Insert scale bar.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutInsertToolStripBitmap">
- <summary>
- Looks up a localized string similar to Insert bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutInsertToolStripMap">
- <summary>
- Looks up a localized string similar to Insert map.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutInsertToolStripNorthArrow">
- <summary>
- Looks up a localized string similar to Insert north arrow.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutInsertToolStripRectangle">
- <summary>
- Looks up a localized string similar to Insert rectangle.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutInsertToolStripText">
- <summary>
- Looks up a localized string similar to Insert text.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutLoadDialogTitle">
- <summary>
- Looks up a localized string similar to Load Print Layout.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutMapToolStripMaxExtent">
- <summary>
- Looks up a localized string similar to Zoom map to full extent of layers.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutMapToolStripPan">
- <summary>
- Looks up a localized string similar to Pan map.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutMapToolStripViewExtent">
- <summary>
- Looks up a localized string similar to Zoom map to extent of data view.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutMapToolStripZoomIn">
- <summary>
- Looks up a localized string similar to Zoom map in.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutMapToolStripZoomOut">
- <summary>
- Looks up a localized string similar to Zoom map out.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutMenuPageSetup">
- <summary>
- Looks up a localized string similar to Page Setup....
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutMenuStripClose">
- <summary>
- Looks up a localized string similar to Close.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutMenuStripDocToolbar">
- <summary>
- Looks up a localized string similar to Document.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutMenuStripEdit">
- <summary>
- Looks up a localized string similar to Edit.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutMenuStripFile">
- <summary>
- Looks up a localized string similar to File.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutMenuStripInsertToolbar">
- <summary>
- Looks up a localized string similar to Insert.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutMenuStripMapToolbar">
- <summary>
- Looks up a localized string similar to Map.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutMenuStripNew">
- <summary>
- Looks up a localized string similar to New.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutMenuStripOpen">
- <summary>
- Looks up a localized string similar to Open....
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutMenuStripPrint">
- <summary>
- Looks up a localized string similar to Print....
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutMenuStripRefresh">
- <summary>
- Looks up a localized string similar to Refresh.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutMenuStripSave">
- <summary>
- Looks up a localized string similar to Save.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutMenuStripSaveAs">
- <summary>
- Looks up a localized string similar to Save as....
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutMenuStripSelect">
- <summary>
- Looks up a localized string similar to Select.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutMenuStripSelectAll">
- <summary>
- Looks up a localized string similar to All.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutMenuStripSelectConvert">
- <summary>
- Looks up a localized string similar to Convert to bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutMenuStripSelectDelete">
- <summary>
- Looks up a localized string similar to Delete.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutMenuStripSelectInvert">
- <summary>
- Looks up a localized string similar to Invert.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutMenuStripSelectMoveDown">
- <summary>
- Looks up a localized string similar to Move down.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutMenuStripSelectMoveUp">
- <summary>
- Looks up a localized string similar to Move up.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutMenuStripSelectNone">
- <summary>
- Looks up a localized string similar to None.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutMenuStripSelectPrinter">
- <summary>
- Looks up a localized string similar to Choose printer....
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutMenuStripShowMargin">
- <summary>
- Looks up a localized string similar to Show Margin.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutMenuStripToolbars">
- <summary>
- Looks up a localized string similar to Toolbars.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutMenuStripView">
- <summary>
- Looks up a localized string similar to View.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutMenuStripZoomFull">
- <summary>
- Looks up a localized string similar to Fit to screen.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutMenuStripZoomIn">
- <summary>
- Looks up a localized string similar to Zoom in.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutMenuStripZoomOut">
- <summary>
- Looks up a localized string similar to Zoom out.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutMenuStripZoomToolbar">
- <summary>
- Looks up a localized string similar to Zoom.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutPageSetupTitle">
- <summary>
- Looks up a localized string similar to Page Setup....
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutSaveDialogTitle">
- <summary>
- Looks up a localized string similar to Save Print Layout As.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutSaveFirst">
- <summary>
- Looks up a localized string similar to Do you want to save the current print layout?.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutToolStripZoomFull">
- <summary>
- Looks up a localized string similar to Fit to screen.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutToolStripZoomIn">
- <summary>
- Looks up a localized string similar to Zoom in.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayoutToolStripZoomOut">
- <summary>
- Looks up a localized string similar to Zoom out.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LayouyCmnuMarginAlignment">
- <summary>
- Looks up a localized string similar to Margin Alignment.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.Legend">
- <summary>
- Looks up a localized string similar to Legend.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LineElementWrongDataType">
- <summary>
- Looks up a localized string similar to The wrong type of feature set was selected. Please select a line feature set..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LineFeatureTypeException">
- <summary>
- Looks up a localized string similar to An incompatible feature type was supplied and was not of type Line..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.linkError">
- <summary>
- Looks up a localized string similar to Failed to create link.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.linkErrorCircle">
- <summary>
- Looks up a localized string similar to Output data cannot be linked to tools that generate it..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.linkErrorToData">
- <summary>
- Looks up a localized string similar to Links can only be made from data to tools..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.linkNoFreeInput">
- <summary>
- Looks up a localized string similar to There are no free inputs for the this tool that take the data type attempting to be linked to it..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.ListItemNotFound">
- <summary>
- Looks up a localized string similar to The item specified was not found in this list..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LoadingPlugins">
- <summary>
- Looks up a localized string similar to Loading Plugins.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.LoadingPluginsPercentComplete">
- <summary>
- Looks up a localized string similar to Loading Plugins - {0}, {1}% complete..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.Map_OnDragDrop_Invalid">
- <summary>
- Looks up a localized string similar to One or more of the files was not a valid data type for the map..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.Map_Tools_Group">
- <summary>
- Looks up a localized string similar to Map Tool.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.MapFrame_GlcLayerAdded_Projection_Mismatch">
- <summary>
- Looks up a localized string similar to Projection Mismatch.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.MapFrame_GlcLayerAdded_ProjectionMismatch">
- <summary>
- Looks up a localized string similar to Reproject map layer to match the map coordinate system? This will not affect the source file..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.MapFrame_Projection">
- <summary>
- Looks up a localized string similar to Projection.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.MapFunctionSelect_NoSelectableLayer">
- <summary>
- Looks up a localized string similar to No layers are currently selectable layers active in the legend. Select the layer or group in the legend for which selection should occur..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.MapFunctionSelect_OnKeyDown_No_Deletable_Layers">
- <summary>
- Looks up a localized string similar to There was no selected feature layer in the legend to clarify which features to delete. Please select a layer or group in the legend..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.MapLayers">
- <summary>
- Looks up a localized string similar to Map Layers.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.ModelerConfirmDelete">
- <summary>
- Looks up a localized string similar to Delete elements?.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.ModelerConfirmDeleteSource">
- <summary>
- Looks up a localized string similar to Deleting the selected model elements will also delete the model elements associated with them..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.ModelSaveCurrentModel">
- <summary>
- Looks up a localized string similar to Do you want to save the changes to %S?.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.ModelTipAddData">
- <summary>
- Looks up a localized string similar to Add data to the model.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.ModelTipDelete">
- <summary>
- Looks up a localized string similar to Delete selected model elements.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.ModelTipFullExtent">
- <summary>
- Looks up a localized string similar to Zoom full extent of model.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.ModelTipLink">
- <summary>
- Looks up a localized string similar to Link data to tools.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.ModelTipLoad">
- <summary>
- Looks up a localized string similar to Load a model.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.ModelTipNew">
- <summary>
- Looks up a localized string similar to Create a new empty model.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.ModelTipRunModel">
- <summary>
- Looks up a localized string similar to Run Model.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.ModelTipSave">
- <summary>
- Looks up a localized string similar to Save the current model.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.ModelTipZoomOut">
- <summary>
- Looks up a localized string similar to Zoom out.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.ModelTipZoonIn">
- <summary>
- Looks up a localized string similar to Zoom in.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.MoreThan100UniqueValues">
- <summary>
- Looks up a localized string similar to There are more than 100 unique values. Are you sure you want to continue?.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.MW4Project">
- <summary>
- Looks up a localized string similar to MW4 Project.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.NewModel">
- <summary>
- Looks up a localized string similar to New Model.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.NoMatch">
- <summary>
- Looks up a localized string similar to None of the rows contain a value that matches the specified value..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.NonStandardFunction">
- <summary>
- Looks up a localized string similar to The function name was not recognized as one of the standard function names..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.NoRowInTable">
- <summary>
- Looks up a localized string similar to There is no row in the Table..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.NotImplemented">
- <summary>
- Looks up a localized string similar to This has not yet been implemented..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.NumberException_NumDigitsTooLarge">
- <summary>
- Looks up a localized string similar to The specified number of significant digits (%S) is too large for this field..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.NumberException_TooLarge_S">
- <summary>
- Looks up a localized string similar to The value %S was too large to encode with 18 ASCII characters..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.NumberException_TooSmall_S">
- <summary>
- Looks up a localized string similar to The value %S was too small to be encoded with 18 ASCII characters..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.NumericValuesOnly">
- <summary>
- Looks up a localized string similar to Please only enter numeric values..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.OnlyShapefilesSupported">
- <summary>
- Looks up a localized string similar to For now, only the shapefile vector format is being supported..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.Opacity">
- <summary>
- Looks up a localized string similar to Opacity controls how transparent the item is. A 0 is fully transparent, while 1 is fully opaque..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.OpacityInvalid">
- <summary>
- Looks up a localized string similar to Opacity should be a floating decimal point between 0 and 1..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.Output">
- <summary>
- Looks up a localized string similar to Output.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.PaintingColorScheme">
- <summary>
- Looks up a localized string similar to Painting Color Scheme To Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.PaintingHillshade">
- <summary>
- Looks up a localized string similar to Painting Hillshade To Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.Pan">
- <summary>
- Looks up a localized string similar to Pan.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.ParameterInvalid">
- <summary>
- Looks up a localized string similar to The parameter is invalid.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.ParameterValid">
- <summary>
- Looks up a localized string similar to The parameter is valid.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.ParseFailed_S">
- <summary>
- Looks up a localized string similar to The value you entered could not be parsed into a %S. Make sure the value is in the valid range..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.Plugins">
- <summary>
- Looks up a localized string similar to Apps.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.PngInsuficientLengthException">
- <summary>
- Looks up a localized string similar to The desired length of %S1 was too long. The total length was %S2 and the offset was %S3..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.PngInvalidSignatureException">
- <summary>
- Looks up a localized string similar to The beginning eight bytes of the specified file did not match the png signature..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.Pointer">
- <summary>
- Looks up a localized string similar to Pointer.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.PointFeatureTypeException">
- <summary>
- Looks up a localized string similar to An incompatible feature type was supplied and was not of type Point..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.PolygonException_HoleElementNull">
- <summary>
- Looks up a localized string similar to Holes must not contain null elements.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.PolygonException_ShellEmptyButHolesNot">
- <summary>
- Looks up a localized string similar to Shell is empty but holes are not.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.PolygonFeatureTypeException">
- <summary>
- Looks up a localized string similar to An incompatible feature type was supplied and was not of type polygon..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.ProjectFile">
- <summary>
- Looks up a localized string similar to Project File.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.PyramidByteMismatchException">
- <summary>
- Looks up a localized string similar to The number of bytes should be 4 * rows * cols since only ARGB format is supported..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.PyramidHeaderException">
- <summary>
- Looks up a localized string similar to The header has not been defined for the image scale you are attempting to access..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.PyramidOutOfBoundsException">
- <summary>
- Looks up a localized string similar to The rows or columns would extend beyond the specified number of columns or rows for the specified scale..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.RasterRequiresCast">
- <summary>
- Looks up a localized string similar to To work with anything other than an in-memory raster window, you must first cast this raster to the correct data format..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.RastersMustHaveCellSize">
- <summary>
- Looks up a localized string similar to The specified rasters must have their cell sizes dimensioned..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.RastersNeedSameCellSize">
- <summary>
- Looks up a localized string similar to The rasters must have equally sized cells to use this method..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.RasterTooLarge">
- <summary>
- Looks up a localized string similar to The specified raster would be too large to store in memory..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.ReadingValuesFrom_S">
- <summary>
- Looks up a localized string similar to Reading values from %S.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.ReadOnlyList">
- <summary>
- Looks up a localized string similar to The list is currently set to read-only, and cannot be modified..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.Remove_Layer">
- <summary>
- Looks up a localized string similar to Remove Layer.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.RemoveFields">
- <summary>
- Looks up a localized string similar to Are you sure you want to remove the fields?.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.RootNthRootIncorrect">
- <summary>
- Looks up a localized string similar to The root n-th root is incorrect.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.Save_Layer">
- <summary>
- Looks up a localized string similar to Save Layer....
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.SaveChanges">
- <summary>
- Looks up a localized string similar to Save Changes?.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.SaveChangesToCurrentProject">
- <summary>
- Looks up a localized string similar to Save changes to current project [{0}] ?.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.Select">
- <summary>
- Looks up a localized string similar to Select.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.SelectFeatures">
- <summary>
- Looks up a localized string similar to No feature layers were selected in the legend. Select the layer to use..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.Selection_FeatureNotFound">
- <summary>
- Looks up a localized string similar to The specified feature was not found in the feature list and could not be selected..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.SpecifyField">
- <summary>
- Looks up a localized string similar to Please specify an attribute field to use for classification before using this feature..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.StartIndexTooLarge">
- <summary>
- Looks up a localized string similar to The argument startIndex was too large to read the requested number of bytes from byteArray..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.StringFieldInvalid">
- <summary>
- Looks up a localized string similar to Fields that are the string datatype cannot be converted to a raster. Do you wish to use the FID value instead?.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.SupportedFiles">
- <summary>
- Looks up a localized string similar to Supported Files.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.ToolSetupIncorectly">
- <summary>
- Looks up a localized string similar to The tool cannot be run because one or more of its parameters is not set..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.TooManyClosingBrackets">
- <summary>
- Looks up a localized string similar to There were too many closing brackets in the string expression..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.TooManyUniqueValues">
- <summary>
- Looks up a localized string similar to There are too many Unique values..
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.TopologyException_Depth">
- <summary>
- Looks up a localized string similar to Assigned depths do not match.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.ToSave">
- <summary>
- Looks up a localized string similar to To save the calulated value press the Apply button.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.View_Group">
- <summary>
- Looks up a localized string similar to View.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.WritingValues_S">
- <summary>
- Looks up a localized string similar to Writing values to %S.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.Zoom_Group">
- <summary>
- Looks up a localized string similar to Zoom.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.Zoom_In">
- <summary>
- Looks up a localized string similar to In.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.Zoom_In_Tooltip">
- <summary>
- Looks up a localized string similar to Zoom In.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.Zoom_Next">
- <summary>
- Looks up a localized string similar to Next.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.Zoom_Next_Tooltip">
- <summary>
- Looks up a localized string similar to Zoom Next.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.Zoom_Out">
- <summary>
- Looks up a localized string similar to Out.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.Zoom_Out_Tooltip">
- <summary>
- Looks up a localized string similar to Zoom Out.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.Zoom_Previous">
- <summary>
- Looks up a localized string similar to Previous.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.Zoom_Previous_Tooltip">
- <summary>
- Looks up a localized string similar to Zoom Previous.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.Zoom_To_Coordinates">
- <summary>
- Looks up a localized string similar to Zoom To Coordinates.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.Zoom_To_Extents">
- <summary>
- Looks up a localized string similar to Full Extent.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.Zoom_To_Extents_Tooltip">
- <summary>
- Looks up a localized string similar to Zoom to Full Extent.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MessageStrings.Zoom_To_Layer">
- <summary>
- Looks up a localized string similar to Zoom To Layer.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.IMapImageLayer">
- <summary>
- IGeoImageLayer
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.IMapLayer">
- <summary>
- Layer
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.IMapLayer.DrawRegions(DotSpatial.Controls.MapArgs,System.Collections.Generic.List{DotSpatial.Data.Extent})">
- <summary>
- This draws content from the specified geographic regions onto the specified graphics
- object specified by MapArgs.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapImageLayer.#ctor">
- <summary>
- Creates a new default instance of a MapImageLayer
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapImageLayer.#ctor(DotSpatial.Data.IImageData)">
- <summary>
- Creates a new instance of GeoImageLayer
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapImageLayer.#ctor(DotSpatial.Data.IImageData,System.Collections.Generic.ICollection{DotSpatial.Symbology.ILayer})">
- <summary>
- Creates a new instance of a GeoImageLayer
- </summary>
- <param name="baseImage">The image to draw as a layer</param>
- <param name="container">The Layers collection that keeps track of the image layer</param>
- </member>
- <member name="M:DotSpatial.Controls.MapImageLayer.#ctor(DotSpatial.Data.IImageData,System.Drawing.Color)">
- <summary>
- Creates a new instance of a GeoImageLayer
- </summary>
- <param name="baseImage">The image to draw as a layer</param>
- <param name="transparent">The color to make transparent when drawing the image.</param>
- </member>
- <member name="M:DotSpatial.Controls.MapImageLayer.DrawRegions(DotSpatial.Controls.MapArgs,System.Collections.Generic.List{DotSpatial.Data.Extent})">
- <summary>
- This will draw any features that intersect this region. To specify the features
- directly, use OnDrawFeatures. This will not clear existing buffer content.
- For that call Initialize instead.
- </summary>
- <param name="args">A GeoArgs clarifying the transformation from geographic to image space</param>
- <param name="regions">The geographic regions to draw</param>
- </member>
- <member name="M:DotSpatial.Controls.MapImageLayer.OnBufferChanged(System.Collections.Generic.List{System.Drawing.Rectangle})">
- <summary>
- Fires the OnBufferChanged event
- </summary>
- <param name="clipRectangles">The Rectangle in pixels</param>
- </member>
- <member name="M:DotSpatial.Controls.MapImageLayer.DrawWindows(DotSpatial.Controls.MapArgs,System.Collections.Generic.IList{DotSpatial.Data.Extent},System.Collections.Generic.IList{System.Drawing.Rectangle})">
- <summary>
- This draws to the back buffer. If the Backbuffer doesn't exist, this will create one.
- This will not flip the back buffer to the front.
- </summary>
- <param name="args"></param>
- <param name="regions"></param>
- <param name="clipRectangles"></param>
- </member>
- <member name="E:DotSpatial.Controls.MapImageLayer.BufferChanged">
- <summary>
- Fires an event that indicates to the parent map-frame that it should first
- redraw the specified clip
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapImageLayer.BackBuffer">
- <summary>
- Gets or sets the back buffer that will be drawn to as part of the initialization process.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapImageLayer.Buffer">
- <summary>
- Gets the current buffer.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapImageLayer.BufferExtent">
- <summary>
- Gets or sets the geographic region represented by the buffer
- Calling Initialize will set this automatically.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapImageLayer.BufferRectangle">
- <summary>
- Gets or sets the rectangle in pixels to use as the back buffer.
- Calling Initialize will set this automatically.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapImageLayer.IsInitialized">
- <summary>
- Gets or sets whether the image layer is initialized
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.MapTiledImageLayer">
- <summary>
- MapTiledImageLayer
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapTiledImageLayer.#ctor(DotSpatial.Data.ITiledImage)">
- <summary>
- Creates a new instance of MapTiledImageLayer
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapTiledImageLayer.DrawRegions(DotSpatial.Controls.MapArgs,System.Collections.Generic.List{DotSpatial.Data.Extent})">
- <summary>
- This will draw any features that intersect this region. To specify the features
- directly, use OnDrawFeatures. This will not clear existing buffer content.
- For that call Initialize instead.
- </summary>
- <param name="args">A GeoArgs clarifying the transformation from geographic to image space</param>
- <param name="regions">The geographic regions to draw</param>
- </member>
- <member name="M:DotSpatial.Controls.MapTiledImageLayer.DrawWindows(DotSpatial.Controls.MapArgs,System.Collections.Generic.IList{DotSpatial.Data.Extent},System.Collections.Generic.IList{System.Drawing.Rectangle})">
- <summary>
- This draws to the back buffer. If the Backbuffer doesn't exist, this will create one.
- This will not flip the back buffer to the front.
- </summary>
- <param name="args"></param>
- <param name="regions"></param>
- <param name="clipRectangles"></param>
- </member>
- <member name="T:DotSpatial.Controls.IMapFrame">
- <summary>
- IMapFrame
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.IMapGroup">
- <summary>
- IGeoGroup
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IMapGroup.Layers">
- <summary>
- Gets the GeoLayerCollection for members contained by this group.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IMapGroup.ParentMapFrame">
- <summary>
- Gets the map frame for this group.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.IMapFrame.BufferToProj(System.Drawing.Point)">
- <summary>
- Unlike PixelToProj, which works relative to the client control,
- BufferToProj takes a pixel coordinate on the buffer and
- converts it to geographic coordinates.
- </summary>
- <param name="position">A Point describing the pixel position on the back buffer</param>
- <returns>An ICoordinate describing the geographic position</returns>
- </member>
- <member name="M:DotSpatial.Controls.IMapFrame.BufferToProj(System.Drawing.Rectangle)">
- <summary>
- This projects a rectangle relative to the buffer into and IEnvelope in geographic coordinates.
- </summary>
- <param name="rect">A Rectangle</param>
- <returns>An IEnvelope interface</returns>
- </member>
- <member name="M:DotSpatial.Controls.IMapFrame.Draw(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Using the standard independent paint method would potentially cause for dis-synchrony between
- the parents state and the state of this control. This way, the drawing is all done at the
- same time.
- </summary>
- <param name="pe"></param>
- </member>
- <member name="M:DotSpatial.Controls.IMapFrame.InvalidateLayers">
- <summary>
- This will cause an invalidation for each layer. The actual rectangle to re-draw is not specified
- here, but rather this simply indicates that some re-calculation is necessary.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.IMapFrame.Initialize">
- <summary>
- Uses the current buffer and envelope to force each of the contained layers
- to re-draw their content. This is useful after a zoom or size change.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.IMapFrame.Initialize(System.Collections.Generic.List{DotSpatial.Data.Extent})">
- <summary>
- Instructs the map frame to draw content from the specified regions to the buffer..
- </summary>
- <param name="regions">The regions to initialize.</param>
- </member>
- <member name="M:DotSpatial.Controls.IMapFrame.ParentToView(System.Drawing.Rectangle)">
- <summary>
- Obtains a rectangle relative to the background image by comparing
- the current View rectangle with the parent control's size.
- </summary>
- <param name="clip"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.IMapFrame.ParentResize">
- <summary>
- When the control is being resized, the view needs to change in order to preserve the aspect ratio,
- even though we want to use the exact same extents.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.IMapFrame.ProjToBuffer(DotSpatial.Topology.Coordinate)">
- <summary>
- Converts a single geographic location into the equivalent point on the
- screen relative to the top left corner of the map.
- </summary>
- <param name="location">The geographic position to transform</param>
- <returns>A Point with the new location.</returns>
- </member>
- <member name="M:DotSpatial.Controls.IMapFrame.ProjToBuffer(DotSpatial.Data.Extent)">
- <summary>
- Converts a single geographic envelope into an equivalent Rectangle
- as it would be drawn on the screen.
- </summary>
- <param name="ext">The geographic IEnvelope</param>
- <returns>A Rectangle</returns>
- </member>
- <member name="M:DotSpatial.Controls.IMapFrame.Pan(System.Drawing.Point)">
- <summary>
- Pans the image for this map frame. Instead of drawing entirely new content, from all 5 zones,
- just the slivers of newly revealed area need to be re-drawn.
- </summary>
- <param name="shift">A Point showing the amount to shift in pixels</param>
- </member>
- <member name="M:DotSpatial.Controls.IMapFrame.Print(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Instead of using the usual buffers, this bypasses any buffering and instructs the layers
- to draw directly to the specified target rectangle on the graphics object. This is useful
- for doing vector drawing on much larger pages. The result will be centered in the
- specified target rectangle bounds.
- </summary>
- <param name="device">Graphics device to print to</param>
- <param name="targetRectangle">The target rectangle in the graphics units of the device</param>
- </member>
- <member name="M:DotSpatial.Controls.IMapFrame.Print(System.Drawing.Graphics,System.Drawing.Rectangle,DotSpatial.Data.Extent)">
- <summary>
- Instead of using the usual buffers, this bypasses any buffering and instructs the layers
- to draw directly to the specified target rectangle on the graphics object. This is useful
- for doing vector drawing on much larger pages. The result will be centered in the
- specified target rectangle bounds.
- </summary>
- <param name="device"></param>
- <param name="targetRectangle"></param>
- <param name="targetEnvelope">the extents to draw to the target rectangle</param>
- </member>
- <member name="M:DotSpatial.Controls.IMapFrame.ResetExtents">
- <summary>
- This is not called during a resize, but rather after panning or zooming where the
- view is used as a guide to update the extents. This will also call ResetBuffer.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.IMapFrame.ResetBuffer">
- <summary>
- Re-creates the buffer based on the size of the control without changing
- the geographic extents. This is used after a resize operation.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.IMapFrame.ZoomIn">
- <summary>
- Zooms in one notch, so that the scale becomes larger and the features become larger.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.IMapFrame.ZoomOut">
- <summary>
- Zooms out one notch so that the scale becomes smaller and the features become smaller.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.IMapFrame.ZoomToNext">
- <summary>
- Zooms to the next extent of the map frame
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.IMapFrame.ZoomToPrevious">
- <summary>
- Zooms to the previous extent of the map frame
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.IMapFrame.ScreenUpdated">
- <summary>
- Occurs after changes have been made to the back buffer that affect the viewing area of the screen,
- thereby requiring an invalidation.
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.IMapFrame.FinishedRefresh">
- <summary>
- Occurs after every one of the zones, chunks and stages has finished rendering to a stencil.
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.IMapFrame.BufferChanged">
- <summary>
- Occurs when the buffer content has been altered and any containing maps should quick-draw
- from the buffer, followed by the tool drawing.
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.IMapFrame.ViewChanged">
- <summary>
- Occurs when View changed
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IMapFrame.BufferImage">
- <summary>
- Gets or sets the buffered image. Mess with this at your own risk.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IMapFrame.ClientRectangle">
- <summary>
- Gets a rectangle indicating the size of the map frame image
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IMapFrame.CurrentChunk">
- <summary>
- Gets or sets the integer that specifies the chunk that is actively being drawn
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IMapFrame.ExtendBuffer">
- <summary>
- Gets or sets whether this map frame should define its buffer
- region to be the same size as the client, or three times larger.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IMapFrame.IsPanning">
- <summary>
- Gets or sets whether this map frame is currently in the process of redrawing the
- stencils after a pan operation. Drawing should not take place if this is true.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IMapFrame.Parent">
- <summary>
- Gets or sets the parent control for this map frame.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IMapFrame.ProjectionModeReproject">
- <summary>
- Gets or sets the PromptMode that determines how to warn users when attempting to add a layer with
- a coordinate system that is different from the current projection.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IMapFrame.ProjectionModeDefine">
- <summary>
- Gets or sets the PromptMode that determines how to warn users when attempting to add a layer without
- a projection to a map that has a projection.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IMapFrame.Layers">
- <summary>
- Gets or sets the layers
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IMapFrame.View">
- <summary>
- gets or sets the rectangle in pixel coordinates that will be drawn to the entire screen.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.IMapLayerCollection">
- <summary>
- IGeoLayerCollection
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.IMapLayerCollection.Add(System.String)">
- <summary>
- Adds the specified fileName to the map as a new layer.
- </summary>
- <param name="fileName">The string fileName to add as a layer.</param>
- <returns>An IMapLayer that is the layer handle for the specified file.</returns>
- </member>
- <member name="M:DotSpatial.Controls.IMapLayerCollection.Add(DotSpatial.Data.IDataSet)">
- <summary>
- Adds the dataset specified to the file. Depending on whether this is a featureSet,
- Raster, or ImageData, this will return the appropriate layer for the map.
- </summary>
- <param name="dataSet">A dataset</param>
- <returns>The IMapLayer to add</returns>
- </member>
- <member name="M:DotSpatial.Controls.IMapLayerCollection.Add(DotSpatial.Data.IFeatureSet)">
- <summary>
- This overload automatically constructs a new MapLayer from the specified
- feature layer with the default drawing characteristics and returns a valid
- IMapLayer which can be further cast into a PointLayer, MapLineLayer or
- a PolygonLayer, depending on the data that is passed in.
- </summary>
- <param name="featureSet">Any valid IFeatureSet that does not yet have drawing characteristics</param>
- <returns>A newly created valid implementation of FeatureLayer which at least gives a few more common
- drawing related methods and can also be cast into the appropriate Point, Line or Polygon layer.</returns>
- </member>
- <member name="M:DotSpatial.Controls.IMapLayerCollection.Add(DotSpatial.Data.IRaster)">
- <summary>
- Adds the specified raster as a new layer
- </summary>
- <param name="raster">The raster to add as a layer</param>
- <returns>the MapRasterLayer interface</returns>
- </member>
- <member name="M:DotSpatial.Controls.IMapLayerCollection.Add(DotSpatial.Data.IImageData)">
- <summary>
- Adds the specified ImageData class to the map as a new layer and returns the newly created layer.
- </summary>
- <param name="image">The image being created</param>
- <returns>An interface to the newly created MapImageLayer</returns>
- </member>
- <member name="M:DotSpatial.Controls.IMapLayerCollection.Move(DotSpatial.Controls.IMapLayer,System.Int32)">
- <summary>
- Moves the given layer to the new position.
- </summary>
- <param name="layer">Layer that is moved.</param>
- <param name="newPosition">Position the layer is moved to.</param>
- </member>
- <member name="M:DotSpatial.Controls.IMapLayerCollection.UnusedName(System.String)">
- <summary>
- Given a base name, this increments a number for appending
- if the name already exists in the collection.
- </summary>
- <param name="baseName">The string base name to start with</param>
- <returns>The base name modified by a number making it unique in the collection</returns>
- </member>
- <member name="E:DotSpatial.Controls.IMapLayerCollection.BufferChanged">
- <summary>
- Occurs when a rectangular region of the buffer for any of the layers in this collection
- should be updated.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IMapLayerCollection.MapFrame">
- <summary>
- Gets or sets the map frame that this belongs to. These are designed to only work with one map frame at a time.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IMapLayerCollection.ParentGroup">
- <summary>
- Gets or sets the ParentGroup for this layer collection, even if that parent group
- is not actually a map frame.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IMapLayerCollection.ProgressHandler">
- <summary>
- Gets or sets the progress handler to report progress for time consuming actions.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IMapLayerCollection.SelectedLayer">
- <summary>
- Gets or sets the currently active layer.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.IMapLabelLayer">
- <summary>
- IGeoLabelLayer
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.IMapLabelLayer.Invalidate">
- <summary>
- Resolves ambiguity
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IMapLabelLayer.FeatureLayer">
- <summary>
- Gets or sets the feature layer that this label layer is attached to.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.MapDrawTextArgs">
- <summary>
- GeoDrawTextArgs
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapDrawTextArgs.#ctor(DotSpatial.Controls.MapDrawArgs,DotSpatial.Symbology.ILabelSymbolizer)">
- <summary>
- Creates a new instance of GeoDrawTextArgs
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapDrawTextArgs.Dispose">
- <summary>
- Disposes the font brush, border pen and background brush
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapDrawTextArgs.Symbolizer">
- <summary>
- Gets the TextSymbolizer for this
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapDrawTextArgs.DrawArgs">
- <summary>
- Gets the GeoDrawArgs
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapDrawTextArgs.BackBrush">
- <summary>
- Gets the brush for drawing the background.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapDrawTextArgs.BorderPen">
- <summary>
- Gets the border pen
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapDrawTextArgs.FontBrush">
- <summary>
- Gets the brush used for drawing fonts.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.MapLabelLayer">
- <summary>
- GeoLabelLayer
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.MapLabelLayer.ExistingLabels">
- <summary>
- The existing labels, accessed for all map label layers, not just this instance
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapLabelLayer.#ctor">
- <summary>
- Creates a new instance of GeoLabelLayer
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapLabelLayer.#ctor(DotSpatial.Data.IFeatureSet)">
- <summary>
- Creates a new label layer based on the specified featureset
- </summary>
- <param name="inFeatureSet"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapLabelLayer.#ctor(DotSpatial.Symbology.IFeatureLayer)">
- <summary>
- Creates a new label layer based on the specified feature layer
- </summary>
- <param name="inFeatureLayer">The feature layer to build layers from</param>
- </member>
- <member name="M:DotSpatial.Controls.MapLabelLayer.ClearAllExistingLabels">
- <summary>
- Cleaer all existing labels for all layers
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapLabelLayer.DrawRegions(DotSpatial.Controls.MapArgs,System.Collections.Generic.List{DotSpatial.Data.Extent})">
- <summary>
- This will draw any features that intersect this region. To specify the features
- directly, use OnDrawFeatures. This will not clear existing buffer content.
- For that call Initialize instead.
- </summary>
- <param name="args">A GeoArgs clarifying the transformation from geographic to image space</param>
- <param name="regions">The geographic regions to draw</param>
- </member>
- <member name="M:DotSpatial.Controls.MapLabelLayer.Clear(System.Collections.Generic.List{System.Drawing.Rectangle},System.Drawing.Color)">
- <summary>
- Call StartDrawing before using this.
- </summary>
- <param name="rectangles">The rectangular region in pixels to clear.</param>
- <param name= "color">The color to use when clearing. Specifying transparent
- will replace content with transparent pixels.</param>
- </member>
- <member name="M:DotSpatial.Controls.MapLabelLayer.DrawFeatures(DotSpatial.Controls.MapArgs,System.Collections.Generic.List{DotSpatial.Data.IFeature},System.Collections.Generic.List{System.Drawing.Rectangle},System.Boolean)">
- <summary>
- Draws the labels for the given features.
- </summary>
- <param name="args">The GeoArgs that control how these features should be drawn.</param>
- <param name="features">The features that should be drawn.</param>
- <param name="clipRectangles">If an entire chunk is drawn and an update is specified, this clarifies the changed rectangles.</param>
- <param name="useChunks">Boolean, if true, this will refresh the buffer in chunks.</param>
- </member>
- <member name="M:DotSpatial.Controls.MapLabelLayer.DrawFeatures(DotSpatial.Controls.MapArgs,System.Collections.Generic.List{System.Int32},System.Collections.Generic.List{System.Drawing.Rectangle},System.Boolean)">
- <summary>
- Draws the labels for the given features.
- </summary>
- <param name="args">The GeoArgs that control how these features should be drawn.</param>
- <param name="features">The features that should be drawn.</param>
- <param name="clipRectangles">If an entire chunk is drawn and an update is specified, this clarifies the changed rectangles.</param>
- <param name="useChunks">Boolean, if true, this will refresh the buffer in chunks.</param>
- </member>
- <member name="M:DotSpatial.Controls.MapLabelLayer.DrawFeatures(DotSpatial.Controls.MapArgs,System.Collections.Generic.IEnumerable{System.Int32})">
- <summary>
- Draws the labels for the given features.
- </summary>
- <param name="e">MapArgs to get Graphics object from.</param>
- <param name="features">Indizes of the features whose labels get drawn.</param>
- </member>
- <member name="M:DotSpatial.Controls.MapLabelLayer.DrawFeatures(DotSpatial.Controls.MapArgs,System.Collections.Generic.IEnumerable{DotSpatial.Data.IFeature})">
- <summary>
- Draws the labels for the given features.
- </summary>
- <param name="e">MapArgs to get Graphics object from.</param>
- <param name="features">Features, whose labels get drawn.</param>
- </member>
- <member name="M:DotSpatial.Controls.MapLabelLayer.Collides(System.Drawing.RectangleF,System.Collections.Generic.IEnumerable{System.Drawing.RectangleF})">
- <summary>
- Checks whether the given rectangle collides with the drawnRectangles.
- </summary>
- <param name="rectangle">Rectangle that we want to draw next.</param>
- <param name="drawnRectangles">Rectangle that were already drawn.</param>
- <returns>True, if the rectangle collides with a rectancle that was already drawn.</returns>
- </member>
- <member name="M:DotSpatial.Controls.MapLabelLayer.DrawPolygonFeature(DotSpatial.Controls.MapArgs,System.Drawing.Graphics,DotSpatial.Data.IFeature,DotSpatial.Symbology.ILabelCategory,System.Boolean,System.Collections.Generic.List{System.Drawing.RectangleF})">
- <summary>
- Draws a label on a polygon with various different methods
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapLabelLayer.CollisionDraw(System.String,System.Drawing.Graphics,DotSpatial.Symbology.ILabelSymbolizer,DotSpatial.Data.IFeature,DotSpatial.Controls.MapArgs,System.Drawing.RectangleF,System.Collections.Generic.List{System.Drawing.RectangleF},System.Single)">
- <summary>
- Draws the given text if it is on screen. If PreventCollision is set only labels that don't collide with existingLables are drawn.
- </summary>
- <param name="txt">Text that should be drawn.</param>
- <param name="g">Graphics object that does the drawing.</param>
- <param name="symb">Symbolizer to figure out the look of the label.</param>
- <param name="f">Feature, the label belongs to.</param>
- <param name="e"></param>
- <param name="labelBounds"></param>
- <param name="existingLabels">List with labels that were already drawn.</param>
- <param name="angle">Angle in degree the label gets rotated by.</param>
- </member>
- <member name="M:DotSpatial.Controls.MapLabelLayer.PlacePolygonLabel(DotSpatial.Topology.IBasicGeometry,DotSpatial.Controls.MapArgs,System.Func{System.Drawing.SizeF},DotSpatial.Symbology.ILabelSymbolizer,System.Single)">
- <summary>
- Calculates the position of the polygon label.
- </summary>
- <param name="geom"></param>
- <param name="e"></param>
- <param name="labelSize"></param>
- <param name="symb"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.MapLabelLayer.DrawPointFeature(DotSpatial.Controls.MapArgs,System.Drawing.Graphics,DotSpatial.Data.IFeature,DotSpatial.Symbology.ILabelCategory,System.Boolean,System.Collections.Generic.List{System.Drawing.RectangleF})">
- <summary>
- Draws a label on a point with various different methods.
- </summary>
- <param name="e"></param>
- <param name="g"></param>
- <param name="f"></param>
- <param name="category"></param>
- <param name="selected"></param>
- <param name="existingLabels"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapLabelLayer.PlaceLabel(DotSpatial.Topology.Coordinate,DotSpatial.Controls.MapArgs,System.Func{System.Drawing.SizeF},DotSpatial.Symbology.ILabelSymbolizer,System.Double)">
- <summary>
- Creates the RectangleF for the label.
- </summary>
- <param name="c">Coordinate, where the label should be placed.</param>
- <param name="e">MapArgs for calculating the position of the label on the output medium.</param>
- <param name="labelSize">Function that calculates the labelSize.</param>
- <param name="symb">ILabelSymbolizer to calculate the orientation based adjustment.</param>
- <param name="angle">Angle in degree used to rotate the label.</param>
- <returns>Empty Rectangle if Coordinate is outside of the drawn extent, otherwise Rectangle needed to draw the label.</returns>
- </member>
- <member name="M:DotSpatial.Controls.MapLabelLayer.RotatePoint(System.Drawing.PointF@,System.Double)">
- <summary>
- Rotates the given point by angle around (0,0).
- </summary>
- <param name="point">Point that gets rotated.</param>
- <param name="angle">Angle in degree.</param>
- </member>
- <member name="M:DotSpatial.Controls.MapLabelLayer.DrawLineFeature(DotSpatial.Controls.MapArgs,System.Drawing.Graphics,DotSpatial.Data.IFeature,DotSpatial.Symbology.ILabelCategory,System.Boolean,System.Collections.Generic.List{System.Drawing.RectangleF})">
- <summary>
- Draws a label on a line with various different methods.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapLabelLayer.PlaceLineLabel(DotSpatial.Topology.IBasicGeometry,System.Func{System.Drawing.SizeF},DotSpatial.Controls.MapArgs,DotSpatial.Symbology.ILabelSymbolizer,System.Single)">
- <summary>
- Places the label according to the selected LabelPlacementMethode.
- </summary>
- <param name="lineString">LineString, whose label gets drawn.</param>
- <param name="labelSize">Function that calculates the size of the label.</param>
- <param name="e"></param>
- <param name="symb">Symbolizer to figure out the look of the label.</param>
- <param name="angle">Angle in degree the label gets rotated by.</param>
- <returns>The RectangleF that is needed to draw the label.</returns>
- </member>
- <member name="M:DotSpatial.Controls.MapLabelLayer.Position(DotSpatial.Symbology.ILabelSymbolizer,System.Drawing.SizeF)">
- <summary>
- Calculates the adjustment of the the label's position based on the symbolizers orientation.
- </summary>
- <param name="symb">ILabelSymbolizer whose orientation should be considered.</param>
- <param name="size">Size of the label.</param>
- <returns>New label-position based on label-size and symbolizer-orientation.</returns>
- </member>
- <member name="M:DotSpatial.Controls.MapLabelLayer.DrawLabel(System.Drawing.Graphics,System.String,System.Drawing.RectangleF,DotSpatial.Symbology.ILabelSymbolizer,DotSpatial.Data.IFeature,System.Single)">
- <summary>
- Draws labels in a specified rectangle
- </summary>
- <param name="g">The graphics object to draw to</param>
- <param name="labelText">The label text to draw</param>
- <param name="labelBounds">The rectangle of the label</param>
- <param name="symb">the Label Symbolizer to use when drawing the label</param>
- <param name="feature">Feature to draw</param>
- <param name="angle">Angle in degree the label gets rotated by.</param>
- </member>
- <member name="M:DotSpatial.Controls.MapLabelLayer.GetAngleToRotate(DotSpatial.Symbology.ILabelSymbolizer,DotSpatial.Data.IFeature,DotSpatial.Topology.IBasicGeometry)">
- <summary>
- Rotates the label for the given feature by the angle of the LabelSymbolizer.
- </summary>
- <param name="symb">LabelSymbolizer that indicates the angle to use.</param>
- <param name="feature">Feature whose label gets rotated.</param>
- <param name="lineString"></param>
- <returns>Resulting angle in degree.</returns>
- </member>
- <member name="M:DotSpatial.Controls.MapLabelLayer.GetSegment(DotSpatial.Topology.ILineString,DotSpatial.Symbology.ILabelSymbolizer)">
- <summary>
- Gets the segment of the LineString that is used to position and rotate the label.
- </summary>
- <param name="lineString">LineString to get the segment from.</param>
- <param name="symb">Symbolizer to get the LineLabelPlacement from.</param>
- <returns>Null on unnown LineLabelPlacementMethod else the calculated segment. </returns>
- </member>
- <member name="M:DotSpatial.Controls.MapLabelLayer.ToSingle(System.Object)">
- <summary>
- Converts the given value to single.
- </summary>
- <param name="value">Value that gets converted to single.</param>
- <returns>0 on error else the resulting value.</returns>
- </member>
- <member name="M:DotSpatial.Controls.MapLabelLayer.FinishDrawing">
- <summary>
- Indicates that the drawing process has been finalized and swaps the back buffer
- to the front buffer.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapLabelLayer.StartDrawing(System.Boolean)">
- <summary>
- Copies any current content to the back buffer so that drawing should occur on the
- back buffer (instead of the fore-buffer). Calling draw methods without
- calling this may cause exceptions.
- </summary>
- <param name="preserve">Boolean, true if the front buffer content should be copied to the back buffer
- where drawing will be taking place.</param>
- </member>
- <member name="M:DotSpatial.Controls.MapLabelLayer.OnBufferChanged(System.Collections.Generic.List{System.Drawing.Rectangle})">
- <summary>
- Fires the OnBufferChanged event
- </summary>
- <param name="clipRectangles">The Rectangle in pixels</param>
- </member>
- <member name="M:DotSpatial.Controls.MapLabelLayer.OnFinishDrawing">
- <summary>
- Indiciates that whatever drawing is going to occur has finished and the contents
- are about to be flipped forward to the front buffer.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapLabelLayer.OnStartDrawing">
- <summary>
- Occurs when a new drawing is started, but after the BackBuffer has been established.
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.MapLabelLayer.BufferChanged">
- <summary>
- Fires an event that indicates to the parent map-frame that it should first
- redraw the specified clip
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapLabelLayer.BackBuffer">
- <summary>
- Gets or sets the back buffer that will be drawn to as part of the initialization process.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapLabelLayer.Buffer">
- <summary>
- Gets the current buffer.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapLabelLayer.BufferEnvelope">
- <summary>
- Gets or sets the geographic region represented by the buffer
- Calling Initialize will set this automatically.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapLabelLayer.BufferRectangle">
- <summary>
- Gets or sets the rectangle in pixels to use as the back buffer.
- Calling Initialize will set this automatically.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapLabelLayer.ChunkSize">
- <summary>
- Gets or sets the maximum number of labels that will be rendered before
- refreshing the screen.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapLabelLayer.FeatureLayer">
- <summary>
- Gets or sets the MapFeatureLayer that this label layer is attached to.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapLabelLayer.IsInitialized">
- <summary>
- Gets or sets whether or not this layer has been initialized.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapArgs.#ctor(System.Drawing.Rectangle,DotSpatial.Data.Extent)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Controls.MapArgs"/> class.
- </summary>
- <param name="bufferRectangle">The buffer rectangle.</param>
- <param name="bufferEnvelope">The buffer envelope.</param>
- </member>
- <member name="M:DotSpatial.Controls.MapArgs.#ctor(System.Drawing.Rectangle,DotSpatial.Data.Extent,System.Drawing.Graphics)">
- <summary>
- Creates a new MapArgs, where the device is also specified, overriding the default buffering behavior.
- </summary>
- <param name="bufferRectangle"></param>
- <param name="bufferEnvelope"></param>
- <param name="g"></param>
- </member>
- <member name="P:DotSpatial.Controls.MapArgs.Device">
- <summary>
- An optional parameter that specifies a device to use instead of the normal buffers.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapArgs.Dx">
- <summary>
- Gets the Dx
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapArgs.Dy">
- <summary>
- Gets the Dy
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapArgs.MinX">
- <summary>
- Gets the minimum X value
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapArgs.MaxY">
- <summary>
- Gets the maximum Y value
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapArgs.ImageRectangle">
- <summary>
- Gets the rectangle dimensions of what the buffer should be in pixels
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapArgs.GeographicExtents">
- <summary>
- Gets the geographic bounds of the content of the buffer.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.MapDrawArgs">
- <summary>
- DrawArgs contains the parameters necessary for 2D drawing
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapDrawArgs.#ctor(System.Drawing.Graphics,System.Drawing.Rectangle,DotSpatial.Controls.IMapFrame)">
- <summary>
- Creates a new instance of DrawArgs
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapDrawArgs.#ctor(System.Drawing.Graphics,System.Drawing.Rectangle,DotSpatial.Controls.MapArgs)">
- <summary>
- Creates a new instance of GeoDrawArgs
- </summary>
- <param name="inGraphics"></param>
- <param name="clipRectangle"></param>
- <param name="inGeoGraphics"></param>
- </member>
- <member name="P:DotSpatial.Controls.MapDrawArgs.Graphics">
- <summary>
- Gets a Graphics object that is useful for drawing in client coordinates. Coordinates
- should be specified as though they were drawn to the client rectangle, even if
- a clip rectangle is specified.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapDrawArgs.GeoGraphics">
- <summary>
- Gets a GeoGraphics wrapper that makes it easy to draw things in geographic coordinates.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapDrawArgs.ClipRectangle">
- <summary>
- Gets the clip rectangle that defines the area on the region in client coordinates where drawing is taking place.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.MapFrame">
- <summary>
- A MapFrame accomplishes two things. Firstly, it organizes the layers to be drawn, and establishes the geographic
- extents. Secondly, it hosts the back-buffer image that can be larger than the component that
- this map frame would normally be drawn to. When it receives instructions to paint itself, the client rectangle
- will automatically end up behaving like a clip rectangle.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.#ctor">
- <summary>
- Creates the default map frame, allowing the control that it belongs to to be set later.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.#ctor(System.Windows.Forms.Control)">
- <summary>
- Creates a new instance of a MapFrame without specifying the extents. The
- geographic extents of the world will be used.
- </summary>
- <param name="inParent">The parent control that should own this map frame.</param>
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.#ctor(System.Windows.Forms.Control,DotSpatial.Data.Extent)">
- <summary>
- Creates a new instance of MapFrame
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.IndexOf(DotSpatial.Symbology.ILayer)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.Add(DotSpatial.Symbology.ILayer)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.Clear">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.GetEnumerator">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.System#Collections#IEnumerable#GetEnumerator">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.Contains(DotSpatial.Symbology.ILayer)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.Remove(DotSpatial.Symbology.ILayer)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.RemoveAt(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.Insert(System.Int32,DotSpatial.Symbology.ILayer)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.SuspendEvents">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.ResumeEvents">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.ResetExtents">
- <summary>
- This is not called during a resize, but rather after panning or zooming where the
- view is used as a guide to update the extents. This will also call ResetBuffer.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.ResetBuffer">
- <summary>
- Re-creates the buffer based on the size of the control without changing
- the geographic extents. This is used after a resize operation.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.Initialize(System.Collections.Generic.List{DotSpatial.Data.Extent})">
- <summary>
- Instructs the map frame to draw content from the specified regions to the buffer..
- </summary>
- <param name="regions">The regions to initialize.</param>
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.Initialize">
- <summary>
- Uses the current buffer and envelope to force each of the contained layers
- to re-draw their content. This is useful after a zoom or size change.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.Pan(System.Drawing.Point)">
- <summary>
- Pans the image for this map frame. Instead of drawing entirely new content, from all 5 zones,
- just the slivers of newly revealed area need to be re-drawn.
- </summary>
- <param name="shift">A Point showing the amount to shift in pixels</param>
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.Invalidate(DotSpatial.Data.Extent)">
- <summary>
- When content in a geographic region needs to be invalidated
- </summary>
- <param name="region"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.GetLayers">
- <summary>
- Converts the internal list of layers into a list of ILayer interfaces
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.Print(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Instead of using the usual buffers, this bypasses any buffering and instructs the layers
- to draw directly to the specified target rectangle on the graphics object. This is useful
- for doing vector drawing on much larger pages. The result will be centered in the
- specified target rectangle bounds.
- </summary>
- <param name="device"></param>
- <param name="targetRectangle"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.Print(System.Drawing.Graphics,System.Drawing.Rectangle,DotSpatial.Data.Extent)">
- <summary>
- Instead of using the usual buffers, this bypasses any buffering and instructs the layers
- to draw directly to the specified target rectangle on the graphics object. This is useful
- for doing vector drawing on much larger pages. The result will be centered in the
- specified target rectangle bounds.
- </summary>
- <param name="device"></param>
- <param name="targetRectangle"></param>
- <param name="targetEnvelope">the extents to draw to the target rectangle</param>
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.Invalidate">
- <summary>
- Forces this MapFrame to copy the buffers for its layers to the back-buffer.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.OnCreateGroup">
- <summary>
- Overrides the group creation to make sure that the new group will cast its layers
- to the appropriate Layer type.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.InitializeLabels(System.Collections.Generic.List{DotSpatial.Data.Extent},DotSpatial.Controls.MapArgs,DotSpatial.Symbology.IRenderable)">
- <summary>
- Draw label content for a Map Layer
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.ParentToView(System.Drawing.Rectangle)">
- <summary>
- Obtains a rectangle relative to the background image by comparing
- the current View rectangle with the parent control's size.
- </summary>
- <param name="clip"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.ZoomIn">
- <summary>
- Zooms in one notch, so that the scale becomes larger and the features become larger.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.ZoomOut">
- <summary>
- Zooms out one notch so that the scale becomes smaller and the features become smaller.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.OnExtentsChanged(DotSpatial.Data.Extent)">
- <summary>
- Fires the ExtentsChanged event
- </summary>
- <param name="ext"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.CanZoomToNext">
- <summary>
- Determines whether this instance [can zoom to next]. Should not be called inside of
- MapFrame_ViewExtentsChanged event.
- </summary>
- <returns>
- <c>true</c> if this instance [can zoom to next]; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.CanZoomToPrevious">
- <summary>
- Determines whether this instance [can zoom to previous]. Should not be called inside of
- MapFrame_ViewExtentsChanged event.
- </summary>
- <returns>
- <c>true</c> if this instance [can zoom to previous]; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.ZoomToNext">
- <summary>
- Zooms to the next extent
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.ZoomToPrevious">
- <summary>
- Zooms to the previous extent
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.ParentResize">
- <summary>
- When the control is being resized, the view needs to change in order to preserve the aspect ratio,
- even though we want to use the exact same extents.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.ResetAspectRatio(DotSpatial.Data.Extent)">
- <summary>
- If a BackBuffer.Extents exists, this will enlarge those extents to match the aspect ratio
- of the pixel view. If one doesn't exist, the _mapFrame.Extents will be used instead.
- </summary>
- <param name="newEnv">The envelope to adjust</param>
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.Add(DotSpatial.Data.IFeatureSet)">
- <summary>
- This will create a new layer from the featureset and add it.
- </summary>
- <param name="featureSet">Any valid IFeatureSet that does not yet have drawing characteristics</param>
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.Draw(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Draws from the buffer.
- </summary>
- <param name="pe"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.BufferToProj(System.Drawing.Point)">
- <summary>
- Unlike PixelToProj, which works relative to the client control,
- BufferToProj takes a pixel coordinate on the buffer and
- converts it to geographic coordinates.
- </summary>
- <param name="position">A Point describing the pixel position on the back buffer</param>
- <returns>An ICoordinate describing the geographic position</returns>
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.BufferToProj(System.Drawing.Rectangle)">
- <summary>
- This projects a rectangle relative to the buffer into and IEnvelope in geographic coordinates.
- </summary>
- <param name="rect">A Rectangle</param>
- <returns>An IEnvelope interface</returns>
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.ProjToBuffer(DotSpatial.Topology.Coordinate)">
- <summary>
- Converts a single geographic location into the equivalent point on the
- screen relative to the top left corner of the map.
- </summary>
- <param name="location">The geographic position to transform</param>
- <returns>A Point with the new location.</returns>
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.ProjToBuffer(DotSpatial.Data.Extent)">
- <summary>
- Converts a single geographic envelope into an equivalent Rectangle
- as it would be drawn on the screen.
- </summary>
- <param name="env">The geographic IEnvelope</param>
- <returns>A Rectangle</returns>
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.InvalidateLayers">
- <summary>
- This will cause an invalidation for each layer. The actual rectangle to re-draw is not specified
- here, but rather this simply indicates that some re-calculation is necessary.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.OnScreenUpdated">
- <summary>
- Fires the ScreenUpdated event
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.OnFinishedRefresh">
- <summary>
- Fires the FinsihedRefresh event
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.Handle_Layer_Events(DotSpatial.Symbology.ILayerEvents)">
- <summary>
- Wires each of the layer events that the MapFrame should be listening to.
- </summary>
- <param name="collection"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.Layers_ZoomToLayer(System.Object,DotSpatial.Symbology.EnvelopeArgs)">
- <summary>
- Modifies the ZoomToLayer behavior to account for the possibility of an expanded
- MapFrame.
- </summary>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.DefineProjection(DotSpatial.Controls.IMapLayer)">
- <summary>
- Prompts the user to define the projection of the given layer, if it doesn't not have one.
- </summary>
- <param name="layer">Layer whose projection gets checked.</param>
- <returns>True if the layer doesn't have a projection.</returns>
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.Ignore_Layer_Events(DotSpatial.Symbology.ILayerEvents)">
- <summary>
- Unwires events from the layer collection
- </summary>
- <param name="collection"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.GeoLayerBufferChanged(System.Object,DotSpatial.Controls.ClipArgs)">
- <summary>
- When any region for the stencil of any layers is changed, we should update the
- image that we have in that region. This activity will be suspended in the
- case of a large scale update for all the layers until they have all updated.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.OnBufferChanged(System.Object,DotSpatial.Controls.ClipArgs)">
- <summary>
- Fires the BufferChanged event. This is fired even if the new content is not currently
- in the view rectangle.
- </summary>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.Projection_Click(System.Object,System.EventArgs)">
- <summary>
- When the Projection context menu is clicked
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFrame.DrawRegions(DotSpatial.Controls.MapArgs,System.Collections.Generic.List{DotSpatial.Data.Extent})">
- <inheritdoc />
- </member>
- <member name="E:DotSpatial.Controls.MapFrame.ScreenUpdated">
- <summary>
- Occurs after changes have been made to the back buffer that affect the viewing area of the screen,
- thereby requiring an invalidation.
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.MapFrame.FinishedRefresh">
- <summary>
- Occurs after every one of the zones, chunks and stages has finished rendering to a stencil.
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.MapFrame.BufferChanged">
- <summary>
- Occurs when the buffer content has been altered and any containing maps should quick-draw
- from the buffer, followed by the tool drawing.
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.MapFrame.ViewChanged">
- <summary>
- Occurs when View changed
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapFrame.Item(System.Int32)">
- <inheritdoc />
- </member>
- <member name="P:DotSpatial.Controls.MapFrame.EventsSuspended">
- <inheritdoc />
- </member>
- <member name="P:DotSpatial.Controls.MapFrame.LegendItems">
- <summary>
- This is a different view of the layers cast as legend items. This allows
- easier cycling in recursive legend code.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapFrame.ClipRectangle">
- <summary>
- This gets or sets the first clipRegion. If more than one region needs to be set,
- the ClipRegions list should be used instead.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapFrame.ClipRegions">
- <summary>
- Gets or sets a set of rectangles that should be drawn during the next update
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapFrame.BufferExtents">
- <summary>
- Gets or sets the geographic extents to be drawn to a buffer.
- If "ExtendBuffer" is true, then these extents are larger
- than the geographic extents of the parent client,
- and care should be taken when using PixelToProj,
- as it will work differently.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapFrame.Height">
- <summary>
- Gets or sets the height
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapFrame.Width">
- <summary>
- Gets or sets the width in pixels for this map frame.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapFrame.CurrentChunk">
- <summary>
- Gets or sets the integer that specifies the chunk that is actively being drawn
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapFrame.ViewExtents">
- <inheritdoc/>
- </member>
- <member name="P:DotSpatial.Controls.MapFrame.GeographicExtents">
- <summary>
- Gets the geographic extents
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapFrame.ExtendBuffer">
- <summary>
- Gets or sets whether this map frame should define its buffer
- region to be the same size as the client, or three times larger.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapFrame.IsPanning">
- <summary>
- Gets or sets whether this map frame is currently in the process of redrawing the
- stencils after a pan operation. Drawing should not take place if this is true.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapFrame.Layers">
- <summary>
- Gets or sets the layers
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapFrame.ProjectionModeReproject">
- <summary>
- gets or sets the ReprojectMode that determines if new layers are reprojected when added to the map.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapFrame.ProjectionModeDefine">
- <summary>
- Gets or sets the PromptMode that determines how to warn users when attempting to add a layer without
- a projection to a map that has a projection.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapFrame.View">
- <summary>
- gets or sets the rectangle in pixel coordinates that will be drawn to the entire screen.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapFrame.Right">
- <summary>
- The right in client rectangle coordinates
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapFrame.Bottom">
- <summary>
- The bottom (or height) of this client rectangle
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapFrame.BufferImage">
- <summary>
- Gets or sets the buffered image. Mess with this at your own risk.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapFrame.ClientRectangle">
- <summary>
- Gets or sets the client rectangle
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapFrame.ImageRectangle">
- <summary>
- Gets or sets the ImageRectangle for drawing the buffer
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapFrame.ProgressHandler">
- <summary>
- Gets or sets the progress handler to use. Setting this will set the progress handler for
- each of the layers in this map frame.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapFrame.Parent">
- <summary>
- Gets or sets the parent control for this map frame.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapFrame.ParentMapFrame">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Controls.MapGroup.OnCreateGroup">
- <summary>
- Overrides the base CreateGroup method to ensure that new groups are GeoGroups.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapGroup.#ctor">
- <summary>
- Creates a new instance of GeoGroup
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapGroup.#ctor(DotSpatial.Controls.IMap,System.String)">
- <summary>
- Creates a new group for the specified map. This will place the group at the root level on the MapFrame.
- </summary>
- <param name="map">The map to add this group to.</param>
- <param name="name">The name to appear in the legend text.</param>
- </member>
- <member name="M:DotSpatial.Controls.MapGroup.#ctor(System.Collections.Generic.ICollection{DotSpatial.Controls.IMapLayer},DotSpatial.Controls.IMapFrame,DotSpatial.Data.IProgressHandler)">
- <summary>
- Creates a group that sits in a layer list and uses the specified progress handler
- </summary>
- <param name="container">the layer list</param>
- <param name="frame"></param>
- <param name="progressHandler">the progress handler</param>
- </member>
- <member name="M:DotSpatial.Controls.MapGroup.IndexOf(DotSpatial.Symbology.ILayer)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Controls.MapGroup.Add(DotSpatial.Symbology.ILayer)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Controls.MapGroup.Remove(DotSpatial.Symbology.ILayer)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Controls.MapGroup.RemoveAt(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Controls.MapGroup.Insert(System.Int32,DotSpatial.Symbology.ILayer)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Controls.MapGroup.Clear">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Controls.MapGroup.Contains(DotSpatial.Symbology.ILayer)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Controls.MapGroup.CopyTo(DotSpatial.Symbology.ILayer[],System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Controls.MapGroup.SuspendEvents">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Controls.MapGroup.ResumeEvents">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Controls.MapGroup.GetEnumerator">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Controls.MapGroup.System#Collections#IEnumerable#GetEnumerator">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Controls.MapGroup.DrawRegions(DotSpatial.Controls.MapArgs,System.Collections.Generic.List{DotSpatial.Data.Extent})">
- <summary>
- This draws content from the specified geographic regions onto the specified graphics
- object specified by MapArgs.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapGroup.GetLayers">
- <summary>
- Gets the layers cast as ILayer without any information about the actual drawing methods.
- This is useful for handling methods that my come from various types of maps.
- </summary>
- <returns>An enumerable collection of ILayer</returns>
- </member>
- <member name="P:DotSpatial.Controls.MapGroup.Item(System.Int32)">
- <inheritdoc />
- </member>
- <member name="P:DotSpatial.Controls.MapGroup.Count">
- <inheritdoc />
- </member>
- <member name="P:DotSpatial.Controls.MapGroup.IsReadOnly">
- <inheritdoc />
- </member>
- <member name="P:DotSpatial.Controls.MapGroup.EventsSuspended">
- <inheritdoc />
- </member>
- <member name="P:DotSpatial.Controls.MapGroup.Layers">
- <summary>
- Gets the collection of Geographic drawing layers.
- </summary>
- <summary>
- Gets or sets the layers
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapGroup.MapFrame">
- <inheritdoc />
- </member>
- <member name="P:DotSpatial.Controls.MapGroup.ParentMapFrame">
- <summary>
- Gets the MapFrame that this group ultimately belongs to. This may not
- be the immediate parent of this group.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapGroup.LegendItems">
- <summary>
- This is a different view of the layers cast as legend items. This allows
- easier cycling in recursive legend code.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.MapGroup.MapLayerEnumerator">
- <summary>
- Transforms an IMapLayer enumerator into an ILayer Enumerator
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapGroup.MapLayerEnumerator.#ctor(System.Collections.Generic.IEnumerator{DotSpatial.Controls.IMapLayer})">
- <summary>
- Creates a new instance of the MapLayerEnumerator
- </summary>
- <param name="subEnumerator"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapGroup.MapLayerEnumerator.Dispose">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Controls.MapGroup.MapLayerEnumerator.MoveNext">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Controls.MapGroup.MapLayerEnumerator.Reset">
- <inheritdoc />
- </member>
- <member name="P:DotSpatial.Controls.MapGroup.MapLayerEnumerator.Current">
- <inheritdoc />
- </member>
- <member name="T:DotSpatial.Controls.MapLayerCollection">
- <summary>
- GeoLayerCollection
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapLayerCollection.#ctor(DotSpatial.Controls.IMapFrame,DotSpatial.Data.IProgressHandler)">
- <summary>
- Creates a new blank instance of a MapLayer collection. This is especially useful
- for tracking layers that can draw themselves. This does not concern itself with
- view extents like a dataframe, but rather is a grouping of layers that is itself
- also an IMapLayer.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapLayerCollection.#ctor(DotSpatial.Controls.IMapFrame,DotSpatial.Controls.IMapGroup,DotSpatial.Data.IProgressHandler)">
- <summary>
- Creates the Collection in the situation where the map frame is not the immediate parent,
- but rather the group is the immediate parent, while frame is the ultimate map frame that
- contains this geo layer collection.
- </summary>
- <param name="frame"></param>
- <param name="group"></param>
- <param name="progressHandler"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapLayerCollection.#ctor(DotSpatial.Controls.IMapFrame)">
- <summary>
- Creates a new blank instance of a MapLayer collection. This is especially useful
- for tracking layers that can draw themselves. This does not concern itself with
- view extents like a dataframe, but rather is a grouping of layers that is itself
- also an IMapLayer.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapLayerCollection.#ctor">
- <summary>
- Creates a new layer collection that is free-floating. This will not be contained in a map frame.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapLayerCollection.Add(DotSpatial.Controls.IMapLayer)">
- <summary>
- This overload automatically constructs a new MapLayer from the specified
- feature layer with the default drawing characteristics and returns a valid
- IMapLayer which can be further cast into a PointLayer, MapLineLayer or
- a PolygonLayer, depending on the data that is passed in.
- </summary>
- <param name="layer">A pre-existing FeatureLayer that has already been created from a featureSet</param>
- </member>
- <member name="M:DotSpatial.Controls.MapLayerCollection.AddRange(System.Collections.Generic.IEnumerable{DotSpatial.Controls.IMapLayer})">
- <summary>
- Adds the elements of the specified collection to the end of the System.Collections.Generic.List<T>
- </summary>
- <param name="collection">collection: The collection whose elements should be added to the end of the
- System.Collections.Generic.List<T>. The collection itself cannot be null, but it can contain elements that are null,
- if type T is a reference type.</param>
- <exception cref="T:System.ApplicationException">Unable to add while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Controls.MapLayerCollection.Add(System.String)">
- <summary>
- Adds the specified fileName to the map as a new layer.
- </summary>
- <param name="fileName">The string fileName to add as a layer.</param>
- <returns>An IMapLayer that is the layer handle for the specified file.</returns>
- </member>
- <member name="M:DotSpatial.Controls.MapLayerCollection.Add(DotSpatial.Data.IDataSet)">
- <summary>
- Adds the dataset specified to the file. Depending on whether this is a featureSet,
- Raster, or ImageData, this will return the appropriate layer for the map.
- </summary>
- <param name="dataSet">A dataset</param>
- <returns>The IMapLayer to add</returns>
- </member>
- <member name="M:DotSpatial.Controls.MapLayerCollection.Add(DotSpatial.Data.IFeatureSet)">
- <summary>
- This overload automatically constructs a new MapLayer from the specified
- feature layer with the default drawing characteristics and returns a valid
- IMapLayer which can be further cast into a PointLayer, MapLineLayer or
- a PolygonLayer, depending on the data that is passed in.
- </summary>
- <param name="featureSet">Any valid IFeatureSet that does not yet have drawing characteristics</param>
- <returns>A newly created valid implementation of FeatureLayer which at least gives a few more common
- drawing related methods and can also be cast into the appropriate Point, Line or Polygon layer.</returns>
- </member>
- <member name="M:DotSpatial.Controls.MapLayerCollection.Add(DotSpatial.Data.IRaster)">
- <summary>
- Adds the raster to layer collection
- </summary>
- <param name="raster"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.MapLayerCollection.Add(DotSpatial.Data.IImageData)">
- <summary>
- Adds the specified image data as a new layer to the map.
- </summary>
- <param name="image">The image to add as a layer</param>
- <returns>the IMapImageLayer interface for the layer that was added to the map.</returns>
- </member>
- <member name="M:DotSpatial.Controls.MapLayerCollection.CopyTo(DotSpatial.Controls.IMapLayer[],System.Int32)">
- <summary>
- This copies the members of this collection to the specified array index, but
- only if they match the IGeoLayer interface. (Other kinds of layers can be
- added to this collection by casting it to a LayerCollection)
- </summary>
- <param name="inArray">The array of IGeoLayer interfaces to copy values to</param>
- <param name="arrayIndex">The zero-based integer index in the output array to start copying values to</param>
- </member>
- <member name="M:DotSpatial.Controls.MapLayerCollection.Contains(DotSpatial.Controls.IMapLayer)">
- <summary>
- Tests to see if the specified IGeoLayer exists in the current collection
- </summary>
- <param name="item"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.MapLayerCollection.IndexOf(DotSpatial.Controls.IMapLayer)">
- <summary>
- Gets the zero-based integer index of the specified IGeoLayer in this collection
- </summary>
- <param name="item"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.MapLayerCollection.Insert(System.Int32,DotSpatial.Controls.IMapLayer)">
- <summary>
- Inserts an element into the System.Collections.Generic.List<T> at the specified index.
- </summary>
- <param name="index">The zero-based index at which item should be inserted.</param>
- <param name="item">The object to insert. The value can be null for reference types.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-index is greater than System.Collections.Generic.List<T>.Count.</exception>
- <exception cref="T:System.ApplicationException">Unable to insert while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Controls.MapLayerCollection.Move(DotSpatial.Controls.IMapLayer,System.Int32)">
- <summary>
- Moves the given layer to the given position.
- </summary>
- <param name="layer">Layer that gets moved.</param>
- <param name="newPosition">Position, the layer is moved to.</param>
- </member>
- <member name="M:DotSpatial.Controls.MapLayerCollection.Remove(DotSpatial.Controls.IMapLayer)">
- <summary>
- Removes the first occurrence of a specific object from the System.Collections.Generic.List<T>.
- </summary>
- <param name="item">The object to remove from the System.Collections.Generic.List<T>. The value can be null for reference types.</param>
- <returns>true if item is successfully removed; otherwise, false. This method also returns false if item was not
- found in the System.Collections.Generic.List<T>.</returns>
- <exception cref="T:System.ApplicationException">Unable to remove while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Controls.MapLayerCollection.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{DotSpatial.Controls.IMapLayer})">
- <summary>
- Inserts the elements of a collection into the EventList<T> at the specified index.
- </summary>
- <param name="index">The zero-based index at which the new elements should be inserted.</param>
- <param name="collection">The collection whose elements should be inserted into the EventList<T>. The collection itself cannot be null, but it can contain elements that are null, if type T is a reference type.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-index is greater than EventList<T>.Count.</exception>
- <exception cref="T:System.ArgumentNullException">collection is null.</exception>
- <exception cref="T:System.ApplicationException">Unable to insert while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Controls.MapLayerCollection.GetEnumerator">
- <summary>
- An IEnumerator
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.MapLayerCollection.OnBufferChanged(System.Object,DotSpatial.Controls.ClipArgs)">
- <summary>
- This simply forwards the call from a layer to the container
- of this collection (like a MapFrame).
- </summary>
- <param name="sender">The layer that actually changed</param>
- <param name="e"></param>
- </member>
- <member name="E:DotSpatial.Controls.MapLayerCollection.BufferChanged">
- <summary>
- Occurs when the stencil for one of the layers has been updated in a specific region.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapLayerCollection.MapFrame">
- <summary>
- Gets the map frame of this layer collection
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapLayerCollection.Item(System.Int32)">
- <summary>
- The default, indexed value of type T
- </summary>
- <param name="index">The numeric index</param>
- <returns>An object of type T corresponding to the index value specified</returns>
- </member>
- <member name="P:DotSpatial.Controls.MapLayerCollection.IsReadOnly">
- <inheritdoc />
- </member>
- <member name="P:DotSpatial.Controls.MapLayerCollection.ParentGroup">
- <inheritdoc />
- </member>
- <member name="P:DotSpatial.Controls.MapLayerCollection.ProgressHandler">
- <summary>
- Gets or sets the progress handler to report progress for time consuming actions.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapLayerCollection.SelectedLayer">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Controls.GeoLayerEnumerator.#ctor(System.Collections.Generic.IEnumerator{DotSpatial.Symbology.ILayer})">
- <summary>
- Creates a new instance of LayerEnumerator
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.GeoLayerEnumerator.Dispose">
- <summary>
- Calls the Dispose method
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.GeoLayerEnumerator.MoveNext">
- <summary>
- Moves to the next member
- </summary>
- <returns>boolean, true if the enumerator was able to advance</returns>
- </member>
- <member name="M:DotSpatial.Controls.GeoLayerEnumerator.Reset">
- <summary>
- Resets to before the first member
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.GeoLayerEnumerator.Current">
- <summary>
- Retrieves the current member as an ILegendItem
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.IMapRasterLayer">
- <summary>
- GeoImageLayer
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.IMapRasterLayer.Clear(System.Collections.Generic.List{System.Drawing.Rectangle},System.Drawing.Color)">
- <summary>
- Call StartDrawing before using this.
- </summary>
- <param name="rectangles">The rectangular region in pixels to clear.</param>
- <param name= "color">The color to use when clearing. Specifying transparent
- will replace content with transparent pixels.</param>
- </member>
- <member name="M:DotSpatial.Controls.IMapRasterLayer.FinishDrawing">
- <summary>
- Indicates that the drawing process has been finalized and swaps the back buffer
- to the front buffer.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.IMapRasterLayer.StartDrawing(System.Boolean)">
- <summary>
- Copies any current content to the back buffer so that drawing should occur on the
- back buffer (instead of the fore-buffer). Calling draw methods without
- calling this may cause exceptions.
- </summary>
- <param name="preserve">Boolean, true if the front buffer content should be copied to the back buffer
- where drawing will be taking place.</param>
- </member>
- <member name="E:DotSpatial.Controls.IMapRasterLayer.BufferChanged">
- <summary>
- Fires an event that indicates to the parent map-frame that it should first
- redraw the specified clip
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IMapRasterLayer.BackBuffer">
- <summary>
- Gets or sets the back buffer that will be drawn to as part of the initialization process.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IMapRasterLayer.Buffer">
- <summary>
- Gets the current buffer.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IMapRasterLayer.BufferEnvelope">
- <summary>
- Gets or sets the geographic region represented by the buffer
- Calling Initialize will set this automatically.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IMapRasterLayer.BufferRectangle">
- <summary>
- Gets or sets the rectangle in pixels to use as the back buffer.
- Calling Initialize will set this automatically.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IMapRasterLayer.IsInitialized">
- <summary>
- Gets or sets whether the image layer is initialized
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapRasterLayer.#ctor(System.String,DotSpatial.Symbology.IRasterSymbolizer)">
- <summary>
- Creates a new raster layer from the specified fileName
- </summary>
- <param name="fileName"></param>
- <param name="symbolizer"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapRasterLayer.#ctor(DotSpatial.Data.IRaster,DotSpatial.Data.ImageData)">
- <summary>
- Creates a new instance of a MapRasterLayer and the specified image data to use for rendering it.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapRasterLayer.#ctor(DotSpatial.Data.IRaster)">
- <summary>
- Creates a new instance of a Raster layer, and will create a "FallLeaves" image based on the
- raster values.
- </summary>
- <param name="raster">The raster to use</param>
- </member>
- <member name="M:DotSpatial.Controls.MapRasterLayer.Clear(System.Collections.Generic.List{System.Drawing.Rectangle},System.Drawing.Color)">
- <summary>
- Call StartDrawing before using this.
- </summary>
- <param name="rectangles">The rectangular region in pixels to clear.</param>
- <param name= "color">The color to use when clearing. Specifying transparent
- will replace content with transparent pixels.</param>
- </member>
- <member name="M:DotSpatial.Controls.MapRasterLayer.DrawRegions(DotSpatial.Controls.MapArgs,System.Collections.Generic.List{DotSpatial.Data.Extent})">
- <summary>
- This will draw any features that intersect this region. To specify the features
- directly, use OnDrawFeatures. This will not clear existing buffer content.
- For that call Initialize instead.
- </summary>
- <param name="args">A GeoArgs clarifying the transformation from geographic to image space</param>
- <param name="regions">The geographic regions to draw</param>
- </member>
- <member name="M:DotSpatial.Controls.MapRasterLayer.FinishDrawing">
- <summary>
- Indicates that the drawing process has been finalized and swaps the back buffer
- to the front buffer.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapRasterLayer.StartDrawing(System.Boolean)">
- <summary>
- Copies any current content to the back buffer so that drawing should occur on the
- back buffer (instead of the fore-buffer). Calling draw methods without
- calling this may cause exceptions.
- </summary>
- <param name="preserve">Boolean, true if the front buffer content should be copied to the back buffer
- where drawing will be taking place.</param>
- </member>
- <member name="M:DotSpatial.Controls.MapRasterLayer.OnBufferChanged(System.Collections.Generic.List{System.Drawing.Rectangle})">
- <summary>
- Fires the OnBufferChanged event
- </summary>
- <param name="clipRectangles">The Rectangle in pixels</param>
- </member>
- <member name="M:DotSpatial.Controls.MapRasterLayer.OnFinishDrawing">
- <summary>
- Indicates that whatever drawing is going to occur has finished and the contents
- are about to be flipped forward to the front buffer.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapRasterLayer.OnStartDrawing">
- <summary>
- Occurs when a new drawing is started, but after the BackBuffer has been established.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapRasterLayer.DrawWindows(DotSpatial.Controls.MapArgs,System.Collections.Generic.IList{DotSpatial.Data.Extent},System.Collections.Generic.IList{System.Drawing.Rectangle})">
- <summary>
- This draws to the back buffer. If the back buffer doesn't exist, this will create one.
- This will not flip the back buffer to the front.
- </summary>
- <param name="args"></param>
- <param name="regions"></param>
- <param name="clipRectangles"></param>
- </member>
- <member name="E:DotSpatial.Controls.MapRasterLayer.BufferChanged">
- <summary>
- Fires an event that indicates to the parent map-frame that it should first
- redraw the specified clip
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapRasterLayer.BackBuffer">
- <summary>
- Gets or sets the back buffer that will be drawn to as part of the initialization process.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapRasterLayer.Buffer">
- <summary>
- Gets the current buffer.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapRasterLayer.BufferEnvelope">
- <summary>
- Gets or sets the geographic region represented by the buffer
- Calling Initialize will set this automatically.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapRasterLayer.BufferRectangle">
- <summary>
- Gets or sets the rectangle in pixels to use as the back buffer.
- Calling Initialize will set this automatically.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapRasterLayer.IsInitialized">
- <summary>
- Gets or sets whether the image layer is initialized
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.ProjectChangeTracker">
- <summary>
- The ProjectChangeTracker class is responsible for tracking changes in the current project.
- A change occurs if layers are added or removed, map view extent is changed, symbology is changed,
- if layers are selected or unselected or if layer visibility is changed.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.ProjectChangeTracker.Map">
- <summary>
- Gets or sets the map where changes are tracked
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.ProjectChangeTracker.MapPropertyChanged">
- <summary>
- This event fires if some visible properties of the map such as view extent or
- map layer appearance is changed.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.SerializationManager">
- <summary>
- Used for opening and saving project files.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.SerializationManager.#ctor(DotSpatial.Controls.AppManager)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Controls.SerializationManager"/> class.
- </summary>
- <param name="applicationManager">The application manager.</param>
- </member>
- <member name="M:DotSpatial.Controls.SerializationManager.SaveProject(System.String)">
- <summary>
- Serializes portions of the map to file.
- </summary>
- <param name="fileName">Name of the file.</param>
- </member>
- <member name="M:DotSpatial.Controls.SerializationManager.OpenProject(System.String)">
- <summary>
- Deserializes the map from a file.
- </summary>
- <param name="fileName">Name of the file.</param>
- </member>
- <member name="M:DotSpatial.Controls.SerializationManager.GetCustomSetting``1(System.String,``0)">
- <summary>
- Gets the custom setting.
- </summary>
- <typeparam name="T"></typeparam>
- <param name="uniqueName">Name of the unique key.</param>
- <param name="defaultValue">The default value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.SerializationManager.SetCustomSetting(System.String,System.Object)">
- <summary>
- Sets the custom setting.
- </summary>
- <param name="uniqueName">Name of the unique key.</param>
- <param name="value">The value.</param>
- </member>
- <member name="M:DotSpatial.Controls.SerializationManager.IsCustomSettingPresent(System.String)">
- <summary>
- Determines whether a uniqueName is already in use.
- </summary>
- <param name="uniqueName">Key to test.</param>
- <returns>
- <c>true</c> if uniqueName is already in use; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:DotSpatial.Controls.SerializationManager.New">
- <summary>
- Creates a new project.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.SerializationManager.StartTrackingChanges">
- <summary>
- Starts tracking changes in the current project
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.SerializationManager.ResetMapProjection">
- <summary>
- This method re-sets the map projection and re-projects all map
- layers to the projection that is specified in the project file
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.SerializationManager.OnDeserializing(DotSpatial.Controls.SerializingEventArgs)">
- <summary>
- Triggers the Deserializing event.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.SerializationManager.OnSerializing(DotSpatial.Controls.SerializingEventArgs)">
- <summary>
- Triggers the Serializing event.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.SerializationManager.OnNewProject(DotSpatial.Controls.SerializingEventArgs)">
- <summary>
- Triggers the NewProjectCreated event.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.SerializationManager.OnIsDirtyChanged">
- <summary>
- Triggers the IsDirtyChanged event.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.SerializationManager.OpenDialogFilterText">
- <summary>
- Filter text for an open project file dialog
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.SerializationManager.SaveDialogFilterText">
- <summary>
- Filter text for a save project as dialog
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.SerializationManager.SaveDialogFilterFormat">
- <summary>
- Gets the save dialog filter format.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.SerializationManager.OpenDialogFilterFormat">
- <summary>
- Gets the open dialog filter format.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.SerializationManager.CurrentProjectDirectory">
- <summary>
- Gets or sets the current project directory.
- </summary>
- <value>
- The current project directory.
- </value>
- </member>
- <member name="P:DotSpatial.Controls.SerializationManager.CurrentProjectFile">
- <summary>
- Gets or sets the current project file.
- </summary>
- <value>
- The current project file.
- </value>
- </member>
- <member name="P:DotSpatial.Controls.SerializationManager.IsDirty">
- <summary>
- True if there are some unsaved changes in the current project,
- False otherwise
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.SerializationManager.SaveProjectFileProviders">
- <summary>
- Gets the save project file providers.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.SerializationManager.OpenProjectFileProviders">
- <summary>
- Gets the open project file providers.
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.SerializationManager.Serializing">
- <summary>
- Occurs when the appmanager is being serialized, allowing a plugin to view and modify custom settings that will be stored with the appmanager.
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.SerializationManager.Deserializing">
- <summary>
- Occurs when the appmanager is being deserialized. allowing a plugin to deal with any custom settings that were deserialized.
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.SerializationManager.NewProjectCreated">
- <summary>
- Occurs when a new project is created using the New() method. allowing a plugin to perform initialization associated with the
- creation of a new project
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.SerializationManager.IsDirtyChanged">
- <summary>
- Occurs when the dirty (unsaved) state of the current project is changed. This occurs when layers are added or removed to the map,
- when layer symbology is changed or when the map view extents are changed.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.ShapefileLayerProvider">
- <summary>
- ShapefileLayerProvider
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.ShapefileLayerProvider.CreateNew(System.String,DotSpatial.Topology.FeatureType,System.Boolean,System.Collections.Generic.ICollection{DotSpatial.Symbology.ILayer},DotSpatial.Data.IProgressHandler)">
- <summary>
- Not Implemented yet
- </summary>
- <param name="fileName"></param>
- <param name="featureType"></param>
- <param name="inRam"></param>
- <param name="container"></param>
- <param name="progressHandler"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.ShapefileLayerProvider.OpenLayer(System.String,System.Boolean,System.Collections.Generic.ICollection{DotSpatial.Symbology.ILayer},DotSpatial.Data.IProgressHandler)">
- <summary>
- Opens a shapefile, but returns it as a FeatureLayer
- </summary>
- <param name="fileName">The string fileName</param>
- <param name="inRam">Boolean, if this is true it will attempt to open the entire layer in memory.</param>
- <param name="container">A container to hold this layer.</param>
- <param name="progressHandler">The progress handler that should receive status messages</param>
- <returns>An IFeatureLayer</returns>
- </member>
- <member name="P:DotSpatial.Controls.ShapefileLayerProvider.DialogReadFilter">
- <summary>
- Gets a dialog read filter that lists each of the file type descriptions and file extensions, delimeted
- by the | symbol. Each will appear in DotSpatial's open file dialog filter, preceeded by the name provided
- on this object.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.ShapefileLayerProvider.DialogWriteFilter">
- <summary>
- Gets a dialog filter that lists each of the file type descriptions and extensions for a Save File Dialog.
- Each will appear in DotSpatial's open file dialog filter, preceeded by the name provided on this object.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.ShapefileLayerProvider.Name">
- <summary>
- Gets a prefereably short name that identifies this data provider. Example might be GDAL.
- This will be prepended to each of the DialogReadFilter members from this plugin.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.ShapefileLayerProvider.Description">
- <summary>
- This is a basic description that will fall next to your plugin in the Add Other Data dialog.
- This will only be shown if your plugin does not supply a DialogReadFilter.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.ClipArgs.#ctor(System.Collections.Generic.List{System.Drawing.Rectangle})">
- <summary>
- Creates a new instance of ClipArgs
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.ClipArgs.#ctor(System.Drawing.Rectangle)">
- <summary>
- Creates a ClipArg from a single rectangle instead of a list of rectangles
- </summary>
- <param name="clipRectangle">The clip rectangle</param>
- </member>
- <member name="P:DotSpatial.Controls.ClipArgs.ClipRectangles">
- <summary>
- Gets the ClipRectangle for this event.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.DuplicationPreventer">
- <summary>
- Contains methods to remove duplicates
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.DuplicationPreventer.Clean(System.Collections.Generic.IEnumerable{System.Drawing.PointF})">
- <summary>
- Cycles through the PointF points, where necessary and removes duplicate points
- that are found at the integer level.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.DuplicationPreventer.Clean(System.Collections.Generic.IEnumerable{System.Double[]})">
- <summary>
- Cleans the enumerable of points by removing duplicates
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.IMapFeatureLayer">
- <summary>
- This is should not be instantiated because it cannot in itself perform the necessary functions.
- Instead, most of the specified functionality must be implemented in the more specific classes.
- This is also why there is no direct constructor for this class. You can use the static
- "FromFile" or "FromFeatureLayer" to create FeatureLayers from a file.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IMapFeatureLayer.LabelLayer">
- <summary>
- Gets or sets the label layer that is associated with this feature layer.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.IMapLineLayer">
- <summary>
- IGeoLineLayer
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.IMapPointLayer">
- <summary>
- IGeoPointLayer
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.IMapPolygonLayer">
- <summary>
- IGeoPolygonLayer
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapLineLayer.#ctor">
- <summary>
- Creates an empty line layer with a Line FeatureSet that has no members.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapLineLayer.#ctor(DotSpatial.Data.IFeatureSet)">
- <summary>
- Constructor
- </summary>
- <param name="inFeatureSet"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapLineLayer.#ctor(DotSpatial.Data.IFeatureSet,System.Collections.Generic.ICollection{DotSpatial.Symbology.ILayer})">
- <summary>
- Constructor that also shows progress
- </summary>
- <param name="featureSet">A featureset that contains lines</param>
- <param name="container">An IContainer that the line layer should be created in</param>
- </member>
- <member name="M:DotSpatial.Controls.MapLineLayer.#ctor(DotSpatial.Data.IFeatureSet,System.Collections.Generic.ICollection{DotSpatial.Symbology.ILayer},System.Boolean)">
- <summary>
- Creates a GeoLineLayer constructor, but passes the boolean notFinished variable to indicate
- whether or not this layer should fire the FinishedLoading event.
- </summary>
- <param name="featureSet"></param>
- <param name="container"></param>
- <param name="notFinished"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapLineLayer.DrawRegions(DotSpatial.Controls.MapArgs,System.Collections.Generic.List{DotSpatial.Data.Extent})">
- <summary>
- This will draw any features that intersect this region. To specify the features
- directly, use OnDrawFeatures. This will not clear existing buffer content.
- For that call Initialize instead.
- </summary>
- <param name="args">A GeoArgs clarifying the transformation from geographic to image space</param>
- <param name="regions">The geographic regions to draw</param>
- </member>
- <member name="M:DotSpatial.Controls.MapLineLayer.Clear(System.Collections.Generic.List{System.Drawing.Rectangle},System.Drawing.Color)">
- <summary>
- Call StartDrawing before using this.
- </summary>
- <param name="rectangles">The rectangular region in pixels to clear.</param>
- <param name= "color">The color to use when clearing. Specifying transparent
- will replace content with transparent pixels.</param>
- </member>
- <member name="M:DotSpatial.Controls.MapLineLayer.CreateLayerFromSelectedFeatures(DotSpatial.Symbology.IFeatureLayer@)">
- <summary>
- This is testing the idea of using an input parameter type that is marked as out
- instead of a return type.
- </summary>
- <param name="result">The result of the creation</param>
- <returns>Boolean, true if a layer can be created</returns>
- </member>
- <member name="M:DotSpatial.Controls.MapLineLayer.CreateLayerFromSelectedFeatures(DotSpatial.Controls.MapLineLayer@)">
- <summary>
- This is the strong typed version of the same process that is specific to geo point layers.
- </summary>
- <param name="result">The new GeoPointLayer to be created</param>
- <returns>Boolean, true if there were any values in the selection</returns>
- </member>
- <member name="M:DotSpatial.Controls.MapLineLayer.DrawFeatures(DotSpatial.Controls.MapArgs,System.Collections.Generic.List{DotSpatial.Data.IFeature},System.Collections.Generic.List{System.Drawing.Rectangle},System.Boolean)">
- <summary>
- If useChunks is true, then this method
- </summary>
- <param name="args">The GeoArgs that control how these features should be drawn.</param>
- <param name="features">The features that should be drawn.</param>
- <param name="clipRectangles">If an entire chunk is drawn and an update is specified, this clarifies the changed rectangles.</param>
- <param name="useChunks">Boolean, if true, this will refresh the buffer in chunks.</param>
- </member>
- <member name="M:DotSpatial.Controls.MapLineLayer.DrawFeatures(DotSpatial.Controls.MapArgs,System.Collections.Generic.List{System.Int32},System.Collections.Generic.List{System.Drawing.Rectangle},System.Boolean)">
- <summary>
- If useChunks is true, then this method
- </summary>
- <param name="args">The GeoArgs that control how these features should be drawn.</param>
- <param name="indices">The features that should be drawn.</param>
- <param name="clipRectangles">If an entire chunk is drawn and an update is specified, this clarifies the changed rectangles.</param>
- <param name="useChunks">Boolean, if true, this will refresh the buffer in chunks.</param>
- </member>
- <member name="M:DotSpatial.Controls.MapLineLayer.BuildLineString(System.Drawing.Drawing2D.GraphicsPath,DotSpatial.Topology.IBasicLineString,System.Double,System.Double,System.Double,System.Double)">
- <summary>
- Builds a linestring into the graphics path, using minX, maxY, dx and dy for the transformations.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapLineLayer.OnBufferChanged(System.Collections.Generic.List{System.Drawing.Rectangle})">
- <summary>
- Fires the OnBufferChanged event
- </summary>
- <param name="clipRectangles">The Rectangle in pixels</param>
- </member>
- <member name="M:DotSpatial.Controls.MapLineLayer.OnFinishDrawing">
- <summary>
- Indiciates that whatever drawing is going to occur has finished and the contents
- are about to be flipped forward to the front buffer.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapLineLayer.OnCreateLabels">
- <summary>
- A default method to generate a label layer.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapLineLayer.OnStartDrawing">
- <summary>
- Occurs when a new drawing is started, but after the BackBuffer has been established.
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.MapLineLayer.BufferChanged">
- <summary>
- Fires an event that indicates to the parent map-frame that it should first
- redraw the specified clip
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapLineLayer.BackBuffer">
- <summary>
- Gets or sets the back buffer that will be drawn to as part of the initialization process.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapLineLayer.Buffer">
- <summary>
- Gets the current buffer.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapLineLayer.BufferEnvelope">
- <summary>
- Gets or sets the geographic region represented by the buffer
- Calling Initialize will set this automatically.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapLineLayer.BufferRectangle">
- <summary>
- Gets or sets the rectangle in pixels to use as the back buffer.
- Calling Initialize will set this automatically.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapLineLayer.NumChunks">
- <summary>
- Gets an integer number of chunks for this layer.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapLineLayer.LabelLayer">
- <summary>
- Gets or sets the label layer that is associated with this line layer.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.MapPointLayer">
- <summary>
- This is a specialized FeatureLayer that specifically handles point drawing
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapPointLayer.#ctor">
- <summary>
- This creates a blank MapPointLayer with the DataSet set to an empty new featureset of the Point featuretype.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapPointLayer.#ctor(DotSpatial.Data.IFeatureSet)">
- <summary>
- Creates a new instance of a GeoPointLayer without sending any status messages
- </summary>
- <param name="featureSet">The IFeatureLayer of data values to turn into a graphical GeoPointLayer</param>
- </member>
- <member name="M:DotSpatial.Controls.MapPointLayer.#ctor(DotSpatial.Data.IFeatureSet,System.Collections.Generic.ICollection{DotSpatial.Symbology.ILayer})">
- <summary>
- Creates a new instance of the point layer where the container is specified
- </summary>
- <param name="featureSet"></param>
- <param name="container"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapPointLayer.#ctor(DotSpatial.Data.IFeatureSet,System.Collections.Generic.ICollection{DotSpatial.Symbology.ILayer},System.Boolean)">
- <summary>
- Creates a new instance of the point layer where the container is specified
- </summary>
- <param name="featureSet"></param>
- <param name="container"></param>
- <param name="notFinished"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapPointLayer.DrawRegions(DotSpatial.Controls.MapArgs,System.Collections.Generic.List{DotSpatial.Data.Extent})">
- <summary>
- This will draw any features that intersect this region. To specify the features
- directly, use OnDrawFeatures. This will not clear existing buffer content.
- For that call Initialize instead.
- </summary>
- <param name="args">A GeoArgs clarifying the transformation from geographic to image space</param>
- <param name="regions">The geographic regions to draw</param>
- </member>
- <member name="M:DotSpatial.Controls.MapPointLayer.Clear(System.Collections.Generic.List{System.Drawing.Rectangle},System.Drawing.Color)">
- <summary>
- Call StartDrawing before using this.
- </summary>
- <param name="rectangles">The rectangular region in pixels to clear.</param>
- <param name= "color">The color to use when clearing. Specifying transparent
- will replace content with transparent pixels.</param>
- </member>
- <member name="M:DotSpatial.Controls.MapPointLayer.CreateLayerFromSelectedFeatures(DotSpatial.Symbology.IFeatureLayer@)">
- <summary>
- This is testing the idea of using an input parameter type that is marked as out
- instead of a return type.
- </summary>
- <param name="result">The result of the creation</param>
- <returns>Boolean, true if a layer can be created</returns>
- </member>
- <member name="M:DotSpatial.Controls.MapPointLayer.CreateLayerFromSelectedFeatures(DotSpatial.Controls.MapPointLayer@)">
- <summary>
- This is the strong typed version of the same process that is specific to geo point layers.
- </summary>
- <param name="result">The new GeoPointLayer to be created</param>
- <returns>Boolean, true if there were any values in the selection</returns>
- </member>
- <member name="M:DotSpatial.Controls.MapPointLayer.DrawFeatures(DotSpatial.Controls.MapArgs,System.Collections.Generic.List{DotSpatial.Data.IFeature},System.Collections.Generic.List{System.Drawing.Rectangle},System.Boolean)">
- <summary>
- If useChunks is true, then this method
- </summary>
- <param name="args">The GeoArgs that control how these features should be drawn.</param>
- <param name="features">The features that should be drawn.</param>
- <param name="clipRectangles">If an entire chunk is drawn and an update is specified, this clarifies the changed rectangles.</param>
- <param name="useChunks">Boolean, if true, this will refresh the buffer in chunks.</param>
- </member>
- <member name="M:DotSpatial.Controls.MapPointLayer.DrawFeatures(DotSpatial.Controls.MapArgs,System.Collections.Generic.List{System.Int32},System.Collections.Generic.List{System.Drawing.Rectangle},System.Boolean)">
- <summary>
- If useChunks is true, then this method
- </summary>
- <param name="args">The GeoArgs that control how these features should be drawn.</param>
- <param name="indices">The features that should be drawn.</param>
- <param name="clipRectangles">If an entire chunk is drawn and an update is specified, this clarifies the changed rectangles.</param>
- <param name="useChunks">Boolean, if true, this will refresh the buffer in chunks.</param>
- </member>
- <member name="M:DotSpatial.Controls.MapPointLayer.FinishDrawing">
- <summary>
- Indicates that the drawing process has been finalized and swaps the back buffer
- to the front buffer.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapPointLayer.StartDrawing(System.Boolean)">
- <summary>
- Copies any current content to the back buffer so that drawing should occur on the
- back buffer (instead of the fore-buffer). Calling draw methods without
- calling this may cause exceptions.
- </summary>
- <param name="preserve">Boolean, true if the front buffer content should be copied to the back buffer
- where drawing will be taking place.</param>
- </member>
- <member name="M:DotSpatial.Controls.MapPointLayer.OnBufferChanged(System.Collections.Generic.List{System.Drawing.Rectangle})">
- <summary>
- Fires the OnBufferChanged event
- </summary>
- <param name="clipRectangles">The Rectangle in pixels</param>
- </member>
- <member name="M:DotSpatial.Controls.MapPointLayer.OnCreateLabels">
- <summary>
- A default method to generate a label layer.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapPointLayer.OnFinishDrawing">
- <summary>
- Indiciates that whatever drawing is going to occur has finished and the contents
- are about to be flipped forward to the front buffer.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapPointLayer.OnStartDrawing">
- <summary>
- Occurs when a new drawing is started, but after the BackBuffer has been established.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapPointLayer.DrawPoint(System.Double,System.Double,DotSpatial.Controls.MapArgs,DotSpatial.Symbology.IPointSymbolizer,System.Drawing.Graphics,System.Drawing.Drawing2D.Matrix)">
- <summary>
- Draws a point at the given location.
- </summary>
- <param name="ptX">X-Coordinate of the point, that should be drawn.</param>
- <param name="ptY">Y-Coordinate of the point, that should be drawn.</param>
- <param name="e">MapArgs for calculating the scaleSize.</param>
- <param name="ps">PointSymbolizer with which the point gets drawn.</param>
- <param name="g">Graphics-Object that should be used by the PointSymbolizer.</param>
- <param name="origTransform">The original transformation that is used to position the point.</param>
- </member>
- <member name="M:DotSpatial.Controls.MapPointLayer.OpenFile(System.String,DotSpatial.Data.IProgressHandler)">
- <summary>
- Attempts to create a new GeoPointLayer using the specified file. If the filetype is not
- does not generate a point layer, an exception will be thrown.
- </summary>
- <param name="fileName">A string fileName to create a point layer for.</param>
- <param name="progressHandler">Any valid implementation of IProgressHandler for receiving progress messages</param>
- <returns>A GeoPointLayer created from the specified fileName.</returns>
- </member>
- <member name="M:DotSpatial.Controls.MapPointLayer.OpenFile(System.String)">
- <summary>
- Attempts to create a new GeoPointLayer using the specified file. If the filetype is not
- does not generate a point layer, an exception will be thrown.
- </summary>
- <param name="fileName">A string fileName to create a point layer for.</param>
- <returns>A GeoPointLayer created from the specified fileName.</returns>
- </member>
- <member name="E:DotSpatial.Controls.MapPointLayer.BufferChanged">
- <summary>
- Occurs when drawing content has changed on the buffer for this layer
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapPointLayer.BackBuffer">
- <summary>
- Gets or sets the back buffer that will be drawn to as part of the initialization process.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapPointLayer.Buffer">
- <summary>
- Gets the current buffer.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapPointLayer.BufferEnvelope">
- <summary>
- Gets or sets the geographic region represented by the buffer
- Calling Initialize will set this automatically.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapPointLayer.BufferRectangle">
- <summary>
- Gets or sets the rectangle in pixels to use as the back buffer.
- Calling Initialize will set this automatically.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapPointLayer.LabelLayer">
- <summary>
- Gets or sets the label layer that is associated with this point layer.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapPolygonLayer.#ctor">
- <summary>
- Creates a new empty MapPolygonLayer with an empty FeatureSet of FeatureType Polygon
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapPolygonLayer.#ctor(DotSpatial.Data.IFeatureSet)">
- <summary>
- Constructor
- </summary>
- <param name="inFeatureSet"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapPolygonLayer.#ctor(DotSpatial.Data.IFeatureSet,System.Collections.Generic.ICollection{DotSpatial.Symbology.ILayer})">
- <summary>
- Constructor that also shows progress
- </summary>
- <param name="featureSet">A featureset that contains lines</param>
- <param name="container">An IContainer that the line layer should be created in</param>
- </member>
- <member name="M:DotSpatial.Controls.MapPolygonLayer.#ctor(DotSpatial.Data.IFeatureSet,System.Collections.Generic.ICollection{DotSpatial.Symbology.ILayer},System.Boolean)">
- <summary>
- Constructor that also shows progress
- </summary>
- <param name="featureSet">A featureset that contains lines</param>
- <param name="container">An IContainer that the line layer should be created in</param>
- <param name="notFinished"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapPolygonLayer.DrawRegions(DotSpatial.Controls.MapArgs,System.Collections.Generic.List{DotSpatial.Data.Extent})">
- <summary>
- This will draw any features that intersect this region. To specify the features
- directly, use OnDrawFeatures. This will not clear existing buffer content.
- For that call Initialize instead.
- </summary>
- <param name="args">A GeoArgs clarifying the transformation from geographic to image space</param>
- <param name="regions">The geographic regions to draw</param>
- </member>
- <member name="M:DotSpatial.Controls.MapPolygonLayer.Clear(System.Collections.Generic.List{System.Drawing.Rectangle},System.Drawing.Color)">
- <summary>
- Call StartDrawing before using this.
- </summary>
- <param name="rectangles">The rectangular region in pixels to clear.</param>
- <param name= "color">The color to use when clearing. Specifying transparent
- will replace content with transparent pixels.</param>
- </member>
- <member name="M:DotSpatial.Controls.MapPolygonLayer.CreateLayerFromSelectedFeatures(DotSpatial.Symbology.IFeatureLayer@)">
- <summary>
- This is testing the idea of using an input parameter type that is marked as out
- instead of a return type.
- </summary>
- <param name="result">The result of the creation</param>
- <returns>Boolean, true if a layer can be created</returns>
- </member>
- <member name="M:DotSpatial.Controls.MapPolygonLayer.CreateLayerFromSelectedFeatures(DotSpatial.Controls.MapPolygonLayer@)">
- <summary>
- This is the strong typed version of the same process that is specific to geo point layers.
- </summary>
- <param name="result">The new GeoPointLayer to be created</param>
- <returns>Boolean, true if there were any values in the selection</returns>
- </member>
- <member name="M:DotSpatial.Controls.MapPolygonLayer.DrawFeatures(DotSpatial.Controls.MapArgs,System.Collections.Generic.List{DotSpatial.Data.IFeature},System.Collections.Generic.List{System.Drawing.Rectangle},System.Boolean)">
- <summary>
- If useChunks is true, then this method
- </summary>
- <param name="args">The GeoArgs that control how these features should be drawn.</param>
- <param name="features">The features that should be drawn.</param>
- <param name="clipRectangles">If an entire chunk is drawn and an update is specified,
- this clarifies the changed rectangles.</param>
- <param name="useChunks">Boolean, if true, this will refresh the buffer in chunks.</param>
- </member>
- <member name="M:DotSpatial.Controls.MapPolygonLayer.DrawFeatures(DotSpatial.Controls.MapArgs,System.Collections.Generic.List{System.Int32},System.Collections.Generic.List{System.Drawing.Rectangle},System.Boolean)">
- <summary>
- If useChunks is true, then this method
- </summary>
- <param name="args">The GeoArgs that control how these features should be drawn.</param>
- <param name="indices">The features that should be drawn.</param>
- <param name="clipRectangles">If an entire chunk is drawn and an update is specified, this clarifies the changed rectangles.</param>
- <param name="useChunks">Boolean, if true, this will refresh the buffer in chunks.</param>
- </member>
- <member name="M:DotSpatial.Controls.MapPolygonLayer.FinishDrawing">
- <summary>
- Indicates that the drawing process has been finalized and swaps the back buffer
- to the front buffer.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapPolygonLayer.StartDrawing(System.Boolean)">
- <summary>
- Copies any current content to the back buffer so that drawing should occur on the
- back buffer (instead of the fore-buffer). Calling draw methods without
- calling this may cause exceptions.
- </summary>
- <param name="preserve">Boolean, true if the front buffer content should be copied to the back buffer
- where drawing will be taking place.</param>
- </member>
- <member name="M:DotSpatial.Controls.MapPolygonLayer.OnBufferChanged(System.Collections.Generic.List{System.Drawing.Rectangle})">
- <summary>
- Fires the OnBufferChanged event
- </summary>
- <param name="clipRectangles">The Rectangle in pixels</param>
- </member>
- <member name="M:DotSpatial.Controls.MapPolygonLayer.OnCreateLabels">
- <summary>
- A default method to generate a label layer.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapPolygonLayer.OnStartDrawing">
- <summary>
- Occurs when a new drawing is started, but after the BackBuffer has been established.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapPolygonLayer.DrawPaths(DotSpatial.Controls.MapArgs,System.Collections.Generic.IList{System.Drawing.Drawing2D.GraphicsPath})">
- <summary>
- Draws the GraphicsPaths. Before we were effectively "re-creating" the same geometric
- </summary>
- <param name="e"></param>
- <param name="paths"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapPolygonLayer.BuildPolygon(System.Double[],DotSpatial.Data.ShapeRange,System.Drawing.Drawing2D.GraphicsPath,DotSpatial.Controls.MapArgs,DotSpatial.Controls.SoutherlandHodgman)">
- <summary>
- Appends the specified polygon to the graphics path.
- </summary>
- </member>
- <member name="E:DotSpatial.Controls.MapPolygonLayer.BufferChanged">
- <summary>
- Fires an event that indicates to the parent map-frame that it should first
- redraw the specified clip
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapPolygonLayer.BackBuffer">
- <summary>
- Gets or sets the back buffer that will be drawn to as part of the initialization process.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapPolygonLayer.Buffer">
- <summary>
- Gets the current buffer.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapPolygonLayer.BufferEnvelope">
- <summary>
- Gets or sets the geographic region represented by the buffer
- Calling Initialize will set this automatically.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapPolygonLayer.BufferRectangle">
- <summary>
- Gets or sets the rectangle in pixels to use as the back buffer.
- Calling Initialize will set this automatically.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapPolygonLayer.ProgressReportingEnabled">
- <summary>
- true if the layer component reports progress messages, false otherwise
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapPolygonLayer.LabelLayer">
- <summary>
- Gets or sets the label layer that is associated with this polygon layer.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.SoutherlandHodgman">
- <summary>
- DoutherlandHodgmanClipper
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.SoutherlandHodgman.#ctor(System.Drawing.Rectangle)">
- <summary>
- Create SoutherlandHodgman polygon clipper with clipping rectangle
- </summary>
- <param name="clipRect"></param>
- </member>
- <member name="M:DotSpatial.Controls.SoutherlandHodgman.#ctor">
- <summary>
- Create southerlandHodgman polygon clipper with default clipping rectangle
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.SoutherlandHodgman.Clip(System.Collections.Generic.List{System.Drawing.PointF})">
- <summary>
- Calculates the Southerland-Hodgman clip using the actual drawing coordinates.
- This hopefully will be much faster than NTS which seems unncessarilly slow to calculate.
- http://www.codeguru.com/cpp/misc/misc/graphics/article.php/c8965
- </summary>
- <param name="points"></param>
- <returns>A modified list of points that has been clipped to the drawing bounds</returns>
- </member>
- <member name="M:DotSpatial.Controls.SoutherlandHodgman.Clip(System.Collections.Generic.List{System.Double[]})">
- <summary>
- Calculates the Southerland-Hodgman clip using the actual drawing coordinates.
- This specific overload works with arrays of doubles instead of PointF structures.
- This hopefully will be much faster than NTS which seems unncessarilly slow to calculate.
- http://www.codeguru.com/cpp/misc/misc/graphics/article.php/c8965
- </summary>
- <param name="vertexValues">The list of arrays of doubles where the X index is 0 and the Y index is 1.</param>
- <returns>A modified list of points that has been clipped to the drawing bounds</returns>
- </member>
- <member name="P:DotSpatial.Controls.SoutherlandHodgman.ClippingRectangle">
- <summary>
- Get or set the clipping rectangle used in subsequent Clip calls.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.MapFunctionClickZoom">
- <summary>
- A MapFunction that can zoom into the map using left mouse clicks or rectangle dragging. It zooms out on right mouse clicks.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFunctionClickZoom.#ctor(DotSpatial.Controls.IMap)">
- <summary>
- Creates a new instance of SelectTool
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFunctionClickZoom.OnMouseDown(DotSpatial.Controls.GeoMouseArgs)">
- <summary>
- Handles the MouseDown
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapFunctionClickZoom.OnMouseMove(DotSpatial.Controls.GeoMouseArgs)">
- <summary>
- Handles MouseMove
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapFunctionClickZoom.OnMouseUp(DotSpatial.Controls.GeoMouseArgs)">
- <summary>
- Handles the Mouse Up situation
- </summary>
- <param name="e"></param>
- </member>
- <member name="T:DotSpatial.Controls.FunctionMode">
- <summary>
- DefaultTools
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.FunctionMode.Info">
- <summary>
- Mousewheel still zooms the map, but left clicking brings items into the view.
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.FunctionMode.ZoomIn">
- <summary>
- Zooms into the map with the left mouse button and zooms out with the right mouse button.
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.FunctionMode.ZoomOut">
- <summary>
- Zooms out by clicking the left mouse button.
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.FunctionMode.ZoomPan">
- <summary>
- Zooms by scrolling the mouse wheel and pans by pressing the mouse wheel and moving the mouse.
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.FunctionMode.Pan">
- <summary>
- Pans the map with the left mouse button, context with the right and zooms with the mouse wheel
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.FunctionMode.Select">
- <summary>
- Selects shapes with the left mouse button, context with the right and zooms with the mouse wheel
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.FunctionMode.Label">
- <summary>
- Left button selects, moves or edits, right produces a context menu
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.FunctionMode.None">
- <summary>
- Disables all the tools
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.GeoMouseArgs.#ctor(System.Windows.Forms.MouseEventArgs,DotSpatial.Controls.IMap)">
- <summary>
- Creates a new instance of MouseArgs
- </summary>
- <param name="e"></param>
- <param name="inMap"></param>
- </member>
- <member name="P:DotSpatial.Controls.GeoMouseArgs.GeographicLocation">
- <summary>
- Gets the position of the Mouse Event in geographic coordinates
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.GeoMouseArgs.Map">
- <summary>
- Gets a simple interface for the map where these events were generated
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.GeoMouseArgs.Handled">
- <summary>
- Gets or sets a handled. If this is set to true, then the mouse event is considered to
- be handled and will not be passed to any other functions in the stack.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.MapFunctionGlyph">
- <summary>
- This is a glyph on the map that if you click on it, it will launch the PluginDialog.
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.MapFunctionGlyph._previousCursor">
- <summary>
- This is the cursor that was the cursor before we did anything.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFunctionGlyph.#ctor">
- <summary>
- Creates a new instance of the GlyphFunction
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFunctionGlyph.#ctor(DotSpatial.Controls.Map)">
- <summary>
- Creates a new instance of a GLyphFunction with the specified Map
- </summary>
- <param name="map"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapFunctionGlyph.OnDraw(DotSpatial.Controls.MapDrawArgs)">
- <summary>
- Draws the glyph on the map.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapFunctionGlyph.OnDrawGlyph(System.Windows.Forms.PaintEventArgs)">
- <summary>
- The drawing space is only the size of the GlyphBounds.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapFunctionGlyph.OnDrawGlyphLit(System.Windows.Forms.PaintEventArgs)">
- <summary>
- When the mouse moves over a glyph, it should light up or change to show it is clickable.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFunctionGlyph.OnGlpyhClick(DotSpatial.Controls.GeoMouseArgs)">
- <summary>
- Occurs when the mouse clicks on the glyph
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapFunctionGlyph.OnGlyphMouseEnter(DotSpatial.Controls.GeoMouseArgs)">
- <summary>
- Occurs when the mouse leaves the glyph
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapFunctionGlyph.OnGlyphMouseLeave(DotSpatial.Controls.GeoMouseArgs)">
- <summary>
- Occurs when the mouse enters the glyph
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapFunctionGlyph.OnMouseDown(DotSpatial.Controls.GeoMouseArgs)">
- <summary>
- Even though we don't take action here, we need to indicate that we handled the event so that the other
- functions that my be active don't do anything for this part.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapFunctionGlyph.OnMouseMove(DotSpatial.Controls.GeoMouseArgs)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Controls.MapFunctionGlyph.OnMouseUp(DotSpatial.Controls.GeoMouseArgs)">
- <inheritdoc/>
- </member>
- <member name="P:DotSpatial.Controls.MapFunctionGlyph.Cursor">
- <summary>
- The cursor to use when the mouse is over this glyph.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapFunctionGlyph.GlpyhBounds">
- <summary>
- This should be overridden by the specific glyph so they don't overlap and appear where they should.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapFunctionGlyph.HasMouse">
- <summary>
- Gets or sets a Boolean indicating whether or not this glyph currently holds the mouse
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapFunctionGlyph.LitImage">
- <summary>
- Unless the OnDrawGlyphLit method is overridden, this is drawn when the mouse is over the image.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapFunctionGlyph.NormalImage">
- <summary>
- Unless the OnDrawGlyph method is overridden, this is drawn. If no LitImage is specified,
- then this image will be drawn also for the LitImage case.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.MapFunctionIdentify">
- <summary>
- Map Identify Function. Used to show information about map layers under map cursor.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFunctionIdentify.#ctor(DotSpatial.Controls.IMap)">
- <summary>
- Creates a new instance of IdentifyFunction
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFunctionIdentify.OnMouseUp(DotSpatial.Controls.GeoMouseArgs)">
- <summary>
- Overrides the OnMouseUp event to handle the situation where we are trying to
- identify the vector features in the specified area.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.MapFunctionLabelSelect">
- <summary>
- A MapFunction that allows labels to be selected.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFunctionLabelSelect.#ctor(DotSpatial.Controls.IMap)">
- <summary>
- Initializes a new instance of the MapFunctionLabelSelect class.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFunctionLabelSelect.OnDraw(DotSpatial.Controls.MapDrawArgs)">
- <summary>
-
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapFunctionLabelSelect.OnMouseDown(DotSpatial.Controls.GeoMouseArgs)">
- <summary>
- Handles the MouseDown
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapFunctionLabelSelect.OnMouseMove(DotSpatial.Controls.GeoMouseArgs)">
- <summary>
- Handles MouseMove
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapFunctionLabelSelect.OnMouseUp(DotSpatial.Controls.GeoMouseArgs)">
- <summary>
- Handles the Mouse Up situation
- </summary>
- <param name="e"></param>
- </member>
- <member name="P:DotSpatial.Controls.MapFunctionLabelSelect.SelectionEnvelope">
- <summary>
- Selection envelope
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.MapFunctionPan">
- <summary>
- A MapFunction that can pan the map.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFunctionPan.#ctor(DotSpatial.Controls.IMap)">
- <summary>
- Initializes a new instance of the MapFunctionPan class.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFunctionPan.OnMouseDown(DotSpatial.Controls.GeoMouseArgs)">
- <summary>
- Handles the actions that the tool controls during the OnMouseDown event
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapFunctionPan.OnMouseMove(DotSpatial.Controls.GeoMouseArgs)">
- <summary>
- Handles the mouse move event, changing the viewing extents to match the movements
- of the mouse if the left mouse button is down.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapFunctionPan.OnMouseUp(DotSpatial.Controls.GeoMouseArgs)">
- <summary>
- Mouse Up
- </summary>
- <param name="e"></param>
- </member>
- <member name="P:DotSpatial.Controls.MapFunctionPan.IsDragging">
- <summary>
- This indicates that this tool is currently being used.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.MapFunctionSelect">
- <summary>
- SelectTool
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFunctionSelect.#ctor(DotSpatial.Controls.IMap)">
- <summary>
- Creates a new instance of SelectTool
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFunctionSelect.OnDraw(DotSpatial.Controls.MapDrawArgs)">
- <summary>
-
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapFunctionSelect.OnMouseDown(DotSpatial.Controls.GeoMouseArgs)">
- <summary>
- Handles the MouseDown
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapFunctionSelect.OnKeyDown(System.Windows.Forms.KeyEventArgs)">
- <summary>
- Handles pressing the delete key to remove features from the specified layer.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapFunctionSelect.OnMouseMove(DotSpatial.Controls.GeoMouseArgs)">
- <summary>
- Handles MouseMove
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapFunctionSelect.OnMouseUp(DotSpatial.Controls.GeoMouseArgs)">
- <summary>
- Handles the Mouse Up situation
- </summary>
- <param name="e"></param>
- </member>
- <member name="T:DotSpatial.Controls.SpatialDockManager">
- <summary>
- Simple dock manager implementation. It can be used in design time.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.SpatialDockManager.AddDefaultTabControls">
- <summary>
- Add default tab controls to the dock manager
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.SpatialDockManager.TabControl1">
- <summary>
- Gets or sets TabControl For Panel1. It used for storing Left and Top panels.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.SpatialDockManager.TabControl2">
- <summary>
- Gets or sets TabControl For Panel2. It used for storing Right and Bottom panels.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.SpatialHeaderControl.ApplicationManager">
- <summary>
- Gets or sets the application manager.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.SpatialHeaderControl.ToolbarsContainer">
- <summary>
- Gets or sets Toolbars container for header control buttons.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.SpatialHeaderControl.MenuStrip">
- <summary>
- Gets or sets Menu strip for header control menus.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.SpatialToolStrip">
- <summary>
- Preconfigured tool strip menu.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.SpatialToolStrip.#ctor">
- <summary>
- Creates a new instance of mwToolBar
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.SpatialToolStrip.#ctor(DotSpatial.Controls.IMap)">
- <summary>
- Constructs and initializes this toolbar using the specified IBasicMap
- </summary>
- <param name="map">The map for the toolbar to interact with</param>
- </member>
- <member name="P:DotSpatial.Controls.SpatialToolStrip.Map">
- <summary>
- Gets or sets the basic map that this toolbar will interact with by default
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.SpatialToolStrip.ApplicationManager">
- <summary>
- Gets or sets the application manager.
- </summary>
- <value>
- The application manager.
- </value>
- </member>
- <member name="T:DotSpatial.Controls.SpatialToolStripPanel">
- <summary>
- Creates a container within which other controls can share horizontal or vertical space.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.YieldStyles">
- <summary>
- Describe different behaviors that map functions can have when working with
- respect to other map-functions.
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.YieldStyles.None">
- <summary>
- This is a null state for testing, and should not be used directly.
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.YieldStyles.LeftButton">
- <summary>
- This function will deactivate if another LeftButton function activates.
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.YieldStyles.RightButton">
- <summary>
- This function will deactivate if another RightButton function activates.
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.YieldStyles.Scroll">
- <summary>
- This function will deactivate if another scroll function activates.
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.YieldStyles.Keyboard">
- <summary>
- This function will deactivate if another keyboard function activates.
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.YieldStyles.AlwaysOn">
- <summary>
- This function is like a glyph and never yields to other functions.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.MapFunctionZoom">
- <summary>
- A MapFunction that zooms the map by scrolling the scroll wheel and pans the map by pressing the mouse wheel and moving the mouse.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFunctionZoom.#ctor(DotSpatial.Controls.IMap)">
- <summary>
- Initializes a new instance of the MapFunctionZoom class.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFunctionZoom.OnMouseWheel(DotSpatial.Controls.GeoMouseArgs)">
- <summary>
- Mouse Wheel
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapFunctionZoom.OnMouseDown(DotSpatial.Controls.GeoMouseArgs)">
- <summary>
- Handles the actions that the tool controls during the OnMouseDown event
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapFunctionZoom.OnMouseMove(DotSpatial.Controls.GeoMouseArgs)">
- <summary>
- Handles the mouse move event, changing the viewing extents to match the movements
- of the mouse if the left mouse button is down.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.MapFunctionZoom.OnMouseUp(DotSpatial.Controls.GeoMouseArgs)">
- <summary>
- Mouse Up
- </summary>
- <param name="e"></param>
- </member>
- <member name="P:DotSpatial.Controls.MapFunctionZoom.Sensitivity">
- <summary>
- Gets or sets the wheel zoom sensitivity. Increasing makes it more sensitive. Maximum is 0.5, Minimum is 0.01
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapFunctionZoom.ForwardZoomsIn">
- <summary>
- Controls the sense (direction) of zoom (in or out) as you roll the mouse wheel
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.MapFunctionZoom.TimerInterval">
- <summary>
- Gets or sets the full refresh timeout value in milliseconds
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.MapFunctionZoomOut">
- <summary>
- A MapFunction that can zoom the map out based on left mouse clicks and in based on right mouse clicks.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFunctionZoomOut.#ctor(DotSpatial.Controls.IMap)">
- <summary>
- Creates a new instance of SelectTool
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.MapFunctionZoomOut.OnMouseUp(DotSpatial.Controls.GeoMouseArgs)">
- <summary>
- Handles the Mouse Up situation
- </summary>
- <param name="e"></param>
- </member>
- <member name="T:DotSpatial.Controls.Modeler">
- <summary>
- A modeler form which allows users to create models with visual representations of tools
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.#ctor">
- <summary>
- Creates an instance of the spatial modeler Element
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.PixelToVirtual(System.Drawing.Point)">
- <summary>
- Translates between pixel location and virtual location
- </summary>
- <param name="pt">A point in pixel coordinantes. 0, 0 is the top left of the modeler</param>
- <returns>A point in the virtual model coordinantes</returns>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.PixelToVirtual(System.Int32,System.Int32)">
- <summary>
- Translates between pixel location and virtual location
- </summary>
- <param name="x">the X location in pixel coordinantes</param>
- <param name="y">the Y location in pixel coordinantes</param>
- <returns>A point in the virtual model coordinantes</returns>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.PixelRectToVirtualRect(System.Drawing.Rectangle)">
- <summary>
- Returns a rectangle in virtual coordinantes based on a pixel rectangle
- </summary>
- <param name="rect"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.VirtualToPixel(System.Drawing.Point)">
- <summary>
- Translates between virtual model coords and pixels
- </summary>
- <param name="pt">A point in the virtual model coordinantes</param>
- <returns>A point in pixel coordinantes. 0, 0 is the top left of the modeler</returns>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.VirtualToPixel(System.Int32,System.Int32)">
- <summary>
- Translates between virtual model coords and pixels
- </summary>
- <param name="x">the X location in virtual model coordinantes</param>
- <param name="y">the Y location in virtual model coordinantes</param>
- <returns>A point in pixel coordinantes. 0, 0 is the top left of the modeler</returns>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.AddData(DotSpatial.Modeling.Forms.Parameter,System.Drawing.Point)">
- <summary>
- Adds a data element to the modeler based on a parameter descrition
- </summary>
- <param name="par">The parameter to add to the modeler</param>
- <param name="location">A point representing the virtual location of the element</param>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.AddData(DotSpatial.Modeling.Forms.Parameter,System.Drawing.Point,System.String)">
- <summary>
- Adds a data element to the modeler
- </summary>
- <param name="par">The data set to add to the modeler</param>
- <param name="location">A point representing the virtual location of the data element</param>
- <param name="name">The name to give the element</param>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.AddArrow(DotSpatial.Modeling.Forms.ModelElement,DotSpatial.Modeling.Forms.ModelElement)">
- <summary>
- Adds an arrow element given a source and destination element
- </summary>
- <param name="sourceElement"></param>
- <param name="destElement"></param>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.AddElement(DotSpatial.Modeling.Forms.ModelElement,System.Drawing.Point)">
- <summary>
- Adds a element to the model
- </summary>
- <param name="element">The new model Element to add to the model form</param>
- <param name="location">A point representing the virtual location of the element</param>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.ClearSelectedElements">
- <summary>
- Clears all the elements in the _selectedElements list, removes their highlights and puts them back in the _modelElements list
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.RemoveSelectedElement(DotSpatial.Modeling.Forms.ModelElement)">
- <summary>
- Removes the specified element from the _selectedElements list
- </summary>
- <param name="element"></param>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.AddSelectedElement(DotSpatial.Modeling.Forms.ModelElement)">
- <summary>
- Adds an element to the _modelElementsSelected Array and highlights it
- </summary>
- <param name="element"></param>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.DeleteElement(DotSpatial.Modeling.Forms.ModelElement)">
- <summary>
- Removes a specific element from the model clearing any links it has to other elements
- </summary>
- <param name="element">The element to remove</param>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.AddTool(DotSpatial.Modeling.Forms.ITool,System.Drawing.Point)">
- <summary>
- Adds a tool to the Modeler
- </summary>
- <param name="tool">the tool to add to the modeler</param>
- <param name="location">A point representing the virtual location of the tool</param>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.AddTool(DotSpatial.Modeling.Forms.ITool,System.String,System.Drawing.Point)">
- <summary>
- Adds a tool to the Modeler
- </summary>
- <param name="tool">the tool to add to the modeler</param>
- <param name="modelName"></param>
- <param name="location">A point representing the virtual location of the tool</param>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.SaveModel">
- <summary>
- Saves the current project, prompting the user to save as if the project is new.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.SaveModel(System.Boolean,System.Boolean)">
- <summary>
- Saves the current project to disk.
- </summary>
- <param name="promptOverwrite">True to prompt for overwrite if file exists</param>
- <param name="promptSaveAs">True show save as dialog</param>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.SaveModel(System.String)">
- <summary>
- Saves a copy of the model to the selected file without renaming the current project
- </summary>
- <param name="fileName"></param>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.LoadModel">
- <summary>
- Prompts the user to load a model and asks them if they want to save the current model first
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.LoadModel(System.String)">
- <summary>
- Loads a model from file closing the existing model without saving it
- </summary>
- <param name="fileName"></param>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.CreateNewModel(System.Boolean)">
- <summary>
- Creates a new model
- </summary>
- <param name="promptSave">if true prompts user to save current model if it is not saved</param>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.DeleteSelectedElements">
- <summary>
- Deletes all of the selected elements if it is allowed
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.ZoomIn">
- <summary>
- Zooms the model in 20%
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.ZoomOut">
- <summary>
- Zooms the model out 20%
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.CenterModelerOnPoint(System.Drawing.Point)">
- <summary>
- Centers the map on a given point
- </summary>
- <param name="centerPoint">A Point in the modelers virtual coordinant system</param>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.ZoomFullExtent">
- <summary>
- Zooms to the extent of all elements in the model and centers the modeler on them
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.GenerateDefaultOutput(DotSpatial.Modeling.Forms.Parameter)">
- <summary>
- Creates a default output locations for tools.
- </summary>
- <param name="par"></param>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.ExecuteModel(System.String@)">
- <summary>
- Executes a model after verifying that it is ready
- </summary>
- <param name="error">A string parameter which will contains a error string if one is generated</param>
- <returns>Returns true if it executed succesfully</returns>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.OnKeyUp(System.Windows.Forms.KeyEventArgs)">
- <summary>
- On Key Up
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.OnMouseDown(System.Windows.Forms.MouseEventArgs)">
- <summary>
- When the users clicks the mouse this event fires
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.OnMouseMove(System.Windows.Forms.MouseEventArgs)">
- <summary>
- When the mouse is moved this event fires
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.OnMouseUp(System.Windows.Forms.MouseEventArgs)">
- <summary>
- When the user mouses up after a single click this event fires
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.OnMouseLeave(System.EventArgs)">
- <summary>
- Occurs when the mouse leaves.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.OnDoubleClick(System.EventArgs)">
- <summary>
- When the user double clicks on the model this event fires
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.OnDragDrop(System.Windows.Forms.DragEventArgs)">
- <summary>
- Adds a tool to the modeler
- </summary>
- <param name="drgevent"></param>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.OnDragEnter(System.Windows.Forms.DragEventArgs)">
- <summary>
- Allows a drag into the modeler
- </summary>
- <param name="drgevent"></param>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.UpdateBackBuffer">
- <summary>
- Paints the elements to the backbuffer
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.OnPaint(System.Windows.Forms.PaintEventArgs)">
- <summary>
- When the element is called on to be painted this method is called
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.OnPaintBackground(System.Windows.Forms.PaintEventArgs)">
- <summary>
- When the form draws the background do nothing
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.OnResize(System.EventArgs)">
- <summary>
- Redraws the background when the form is resized
- </summary>
- <param name="e"></param>
- </member>
- <member name="F:DotSpatial.Controls.Modeler.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.Modeler.OnModelFilenameChanged(System.EventArgs)">
- <summary>
- Fires when the Filename of the project is changed
- </summary>
- <param name="e"></param>
- </member>
- <member name="E:DotSpatial.Controls.Modeler.ModelFilenameChanged">
- <summary>
- Occurs when the model fileName has changed
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Modeler.MaxExecutionThreads">
- <summary>
- The maximum number of processes to execute at the same time
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Modeler.EnableLinking">
- <summary>
- Turns linking by mouse on and off
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Modeler.DrawingQuality">
- <summary>
- Gets or Sets the drawing quality for the toolbox
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Modeler.DataFont">
- <summary>
- Gets or sets the font that will be used to label the data in the modeler
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Modeler.DataColor">
- <summary>
- Gets or sets the color that data should have in the modeler
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Modeler.DataShape">
- <summary>
- Gets or sets the shape that data should be represented with in the modeler
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Modeler.ToolFont">
- <summary>
- Gets or sets the font that will be used to label the tools in the modeler
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Modeler.ToolColor">
- <summary>
- Gets or sets the color that tools should have in the modeler
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Modeler.ToolShape">
- <summary>
- Gets or sets the shape that tools should be represented with in the modeler
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Modeler.ShowWaterMark">
- <summary>
- Turns the DotSpatial watermark in the lower right hand corner on or off. Defautl true.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Modeler.ToolManager">
- <summary>
- Sets the toolManager used to create instances of all the tools.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Modeler.IsInitialized">
- <summary>
- Gets or Sets if the model drawing needs to be initialized
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Modeler.ZoomFactor">
- <summary>
- Gets or sets the zoom factor of the map values below 0 zoom out, values above 1 zoom in. 1 = no zoom
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Modeler.ModelFilename">
- <summary>
- Gets or sets the fileName of the current model
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Modeler.DefaultFileExtension">
- <summary>
- Gets or sets the extension used by default for opening, saving and creating new models. ex "mwm"
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.Modeler.WorkingPath">
- <summary>
- Gets or sets the working path for the model
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.ModelerForm">
- <summary>
- A form used in Brian's toolkit code
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.ModelerForm.#ctor">
- <summary>
- Creates a new instance of the modeler's form
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.ModelerForm.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.ModelerForm.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Controls.ModelerForm.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.ModelerForm.Modeler">
- <summary>
- Gets modeler in the form
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.ModelerToolStrip">
- <summary>
- A Brian Marchioni original toolstrip... preloaded with content.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.ModelerToolStrip.#ctor">
- <summary>
- Creates an instance of the toolstrip
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.ModelerToolStrip.Modeler">
- <summary>
- Gets or sets the modeler currently associated with the toolstrip
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.PageSetupForm">
- <summary>
- A dialog that allows users to modify the size of the layout paper and margins
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.PageSetupForm.#ctor(System.Drawing.Printing.PrinterSettings)">
- <summary>
- Creates a new instance of the Page Setup Form
- </summary>
- <param name="settings"></param>
- </member>
- <member name="M:DotSpatial.Controls.PageSetupForm.IsValidMargin(System.String)">
- <summary>
- Takes a string and returns true if it can be converted to a double
- </summary>
- <param name="input"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Controls.PageSetupForm.OK_Button_Click(System.Object,System.EventArgs)">
- <summary>
- Sets the printerSettings to the new settings and sets the result to OK
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.PageSetupForm.Cancel_Button_Click(System.Object,System.EventArgs)">
- <summary>
- Disgards the settings and sets dialogresult to cancel
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.PageSetupForm.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.PageSetupForm.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Controls.PageSetupForm.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.IconMenuItem">
- <summary>
- Handles drawing by adding an icon to the mix.
- Owner draw must be set to true for this to work.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.IconMenuItem.#ctor(System.String,System.Drawing.Icon,System.EventHandler)">
- <summary>
- Creates a new instance of the Icon Menu Item with the specified name
- </summary>
- <param name="name"></param>
- <param name="icon"></param>
- <param name="onClick"></param>
- </member>
- <member name="M:DotSpatial.Controls.IconMenuItem.#ctor(System.String,System.Drawing.Image,System.EventHandler)">
- <summary>
- Creates a new instance of the Icon Menu Item with the specified name
- </summary>
- <param name="name"></param>
- <param name="image"></param>
- <param name="onClick"></param>
- </member>
- <member name="M:DotSpatial.Controls.IconMenuItem.#ctor(System.String,System.EventHandler)">
- <summary>
- Creates a new instance of the Icon Menu Item with the specified name
- </summary>
- <param name="name"></param>
- <param name="onClick"></param>
- </member>
- <member name="M:DotSpatial.Controls.IconMenuItem.OnDrawItem(System.Windows.Forms.DrawItemEventArgs)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Controls.IconMenuItem.OnMeasureItem(System.Windows.Forms.MeasureItemEventArgs)">
- <inheritdoc/>
- </member>
- <member name="P:DotSpatial.Controls.IconMenuItem.Icon">
- <summary>
- Gets or sets the icon to be drawn to the left of this menu item.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.IconMenuItem.Image">
- <summary>
- Gets or sets the image to be drawn to the left of this menu item
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.SpatialProgressBar">
- <summary>
- mwProgressBar
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.SpatialStatusStrip">
- <summary>
- A pre-configured status strip with a thread safe Progress function
- </summary>
- <summary>
- The Designer for the Spatial Status Strip
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.SpatialStatusStrip.#ctor">
- <summary>
- Creates a new instance of the StatusStrip which has a built in, thread safe Progress handler
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.SpatialStatusStrip.Progress(System.String,System.Int32,System.String)">
- <summary>
- This method is thread safe so that people calling this method don't cause a cross-thread violation
- by updating the progress indicator from a different thread
- </summary>
- <param name="key">A string message with just a description of what is happening, but no percent completion information</param>
- <param name="percent">The integer percent from 0 to 100</param>
- <param name="message">A message</param>
- </member>
- <member name="M:DotSpatial.Controls.SpatialStatusStrip.OnItemAdded(System.Windows.Forms.ToolStripItemEventArgs)">
- <summary>
- Raises the <see cref="E:System.Windows.Forms.ToolStrip.ItemAdded"/> event.
- </summary>
- <param name="e">A <see cref="T:System.Windows.Forms.ToolStripItemEventArgs"/> that contains the event data.</param>
- </member>
- <member name="F:DotSpatial.Controls.SpatialStatusStrip.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.SpatialStatusStrip.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Controls.SpatialStatusStrip.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.SpatialStatusStrip.ProgressBar">
- <summary>
- Gets or sets the progress bar. By default, the first ToolStripProgressBar that is added to the tool strip.
- </summary>
- <value>
- The progress bar.
- </value>
- </member>
- <member name="P:DotSpatial.Controls.SpatialStatusStrip.ProgressLabel">
- <summary>
- Gets or sets the progress label. By default, the first ToolStripStatusLabel that is added to the tool strip.
- </summary>
- <value>
- The progress label.
- </value>
- </member>
- <member name="T:DotSpatial.Controls.ToolManager">
- <summary>
- This class provides a ToolManager for loading tools from .dll's
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.ToolManager.#ctor">
- <summary>
- Creates a new instance of the ToolManager, scans the executables root path\tools
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.ToolManager.OnImportsSatisfied">
- <summary>
- Called when a part's imports have been satisfied and it is safe to use. Refreshes the tree of tools.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.ToolManager.CanCreateTool(System.String)">
- <summary>
- Returns true if the Tool Manager can create the tool specified by the Name
- </summary>
- <param name="name">The unique name of a tool</param>
- <returns>true if the tool can be created otherwise false</returns>
- </member>
- <member name="M:DotSpatial.Controls.ToolManager.GetTool(System.String)">
- <summary>
- Creates a new instance of a tool based on its Name
- </summary>
- <param name="name">The unique name of the tool</param>
- <returns>Returns an new instance of the tool or NULL if the tools unique name doesn't exist in the manager</returns>
- </member>
- <member name="M:DotSpatial.Controls.ToolManager.HighlightNextTool(System.String)">
- <summary>
- Highlights the next tool
- </summary>
- <param name="toolName"></param>
- </member>
- <member name="M:DotSpatial.Controls.ToolManager.HighlightTool(System.String)">
- <summary>
- Locates a tool by its name in the tree and highlights it
- </summary>
- <param name="toolName"></param>
- </member>
- <member name="M:DotSpatial.Controls.ToolManager.RefreshTree">
- <summary>
- This clears the list of available tools and loads them from file again
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.ToolManager.ToolManager_NodeMouseDoubleClick(System.Object,System.Windows.Forms.TreeNodeMouseClickEventArgs)">
- <summary>
- Handles the NodeMouseDoubleClick event of the ToolManager control.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">The <see cref="T:System.Windows.Forms.TreeNodeMouseClickEventArgs"/> instance containing the event data.</param>
- </member>
- <member name="M:DotSpatial.Controls.ToolManager.OnItemDrag(System.Windows.Forms.ItemDragEventArgs)">
- <summary>
- Runs when and item gets dragged
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Controls.ToolManager.OnMouseMove(System.Windows.Forms.MouseEventArgs)">
- <summary>
- Thie event fires when the mouse moves to change the ToolTip
- </summary>
- <param name="e"></param>
- </member>
- <member name="P:DotSpatial.Controls.ToolManager.DataSets">
- <summary>
- Sets the data that are available by default to tools
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.ToolManager.Legend">
- <summary>
- Gets or Sets the legend object. This is needed to automatically populate the list of data layers in tool dialogs.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.ToolManager.App">
- <summary>
- App is the current AppManager handle.
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.ToolManager.Tools">
- <summary>
- Gets the list tools available.
- </summary>
- </member>
- <member name="T:DotSpatial.Controls.ToolManagerToolStrip">
- <summary>
- A Tool strip to use with the ToolManager when used as a graphical control
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.ToolManagerToolStrip.#ctor">
- <summary>
- Creates an instance of the toolstrip
- </summary>
- </member>
- <member name="P:DotSpatial.Controls.ToolManagerToolStrip.ToolManager">
- <summary>
- Gets or sets the ToolManager currently associated with the toolstrip
- </summary>
- </member>
- <member name="F:DotSpatial.Controls.ZoomToCoordinatesDialog.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Controls.ZoomToCoordinatesDialog.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Controls.ZoomToCoordinatesDialog.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- </members>
-</doc>
diff --git a/MES_Wind/bin/Debug/DotSpatial.Data.Forms.pdb b/MES_Wind/bin/Debug/DotSpatial.Data.Forms.pdb
deleted file mode 100644
index 717d22c639c9751b92d08fbfa579fd092b918fe3..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/DotSpatial.Data.Forms.pdb and /dev/null differ
diff --git a/MES_Wind/bin/Debug/DotSpatial.Data.Forms.xml b/MES_Wind/bin/Debug/DotSpatial.Data.Forms.xml
deleted file mode 100644
index b74f4f3fa7da627e3da5ce77719e85148251116c..0000000000000000000000000000000000000000
--- a/MES_Wind/bin/Debug/DotSpatial.Data.Forms.xml
+++ /dev/null
@@ -1,1701 +0,0 @@
-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>DotSpatial.Data.Forms</name>
- </assembly>
- <members>
- <member name="T:DotSpatial.Data.Forms.DataFormsMessageStrings">
- <summary>
- A strongly-typed resource class, for looking up localized strings, etc.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.DataFormsMessageStrings.ResourceManager">
- <summary>
- Returns the cached ResourceManager instance used by this class.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.DataFormsMessageStrings.Culture">
- <summary>
- Overrides the current thread's CurrentUICulture property for all
- resource lookups using this strongly typed resource class.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.DataFormsMessageStrings.CurrentElementNotSpecified">
- <summary>
- Looks up a localized string similar to The current element was not defined. Before attempting to read the element, first assign the value of the current XML Element to read..
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.DataFormsMessageStrings.ExtentDialog_Fail_Invalid_Value">
- <summary>
- Looks up a localized string similar to Invalid Value..
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.DataFormsMessageStrings.ExtentDialog_Fail_Post">
- <summary>
- Looks up a localized string similar to box. Either fix the value to represent a double precision floating point value or choose cancel..
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.DataFormsMessageStrings.ExtentDialog_Fail_Pre">
- <summary>
- Looks up a localized string similar to There is an invalid entry in the.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.DataFormsMessageStrings.ParseFailed_S">
- <summary>
- Looks up a localized string similar to The value you entered could not be parsed into a %S. Make sure the value is in the valid range..
- </summary>
- </member>
- <member name="T:DotSpatial.Data.Forms.DataManagerExt">
- <summary>
- Extend the data manager with some convenient dialog spawning options.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Forms.DataManagerExt.OpenVector(DotSpatial.Data.IDataManager)">
- <summary>
- This opens a file, but populates the dialog filter with only vector formats.
- </summary>
- <returns>An IFeatureSet with the data from the file specified in a dialog, or null if nothing load.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.DataManagerExt.OpenVectors(DotSpatial.Data.IDataManager)">
- <summary>
- This uses an open dialog filter with only vector extensions but where multi-select is
- enabled, hence allowing multiple vectors to be returned in this list.
- </summary>
- <returns>The enumerable or vectors.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.DataManagerExt.OpenImage(DotSpatial.Data.IDataManager)">
- <summary>
- This opens a file, but populates the dialog filter with only raster formats.
- </summary>
- <returns>for now an IDataSet</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.DataManagerExt.OpenImages(DotSpatial.Data.IDataManager)">
- <summary>
- This uses an open dialog filter with only image extensions for supported image formats,
- but where multi-select is enabled, and so allowing multiple images to be returned at once.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.DataManagerExt.OpenFile(DotSpatial.Data.IDataManager)">
- <summary>
- This launches an open file dialog and attempts to load the specified file.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Forms.DataManagerExt.OpenFiles(DotSpatial.Data.IDataManager)">
- <summary>
- This launches an open file dialog that allows loading of several files at once
- and returns the datasets in a list.
- </summary>
- <returns>An enumerable of all the files that were opened.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.DataManagerExt.OpenRaster(DotSpatial.Data.IDataManager)">
- <summary>
- This opens a file, but populates the dialog filter with only raster formats.
- </summary>
- <returns>An IRaster with the data from the file specified in an open file dialog</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.DataManagerExt.OpenRasters(DotSpatial.Data.IDataManager)">
- <summary>
- This uses an open dialog filter with only raster extensions but where multi-select is
- enabled, hence allowing multiple rasters to be returned in this list.
- </summary>
- <returns>An enumerable or rasters.</returns>
- </member>
- <member name="T:DotSpatial.Data.Forms.DialogImages">
- <summary>
- A strongly-typed resource class, for looking up localized strings, etc.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.DialogImages.ResourceManager">
- <summary>
- Returns the cached ResourceManager instance used by this class.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.DialogImages.Culture">
- <summary>
- Overrides the current thread's CurrentUICulture property for all
- resource lookups using this strongly typed resource class.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.Forms.DirectoryItem">
- <summary>
- DirectoryItems can be either Files or Folders
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Forms.DirectoryItem.#ctor">
- <summary>
- Creates a new instance of DirectoryItem
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Forms.DirectoryItem.#ctor(System.String)">
- <summary>
- Creates a new instance of a directory item based on the specified path.
- </summary>
- <param name="path"></param>
- </member>
- <member name="M:DotSpatial.Data.Forms.DirectoryItem.Draw(System.Windows.Forms.PaintEventArgs)">
- <summary>
- This method instructs this item to draw itself onto the specified graphics surface.
- </summary>
- <param name="e">A PaintEventArgs that contains the Graphics object needed for drawing.</param>
- </member>
- <member name="M:DotSpatial.Data.Forms.DirectoryItem.OnDraw(System.Windows.Forms.PaintEventArgs)">
- <summary>
- This supplies the basic drawing for this one element where the graphics object has been transformed
- based on the position of this item.
- </summary>
- <param name="e">A PaintEventArgs that contains the Graphics object needed for drawing.</param>
- </member>
- <member name="P:DotSpatial.Data.Forms.DirectoryItem.BackColor">
- <summary>
- Gets or sets the background color for this item.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.DirectoryItem.Bounds">
- <summary>
- Gets or sets the rectangle in
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.DirectoryItem.ClientRectangle">
- <summary>
- Gets a rectangle in control coordinates showing the size of this control
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.DirectoryItem.CustomImage">
- <summary>
- Gets or sets the custom icon that is used if the ItemType is set to custom
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.DirectoryItem.Font">
- <summary>
- Gets or sets the font for this directory item
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.DirectoryItem.FontColor">
- <summary>
- Gets or sets the color that should be used for drawing the fonts.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.DirectoryItem.Image">
- <summary>
- Gets the icon that should be used
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.DirectoryItem.IsHighlighted">
- <summary>
- Gets or sets whether this specific item should be drawn highlighted
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.DirectoryItem.IsOutlined">
- <summary>
- Gets or sets a boolean that controls whether or not a black dotted rectangle
- will surround this item.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.DirectoryItem.IsSelected">
- <summary>
- Gets or sets whether this specific item should be drawn highlighted
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.DirectoryItem.ItemType">
- <summary>
- Gets or set the ItemType for this particular directory item.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.DirectoryItem.Path">
- <summary>
- Gets or sets the complete path for this directory item.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.DirectoryItem.ShowImage">
- <summary>
- Gets or sets a boolean governing whether or not an icon should be drawn.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.DirectoryItem.Text">
- <summary>
- Gets or sets the string text for this directory item.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.DirectoryItem.Top">
- <summary>
- Gets or set the integer top of this item
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.DirectoryItem.Width">
- <summary>
- Gets or sets the width of this control
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.DirectoryItem.Height">
- <summary>
- Gets or sets the height of this control
- </summary>
- </member>
- <member name="T:DotSpatial.Data.Forms.DirectoryView">
- <summary>
- DirectoryView
- </summary>
- </member>
- <member name="T:DotSpatial.Data.Forms.ScrollingControl">
- <summary>
- ScrollingControl that provides autoscroll and custom draw that won't crash mono
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Forms.ScrollingControl.#ctor">
- <summary>
- Creates a new instance of ScrollingControl
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Forms.ScrollingControl.OnVerticalScroll(System.Object,System.Windows.Forms.ScrollEventArgs)">
- <summary>
- Occurs when scrolling vertically
- </summary>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Data.Forms.ScrollingControl.OnHorizontalScroll(System.Object,System.Windows.Forms.ScrollEventArgs)">
- <summary>
- Occurs when scrolling horizontally
- </summary>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Data.Forms.ScrollingControl.ClientToDocument(System.Drawing.Rectangle)">
- <summary>
- Gets a rectangle in document coordinates for hte specified rectangle in client coordinates
- </summary>
- <param name="rect"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.ScrollingControl.DocumentToClient(System.Drawing.Rectangle)">
- <summary>
- Translates a rectangle from document coordinates to coordinates relative to the client control
- </summary>
- <param name="rect"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.ScrollingControl.ResetScroll">
- <summary>
- Recalculates the size and visibility of the scroll bars based on the current document.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Forms.ScrollingControl.OnPaintBackground(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Prevent flicker by preventing this
- </summary>
- <param name="pevent"></param>
- </member>
- <member name="M:DotSpatial.Data.Forms.ScrollingControl.OnPaint(System.Windows.Forms.PaintEventArgs)">
- <summary>
- On Paint only paints the specified clip rectangle, but paints
- it from the page buffer.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Data.Forms.ScrollingControl.OnDrawBackground(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Occurs during custom drawing when erasing things
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Data.Forms.ScrollingControl.OnDraw(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Occurs during custom drawing
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Data.Forms.ScrollingControl.Dispose(System.Boolean)">
- <summary>
- Disposes the unmanaged memory objects and optionally disposes
- the managed memory objects
- </summary>
- <param name="disposing"></param>
- </member>
- <member name="M:DotSpatial.Data.Forms.ScrollingControl.OnInitialize(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Fires the Initialized event
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Data.Forms.ScrollingControl.OnResize(System.EventArgs)">
- <summary>
-
- </summary>
- <param name="e"></param>
- </member>
- <member name="E:DotSpatial.Data.Forms.ScrollingControl.Initialized">
- <summary>
- Occurs after the base drawing content has been rendered to the page.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.ScrollingControl.BackColor">
- <summary>
- Gets or sets the background color to use for this control
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.ScrollingControl.BackgroundImage">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.ScrollingControl.ControlRectangle">
- <summary>
- Gets the rectangular region of the control in page coordinates.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.ScrollingControl.DocumentRectangle">
- <summary>
- Gets or sets the rectangle for the entire content, whether on the page buffer or not. X and Y for this
- are always 0.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.ScrollingControl.IsInitialized">
- <summary>
- Gets or sets whether or not the page for this control has been drawn.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.ScrollingControl.HorizontalScrollEnabled">
- <summary>
- Gets or sets a boolean indicating whether or not horizontal scrolling is enabled
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.ScrollingControl.Page">
- <summary>
- Gets or sets the page image being used as a buffer. This is useful
- for content changes that need to be made rapidly. First refresh
- a small region of this page, and then invalidate the client rectangle.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.ScrollingControl.ResetOnResize">
- <summary>
- Gets or sets a boolean that indicates whether or not the scrolling
- should be reset on every resize or not.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.ScrollingControl.VerticalScrollEnabled">
- <summary>
- Gets or sets a boolean indicating whether the vertical scroll should be permitted
- </summary>
- </member>
- <member name="F:DotSpatial.Data.Forms.DirectoryView._directory">
- <summary>
- Designer variable
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Forms.DirectoryView.#ctor">
- <summary>
- Creates a new instance of DirectoryView
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Forms.DirectoryView.OnInitialize(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Draws
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Data.Forms.DirectoryView.OnMouseDown(System.Windows.Forms.MouseEventArgs)">
- <summary>
- Handles the situation where the mouse has been pressed down.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Data.Forms.DirectoryView.RefreshItem(DotSpatial.Data.Forms.DirectoryItem)">
- <summary>
- Updates the buffer in order to correctly re-draw this item, if it is on the page, and then invalidates
- the area where this will be drawn.
- </summary>
- <param name="item">The directory item to invalidate</param>
- </member>
- <member name="M:DotSpatial.Data.Forms.DirectoryView.Clear">
- <summary>
- Removes the existing Directory Items from the control
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Forms.DirectoryView.UpdateContent">
- <summary>
- Causes the control to refresh the current content.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Forms.DirectoryView.ClearSelection">
- <summary>
- Systematically clears any currently selected items.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.DirectoryView.SelectedItem">
- <summary>
- Gets or sets the selected item. In cases of a multiple select, this is the
- last member added to the selection.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.DirectoryView.Directory">
- <summary>
- Gets or sets the string path that should be itemized in the view.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.DirectoryView.Items">
- <summary>
- Gets or sets the collection of DirectoryItems to draw in this control
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.DirectoryView.Font">
- <summary>
- Gets or sets the Font to be used for all of the items in this view.
- </summary>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.ExtentDialog">
- <summary>
- A Dialog that allows users to enter an X, Y, Z or M extent.
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ExtentDialog.#ctor">
- <summary>
- Initializes a new instance of the ExtentDialog class.
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ExtentDialog.Clear">
- <summary>
- Resets all the values to 0.
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ExtentDialog.OnClosing(System.ComponentModel.CancelEventArgs)">
- <summary>
- Prevents closing as "OK" if there are invalid double values.
- </summary>
- <param name="e">CancelEventArgs that allow canceling close.</param>
- </member>
- <member name="F:DotSpatial.Modeling.Forms.ExtentDialog.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ExtentDialog.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ExtentDialog.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ExtentDialog.Extent">
- <summary>
- Gets or sets the extent specified by this form.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.Forms.FeatureSetExt">
- <summary>
- extension method for feature set
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Forms.FeatureSetExt.Open(DotSpatial.Data.FeatureSet)">
- <summary>
- Displays a dialog, allowing the users to open a raster.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.Forms.FileItem">
- <summary>
- FileItem
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Forms.FileItem.#ctor">
- <summary>
- Creates a new instance of FileItem
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Forms.FileItem.#ctor(System.String)">
- <summary>
- Creates a new insteance of a FileItem associated with the specified path.
- </summary>
- <param name="path">Gets or sets a string path</param>
- </member>
- <member name="P:DotSpatial.Data.Forms.FileItem.Info">
- <summary>
- Gets or sets the FileInfo
- </summary>
- </member>
- <member name="T:DotSpatial.Data.Forms.FolderItem">
- <summary>
- FolderItem
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Forms.FolderItem.#ctor">
- <summary>
- Creates a new instance of FolderItem
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Forms.FolderItem.#ctor(System.String)">
- <summary>
- Creates a new instance of FolderItem, but already pointing to the specified path
- </summary>
- <param name="path">The string path that this FolderItem should be identified with</param>
- </member>
- <member name="P:DotSpatial.Data.Forms.FolderItem.Info">
- <summary>
- Gets or sets the directory info
- </summary>
- </member>
- <member name="T:DotSpatial.Data.Forms.HighlightEventArgs">
- <summary>
- HighlightEventArgs
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Forms.HighlightEventArgs.#ctor(System.Boolean)">
- <summary>
- Creates a new instance of HighlightEventArgs
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.HighlightEventArgs.IsHighlighted">
- <summary>
- Gets or sets whether or not the control is now highlighted
- </summary>
- </member>
- <member name="T:DotSpatial.Data.Forms.ILogger">
- <summary>
- Implementing this interface will allow the plugin developer to
- intercept the different log levels.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Forms.ILogger.Exception(System.Exception)">
- <summary>
- The Complete exception is passed here. To get the stack
- trace, be sure to call ex.ToString().
- </summary>
- <param name="ex">The exception that was thrown by DotSpatial.</param>
- </member>
- <member name="M:DotSpatial.Data.Forms.ILogger.PublicMethodEntered(System.String,System.Collections.Generic.IEnumerable{System.String})">
- <summary>
- This event will allow the registering of an entrance into a public Method of a "tools" related
- action to register its entrance into a function as well as logging the parameter names
- and a type specific indicator of their value.
- </summary>
- <param name="methodName">The string name of the method</param>
- <param name="parameters">The list of calling parameters</param>
- </member>
- <member name="M:DotSpatial.Data.Forms.ILogger.PublicMethodLeft(System.String)">
- <summary>
- This event will allow the registering of the exit from each public method
- </summary>
- <param name="methodName">The Method name of the method being left</param>
- </member>
- <member name="M:DotSpatial.Data.Forms.ILogger.Status(System.String)">
- <summary>
- A status message was sent. Complex methods that have a few major steps will
- call a status message to show which step the process is in. Loops will call
- the progress method instead.
- </summary>
- <param name="message">The string message that was posted.</param>
- </member>
- <member name="M:DotSpatial.Data.Forms.ILogger.MessageBoxShown(System.String,System.Windows.Forms.DialogResult)">
- <summary>
- This method allows a user to recieve messages that were shown to the user, as well as
- their choice on those message boxes.
- </summary>
- <param name="messageText">A MessageBox after it has resolved.</param>
- <param name="result">A DialogResult from showing a message</param>
- </member>
- <member name="M:DotSpatial.Data.Forms.ILogger.InputBoxShown(System.String,System.Windows.Forms.DialogResult,System.String)">
- <summary>
- This method allows the logger to recieve information about input boxes that were shown
- as well as the values enterred into them and the result.
- </summary>
- <param name="messageText">The string message that appeared on the InputBox</param>
- <param name="result">The ystem.Windows.Forms.DialogResult describing if the value was cancelled </param>
- <param name="value">The string containing the value entered.</param>
- </member>
- <member name="P:DotSpatial.Data.Forms.ILogger.Description">
- <summary>
- Gets a string description for this logger.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.ILogger.Key">
- <summary>
- Gets or Sets an integer key to keep track of this logger.
- When you add this logger to a LogManager, it will attempt to keep track of the
- logger by using the key it was given. If that key is already in use, this
- will be set to the next available integer.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.Forms.ILogManager">
- <summary>
- This component allows customization of how log messages are sent
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Forms.ILogManager.AddLogger(DotSpatial.Data.Forms.ILogger)">
- <summary>
- To begin logging, create an implementation of the ILogHandler interface,
- or use the DefaultLogger class that is already implemented in this project.
- Then, call this function to add that logger to the list of active loggers.
- This function will return an integer key that you can use to keep track
- of your specific logger.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Forms.ILogManager.RemoveLogger(System.Int32)">
- <summary>
- The key specified here is the key that was returned by the AddLogger method.
- </summary>
- <param name="key">The integer key of the logger to remove.</param>
- <returns>True if the logger was successfully removed, or false if the key could not be found</returns>
- <exception cref="T:System.ArgumentNullException">key is null</exception>
- </member>
- <member name="M:DotSpatial.Data.Forms.ILogManager.AddLoggersFromDirectories">
- <summary>
- Adds all the loggers from directories.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.ILogManager.Exception(System.Exception)">
- <summary>
- The Complete exception is passed here. To get the stack
- trace, be sure to call ex.ToString().
- </summary>
- <param name="ex">The exception that was thrown by DotSpatial.</param>
- </member>
- <member name="M:DotSpatial.Data.Forms.ILogManager.PublicMethodEntered(System.String,System.Collections.Generic.List{System.String})">
- <summary>
- This event will allow the registering of an entrance into a public Method of a "tools" related
- action to register its entrance into a function as well as logging the parameter names
- and a type specific indicator of their value.
- </summary>
- <param name="methodName">The string name of the method</param>
- <param name="parameters">The List<string> of Parameter names and string form values</param>
- </member>
- <member name="M:DotSpatial.Data.Forms.ILogManager.PublicMethodLeft(System.String)">
- <summary>
- This event will allow the registering of the exit from each public method
- </summary>
- <param name="methodName">The Method name of the method being left</param>
- </member>
- <member name="M:DotSpatial.Data.Forms.ILogManager.Status(System.String)">
- <summary>
- A status message was sent. Complex methods that have a few major steps will
- call a status message to show which step the process is in. Loops will call
- the progress method instead.
- </summary>
- <param name="message">The string message that was posted.</param>
- </member>
- <member name="M:DotSpatial.Data.Forms.ILogManager.LogMessage(System.String,System.Windows.Forms.DialogResult)">
- <summary>
- This is called by each of the LogMessageBox methods automatically, but if the user wants to use
- a custom messagebox and then log the message and result directly this is the technique.
- </summary>
- <param name="text">The string text of the message that needs to be logged.</param>
- <param name="result">The dialog result from the shown messagebox.</param>
- </member>
- <member name="M:DotSpatial.Data.Forms.ILogManager.LogInput(System.String,System.Windows.Forms.DialogResult,System.String)">
- <summary>
- This method echoes information about input boxes to all the loggers.
- </summary>
- <param name="text">The string message that appeared on the InputBox</param>
- <param name="result">The ystem.Windows.Forms.DialogResult describing if the value was cancelled </param>
- <param name="value">The string containing the value entered.</param>
- </member>
- <member name="M:DotSpatial.Data.Forms.ILogManager.LogInputBox(System.String,System.String@)">
- <summary>
- Displays an InputBox form given the specified text string. The result is returned byref.
- A DialogResult is returned to show whether the user cancelled the form without providing input.
- </summary>
- <param name="text">The string text to use as an input prompt.</param>
- <param name="result">The string result that was typed into the dialog.</param>
- <returns>A DialogResult showing the outcome.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.ILogManager.LogInputBox(System.String,System.String,System.String@)">
- <summary>
- Displays an InputBox form given the specified text string. The result is returned byref.
- A DialogResult is returned to show whether the user cancelled the form without providing input.
- </summary>
- <param name="text">The string text to use as an input prompt.</param>
- <param name="caption">The string to use in the title bar of the InputBox.</param>
- <param name="result">The string result that was typed into the dialog.</param>
- <returns>A DialogResult showing the outcome.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.ILogManager.LogInputBox(System.String,System.String,DotSpatial.Data.ValidationType,System.String@)">
- <summary>
- Displays an InputBox form given the specified text string. The result is returned byref.
- A DialogResult is returned to show whether the user cancelled the form without providing input.
- </summary>
- <param name="text">The string text to use as an input prompt.</param>
- <param name="caption">The string to use in the title bar of the InputBox.</param>
- <param name="validation">A DotSpatial.Data.ValidationType enumeration specifying acceptable validation to return OK.</param>
- <param name="result">The string result that was typed into the dialog.</param>
- <returns>A DialogResult showing the outcome.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.ILogManager.LogInputBox(System.String,System.String,DotSpatial.Data.ValidationType,System.Drawing.Icon,System.String@)">
- <summary>
- Displays an InputBox form given the specified text string. The result is returned byref.
- A DialogResult is returned to show whether the user cancelled the form without providing input.
- </summary>
- <param name="text">The string text to use as an input prompt.</param>
- <param name="caption">The string to use in the title bar of the InputBox.</param>
- <param name="validation">A DotSpatial.Data.ValidationType enumeration specifying acceptable validation to return OK.</param>
- <param name="icon">Specifies an icon to display on this form.</param>
- <param name="result">The string result that was typed into the dialog.</param>
- <returns>A DialogResult showing the outcome.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.ILogManager.LogInputBox(System.Windows.Forms.Form,System.String,System.String@)">
- <summary>
- Displays an InputBox form given the specified text string. The result is returned byref.
- A DialogResult is returned to show whether the user cancelled the form without providing input.
- </summary>
- <param name="owner">The window that owns this modal dialog.</param>
- <param name="text">The string text to use as an input prompt.</param>
- <param name="result">The string result that was typed into the dialog.</param>
- <returns>A DialogResult showing the outcome.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.ILogManager.LogInputBox(System.Windows.Forms.Form,System.String,System.String,System.String@)">
- <summary>
- Displays an InputBox form given the specified text string. The result is returned byref.
- A DialogResult is returned to show whether the user cancelled the form without providing input.
- </summary>
- <param name="owner">The window that owns this modal dialog.</param>
- <param name="text">The string text to use as an input prompt.</param>
- <param name="caption">The string to use in the title bar of the InputBox.</param>
- <param name="result">The string result that was typed into the dialog.</param>
- <returns>A DialogResult showing the outcome.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.ILogManager.LogInputBox(System.Windows.Forms.Form,System.String,System.String,DotSpatial.Data.ValidationType,System.String@)">
- <summary>
- Displays an InputBox form given the specified text string. The result is returned byref.
- A DialogResult is returned to show whether the user cancelled the form without providing input.
- </summary>
- <param name="owner">The window that owns this modal dialog.</param>
- <param name="text">The string text to use as an input prompt.</param>
- <param name="caption">The string to use in the title bar of the InputBox.</param>
- <param name="validation">A DotSpatial.Data.ValidationType enumeration specifying acceptable validation to return OK.</param>
- <param name="result">The string result that was typed into the dialog.</param>
- <returns>A DialogResult showing the outcome.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.ILogManager.LogInputBox(System.Windows.Forms.Form,System.String,System.String,DotSpatial.Data.ValidationType,System.Drawing.Icon,System.String@)">
- <summary>
- Displays an InputBox form given the specified text string. The result is returned byref.
- A DialogResult is returned to show whether the user cancelled the form without providing input.
- </summary>
- <param name="owner">The window that owns this modal dialog.</param>
- <param name="text">The string text to use as an input prompt.</param>
- <param name="caption">The string to use in the title bar of the InputBox.</param>
- <param name="validation">A DotSpatial.Data.ValidationType enumeration specifying acceptable validation to return OK.</param>
- <param name="icon">Specifies an icon to display on this form.</param>
- <param name="result">The string result that was typed into the dialog.</param>
- <returns>A DialogResult showing the outcome.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.ILogManager.LogMessageBox(System.Windows.Forms.IWin32Window,System.String)">
- <summary>
- Shows a MessageBox, logs the text of the text and the result chosen by the user.
- </summary>
- <param name="owner">An implementation of the IWin32Window that will own the modal form dialog box.</param>
- <param name="text">The text to display in the MessageBox</param>
- <returns>A DialogResult showing the user input from this messagebox.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.ILogManager.LogMessageBox(System.Windows.Forms.IWin32Window,System.String,System.String)">
- <summary>
- Shows a MessageBox, logs the text of the text and the result chosen by the user.
- </summary>
- <param name="owner">An implementation of the IWin32Window that will own the modal form dialog box.</param>
- <param name="text">The text to display in the MessageBox</param>
- <param name="caption">The text to display in the title bar of the MessageBox</param>
- <returns>A DialogResult showing the user input from this messagebox.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.ILogManager.LogMessageBox(System.Windows.Forms.IWin32Window,System.String,System.String,System.Windows.Forms.MessageBoxButtons)">
- <summary>
- Shows a MessageBox, logs the text of the text and the result chosen by the user.
- </summary>
- <param name="owner">An implementation of the IWin32Window that will own the modal form dialog box.</param>
- <param name="text">The text to display in the MessageBox</param>
- <param name="caption">The text to display in the title bar of the MessageBox</param>
- <param name="buttons">One of the MessageBoxButtons that describes which button to display in the MessageBox</param>
- <returns>A DialogResult showing the user input from this messagebox.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.ILogManager.LogMessageBox(System.Windows.Forms.IWin32Window,System.String,System.String,System.Windows.Forms.MessageBoxButtons,System.Windows.Forms.MessageBoxIcon)">
- <summary>
- Shows a MessageBox, logs the text of the text and the result chosen by the user.
- </summary>
- <param name="owner">An implementation of the IWin32Window that will own the modal form dialog box.</param>
- <param name="text">The text to display in the MessageBox</param>
- <param name="caption">The text to display in the title bar of the MessageBox</param>
- <param name="buttons">One of the MessageBoxButtons that describes which button to display in the MessageBox</param>
- <param name="icon">One of the MessageBoxIcons that describes which icon to display in the MessageBox</param>
- <returns>A DialogResult showing the user input from this messagebox.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.ILogManager.LogMessageBox(System.Windows.Forms.IWin32Window,System.String,System.String,System.Windows.Forms.MessageBoxButtons,System.Windows.Forms.MessageBoxIcon,System.Windows.Forms.MessageBoxDefaultButton)">
- <summary>
- Shows a MessageBox, logs the text of the text and the result chosen by the user.
- </summary>
- <param name="owner">An implementation of the IWin32Window that will own the modal form dialog box.</param>
- <param name="text">The text to display in the MessageBox</param>
- <param name="caption">The text to display in the title bar of the MessageBox</param>
- <param name="buttons">One of the MessageBoxButtons that describes which button to display in the MessageBox</param>
- <param name="icon">One of the MessageBoxIcons that describes which icon to display in the MessageBox</param>
- <param name="defaultButton">One of the MessageBoxDefaultButtons that describes the default button for the MessageBox</param>
- <returns>A DialogResult showing the user input from this messagebox.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.ILogManager.LogMessageBox(System.Windows.Forms.IWin32Window,System.String,System.String,System.Windows.Forms.MessageBoxButtons,System.Windows.Forms.MessageBoxIcon,System.Windows.Forms.MessageBoxDefaultButton,System.Windows.Forms.MessageBoxOptions)">
- <summary>
- Shows a MessageBox, logs the text of the text and the result chosen by the user.
- </summary>
- <param name="owner">An implementation of the IWin32Window that will own the modal form dialog box.</param>
- <param name="text">The text to display in the MessageBox</param>
- <param name="caption">The text to display in the title bar of the MessageBox</param>
- <param name="buttons">One of the MessageBoxButtons that describes which button to display in the MessageBox</param>
- <param name="icon">One of the MessageBoxIcons that describes which icon to display in the MessageBox</param>
- <param name="defaultButton">One of the MessageBoxDefaultButtons that describes the default button for the MessageBox</param>
- <param name="options">One of the MessageBoxOptions that describes which display and association options to use for the MessageBox. You may pass 0 if you wish to use the defaults.</param>
- <returns>A DialogResult showing the user input from this messagebox.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.ILogManager.LogMessageBox(System.String)">
- <summary>
- Shows a MessageBox, logs the text of the text and the result chosen by the user.
- </summary>
- <param name="text">The text to display in the MessageBox</param>
- <returns>A DialogResult showing the user input from this messagebox.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.ILogManager.LogMessageBox(System.String,System.String)">
- <summary>
- Shows a MessageBox, logs the text of the text and the result chosen by the user.
- </summary>
- <param name="text">The text to display in the MessageBox</param>
- <param name="caption">The text to display in the title bar of the MessageBox</param>
- <returns>A DialogResult showing the user input from this messagebox.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.ILogManager.LogMessageBox(System.String,System.String,System.Windows.Forms.MessageBoxButtons)">
- <summary>
- Shows a MessageBox, logs the text of the text and the result chosen by the user.
- </summary>
- <param name="text">The text to display in the MessageBox</param>
- <param name="caption">The text to display in the title bar of the MessageBox</param>
- <param name="buttons">One of the MessageBoxButtons that describes which button to display in the MessageBox</param>
- <returns>A DialogResult showing the user input from this messagebox.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.ILogManager.LogMessageBox(System.String,System.String,System.Windows.Forms.MessageBoxButtons,System.Windows.Forms.MessageBoxIcon)">
- <summary>
- Shows a MessageBox, logs the text of the text and the result chosen by the user.
- </summary>
- <param name="text">The text to display in the MessageBox</param>
- <param name="caption">The text to display in the title bar of the MessageBox</param>
- <param name="buttons">One of the MessageBoxButtons that describes which button to display in the MessageBox</param>
- <param name="icon">One of the MessageBoxIcons that describes which icon to display in the MessageBox</param>
- <returns>A DialogResult showing the user input from this messagebox.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.ILogManager.LogMessageBox(System.String,System.String,System.Windows.Forms.MessageBoxButtons,System.Windows.Forms.MessageBoxIcon,System.Windows.Forms.MessageBoxDefaultButton)">
- <summary>
- Shows a MessageBox, logs the text of the text and the result chosen by the user.
- </summary>
- <param name="text">The text to display in the MessageBox</param>
- <param name="caption">The text to display in the title bar of the MessageBox</param>
- <param name="buttons">One of the MessageBoxButtons that describes which button to display in the MessageBox</param>
- <param name="icon">One of the MessageBoxIcons that describes which icon to display in the MessageBox</param>
- <param name="defaultButton">One of the MessageBoxDefaultButtons that describes the default button for the MessageBox</param>
- <returns>A DialogResult showing the user input from this messagebox.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.ILogManager.LogMessageBox(System.String,System.String,System.Windows.Forms.MessageBoxButtons,System.Windows.Forms.MessageBoxIcon,System.Windows.Forms.MessageBoxDefaultButton,System.Windows.Forms.MessageBoxOptions)">
- <summary>
- Shows a MessageBox, logs the text of the text and the result chosen by the user.
- </summary>
- <param name="text">The text to display in the MessageBox</param>
- <param name="caption">The text to display in the title bar of the MessageBox</param>
- <param name="buttons">One of the MessageBoxButtons that describes which button to display in the MessageBox</param>
- <param name="icon">One of the MessageBoxIcons that describes which icon to display in the MessageBox</param>
- <param name="defaultButton">One of the MessageBoxDefaultButtons that describes the default button for the MessageBox</param>
- <param name="options">One of the MessageBoxOptions that describes which display and association options to use for the MessageBox. You may pass 0 if you wish to use the defaults.</param>
- <returns>A DialogResult showing the user input from this messagebox.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.ILogManager.LogMessageBox(System.String,System.String,System.Windows.Forms.MessageBoxButtons,System.Windows.Forms.MessageBoxIcon,System.Windows.Forms.MessageBoxDefaultButton,System.Windows.Forms.MessageBoxOptions,System.Boolean)">
- <summary>
- Shows a MessageBox, logs the text of the text and the result chosen by the user.
- </summary>
- <param name="text">The text to display in the MessageBox</param>
- <param name="caption">The text to display in the title bar of the MessageBox</param>
- <param name="buttons">One of the MessageBoxButtons that describes which button to display in the MessageBox</param>
- <param name="icon">One of the MessageBoxIcons that describes which icon to display in the MessageBox</param>
- <param name="defaultButton">One of the MessageBoxDefaultButtons that describes the default button for the MessageBox</param>
- <param name="options">One of the MessageBoxOptions that describes which display and association options to use for the MessageBox. You may pass 0 if you wish to use the defaults.</param>
- <param name="displayHelpButton">A boolean indicating whether or not to display a help button on the messagebox</param>
- <returns>A DialogResult showing the user input from this messagebox.</returns>
- </member>
- <member name="T:DotSpatial.Data.Forms.InputBox">
- <summary>
- frmInputBox
- </summary>
- </member>
- <member name="F:DotSpatial.Data.Forms.InputBox.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Forms.InputBox.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Forms.InputBox.#ctor">
- <summary>
- Creates a new instance of frmInputBox
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Forms.InputBox.#ctor(System.String)">
- <summary>
- Creates a new instance of frmInputBox
- </summary>
- <param name="text">Sets the text of the message to show.</param>
- </member>
- <member name="M:DotSpatial.Data.Forms.InputBox.#ctor(System.String,System.String)">
- <summary>
- Creates a new instance of frmInputBox
- </summary>
- <param name="text">The string message to show.</param>
- <param name="caption">The string caption to allow.</param>
- </member>
- <member name="M:DotSpatial.Data.Forms.InputBox.#ctor(System.String,System.String,DotSpatial.Data.ValidationType)">
- <summary>
- Creates a new instance of frmInputBox
- </summary>
- <param name="text">The string message to show.</param>
- <param name="caption">The string caption to allow.</param>
- <param name="validation">A DotSpatial.Data.ValidationType enumeration specifying acceptable validation to return OK.</param>
- </member>
- <member name="M:DotSpatial.Data.Forms.InputBox.#ctor(System.String,System.String,DotSpatial.Data.ValidationType,System.Drawing.Icon)">
- <summary>
- Creates a new instance of frmInputBox
- </summary>
- <param name="text">The string message to show.</param>
- <param name="caption">The string caption to allow.</param>
- <param name="validation">A DotSpatial.Data.ValidationType enumeration specifying acceptable validation to return OK.</param>
- <param name="icon">Specifies an icon to appear on this messagebox.</param>
- </member>
- <member name="M:DotSpatial.Data.Forms.InputBox.#ctor(System.Windows.Forms.Form,System.String)">
- <summary>
- Creates a new instance of frmInputBox
- </summary>
- <param name="owner">Specifies the Form to set as the owner of this dialog.</param>
- <param name="text">Sets the text of the message to show.</param>
- </member>
- <member name="M:DotSpatial.Data.Forms.InputBox.#ctor(System.Windows.Forms.Form,System.String,System.String)">
- <summary>
- Creates a new instance of frmInputBox
- </summary>
- <param name="owner">Specifies the Form to set as the owner of this dialog.</param>
- <param name="text">The string message to show.</param>
- <param name="caption">The string caption to allow.</param>
- </member>
- <member name="M:DotSpatial.Data.Forms.InputBox.#ctor(System.Windows.Forms.Form,System.String,System.String,DotSpatial.Data.ValidationType)">
- <summary>
- Creates a new instance of frmInputBox
- </summary>
- <param name="owner">Specifies the Form to set as the owner of this dialog.</param>
- <param name="text">The string message to show.</param>
- <param name="caption">The string caption to allow.</param>
- <param name="validation">A DotSpatial.Data.ValidationType enumeration specifying acceptable validation to return OK.</param>
- </member>
- <member name="M:DotSpatial.Data.Forms.InputBox.#ctor(System.Windows.Forms.Form,System.String,System.String,DotSpatial.Data.ValidationType,System.Drawing.Icon)">
- <summary>
- Creates a new instance of frmInputBox
- </summary>
- <param name="owner">Specifies the Form to set as the owner of this dialog.</param>
- <param name="text">The string message to show.</param>
- <param name="caption">The string caption to allow.</param>
- <param name="validation">A DotSpatial.Data.ValidationType enumeration specifying acceptable validation to return OK.</param>
- <param name="icon">Specifies an icon to appear on this messagebox.</param>
- </member>
- <member name="M:DotSpatial.Data.Forms.InputBox.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="P:DotSpatial.Data.Forms.InputBox.Result">
- <summary>
- The string result that was entered for this text box.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.InputBox.Validation">
- <summary>
- Gets or sets the type of validation to force on the value before the OK option is permitted.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.Forms.ItemType">
- <summary>
- ItemTypes
- </summary>
- </member>
- <member name="F:DotSpatial.Data.Forms.ItemType.Folder">
- <summary>
- The specified element is a folder
- </summary>
- </member>
- <member name="F:DotSpatial.Data.Forms.ItemType.Image">
- <summary>
- The specified element is an image
- </summary>
- </member>
- <member name="F:DotSpatial.Data.Forms.ItemType.Line">
- <summary>
- The specified element is a vector line file format
- </summary>
- </member>
- <member name="F:DotSpatial.Data.Forms.ItemType.Point">
- <summary>
- The specified element is a vector line point format
- </summary>
- </member>
- <member name="F:DotSpatial.Data.Forms.ItemType.Polygon">
- <summary>
- The specified element is a vector polygon format
- </summary>
- </member>
- <member name="F:DotSpatial.Data.Forms.ItemType.Raster">
- <summary>
- The specified element is a raster format
- </summary>
- </member>
- <member name="F:DotSpatial.Data.Forms.ItemType.Custom">
- <summary>
- The specified element is a custom format, so the custom icon is used
- </summary>
- </member>
- <member name="T:DotSpatial.Data.Forms.LogManager">
- <summary>
- This component allows customization of how log messages are sent
- </summary>
- </member>
- <member name="F:DotSpatial.Data.Forms.LogManager._components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="F:DotSpatial.Data.Forms.LogManager.DefaultLogManager">
- <summary>
- This ensures that there will always be some kind of log manager.
- When a new LogManager is created, this static is set to be that instance.
- Controlling the DefaultLogManager will control which log manager
- is actively in use.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Forms.LogManager.#ctor">
- <summary>
- Creates a new instance of the LogManager.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Forms.LogManager.AddLogger(DotSpatial.Data.Forms.ILogger)">
- <summary>
- To begin logging, create an implementation of the ILogHandler interface,
- or use the DefaultLogger class that is already implemented in this project.
- Then, call this function to add that logger to the list of active loggers.
- This function will return an integer key that you can use to keep track
- of your specific logger.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Forms.LogManager.RemoveLogger(System.Int32)">
- <summary>
- The key specified here is the key that was returned by the AddLogger method.
- </summary>
- <param name="key">The integer key of the logger to remove.</param>
- <returns>True if the logger was successfully removed, or false if the key could not be found</returns>
- <exception cref="T:System.ArgumentNullException">key is null</exception>
- </member>
- <member name="M:DotSpatial.Data.Forms.LogManager.AddLoggersFromDirectories">
- <summary>
- Adds all the loggers from directories.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.LogManager.Exception(System.Exception)">
- <summary>
- The Complete exception is passed here. To get the stack
- trace, be sure to call ex.ToString().
- </summary>
- <param name="ex">The exception that was thrown by DotSpatial.</param>
- </member>
- <member name="M:DotSpatial.Data.Forms.LogManager.PublicMethodEntered(System.String,System.Collections.Generic.List{System.String})">
- <summary>
- This event will allow the registering of an entrance into a public Method of a "tools" related
- action to register its entrance into a function as well as logging the parameter names
- and a type specific indicator of their value.
- </summary>
- <param name="methodName">The string name of the method</param>
- <param name="parameters">The List<string> of Parameter names and string form values</param>
- </member>
- <member name="M:DotSpatial.Data.Forms.LogManager.PublicMethodLeft(System.String)">
- <summary>
- This event will allow the registering of the exit from each public method
- </summary>
- <param name="methodName">The Method name of the method being left</param>
- </member>
- <member name="M:DotSpatial.Data.Forms.LogManager.Status(System.String)">
- <summary>
- A status message was sent. Complex methods that have a few major steps will
- call a status message to show which step the process is in. Loops will call
- the progress method instead.
- </summary>
- <param name="message">The string message that was posted.</param>
- </member>
- <member name="M:DotSpatial.Data.Forms.LogManager.Progress(System.String,System.Int32,System.String)">
- <summary>
- A progress message, generally as part of a long loop was sent. It is a bad
- idea to log these to a file as there may be thousands of them.
- </summary>
- <param name="baseMessage">The status part of the progress message with no percent information</param>
- <param name="percent">The integer percent from 0 to 100</param>
- <param name="message">The complete message, showing both status and completion percent</param>
- </member>
- <member name="M:DotSpatial.Data.Forms.LogManager.LogMessage(System.String,System.Windows.Forms.DialogResult)">
- <summary>
- This is called by each of the LogMessageBox methods automatically, but if the user wants to use
- a custom messagebox and then log the message and result directly this is the technique.
- </summary>
- <param name="text">The string text of the message that needs to be logged.</param>
- <param name="result">The dialog result from the shown messagebox.</param>
- </member>
- <member name="M:DotSpatial.Data.Forms.LogManager.LogInput(System.String,System.Windows.Forms.DialogResult,System.String)">
- <summary>
- This method echoes information about input boxes to all the loggers.
- </summary>
- <param name="text">The string message that appeared on the InputBox</param>
- <param name="result">The ystem.Windows.Forms.DialogResult describing if the value was cancelled </param>
- <param name="value">The string containing the value entered.</param>
- </member>
- <member name="M:DotSpatial.Data.Forms.LogManager.LogMessageBox(System.Windows.Forms.IWin32Window,System.String)">
- <summary>
- Shows a MessageBox, logs the text of the text and the result chosen by the user.
- </summary>
- <param name="owner">An implementation of the IWin32Window that will own the modal form dialog box.</param>
- <param name="text">The text to display in the MessageBox</param>
- <returns>A DialogResult showing the user input from this messagebox.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.LogManager.LogMessageBox(System.Windows.Forms.IWin32Window,System.String,System.String)">
- <summary>
- Shows a MessageBox, logs the text of the text and the result chosen by the user.
- </summary>
- <param name="owner">An implementation of the IWin32Window that will own the modal form dialog box.</param>
- <param name="text">The text to display in the MessageBox</param>
- <param name="caption">The text to display in the title bar of the MessageBox</param>
- <returns>A DialogResult showing the user input from this messagebox.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.LogManager.LogMessageBox(System.Windows.Forms.IWin32Window,System.String,System.String,System.Windows.Forms.MessageBoxButtons)">
- <summary>
- Shows a MessageBox, logs the text of the text and the result chosen by the user.
- </summary>
- <param name="owner">An implementation of the IWin32Window that will own the modal form dialog box.</param>
- <param name="text">The text to display in the MessageBox</param>
- <param name="caption">The text to display in the title bar of the MessageBox</param>
- <param name="buttons">One of the MessageBoxButtons that describes which button to display in the MessageBox</param>
- <returns>A DialogResult showing the user input from this messagebox.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.LogManager.LogMessageBox(System.Windows.Forms.IWin32Window,System.String,System.String,System.Windows.Forms.MessageBoxButtons,System.Windows.Forms.MessageBoxIcon)">
- <summary>
- Shows a MessageBox, logs the text of the text and the result chosen by the user.
- </summary>
- <param name="owner">An implementation of the IWin32Window that will own the modal form dialog box.</param>
- <param name="text">The text to display in the MessageBox</param>
- <param name="caption">The text to display in the title bar of the MessageBox</param>
- <param name="buttons">One of the MessageBoxButtons that describes which button to display in the MessageBox</param>
- <param name="icon">One of the MessageBoxIcons that describes which icon to display in the MessageBox</param>
- <returns>A DialogResult showing the user input from this messagebox.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.LogManager.LogMessageBox(System.Windows.Forms.IWin32Window,System.String,System.String,System.Windows.Forms.MessageBoxButtons,System.Windows.Forms.MessageBoxIcon,System.Windows.Forms.MessageBoxDefaultButton)">
- <summary>
- Shows a MessageBox, logs the text of the text and the result chosen by the user.
- </summary>
- <param name="owner">An implementation of the IWin32Window that will own the modal form dialog box.</param>
- <param name="text">The text to display in the MessageBox</param>
- <param name="caption">The text to display in the title bar of the MessageBox</param>
- <param name="buttons">One of the MessageBoxButtons that describes which button to display in the MessageBox</param>
- <param name="icon">One of the MessageBoxIcons that describes which icon to display in the MessageBox</param>
- <param name="defaultButton">One of the MessageBoxDefaultButtons that describes the default button for the MessageBox</param>
- <returns>A DialogResult showing the user input from this messagebox.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.LogManager.LogMessageBox(System.Windows.Forms.IWin32Window,System.String,System.String,System.Windows.Forms.MessageBoxButtons,System.Windows.Forms.MessageBoxIcon,System.Windows.Forms.MessageBoxDefaultButton,System.Windows.Forms.MessageBoxOptions)">
- <summary>
- Shows a MessageBox, logs the text of the text and the result chosen by the user.
- </summary>
- <param name="owner">An implementation of the IWin32Window that will own the modal form dialog box.</param>
- <param name="text">The text to display in the MessageBox</param>
- <param name="caption">The text to display in the title bar of the MessageBox</param>
- <param name="buttons">One of the MessageBoxButtons that describes which button to display in the MessageBox</param>
- <param name="icon">One of the MessageBoxIcons that describes which icon to display in the MessageBox</param>
- <param name="defaultButton">One of the MessageBoxDefaultButtons that describes the default button for the MessageBox</param>
- <param name="options">One of the MessageBoxOptions that describes which display and association options to use for the MessageBox. You may pass 0 if you wish to use the defaults.</param>
- <returns>A DialogResult showing the user input from this messagebox.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.LogManager.LogMessageBox(System.String)">
- <summary>
- Shows a MessageBox, logs the text of the text and the result chosen by the user.
- </summary>
- <param name="text">The text to display in the MessageBox</param>
- <returns>A DialogResult showing the user input from this messagebox.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.LogManager.LogMessageBox(System.String,System.String)">
- <summary>
- Shows a MessageBox, logs the text of the text and the result chosen by the user.
- </summary>
- <param name="text">The text to display in the MessageBox</param>
- <param name="caption">The text to display in the title bar of the MessageBox</param>
- <returns>A DialogResult showing the user input from this messagebox.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.LogManager.LogMessageBox(System.String,System.String,System.Windows.Forms.MessageBoxButtons)">
- <summary>
- Shows a MessageBox, logs the text of the text and the result chosen by the user.
- </summary>
- <param name="text">The text to display in the MessageBox</param>
- <param name="caption">The text to display in the title bar of the MessageBox</param>
- <param name="buttons">One of the MessageBoxButtons that describes which button to display in the MessageBox</param>
- <returns>A DialogResult showing the user input from this messagebox.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.LogManager.LogMessageBox(System.String,System.String,System.Windows.Forms.MessageBoxButtons,System.Windows.Forms.MessageBoxIcon)">
- <summary>
- Shows a MessageBox, logs the text of the text and the result chosen by the user.
- </summary>
- <param name="text">The text to display in the MessageBox</param>
- <param name="caption">The text to display in the title bar of the MessageBox</param>
- <param name="buttons">One of the MessageBoxButtons that describes which button to display in the MessageBox</param>
- <param name="icon">One of the MessageBoxIcons that describes which icon to display in the MessageBox</param>
- <returns>A DialogResult showing the user input from this messagebox.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.LogManager.LogMessageBox(System.String,System.String,System.Windows.Forms.MessageBoxButtons,System.Windows.Forms.MessageBoxIcon,System.Windows.Forms.MessageBoxDefaultButton)">
- <summary>
- Shows a MessageBox, logs the text of the text and the result chosen by the user.
- </summary>
- <param name="text">The text to display in the MessageBox</param>
- <param name="caption">The text to display in the title bar of the MessageBox</param>
- <param name="buttons">One of the MessageBoxButtons that describes which button to display in the MessageBox</param>
- <param name="icon">One of the MessageBoxIcons that describes which icon to display in the MessageBox</param>
- <param name="defaultButton">One of the MessageBoxDefaultButtons that describes the default button for the MessageBox</param>
- <returns>A DialogResult showing the user input from this messagebox.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.LogManager.LogMessageBox(System.String,System.String,System.Windows.Forms.MessageBoxButtons,System.Windows.Forms.MessageBoxIcon,System.Windows.Forms.MessageBoxDefaultButton,System.Windows.Forms.MessageBoxOptions)">
- <summary>
- Shows a MessageBox, logs the text of the text and the result chosen by the user.
- </summary>
- <param name="text">The text to display in the MessageBox</param>
- <param name="caption">The text to display in the title bar of the MessageBox</param>
- <param name="buttons">One of the MessageBoxButtons that describes which button to display in the MessageBox</param>
- <param name="icon">One of the MessageBoxIcons that describes which icon to display in the MessageBox</param>
- <param name="defaultButton">One of the MessageBoxDefaultButtons that describes the default button for the MessageBox</param>
- <param name="options">One of the MessageBoxOptions that describes which display and association options to use for the MessageBox. You may pass 0 if you wish to use the defaults.</param>
- <returns>A DialogResult showing the user input from this messagebox.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.LogManager.LogMessageBox(System.String,System.String,System.Windows.Forms.MessageBoxButtons,System.Windows.Forms.MessageBoxIcon,System.Windows.Forms.MessageBoxDefaultButton,System.Windows.Forms.MessageBoxOptions,System.Boolean)">
- <summary>
- Shows a MessageBox, logs the text of the text and the result chosen by the user.
- </summary>
- <param name="text">The text to display in the MessageBox</param>
- <param name="caption">The text to display in the title bar of the MessageBox</param>
- <param name="buttons">One of the MessageBoxButtons that describes which button to display in the MessageBox</param>
- <param name="icon">One of the MessageBoxIcons that describes which icon to display in the MessageBox</param>
- <param name="defaultButton">One of the MessageBoxDefaultButtons that describes the default button for the MessageBox</param>
- <param name="options">One of the MessageBoxOptions that describes which display and association options to use for the MessageBox. You may pass 0 if you wish to use the defaults.</param>
- <param name="displayHelpButton">A boolean indicating whether or not to display a help button on the messagebox</param>
- <returns>A DialogResult showing the user input from this messagebox.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.LogManager.LogInputBox(System.String,System.String@)">
- <summary>
- Displays an InputBox form given the specified text string. The result is returned byref.
- A DialogResult is returned to show whether the user cancelled the form without providing input.
- </summary>
- <param name="text">The string text to use as an input prompt.</param>
- <param name="result">The string result that was typed into the dialog.</param>
- <returns>A DialogResult showing the outcome.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.LogManager.LogInputBox(System.String,System.String,System.String@)">
- <summary>
- Displays an InputBox form given the specified text string. The result is returned byref.
- A DialogResult is returned to show whether the user cancelled the form without providing input.
- </summary>
- <param name="text">The string text to use as an input prompt.</param>
- <param name="caption">The string to use in the title bar of the InputBox.</param>
- <param name="result">The string result that was typed into the dialog.</param>
- <returns>A DialogResult showing the outcome.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.LogManager.LogInputBox(System.String,System.String,DotSpatial.Data.ValidationType,System.String@)">
- <summary>
- Displays an InputBox form given the specified text string. The result is returned byref.
- A DialogResult is returned to show whether the user cancelled the form without providing input.
- </summary>
- <param name="text">The string text to use as an input prompt.</param>
- <param name="caption">The string to use in the title bar of the InputBox.</param>
- <param name="validation">A DotSpatial.Data.ValidationType enumeration specifying acceptable validation to return OK.</param>
- <param name="result">The string result that was typed into the dialog.</param>
- <returns>A DialogResult showing the outcome.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.LogManager.LogInputBox(System.String,System.String,DotSpatial.Data.ValidationType,System.Drawing.Icon,System.String@)">
- <summary>
- Displays an InputBox form given the specified text string. The result is returned byref.
- A DialogResult is returned to show whether the user cancelled the form without providing input.
- </summary>
- <param name="text">The string text to use as an input prompt.</param>
- <param name="caption">The string to use in the title bar of the InputBox.</param>
- <param name="validation">A DotSpatial.Data.ValidationType enumeration specifying acceptable validation to return OK.</param>
- <param name="icon">Specifies an icon to display on this form.</param>
- <param name="result">The string result that was typed into the dialog.</param>
- <returns>A DialogResult showing the outcome.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.LogManager.LogInputBox(System.Windows.Forms.Form,System.String,System.String@)">
- <summary>
- Displays an InputBox form given the specified text string. The result is returned byref.
- A DialogResult is returned to show whether the user cancelled the form without providing input.
- </summary>
- <param name="owner">The window that owns this modal dialog.</param>
- <param name="text">The string text to use as an input prompt.</param>
- <param name="result">The string result that was typed into the dialog.</param>
- <returns>A DialogResult showing the outcome.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.LogManager.LogInputBox(System.Windows.Forms.Form,System.String,System.String,System.String@)">
- <summary>
- Displays an InputBox form given the specified text string. The result is returned byref.
- A DialogResult is returned to show whether the user cancelled the form without providing input.
- </summary>
- <param name="owner">The window that owns this modal dialog.</param>
- <param name="text">The string text to use as an input prompt.</param>
- <param name="caption">The string to use in the title bar of the InputBox.</param>
- <param name="result">The string result that was typed into the dialog.</param>
- <returns>A DialogResult showing the outcome.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.LogManager.LogInputBox(System.Windows.Forms.Form,System.String,System.String,DotSpatial.Data.ValidationType,System.String@)">
- <summary>
- Displays an InputBox form given the specified text string. The result is returned byref.
- A DialogResult is returned to show whether the user cancelled the form without providing input.
- </summary>
- <param name="owner">The window that owns this modal dialog.</param>
- <param name="text">The string text to use as an input prompt.</param>
- <param name="caption">The string to use in the title bar of the InputBox.</param>
- <param name="validation">A DotSpatial.Data.ValidationType enumeration specifying acceptable validation to return OK.</param>
- <param name="result">The string result that was typed into the dialog.</param>
- <returns>A DialogResult showing the outcome.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.LogManager.LogInputBox(System.Windows.Forms.Form,System.String,System.String,DotSpatial.Data.ValidationType,System.Drawing.Icon,System.String@)">
- <summary>
- Displays an InputBox form given the specified text string. The result is returned byref.
- A DialogResult is returned to show whether the user cancelled the form without providing input.
- </summary>
- <param name="owner">The window that owns this modal dialog.</param>
- <param name="text">The string text to use as an input prompt.</param>
- <param name="caption">The string to use in the title bar of the InputBox.</param>
- <param name="validation">A DotSpatial.Data.ValidationType enumeration specifying acceptable validation to return OK.</param>
- <param name="icon">Specifies an icon to display on this form.</param>
- <param name="result">The string result that was typed into the dialog.</param>
- <returns>A DialogResult showing the outcome.</returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.LogManager.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.LogManager.Components1">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.LogManager.Directories">
- <summary>
- Gets or sets the list of string directories that may contain dlls with ILogManagers
- </summary>
- </member>
- <member name="T:DotSpatial.Data.Forms.NavigateEventArgs">
- <summary>
- NavigateEventArgs
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Forms.NavigateEventArgs.#ctor(System.String)">
- <summary>
- Creates a new instance of NavigateEventArgs
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.NavigateEventArgs.Path">
- <summary>
- Gets the string path that is being navigated to
- </summary>
- </member>
- <member name="T:DotSpatial.Data.Forms.OpenDataDialog">
- <summary>
- frmOpenDataDialog
- </summary>
- </member>
- <member name="F:DotSpatial.Data.Forms.OpenDataDialog.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Forms.OpenDataDialog.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Forms.OpenDataDialog.#ctor">
- <summary>
- Creates a new instance of frmOpenDataDialog
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Forms.OpenDataDialog.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="T:DotSpatial.Data.Forms.OpenFileElement">
- <summary>
- The OpenFileElement can be added directly to a form and supports all of the
- basic dialog options that are important for browsing vector/raster/image
- data.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.Forms.RasterExt">
- <summary>
- Extension method for raster
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Forms.RasterExt.Open(DotSpatial.Data.Raster)">
- <summary>
- Displays a dialog, allowing the users to open a raster.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.Forms.SelectEventArgs">
- <summary>
- SelectEventArgs
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Forms.SelectEventArgs.#ctor(System.Boolean)">
- <summary>
- Creates a new instance of SelectEventArgs
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.SelectEventArgs.IsSelected">
- <summary>
- Gets whether or not the new state of the item is selected
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.SelectEventArgs.Modifiers">
- <summary>
- Gets the modifiers that existed when this event is fired.
- use like if (Modifiers and Keys.Shift){}
- </summary>
- </member>
- <member name="T:DotSpatial.Data.Forms.ShapefileExt">
- <summary>
- Extension method for shapefile
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Forms.ShapefileExt.OpenFile(DotSpatial.Data.Shapefile)">
- <summary>
- This will use this object to open a shapefile, but launches an open file dialog for the user
- to select the file to open.
- </summary>
- <returns>A new Shapefile created from the file chosen by the open file dialog.</returns>
- </member>
- <member name="T:DotSpatial.Data.Forms.TimedProgressMeter">
- <summary>
- This handles the methodology of progress messaging in one place to make it easier to update.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Forms.TimedProgressMeter.#ctor(DotSpatial.Data.IProgressHandler,System.String,System.TimeSpan)">
- <summary>
- Constructs a Time-Based progress meter that shows progress against an expected time.
- </summary>
- <param name="progressHandler"></param>
- <param name="baseMessage"></param>
- <param name="estimatedTime"></param>
- </member>
- <member name="M:DotSpatial.Data.Forms.TimedProgressMeter.#ctor">
- <summary>
- Intializes a new progress meter, but doesn't support the IProgressHandler unless one is specified.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Forms.TimedProgressMeter.#ctor(DotSpatial.Data.IProgressHandler)">
- <summary>
- A progress meter can't actually do anything without a progressHandler, which actually displays the status.
- </summary>
- <param name="progressHandler">An IProgressHandler that will actually handle the status messages sent by this meter.</param>
- </member>
- <member name="M:DotSpatial.Data.Forms.TimedProgressMeter.#ctor(DotSpatial.Data.IProgressHandler,System.String)">
- <summary>
- A progress meter that simply keeps track of progress and is capable of sending progress messages.
- This assumes a MaxValue of 100 unless it is changed later.
- </summary>
- <param name="progressHandler">Any valid IProgressHandler that will display progress messages</param>
- <param name="baseMessage">A base message to use as the basic status for this progress handler.</param>
- </member>
- <member name="M:DotSpatial.Data.Forms.TimedProgressMeter.#ctor(DotSpatial.Data.IProgressHandler,System.String,System.Object)">
- <summary>
- A progress meter that simply keeps track of progress and is capable of sending progress messages.
- </summary>
- <param name="progressHandler">Any valid implementation if IProgressHandler that will handle the progress function</param>
- <param name="baseMessage">The message without any progress information.</param>
- <param name="endValue">Percent shoudl show a range between the MinValue and MaxValue. MinValue is assumed to be 0.</param>
- </member>
- <member name="M:DotSpatial.Data.Forms.TimedProgressMeter.Reset">
- <summary>
- Resets the progress meter to the 0 value. This sets the status message to "Ready.".
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Forms.TimedProgressMeter.SendProgress">
- <summary>
- Sends a progress message to the IProgressHandler interface with the current message and progres
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.TimedProgressMeter.Key">
- <summary>
- Gets or sets the string that does not include any mention of progress percentage, but specifies what is occuring.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.TimedProgressMeter.CurrentPercent">
- <summary>
- Gets or sets the current integer progress level from 0 to 100. If a new update is less than or equal to the previous
- value, then no progress will be displayed by the ProgressMeter. Values less than 0 are set to 0. Values greater than
- 100 are set to 100.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.TimedProgressMeter.CurrentValue">
- <summary>
- Gets or sets the current value relative to the specified MaxValue in order to update the progress.
- Setting this will also update OldProgress if there is an integer change in the percentage, and send
- a progress message to the IProgressHandler interface.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.TimedProgressMeter.EndValue">
- <summary>
- The value that defines when the meter should show as 100% complete.
- EndValue can be less than StartValue, but values closer to EndValue
- will show as being closer to 100%.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.TimedProgressMeter.Silent">
- <summary>
- Gets or sets whether the progress meter should send messages to the IProgressHandler.
- By default Silent is false, but setting this to true will disable the messaging portion.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.TimedProgressMeter.StartValue">
- <summary>
- The minimum value defines when the meter should show as 0% complete.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.TimedProgressMeter.StepPercent">
- <summary>
- An integer value that is 1 by default. Ordinarilly this will send a progress message only when the integer progress
- has changed by 1 percentage point. For example, if StepPercent were set to 5, then a progress update would only
- be sent out at 5%, 10% and so on. This helps reduce overhead in cases where showing status messages is actually
- the majority of the processing time for the function.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.TimedProgressMeter.PreviousPercent">
- <summary>
- Gets or sets the previous integer progress level from 0 to 100. If a new update is less than or equal to the previous
- value, then no progress will be displayed by the ProgressMeter. Values less than 0 are set to 0. Values greater than
- 100 are set to 100.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.TimedProgressMeter.ProgressHandler">
- <summary>
- Gets or sets the progress handler for this meter
- </summary>
- </member>
- <member name="T:DotSpatial.Data.Forms.TryXmlDocument">
- <summary>
- TryXmlDocument
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Forms.TryXmlDocument.#ctor">
- <summary>
- Creates a new instance of TryXmlDocument
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Forms.TryXmlDocument.NavigateToChild(System.String)">
- <summary>
- This changes CurrentNode to the child node with the specified name.
- If there are no child nodes, or the child node is not found, this returns false.
- If the navigation is successful, this returns true.
- </summary>
- <param name="name"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.TryXmlDocument.NavigateToParent">
- <summary>
- Attempts to navigate to the parent.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Forms.TryXmlDocument.Open(System.String)">
- <summary>
- Opens the specified
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Forms.TryXmlDocument.ReadText(System.String)">
- <summary>
- Attempts to read the string for the specified value. This will first test to see if the
- attribute exists and encloses the test in a try block. If it fails or the node does not
- exist, the default value is returned.
- </summary>
- <param name="attribute">The string name for the attribute to read from the CurrentElement.</param>
- <returns>A string specifying the value</returns>
- <exception cref="T:DotSpatial.Data.Forms.TryXmlDocumentException">CurrentElement Not Specified</exception>
- </member>
- <member name="M:DotSpatial.Data.Forms.TryXmlDocument.ReadColor(System.String)">
- <summary>
- Attempts to read the color from a text representation of an argb integer value.
- </summary>
- <param name="attribute">The name of the attribute to read from the CurrentElement</param>
- <returns>A Color structure</returns>
- <exception cref="T:DotSpatial.Data.Forms.TryXmlDocumentException">CurrentElement Not Specified</exception>
- </member>
- <member name="M:DotSpatial.Data.Forms.TryXmlDocument.ReadBool(System.String)">
- <summary>
- Attempts to read the boolean value from the specified attribute, translating it from
- a text equivalent.
- </summary>
- <param name="attribute">The string name of the attribute to read from the CurrentElement</param>
- <returns>A boolean value based on parsing the text.</returns>
- <exception cref="T:DotSpatial.Data.Forms.TryXmlDocumentException">CurrentElement Not Specified</exception>
- </member>
- <member name="M:DotSpatial.Data.Forms.TryXmlDocument.ReadInteger(System.String)">
- <summary>
- Attempts to read the integer value from the specified attribute, translating it from
- a text equivalent via parsing.
- </summary>
- <param name="attribute">The string name of the attribute to read from the CurrentElement</param>
- <returns>An integer parsed from the inner text of the specified attribute on the CurrentElement</returns>
- <exception cref="T:DotSpatial.Data.Forms.TryXmlDocumentException">CurrentElement Not Specified</exception>
- </member>
- <member name="M:DotSpatial.Data.Forms.TryXmlDocument.ReadDouble(System.String)">
- <summary>
- Attempts to read the double value from the specified attribute, translating it from
- a text equivalent via parsing.
- </summary>
- <param name="attribute">The string name of the attribute to read from the CurrentElement</param>
- <returns>A double value parsed from the inner text of the specified attribute on the CurrentElement</returns>
- <exception cref="T:DotSpatial.Data.Forms.TryXmlDocumentException">CurrentElement Not Specified</exception>
- </member>
- <member name="P:DotSpatial.Data.Forms.TryXmlDocument.Filename">
- <summary>
- Gets or sets the fileName for this document.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.TryXmlDocument.Document">
- <summary>
- Gets or sets the XmlDocument that this class uses for data access.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Forms.TryXmlDocument.CurrentElement">
- <summary>
- Gets or sets the current node that should be referenced for reading attributes.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.Forms.TryXmlDocumentException">
- <summary>
- TryXmlDocumentException
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Forms.TryXmlDocumentException.#ctor(System.String)">
- <summary>
- Creates a new instance of TryXmlDocumentException
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Forms.TryXmlDocumentException.Log">
- <summary>
- Logs this exception
- </summary>
- </member>
- </members>
-</doc>
diff --git a/MES_Wind/bin/Debug/DotSpatial.Data.pdb b/MES_Wind/bin/Debug/DotSpatial.Data.pdb
deleted file mode 100644
index 0947a43e53280df0cf6699e6d56f7c4cae3858a7..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/DotSpatial.Data.pdb and /dev/null differ
diff --git a/MES_Wind/bin/Debug/DotSpatial.Data.xml b/MES_Wind/bin/Debug/DotSpatial.Data.xml
deleted file mode 100644
index 752de359182cfe522d01a2a418ad7d2274353f29..0000000000000000000000000000000000000000
--- a/MES_Wind/bin/Debug/DotSpatial.Data.xml
+++ /dev/null
@@ -1,19161 +0,0 @@
-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>DotSpatial.Data</name>
- </assembly>
- <members>
- <member name="T:DotSpatial.Data.Argb">
- <summary>
- Tiny structure for storing A,R,G,B components of Color
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Argb.ByteRange(System.Int32)">
- <summary>
- Returns an integer that ranges from 0 to 255. If value is larger than 255, the value will be equal to 255.
- If the value is smaller than 255, it will be equal to 255.
- </summary>
- <param name="value">A Double value to convert.</param>
- <returns>An integer ranging from 0 to 255</returns>
- </member>
- <member name="T:DotSpatial.Data.BinaryReaderWriterExtensions">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Data.BinaryReaderWriterExtensions.Write``1(System.IO.BinaryWriter,``0)">
- <summary>
- Writes the specified type.
- </summary>
- <typeparam name="T"></typeparam>
- <param name="writer">The writer.</param>
- <param name="num">The value.</param>
- </member>
- <member name="M:DotSpatial.Data.BinaryReaderWriterExtensions.Read``1(System.IO.BinaryReader)">
- <summary>
- Reads the specified type.
- </summary>
- <typeparam name="T"></typeparam>
- <param name="reader">The reader.</param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Data.DbaseLocaleRegistry">
- <summary>
- A registry used to map CLR cultures and encodings to
- dBase language driver id (LDID) encoding specifiers.
- </summary>
- <remarks>
- Lookup values are taken from Esri's
- <a href="http://downloads.esri.com/support/documentation/pad_/ArcPad_RefGuide_1105.pdf">
- ArcPad Reference Guide</a>
- </remarks>
- </member>
- <member name="M:DotSpatial.Data.DbaseLocaleRegistry.GetCulture(System.Byte)">
- <summary>
- Gets the <see cref="T:System.Globalization.CultureInfo"/> associated with the
- given dBase LDID.
- </summary>
- <param name="dBaseEncoding">
- The language driver id (LDID) to get a CultureInfo for.
- </param>
- <returns>
- A <see cref="T:System.Globalization.CultureInfo"/> which uses the encoding represented by
- <paramref name="dBaseEncoding"/> by default.
- </returns>
- </member>
- <member name="M:DotSpatial.Data.DbaseLocaleRegistry.GetEncoding(System.Byte)">
- <summary>
- Gets the <see cref="T:System.Text.Encoding"/> which matches the
- given dBase LDID.
- </summary>
- <param name="dBaseEncoding">
- The language driver id (LDID) to get the <see cref="T:System.Text.Encoding"/> for.
- </param>
- <returns>
- An <see cref="T:System.Text.Encoding"/> which corresponds to the the
- <paramref name="dBaseEncoding"/> code established by Esri.
- </returns>
- </member>
- <member name="M:DotSpatial.Data.DbaseLocaleRegistry.GetLanguageDriverId(System.Text.Encoding)">
- <summary>
- Gets a language driver id (LDID) for the given encoding.
- </summary>
- <param name="encoding">The Encoding used to lookup the LDID.</param>
- <returns>A language driver code used to specify the encoding used to write text in the dBase file.</returns>
- <remarks>0x57 (Windows ANSI) is returned as a default if there is no associated LDID for the given encoding.</remarks>
- </member>
- <member name="T:DotSpatial.Data.DbaseLocaleRegistry.CodePageChoice">
- <summary>
- Specifies which code page to use in a <see cref="T:System.Globalization.TextInfo"/>
- instance.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.DbaseLocaleRegistry.CultureWithEncoding">
- <summary>
- Represents a culture and encoding pair.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.DisposeBase">
- <summary>
- This base class tries to correctly implement disposable, and should help make the behaviors
- more consistent across classes that inherit from this class.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IDisposeLock">
- <summary>
- Unlike forms that have a disposable life cycle with a clear chain of ownership, or purely managed
- libraries that have in a built in reference counting system, disposable members in DotSpatial
- require the ability to behave in some cases like a layer that should be removed from memory
- as soon as it is removed from the map, and other times like a persistent object. The DisposeLock
- concept works like an industrial lock-out system. Each additional lock increases the lock count.
- When all users have released the lock, the IsDisposedLocked property will be false, and the next
- action like a removal from the parent layers will properly dispose the item. Users may feel free
- to add the lock in order to handle disposal on the layers themselves. These methods will not
- actually prevent Dispose from functioning, but understand that calling dispose when there is an
- IsDisposeLocked is true means that there will likely be a problem.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IDisposeLock.LockDispose">
- <summary>
- Locks dispose. This typically adds one instance of an internal reference counter.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IDisposeLock.UnlockDispose">
- <summary>
- Unlocks dispose. This typically removes one instance of an internal reference counter.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IDisposeLock.IsDisposeLocked">
- <summary>
- Gets a value indicating whether an existing reference is requesting that the object is not disposed of.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.DisposeBase.Dispose">
- <summary>
- Disposes
- </summary>
- </member>
- <member name="M:DotSpatial.Data.DisposeBase.LockDispose">
- <summary>
- Adds one request or "reference count" for this item not to be disposed. When an owner is finished,
- if this is 0, then dispose should be called. For now this does not prevent Dispose from being
- called, it is simply for tracking purposes.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.DisposeBase.UnlockDispose">
- <summary>
- Removes one reference or request to prevent an object from being automatically disposed.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.DisposeBase.Finalize">
- <summary>
- Finalizes an instance of the <see cref="T:DotSpatial.Data.DisposeBase"/> class.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.DisposeBase.Dispose(System.Boolean)">
- <summary>
- This is where the meat of the dispose work is done. Subclasses should call dispose on any disposable
- members or internal members (presuming they are not dispose locked).
- </summary>
- <param name="isDisposing">True if the "Dispose" method was called instead of the destructor.</param>
- </member>
- <member name="P:DotSpatial.Data.DisposeBase.IsDisposed">
- <summary>
- Gets a value indicating whether this instance has already had the Dispose method called on it.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DisposeBase.IsDisposeLocked">
- <summary>
- Gets a value indicating whether there are outstanding references that may be using the item
- that would prefer it if you did not dispose of the item while they are still using it.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.ExtentArgs">
- <summary>
- An EventArgs class for passing around an extent.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ExtentArgs.#ctor(DotSpatial.Data.Extent)">
- <summary>
- Initializes a new instance of the ExtentArgs class.
- </summary>
- <param name="value">The value for this event.</param>
- </member>
- <member name="P:DotSpatial.Data.ExtentArgs.Extent">
- <summary>
- Gets or sets the Extents for this event.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.ExtentM">
- <summary>
- The ExtentsM class extends the regular X and Y extent to the X, Y and M case.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.Extent">
- <summary>
- Extent works like an envelope but is faster acting, has a minimum memory profile,
- only works in 2D and has no events.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IExtent">
- <summary>
- A very simple, 2D extent specification.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IExtent.MinX">
- <summary>
- Minimum in the X dimension, usually left or minimum longitude.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IExtent.MaxX">
- <summary>
- Maximum in the x dimension, usually right or maximum longitude.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IExtent.MinY">
- <summary>
- Minimum in the y dimension, usually bottom or minimum latitude.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IExtent.MaxY">
- <summary>
- Maximum in the y dimension, usually the top or maximum latitude.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IExtent.HasM">
- <summary>
- Gets a Boolean that is true if the Min and Max M range should be used.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IExtent.HasZ">
- <summary>
- Gets a Boolean indicating whether the Z value should be used.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Extent.#ctor">
- <summary>
- Creates a new instance of Extent. This introduces no error checking and assumes
- that the user knows what they are doing when working with this.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Extent.#ctor(System.Double,System.Double,System.Double,System.Double)">
- <summary>
- Creates a new extent from the specified ordinates
- </summary>
- <param name="xMin"></param>
- <param name="yMin"></param>
- <param name="xMax"></param>
- <param name="yMax"></param>
- </member>
- <member name="M:DotSpatial.Data.Extent.#ctor(System.Double[],System.Int32)">
- <summary>
- Given a long array of doubles, this builds an extent from a small part of that
- xmin, ymin, xmax, ymax
- </summary>
- <param name="values"></param>
- <param name="offset"></param>
- </member>
- <member name="M:DotSpatial.Data.Extent.#ctor(System.Double[])">
- <summary>
- XMin, YMin, XMax, YMax order
- </summary>
- <param name="values"></param>
- </member>
- <member name="M:DotSpatial.Data.Extent.#ctor(DotSpatial.Topology.IEnvelope)">
- <summary>
- Creates a new extent from the specified envelope
- </summary>
- <param name="env"></param>
- </member>
- <member name="M:DotSpatial.Data.Extent.Clone">
- <summary>
- Produces a clone, rather than using this same object.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Extent.op_Equality(DotSpatial.Data.Extent,DotSpatial.Data.IExtent)">
- <summary>
- Equality test
- </summary>
- <param name="left"></param>
- <param name="right"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Extent.op_Inequality(DotSpatial.Data.Extent,DotSpatial.Data.IExtent)">
- <summary>
- Inequality test
- </summary>
- <param name="left"></param>
- <param name="right"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Extent.Contains(DotSpatial.Data.IExtent)">
- <summary>
- Tests if this envelope is contained by the specified envelope
- </summary>
- <param name="ext"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Extent.Contains(DotSpatial.Topology.Coordinate)">
- <summary>
- Tests if this envelope is contained by the specified envelope
- </summary>
- <param name="c">The coordinate to test.</param>
- <returns>Boolean</returns>
- </member>
- <member name="M:DotSpatial.Data.Extent.Contains(DotSpatial.Topology.IEnvelope)">
- <summary>
- Tests if this envelope is contained by the specified envelope
- </summary>
- <param name="env"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Extent.CopyFrom(DotSpatial.Data.IExtent)">
- <summary>
- Copies the MinX, MaxX, MinY, MaxY values from extent.
- </summary>
- <param name="extent">Any IExtent implementation.</param>
- </member>
- <member name="M:DotSpatial.Data.Extent.Equals(System.Object)">
- <summary>
- Allows equality testing for extents that is derived on the extent itself.
- </summary>
- <param name="obj"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Extent.ExpandBy(System.Double,System.Double)">
- <summary>
- Expand will adjust both the minimum and maximum by the specified sizeX and sizeY
- </summary>
- <param name="padX">The amount to expand left and right.</param>
- <param name="padY">The amount to expand up and down.</param>
- </member>
- <member name="M:DotSpatial.Data.Extent.ExpandBy(System.Double)">
- <summary>
- This expand the extent by the specified padding on all bounds. So the width will
- change by twice the padding for instance. To Expand only x and y, use
- the overload with those values explicitly specified.
- </summary>
- <param name="padding">The double padding to expand the extent.</param>
- </member>
- <member name="M:DotSpatial.Data.Extent.ExpandToInclude(DotSpatial.Data.IExtent)">
- <summary>
- Expands this extent to include the domain of the specified extent
- </summary>
- <param name="ext">The extent to expand to include</param>
- </member>
- <member name="M:DotSpatial.Data.Extent.ExpandToInclude(System.Double,System.Double)">
- <summary>
- Expands this extent to include the domain of the specified point
- </summary>
- <param name="x"></param>
- <param name="y"></param>
- </member>
- <member name="M:DotSpatial.Data.Extent.GetHashCode">
- <summary>
- Spreads the values for the basic X, Y extents across the whole range of int.
- Repetition will occur, but it should be rare.
- </summary>
- <returns>Integer</returns>
- </member>
- <member name="M:DotSpatial.Data.Extent.Intersection(DotSpatial.Data.Extent)">
- <summary>
- Calculates the intersection of this extent and the other extent. A result
- with a min greater than the max in either direction is considered invalid
- and represents no intersection.
- </summary>
- <param name="other">The other extent to intersect with.</param>
- </member>
- <member name="M:DotSpatial.Data.Extent.Intersects(DotSpatial.Topology.Coordinate)">
- <summary>
- Returns true if the coordinate exists anywhere within this envelope
- </summary>
- <param name="c"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Extent.Intersects(System.Double,System.Double)">
- <summary>
- Tests for intersection with the specified coordinate
- </summary>
- <param name="x">The double ordinate to test intersection with in the X direction</param>
- <param name="y">The double ordinate to test intersection with in the Y direction</param>
- <returns>True if a point with the specified x and y coordinates is within or on the border
- of this extent object. NAN values will always return false.</returns>
- </member>
- <member name="M:DotSpatial.Data.Extent.Intersects(DotSpatial.Data.Vertex)">
- <summary>
- Tests to see if the point is inside or on the boundary of this extent.
- </summary>
- <param name="vert"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Extent.Intersects(DotSpatial.Data.IExtent)">
- <summary>
- Tests for an intersection with the specified extent
- </summary>
- <param name="ext">The other extent</param>
- <returns>Boolean, true if they overlap anywhere, or even touch</returns>
- </member>
- <member name="M:DotSpatial.Data.Extent.Intersects(DotSpatial.Topology.IEnvelope)">
- <summary>
- Tests with the specified envelope for a collision
- </summary>
- <param name="env"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Extent.IsEmpty">
- <summary>
- If this is undefined, it will have a min that is larger than the max, or else
- any value is NaN. This only applies to the X and Z terms. Check HasM or HasZ higher dimensions.
- </summary>
- <returns>Boolean, true if the envelope has not had values set for it yet.</returns>
- </member>
- <member name="M:DotSpatial.Data.Extent.Parse(System.String)">
- <summary>
- This allows parsing the X and Y values from a string version of the extent as:
- 'X[-180|180], Y[-90|90]' Where minimum always precedes maximum. The correct
- M or MZ version of extent will be returned if the string has those values.
- </summary>
- <param name="text">The string text to parse.</param>
- </member>
- <member name="M:DotSpatial.Data.Extent.TryParse(System.String,DotSpatial.Data.Extent@,System.String@)">
- <summary>
- This reads the string and attempts to derive values from the text.
- </summary>
- <param name="text"></param>
- <param name="result"></param>
- <param name="nameFailed"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Extent.SetCenter(System.Double,System.Double,System.Double,System.Double)">
- <summary>
- This centers the X and Y aspect of the extent on the specified center location.
- </summary>
- <param name="centerX"></param>
- <param name="centerY"></param>
- <param name="width"></param>
- <param name="height"></param>
- </member>
- <member name="M:DotSpatial.Data.Extent.SetCenter(DotSpatial.Topology.Coordinate,System.Double,System.Double)">
- <summary>
- This centers the X and Y aspect of the extent on the specified center location.
- </summary>
- <param name="center">The center coordinate to to set.</param>
- <param name="width"></param>
- <param name="height"></param>
- </member>
- <member name="M:DotSpatial.Data.Extent.SetCenter(DotSpatial.Topology.Coordinate)">
- <summary>
- This centers the extent on the specified coordinate, keeping the width and height the same.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Extent.SetValues(System.Double,System.Double,System.Double,System.Double)">
- <summary>
- Sets the values for xMin, xMax, yMin and yMax.
- </summary>
- <param name="minX">The double Minimum in the X direction.</param>
- <param name="minY">The double Minimum in the Y direction.</param>
- <param name="maxX">The double Maximum in the X direction.</param>
- <param name="maxY">The double Maximum in the Y direction.</param>
- </member>
- <member name="M:DotSpatial.Data.Extent.ToEnvelope">
- <summary>
- Creates a geometric envelope interface from this
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Extent.ToString">
- <summary>
- Creates a string that shows the extent.
- </summary>
- <returns>The string form of the extent.</returns>
- </member>
- <member name="M:DotSpatial.Data.Extent.Within(DotSpatial.Data.IExtent)">
- <summary>
- Tests if this envelope is contained by the specified envelope
- </summary>
- <param name="ext"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Extent.Within(DotSpatial.Topology.IEnvelope)">
- <summary>
- Tests if this envelope is contained by the specified envelope
- </summary>
- <param name="env"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Extent.TryExtract(System.String,System.String,System.Double@,System.Double@)">
- <summary>
- Attempts to extract the min and max from one element of text. The element should be
- formatted like X[1.5, 2.7] using an invariant culture.
- </summary>
- <param name="entireText"></param>
- <param name="name">The name of the dimension, like X.</param>
- <param name="min">The minimum that gets assigned</param>
- <param name="max">The maximum that gets assigned</param>
- <returns>Boolean, true if the parse was successful.</returns>
- </member>
- <member name="M:DotSpatial.Data.Extent.TryParseExtremes(System.String,System.Double@,System.Double@)">
- <summary>
- This method converts the X and Y text into two doubles.
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Data.Extent.Center">
- <summary>
- Gets the Center of this extent.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Extent.HasM">
- <summary>
- Gets or sets whether the M values are used. M values are considered optional,
- and not mandatory. Unused could mean either bound is NaN for some reason, or
- else that the bounds are invalid by the Min being less than the Max.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Extent.HasZ">
- <summary>
- Gets or sets whether the M values are used. M values are considered optional,
- and not mandatory. Unused could mean either bound is NaN for some reason, or
- else that the bounds are invalid by the Min being less than the Max.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Extent.MaxX">
- <summary>
- Max X
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Extent.MaxY">
- <summary>
- Max Y
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Extent.MinX">
- <summary>
- Min X
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Extent.MinY">
- <summary>
- Min Y
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Extent.Height">
- <summary>
- Gets MaxY - MinY. Setting this will update MinY, keeping MaxY the same. (Pinned at top left corner).
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Extent.Width">
- <summary>
- Gets MaxX - MinX. Setting this will update MaxX, keeping MinX the same. (Pinned at top left corner).
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Extent.X">
- <summary>
- Gets MinX. Setting this will shift both MinX and MaxX, keeping the width the same.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Extent.Y">
- <summary>
- Gets MaxY. Setting this will shift both MinY and MaxY, keeping the height the same.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IExtentM">
- <summary>
- Supports bounding in the M Dimension
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IExtentM.MinM">
- <summary>
- Gets or sets the minimum M value
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IExtentM.MaxM">
- <summary>
- Gets or sets the maximum M value
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ExtentM.#ctor">
- <summary>
- Initializes a new instance of the ExtentM class.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ExtentM.#ctor(System.Double,System.Double,System.Double,System.Double,System.Double,System.Double)">
- <summary>
- Initializes a new instance of the ExtentM class.
- </summary>
- <param name="minX">The double Minimum in the X direction.</param>
- <param name="minY">The double Minimum in the Y direction.</param>
- <param name="minM">The double Minimum in the Measure category.</param>
- <param name="maxX">The double Maximum in the X direction.</param>
- <param name="maxY">The double Maximum in the Y direction.</param>
- <param name="maxM">The double Maximum in the Measure category.</param>
- </member>
- <member name="M:DotSpatial.Data.ExtentM.#ctor(DotSpatial.Data.IExtent,System.Double,System.Double)">
- <summary>
- Initializes a new instance of the ExtentM class that is specially designed to work
- with shapefile formats that have a Measure value. Obviously other formats can use
- this as well.
- </summary>
- <param name="xyExtent">An extent that contains only the x and y boundaries.</param>
- <param name="minM">The minimum M.</param>
- <param name="maxM">The maximum M.</param>
- </member>
- <member name="M:DotSpatial.Data.ExtentM.#ctor(DotSpatial.Topology.IEnvelope)">
- <summary>
- Initializes a new instance of the ExtentM class. This overload works from an envelope.
- </summary>
- <param name="env">The envelope with extent values to read.</param>
- </member>
- <member name="M:DotSpatial.Data.ExtentM.Clone">
- <summary>
- Produces a clone, rather than using this same object.
- </summary>
- <returns>Returns a copy of this object.</returns>
- </member>
- <member name="M:DotSpatial.Data.ExtentM.Contains(DotSpatial.Topology.Coordinate)">
- <summary>
- Tests if this envelope is contained by the specified envelope
- </summary>
- <param name="c">The coordinate to test.</param>
- <returns>Boolean.</returns>
- </member>
- <member name="M:DotSpatial.Data.ExtentM.Contains(DotSpatial.Data.IExtent)">
- <summary>
- Tests if this envelope is contained by the specified envelope
- </summary>
- <param name="ext"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.ExtentM.Contains(DotSpatial.Topology.IEnvelope)">
- <summary>
- Tests if this envelope is contained by the specified envelope. If either element
- does not support M values, then only the default X and Y contains test is used.
- </summary>
- <param name="env">The envelope to test.</param>
- <returns>Boolean.</returns>
- </member>
- <member name="M:DotSpatial.Data.ExtentM.CopyFrom(DotSpatial.Data.IExtent)">
- <summary>
- Copies from the implementation of IExtent. This checks to see if IExtentM is implemented
- and if not, this only sets the X and Y bounds.
- </summary>
- <param name="extent"></param>
- </member>
- <member name="M:DotSpatial.Data.ExtentM.ExpandBy(System.Double)">
- <summary>
- This expand the extent by the specified padding on all bounds. So the width will
- change by twice the padding for instance. To Expand only x and y, use
- the overload with those values explicitly specified.
- </summary>
- <param name="padding">The double padding to expand the extent.</param>
- </member>
- <member name="M:DotSpatial.Data.ExtentM.ExpandToInclude(DotSpatial.Data.IExtent)">
- <summary>
- Expands this extent to include the domain of the specified extent. If the specified case
- doesn't support IExtentM or HasM is false for that extent, then this test will default
- to the XY case.
- </summary>
- <param name="ext">The extent to expand to include.</param>
- </member>
- <member name="M:DotSpatial.Data.ExtentM.ExpandToInclude(System.Double,System.Double,System.Double)">
- <summary>
- Expands this extent to include the domain of the specified point
- </summary>
- <param name="x">The x ordinate to expand to.</param>
- <param name="y">The y ordinate to expand to.</param>
- <param name="m">The m ordinate to expand to.</param>
- </member>
- <member name="M:DotSpatial.Data.ExtentM.Intersection(DotSpatial.Data.Extent)">
- <summary>
- Calculates the intersection of this extent and the other extent. A result
- with a min greater than the max in either direction is considered invalid
- and represents no intersection.
- </summary>
- <param name="other">The other extent to intersect with.</param>
- </member>
- <member name="M:DotSpatial.Data.ExtentM.Intersects(DotSpatial.Topology.Coordinate)">
- <summary>
- Returns true if the coordinate exists anywhere within this envelope. If this
- envelope represents a valid M extent by having a max greater than min and
- neither value being NaN, then this will also test the coordinate for the
- M range.
- </summary>
- <param name="c">The Coordinate to test.</param>
- <returns>Boolean</returns>
- </member>
- <member name="M:DotSpatial.Data.ExtentM.Intersects(System.Double,System.Double,System.Double)">
- <summary>
- Tests for intersection with the specified coordinate. If the m is double.NaN
- then it degenerates to only testing X and Y, even if this envelope has an M range.
- </summary>
- <param name="x">The double ordinate to test intersection with in the X direction</param>
- <param name="y">The double ordinate to test intersection with in the Y direction</param>
- <param name="m">The optional double measure parameter to test.</param>
- <returns>Boolean</returns>
- </member>
- <member name="M:DotSpatial.Data.ExtentM.Intersects(DotSpatial.Data.IExtent)">
- <summary>
- Tests for an intersection with the specified extent. Both this extent and the
- other must implement IExtentM and HasM must be true for both, or else just
- the X and Y are compared.
- </summary>
- <param name="ext">The other extent. If the extent doesn't implement IExtentM, then
- this comparison simply defaults to the X Y intersect case.</param>
- <returns>Boolean, true if they overlap anywhere, or even touch.</returns>
- </member>
- <member name="M:DotSpatial.Data.ExtentM.Intersects(DotSpatial.Topology.IEnvelope)">
- <summary>
- Tests with the specified envelope for a collision. If any part of the M bounds
- are invalid, this will default to the XY Intersect comparison.
- </summary>
- <param name="env">The envelope to test.</param>
- <returns>Boolean.</returns>
- </member>
- <member name="M:DotSpatial.Data.ExtentM.RemoveM">
- <summary>
- Since M values are optional, they can be set to an invalid state, which will behave the
- same as if the M bounds did not exist.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ExtentM.SetValues(System.Double,System.Double,System.Double,System.Double,System.Double,System.Double)">
- <summary>
- Sets the values for xMin, xMax, yMin and yMax.
- </summary>
- <param name="minX">The double Minimum in the X direction.</param>
- <param name="minY">The double Minimum in the Y direction.</param>
- <param name="minM">The double Minimum in the Measure category.</param>
- <param name="maxX">The double Maximum in the X direction.</param>
- <param name="maxY">The double Maximum in the Y direction.</param>
- <param name="maxM">The double Maximum in the Measure category.</param>
- </member>
- <member name="M:DotSpatial.Data.ExtentM.Within(DotSpatial.Data.IExtent)">
- <summary>
- Tests if this envelope is contained by the specified envelope. If either party doesn't have
- M constraints, they will not be used for this test.
- </summary>
- <param name="ext">implementation of IExtent to compare to.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.ExtentM.Within(DotSpatial.Topology.IEnvelope)">
- <summary>
- Tests if this envelope is contained by the specified envelope. If either envelope doesn't
- support M then only the X and Y case will be tested.
- </summary>
- <param name="env">The envelope to compare.</param>
- <returns>Boolean.</returns>
- </member>
- <member name="M:DotSpatial.Data.ExtentM.Equals(System.Object)">
- <summary>
- Allows equality testing for extents that is derived on the extent itself.
- </summary>
- <param name="obj"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.ExtentM.ToString">
- <summary>
- Creates a string that shows the extent.
- </summary>
- <returns>The string form of the extent.</returns>
- </member>
- <member name="M:DotSpatial.Data.ExtentM.GetHashCode">
- <summary>
- Spreads the values for the basic X, Y extents across the whole range of int.
- Repetition will occur, but it should be rare.
- </summary>
- <returns>Integer</returns>
- </member>
- <member name="P:DotSpatial.Data.ExtentM.HasM">
- <summary>
- Gets or sets whether the M values are used. M values are considered optional,
- and not mandatory. Unused could mean either bound is NaN for some reason, or
- else that the bounds are invalid by the Min being less than the Max.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ExtentM.MaxM">
- <inheritdoc/>
- </member>
- <member name="P:DotSpatial.Data.ExtentM.MinM">
- <inheritdoc/>
- </member>
- <member name="T:DotSpatial.Data.ExtentMZ">
- <summary>
- For shapefiles, the extents may or may not have M and Z values depending on the file type.
- These are valid IExtent implementations, but add both the M and Z extent options.
- For the file format, the Z values are mandatory, and so whatever the values are will be
- stored. This may cause issues when viewing in ArcGIS if you have entered some bad Z
- envelope extents.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IExtentZ">
- <summary>
- The Extent interface for Z dimension extent bounds.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IExtentZ.MinZ">
- <summary>
- The minimum in the Z dimension (usually the bottom)
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IExtentZ.MaxZ">
- <summary>
- The maximum in the Z dimension (usually the top)
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ExtentMZ.#ctor">
- <summary>
- Initializes a new instance of the ExtentMZ class.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ExtentMZ.#ctor(System.Double,System.Double,System.Double,System.Double,System.Double,System.Double,System.Double,System.Double)">
- <summary>
- Initializes a new instance of the ExtentMZ class.
- </summary>
- <param name="minX">The double Minimum in the X direction.</param>
- <param name="minY">The double Minimum in the Y direction.</param>
- <param name="minM">The double Minimum in the Measure category.</param>
- <param name="minZ">The double Minimum in the Z direction.</param>
- <param name="maxX">The double Maximum in the X direction.</param>
- <param name="maxY">The double Maximum in the Y direction.</param>
- <param name="maxM">The double Maximum in the Measure category.</param>
- <param name="maxZ">The double Maximum in the Z direction.</param>
- </member>
- <member name="M:DotSpatial.Data.ExtentMZ.#ctor(DotSpatial.Topology.IEnvelope)">
- <summary>
- Initialize a new instance of the ExtentMZ class.
- </summary>
- <param name="env">The Envelope to read the minimum and maximum values from.</param>
- </member>
- <member name="M:DotSpatial.Data.ExtentMZ.RemoveZ">
- <summary>
- Since M values are optional, they can be set to an invalid state, which will behave the
- same as if the M bounds did not exist.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ExtentMZ.CopyFrom(DotSpatial.Data.IExtent)">
- <summary>
- Copies from the implementation of IExtent. This checks to see if IExtentM is implemented
- and if not, this only sets the X and Y bounds.
- </summary>
- <param name="extent"></param>
- </member>
- <member name="M:DotSpatial.Data.ExtentMZ.SetValues(System.Double,System.Double,System.Double,System.Double,System.Double,System.Double,System.Double,System.Double)">
- <summary>
- Sets the values for xZin, xMax, yMin and yMax.
- </summary>
- <param name="minX">The double Minimum in the X direction.</param>
- <param name="minY">The double Minimum in the Y direction.</param>
- <param name="minM">The double Minimum in the Measure category.</param>
- <param name="minZ">The double Minimum in the Z direction.</param>
- <param name="maxX">The double Maximum in the X direction.</param>
- <param name="maxY">The double Maximum in the Y direction.</param>
- <param name="maxM">The double Maximum in the Measure category.</param>
- <param name="maxZ">The double Maximum in the Z direction.</param>
- </member>
- <member name="M:DotSpatial.Data.ExtentMZ.Contains(DotSpatial.Topology.Coordinate)">
- <summary>
- Tests if this envelope is contained by the specified envelope
- </summary>
- <param name="c">The coordinate to test.</param>
- <returns>Boolean.</returns>
- </member>
- <member name="M:DotSpatial.Data.ExtentMZ.Intersects(DotSpatial.Topology.Coordinate)">
- <summary>
- Returns true if the coordinate exists anywhere within this envelope. If this
- envelope represents a valid Z extent by having a max greater than min and
- neither value being NaN, then this will also test the coordinate for the
- Z range.
- </summary>
- <param name="c">The Coordinate to test.</param>
- <returns>Boolean</returns>
- </member>
- <member name="M:DotSpatial.Data.ExtentMZ.Intersects(System.Double,System.Double,System.Double,System.Double)">
- <summary>
- Tests for intersection with the specified coordinate. If the m is double.NaN
- then it degenerates to only testing M, X and Y, even if this envelope has an M range.
- </summary>
- <param name="x">The double ordinate to test intersection with in the X direction.</param>
- <param name="y">The double ordinate to test intersection with in the Y direction.</param>
- <param name="m">The optional double measure parameter to test.</param>
- <param name="z">The double ordinate to test intersection with in the Z direction.</param>
- <returns>Boolean</returns>
- </member>
- <member name="M:DotSpatial.Data.ExtentMZ.Intersects(DotSpatial.Data.IExtent)">
- <summary>
- Tests for an intersection with the specified extent. Both this extent and the
- other must implement IExtentM and HasM must be true for both, or else just
- the X and Y are compared.
- </summary>
- <param name="ext">The other extent. If the extent doesn't implement IExtentM, then
- this comparison simply defaults to the M, X and Y intersect case.</param>
- <returns>Boolean, true if they overlap anywhere, or even touch.</returns>
- </member>
- <member name="M:DotSpatial.Data.ExtentMZ.Intersects(DotSpatial.Topology.IEnvelope)">
- <summary>
- Tests with the specified envelope for a collision. If any part of the Z bounds
- are invalid, this will default to the M, X and Y Intersect comparison.
- </summary>
- <param name="env">The envelope to test.</param>
- <returns>Boolean.</returns>
- </member>
- <member name="M:DotSpatial.Data.ExtentMZ.Intersection(DotSpatial.Data.Extent)">
- <summary>
- Calculates the intersection of this extent and the other extent. A result
- with a min greater than the max in either direction is considered invalid
- and represents no intersection.
- </summary>
- <param name="other">The other extent to intersect with.</param>
- </member>
- <member name="M:DotSpatial.Data.ExtentMZ.ExpandToInclude(DotSpatial.Data.IExtent)">
- <summary>
- Expands this extent to include the domain of the specified extent. If the specified case
- doesn't support IExtentM or HasM is false for that extent, then this test will default
- to the M, X and Y case.
- </summary>
- <param name="ext">The extent to expand to include</param>
- </member>
- <member name="M:DotSpatial.Data.ExtentMZ.ExpandBy(System.Double)">
- <summary>
- This expand the extent by the specified padding on all bounds. So the width will
- change by twice the padding for instance. To Expand only x and y, use
- the overload with those values explicitly specified.
- </summary>
- <param name="padding">The double padding to expand the extent.</param>
- </member>
- <member name="M:DotSpatial.Data.ExtentMZ.ExpandToInclude(System.Double,System.Double,System.Double,System.Double)">
- <summary>
- Expands this extent to include the domain of the specified point
- </summary>
- <param name="x">The x ordinate to expand to.</param>
- <param name="y">The y ordinate to expand to.</param>
- <param name="m">The m ordinate to expand to.</param>
- <param name="z">The z ordinate to expand to.</param>
- </member>
- <member name="M:DotSpatial.Data.ExtentMZ.Within(DotSpatial.Data.IExtent)">
- <summary>
- Tests if this envelope is contained by the specified envelope. If either party doesn't have
- M constraints, they will not be used for this test.
- </summary>
- <param name="ext">implementation of IExtent to compare to.</param>
- <returns>Boolean.</returns>
- </member>
- <member name="M:DotSpatial.Data.ExtentMZ.Contains(DotSpatial.Data.IExtent)">
- <summary>
- Tests if this envelope is contained by the specified envelope
- </summary>
- <param name="ext">The extent to test.</param>
- <returns>Boolean.</returns>
- </member>
- <member name="M:DotSpatial.Data.ExtentMZ.Within(DotSpatial.Topology.IEnvelope)">
- <summary>
- Tests if this envelope is contained by the specified envelope. If either envelope doesn't
- support M then only the XY case will be tested.
- </summary>
- <param name="env">The envelope to compare.</param>
- <returns>Boolean.</returns>
- </member>
- <member name="M:DotSpatial.Data.ExtentMZ.Contains(DotSpatial.Topology.IEnvelope)">
- <summary>
- Tests if this envelope is contained by the specified envelope. If either element
- does not support M values, then only the default XY contains test is used.
- </summary>
- <param name="env">The envelope to test.</param>
- <returns>Boolean.</returns>
- </member>
- <member name="M:DotSpatial.Data.ExtentMZ.ToString">
- <summary>
- Creates a string that shows the extent.
- </summary>
- <returns>The string form of the extent.</returns>
- </member>
- <member name="M:DotSpatial.Data.ExtentMZ.Clone">
- <summary>
- Produces a clone, rather than using this same object.
- </summary>
- <returns>Returns a copy of this object.</returns>
- </member>
- <member name="M:DotSpatial.Data.ExtentMZ.Equals(System.Object)">
- <summary>
- Allows equality testing for extents that is derived on the extent itself.
- </summary>
- <param name="obj"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.ExtentMZ.GetHashCode">
- <summary>
- Spreads the values for the basic X, Y extents across the whole range of int.
- Repetition will occur for extents that are close, but should be rare.
- </summary>
- <returns>Integer</returns>
- </member>
- <member name="P:DotSpatial.Data.ExtentMZ.HasZ">
- <summary>
- Gets or sets whether the M values are used. M values are considered optional,
- and not mandatory. Unused could mean either bound is NaN for some reason, or
- else that the bounds are invalid by the Min being less than the Max.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ExtentMZ.MinZ">
- <inheritdoc/>
- </member>
- <member name="P:DotSpatial.Data.ExtentMZ.MaxZ">
- <inheritdoc/>
- </member>
- <member name="T:DotSpatial.Data.ExtentParseException">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ExtentParseException.EXTENT_TEXT_TEMPLATE">
- <summary>
- The string template that should be used. M and Z are optional. Do use a comma to
- delimit terms, but the space doesn't matter. Do use square brackets to enclose
- numbers, and do use the | separator to separate min from max. Do place min
- before max in each term. The order of the terms doesn't matter. Use periods
- for decimals and an invariant culture.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ExtentParseException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the ExtentParseException
- </summary>
- <param name="message">The string message to parse.</param>
- </member>
- <member name="M:DotSpatial.Data.ExtentParseException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the ExtentParseException
- </summary>
- <param name="message">The string message to parse.</param>
- <param name="innerException">The inner exception that caused this exception.</param>
- </member>
- <member name="M:DotSpatial.Data.ExtentParseException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the ExtentParseException
- </summary>
- <param name="info">The Serialization info class that holds the serialized object about which
- the exception is being thrown.</param>
- <param name="context">The streaming context that contains contextual information about the
- source or destination.</param>
- </member>
- <member name="P:DotSpatial.Data.ExtentParseException.Expression">
- <summary>
- Gets the string expression that provoked the exception.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.FeatureRow">
- <summary>
- Represents strongly named DataRow class.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IFeatureRow">
- <summary>
- This interface allows access to geometries and attributes in a more cohesive package.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IFeatureRow.StoreShape">
- <summary>
- Stores the shape to the GEOMETRY WKB.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IFeatureRow.StoreGeometry">
- <summary>
- Stores the geometry to the geometry wkb.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IFeatureRow.Extent">
- <summary>
- This is a cached extent. This will not reflect changes in Geometry or Shape unless
- they have been stored, but will reflect the most recently stored or retrieved
- extent from accessing either the shape or geometry. In cases where reading from
- WKB, this will be lazily created, but it will be cached when reading from
- shapefiles.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IFeatureRow.Geometry">
- <summary>
- A Geometry created lazily from a WKB byte structure in the GEOMETRY field preferentially
- or if the field is DBNull and the shape is not null, then from the Shape object.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IFeatureRow.Shape">
- <summary>
- A Shape that is either created lazily from the WKB Geometry or directly from a shapefile.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IFeatureRow.Item(System.String)">
- <summary>
- The rest of the attributes are stored by an indexed property.
- </summary>
- <param name="fieldName"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Data.IFeatureRow.IsGeometryCreated">
- <summary>
- Boolean, true if the geometry has already been created, false otherwise.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IFeatureRow.IsShapeCreated">
- <summary>
- Boolean, true if the shape has already been created, false otherwise.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IFeatureRow.IsExtentCreated">
- <summary>
- Boolean, true if the extent has been created, false otherwise.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.FeatureRow.#ctor(System.Data.DataRowBuilder)">
- <summary>
- Creates a new instance of the FeatureRow class.
- </summary>
- <param name="rb"></param>
- </member>
- <member name="M:DotSpatial.Data.FeatureRow.StoreShape">
- <summary>
- Stores the shape into the WKB for storage in a database, overwriting any existing value.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.FeatureRow.StoreGeometry">
- <summary>
- Stores the goemetry as WKB, overwriting any existing value.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.FeatureRow.SetWellKnwonBinaryNull">
- <summary>
- Sets the geometry field to DBNull.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.FeatureRow.IsWellKnownBinaryNull">
- <summary>
- Gets whether the geometry is null.
- </summary>
- <returns>Boolean, true if the column is null.</returns>
- </member>
- <member name="P:DotSpatial.Data.FeatureRow.FID">
- <summary>
- A long integer representing the FID.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.FeatureRow.WellKnownBinary">
- <summary>
- The Byte form of the Geometry
- </summary>
- </member>
- <member name="P:DotSpatial.Data.FeatureRow.Extent">
- <summary>
- From shapefiles, this should be cached. Any other source must likely
- create the extent from a geometry, and possibly all the way from WKB.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.FeatureRow.Geometry">
- <summary>
- A lazily created and cached geometry.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.FeatureRow.IsExtentCreated">
- <summary>
- Boolean, true if the extent has been created, false otherwise.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.FeatureRow.IsGeometryCreated">
- <summary>
- Boolean, true if the geometry has already been created, false otherwise.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.FeatureRow.IsShapeCreated">
- <summary>
- Boolean, true if the shape has already been created, false otherwise.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.FeatureRow.Shape">
- <summary>
- When reading from WKB, the Shape is lazily created. When reading from sources like
- a shapefile, the Shape is actually pre-fetched because the value exists as a shape
- rather than a geometry.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.FeatureRowChangeEvent">
- <summary>
- Row event argument class
- </summary>
- </member>
- <member name="M:DotSpatial.Data.FeatureRowChangeEvent.#ctor(DotSpatial.Data.FeatureRow,System.Data.DataRowAction)">
- <summary>
- A new event argument for events in a FeatureTable.
- </summary>
- <param name="row">The FeatureRow of the event.</param>
- <param name="action">The action occuring for this event.</param>
- </member>
- <member name="P:DotSpatial.Data.FeatureRowChangeEvent.Row">
- <summary>
- The FeatureRow for this event.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.FeatureRowChangeEvent.Action">
- <summary>
- The action for this event.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.FeatureSetEventArgs">
- <summary>
- An EventArgs specifically tailored to FeatureSet.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.FeatureSetEventArgs.#ctor(DotSpatial.Data.IFeatureSet)">
- <summary>
- Initializes a new instance of the FeatureSetEventArgs class.
- </summary>
- <param name="featureSet">The IFeatureSet that is involved in this event.</param>
- </member>
- <member name="P:DotSpatial.Data.FeatureSetEventArgs.FeatureSet">
- <summary>
- Gets the Raster associated with this event.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.FeatureSourceRowEditEvent">
- <summary>
- Callback specified when calling IFeatureSource.SearchAndModifyAttributes
- </summary>
- <param name="e"></param>
- </member>
- <member name="T:DotSpatial.Data.FeatureSourceRowEditEventArgs">
- <summary>
- FeatureSourceRowEditEvent arguments
- </summary>
- </member>
- <member name="F:DotSpatial.Data.FeatureSourceRowEditEventArgs.RowEditEventArgs">
- <summary>
- RowEditEvent arguments
- </summary>
- </member>
- <member name="F:DotSpatial.Data.FeatureSourceRowEditEventArgs.Shape">
- <summary>
- Shape geometry associated with the row
- </summary>
- </member>
- <member name="M:DotSpatial.Data.FeatureSourceRowEditEventArgs.#ctor(DotSpatial.Data.RowEditEventArgs,DotSpatial.Data.Shape)">
- <summary>
- Construct FeatureSourceRowEditEventArgs
- </summary>
- <param name="rowEditEventArgs"></param>
- <param name="shape"></param>
- </member>
- <member name="T:DotSpatial.Data.FeatureTable">
- <summary>
- Represents the strongly named DataTable class.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.FeatureTable.#ctor">
- <summary>
- Initializes a new instance of a FeatureTable class.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.FeatureTable.#ctor(System.String)">
- <summary>
- Initializes a new instance of a FeatureTable class.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.FeatureTable.AddFeatureRow(DotSpatial.Data.FeatureRow)">
- <summary>
- Adds the specified FeatureRow to this FeatureTable.
- </summary>
- <param name="row">the row to add.</param>
- </member>
- <member name="M:DotSpatial.Data.FeatureTable.AddFeatureRow(System.Byte[])">
- <summary>
- Generates a new feature row using only the goemetry.
- </summary>
- <param name="wellKnownBinary">The byte form of the well known text to use in creating a new, otherwise empty row.</param>
- <returns>The newly created FeatureRow with the specified well known text.</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureTable.NewFeatureRow">
- <summary>
- Retrieves a newly generated row from this table cast as a FeatureRow.
- </summary>
- <returns>The FeatureRow class.</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureTable.Clone">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Data.FeatureTable.FindByFID(System.Int64)">
- <summary>
- Finds a FeatureRow by the FID field.
- </summary>
- <param name="fid">The long fid to find</param>
- <returns>A FeatureRow</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureTable.RemoveFeatureRow(DotSpatial.Data.FeatureRow)">
- <summary>
- Removes the specified row from the table.
- </summary>
- <param name="row">The FeatureRow to remove.</param>
- </member>
- <member name="M:DotSpatial.Data.FeatureTable.AddFeatureRow(DotSpatial.Topology.IGeometry)">
- <summary>
- Generates a new feature row using only the goemetry.
- </summary>
- <param name="geometry">The byte form of the well known text to use in creating a new, otherwise empty row.</param>
- <returns>The newly created FeatureRow with the specified well known text.</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureTable.CreateInstance">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Data.FeatureTable.GetRowType">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Data.FeatureTable.NewRowFromBuilder(System.Data.DataRowBuilder)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Data.FeatureTable.OnRowChanged(System.Data.DataRowChangeEventArgs)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Data.FeatureTable.OnRowChanging(System.Data.DataRowChangeEventArgs)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Data.FeatureTable.OnRowDeleted(System.Data.DataRowChangeEventArgs)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Data.FeatureTable.OnRowDeleting(System.Data.DataRowChangeEventArgs)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Data.FeatureTable.#ctor(System.Data.DataTable)">
- <summary>
- This may or may not be required for proper functioning, but is not part of the public API.
- </summary>
- <param name="table">A DataTable</param>
- </member>
- <member name="M:DotSpatial.Data.FeatureTable.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- This may not work since I stripped off the xml related auto text that seems to rely on an existing dataset
- </summary>
- <param name="info"></param>
- <param name="context"></param>
- </member>
- <member name="E:DotSpatial.Data.FeatureTable.FeatureRowChanging">
- <summary>
- Occurs while the row is changing
- </summary>
- </member>
- <member name="E:DotSpatial.Data.FeatureTable.FeatureRowChanged">
- <summary>
- Occurs after the row has been changed.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.FeatureTable.FeatureRowDeleting">
- <summary>
- Occurs while the row is being deleted.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.FeatureTable.FeatureRowDeleted">
- <summary>
- Occurs after the row has been deleted.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.FeatureTable.Count">
- <summary>
- The integer number of rows in this table.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.FeatureTable.FidColumn">
- <summary>
- The Column containing the FID value.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.FeatureTable.GeometryColumn">
- <summary>
- The Column containing the Geometry column.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.FeatureTable.GeometryFactory">
- <summary>
- Optionally gets or sets a geometry factory to use when instantiating geometries
- from WKB for the rows of this table.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.FeatureTable.Item(System.Int32)">
- <summary>
- Accesses the FeatureRow of this table based on the specified index.
- </summary>
- <param name="index">The integer index of the feature row to access.</param>
- <returns>This FeatureRow</returns>
- </member>
- <member name="T:DotSpatial.Data.Fields">
- <summary>
- Manage the Fields associated with a dbase
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Fields.#ctor(System.Collections.Generic.IEnumerable{DotSpatial.Data.Field})">
- <summary>
- Construct Fields and update the individual field data addresses
- </summary>
- <param name="fields"></param>
- </member>
- <member name="M:DotSpatial.Data.Fields.Add(DotSpatial.Data.Field)">
- <summary>
- Add a field
- </summary>
- <param name="field"></param>
- </member>
- <member name="M:DotSpatial.Data.Fields.UpdateDataAddresses">
- <summary>
- Update the DataAddress of each field
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Fields.Item(System.Int32)">
- <summary>
- Retrieve field by ordinal
- </summary>
- <param name="pos"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Data.Fields.Item(System.String)">
- <summary>
- Retrieve field by name
- </summary>
- <param name="name"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Data.Fields.Count">
- <summary>
- Get number of fields
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IContainRasterBounds">
- <summary>
- An interface for specifying something has a Bounds property on it that is a raster bounds.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IContainRasterBounds.Bounds">
- <summary>
- Gets or sets the image bounds being used to define the georeferencing of the image
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IGetBitmap">
- <summary>
- Returns the bitmap
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IGetBitmap.GetBitmap">
- <summary>
- Attempts to create a bitmap for the entire image. This may cause memory exceptions.
- </summary>
- <returns>
- A Bitmap of the image.
- </returns>
- </member>
- <member name="M:DotSpatial.Data.IGetBitmap.GetBitmap(DotSpatial.Data.Extent,System.Drawing.Size)">
- <summary>
- The geographic envelope gives the region that the image should be created for.
- The window gives the corresponding pixel dimensions for the image, so that
- images matching the resolution of the screen can be used.
- </summary>
- <param name="envelope">
- The geographic extents to retrieve data for
- </param>
- <param name="size">
- The rectangle that defines the size of the drawing area in pixels
- </param>
- <returns>
- A bitmap captured from the main image
- </returns>
- </member>
- <member name="M:DotSpatial.Data.IGetBitmap.GetBitmap(DotSpatial.Data.Extent,System.Drawing.Rectangle)">
- <summary>
- The geographic envelope gives the region that the image should be created for.
- The window gives the corresponding pixel dimensions for the image, so that
- images matching the resolution of the screen can be used.
- </summary>
- <param name="envelope">
- The geographic extents to retrieve data for
- </param>
- <param name="window">
- The rectangle that defines the size of the drawing area in pixels
- </param>
- <returns>
- A bitmap captured from the main image
- </returns>
- </member>
- <member name="T:DotSpatial.Data.ImageDataEventArgs">
- <summary>
- An EventArgs specifically tailored to ImageData.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ImageDataEventArgs.#ctor(DotSpatial.Data.IImageData)">
- <summary>
- Initializes a new instance of the ImageDataEventArgs class.
- </summary>
- <param name="imageData">The IImageData that is involved in this event.</param>
- </member>
- <member name="P:DotSpatial.Data.ImageDataEventArgs.ImageData">
- <summary>
- Gets the ImageData associated with this event.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.Endian">
- <summary>
- An enumeration for specifying the endian byte order to use.
- </summary>
- </member>
- <member name="F:DotSpatial.Data.Endian.BigEndian">
- <summary>
- Specifies big endian like mainframe or unix system.
- </summary>
- </member>
- <member name="F:DotSpatial.Data.Endian.LittleEndian">
- <summary>
- Specifies little endian like most pc systems.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IFeatureSource">
- <summary>
- A new interface for accessing database or file features to large for memory. This allows editing only for attribute content,
- but allows Add, Remove, AddRange, and Query functionality that covers both vector and raster content.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IFeatureSource.Add(DotSpatial.Data.IFeature)">
- <summary>
- Updates the file with an additional feature.
- </summary>
- <param name="feature"></param>
- </member>
- <member name="M:DotSpatial.Data.IFeatureSource.RemoveAt(System.Int32)">
- <summary>
- Removes the feature with the specified index
- </summary>
- <param name="index">Removes the feature from the specified index location</param>
- </member>
- <member name="M:DotSpatial.Data.IFeatureSource.AddRange(System.Collections.Generic.IEnumerable{DotSpatial.Data.IFeature})">
- <summary>
- The default implementation calls the add method repeatedly.
- </summary>
- <param name="features">The set of features to add</param>
- </member>
- <member name="M:DotSpatial.Data.IFeatureSource.Select(System.String,DotSpatial.Topology.IEnvelope,System.Int32@,System.Int32)">
- <summary>
- Select function passed with a filter expression.
- </summary>
- <param name="filterExpression">The string filter expression based on attributes</param>
- <param name="envelope">The envelope for vector filtering.</param>
- <param name="startIndex">The integer start index where values should be checked. This will be updated to the </param>
- last index that was checked before the return, so that paging the query can begin with that index in the next cycle.
- Be sure to add one before the next call.
- <param name="maxCount">The integer maximum number of IFeature values that should be returned.</param>
- <returns>A dictionary with FID keys and IFeature values.</returns>
- </member>
- <member name="M:DotSpatial.Data.IFeatureSource.SearchAndModifyAttributes(DotSpatial.Topology.IEnvelope,System.Int32,DotSpatial.Data.FeatureSourceRowEditEvent)">
- <summary>
- Conditionally modify attributes as searched in a single pass via client supplied callback.
- </summary>
- <param name="envelope">The envelope for vector filtering.</param>
- <param name="chunkSize">Number of shapes to request from the ShapeSource in each chunk</param>
- <param name="rowCallback">Callback on each feature</param>
- </member>
- <member name="M:DotSpatial.Data.IFeatureSource.EditAttributes(System.Int32,System.Data.DataRow)">
- <summary>
- Edits the values of the specified row in the attribute table. Since not all data formats
- can handle the dynamic change of attributes, updating vectors can be done with Remove and Add.
- </summary>
- <param name="fid">The feature offest</param>
- <param name="attributeValues">The row of new attribute values.</param>
- </member>
- <member name="M:DotSpatial.Data.IFeatureSource.EditAttributes(System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.Int32,System.Data.DataRow}})">
- <summary>
- Edits the values of the specified rows in the attribute table.
- </summary>
- <param name="indexDataRowPairs"></param>
- </member>
- <member name="M:DotSpatial.Data.IFeatureSource.UpdateExtents">
- <summary>
- Adding and removing shapes may make the bounds for the entire shapefile invalid.
- This triggers a check that ensures that the collective extents contain all the shapes.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IFeatureSource.Extent">
- <summary>
- The geographic extent of the feature source
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IFeatureSource.AttributeTable">
- <summary>
- Get the attribute table associated with the feature source
- </summary>
- </member>
- <member name="T:DotSpatial.Data.ImageBandType">
- <summary>
- An enumeration listing the types of image band interpretations supported.
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ImageBandType.ARGB">
- <summary>
- Alpha, Red, Green, Blue 4 bytes per pixel, 4 bands
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ImageBandType.RGB">
- <summary>
- Red, Green, Blue 3 bytes per pixel, 3 bands
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ImageBandType.Gray">
- <summary>
- Gray as one byte per pixel, 1 band
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ImageBandType.PalletCoded">
- <summary>
- Colors encoded 1 byte per pixel, 1 band
- </summary>
- </member>
- <member name="T:DotSpatial.Data.InRamImage">
- <summary>
- Sets the InRamImage for this class. This is just a georeferenced .Net bitmap that also implements
- IGetBitmap for cross purpose use with IImageData implementations.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.InRamImage.#ctor(System.Drawing.Bitmap)">
- <summary>
- Initializes a new instance of an InRamImage class. This class supports a basic .Net Image
- plus a geographic extent as a RasterBounds. This class does not feature any byte level
- data access or built in file access. The expectation is that this will only be used in memory.
- </summary>
- <param name="image">THe Bitmap image to use to create this image.</param>
- </member>
- <member name="M:DotSpatial.Data.InRamImage.GetBitmap">
- <summary>
- Returns the internal bitmap in this case. In other cases, this may have to be constructed
- from the unmanaged memory content.
- </summary>
- <returns>
- A Bitmap that represents the entire image.
- </returns>
- </member>
- <member name="M:DotSpatial.Data.InRamImage.GetBitmap(DotSpatial.Data.Extent,System.Drawing.Rectangle)">
- <summary>
- The geographic envelope gives the region that the image should be created for.
- The window gives the corresponding pixel dimensions for the image, so that
- images matching the resolution of the screen can be used.
- </summary>
- <param name="envelope">
- The geographic extents to retrieve data for
- </param>
- <param name="window">
- The rectangle that defines the size of the drawing area in pixels
- </param>
- <returns>
- A bitmap captured from the main image
- </returns>
- </member>
- <member name="M:DotSpatial.Data.InRamImage.GetBitmap(DotSpatial.Data.Extent,System.Drawing.Size)">
- <summary>
- The geographic envelope gives the region that the image should be created for.
- The window gives the corresponding pixel dimensions for the image, so that
- images matching the resolution of the screen can be used.
- </summary>
- <param name="envelope">The geographic extents to retrieve data for</param>
- <param name="size">The rectangle that defines the size of the drawing area in pixels</param>
- <returns>A bitmap captured from the main image </returns>
- </member>
- <member name="M:DotSpatial.Data.InRamImage.SetBitmap(System.Drawing.Bitmap)">
- <summary>
- Sets the bitmap for this InRamImage to use.
- </summary>
- <param name="value">the value to set.</param>
- </member>
- <member name="M:DotSpatial.Data.InRamImage.ToImageData">
- <summary>
- If byte access is required, a new class can be created that is a copy of this class for
- modifying values byte by byte.
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Data.InRamImage.Bounds">
- <summary>
- Gets or sets the raster bounds
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IProj">
- <summary>
- The Projection interface that acts as a useful tool for calculating pixel coordinates
- to geographic coordinates and vise-versa.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IProj.ImageRectangle">
- <summary>
- The Rectangle representation of the geographic extents in image coordinates
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IProj.GeographicExtents">
- <summary>
- The geographic extents used for projection.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IRasterBoundDataSet">
- <summary>
- This interface specifically insists on an IRasterBounds as the Bounds property.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IDataSet">
- <summary>
- A very generic interface that is implemented by any dataset, regardless of what kinds of data that it has.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IReproject">
- <summary>
- This interface supports the basic Reprojection content. CanReproject tests to see if the
- DotSpatial.Projections library exists and will return false if it does not exist. In
- such a case the
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IReproject.Reproject(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Reprojects all of the in-ram vertices of vectors, or else this
- simply updates the "Bounds" of image and raster objects
- This will also update the projection to be the specified projection.
- </summary>
- <param name="targetProjection">
- The projection information to reproject the coordinates to.
- </param>
- </member>
- <member name="P:DotSpatial.Data.IReproject.CanReproject">
- <summary>
- Gets a value indicating whether the DotSpatial.Projections assembly is loaded. If
- not, this returns false, and neither ProjectionInfo nor the Reproject() method should
- be used.
- </summary>
- <returns>Boolean, true if the value can reproject.</returns>
- </member>
- <member name="P:DotSpatial.Data.IReproject.Projection">
- <summary>
- Gets or sets the projection information for this dataset
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IReproject.ProjectionString">
- <summary>
- Gets or sets the proj4 string for this dataset. This exists in
- case the Projections library is not loaded. If the projection
- library is loaded, this also updates the Projection property.
- Setting this behaves like defining the projection and will not
- reproject the values.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IDataSet.Close">
- <summary>
- This closes the data set. Many times this will simply do nothing, but
- in some cases this may close an open connection to a data source.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IDataSet.Extent">
- <summary>
- Gets or sets the extent for the dataset. Usages to Envelope were replaced
- as they required an explicit using to DotSpatial.Topology which is not
- as intuitive. Extent.ToEnvelope() and new Extent(myEnvelope) convert them.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IDataSet.IsDisposed">
- <summary>
- True if the dispose method has been called on this dataset.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IDataSet.Name">
- <summary>
- Gets or sets a string name identifying this dataset
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IDataSet.ProgressHandler">
- <summary>
- Gets or sets the progress handler to use for internal actions taken by this dataset.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IDataSet.SpaceTimeSupport">
- <summary>
- Gets or sets the space time support for this dataset.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IDataSet.TypeName">
- <summary>
- Gets or sets a string that describes as clearly as possible what type of
- elements are contained in this dataset.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IShapeSource">
- <summary>
- Rendering is considered a different pathway from editing. For rendering, we can distance
- ourselves from the attributes all together in order to speedily grab just the indices
- that are within the view extent.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IShapeSource.GetShapes(System.Int32@,System.Int32,DotSpatial.Topology.IEnvelope)">
- <summary>
- Returns a dictionary with the FID and Shape, but only returns shapes within the envelope.
- </summary>
- <param name="startIndex">The integer offset of the first shape to test. When this returns, the offset is set to the integer index of the last shape tested, regardless of whether or not it was returned.</param>
- <param name="count">The integer count of the maximum number of shapes to return here. </param>
- <param name="envelope">The geographic extents that can be used to limit the shapes. If this is null, then no envelope is used.</param>
- <returns>The Dictionary with FID indices and Shape values</returns>
- </member>
- <member name="M:DotSpatial.Data.IShapeSource.GetShapes(System.Int32[])">
- <summary>
- Returns array of shapes at the specified indices
- </summary>
- <param name="indices"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.IShapeSource.GetShapeCount">
- <summary>
- Gets the integer count of the total number of shapes in the set. This may run a query,
- so it is better to cache the result than call this repeatedly.
- </summary>
- <returns>The integer number of shapes in the entire source.</returns>
- </member>
- <member name="M:DotSpatial.Data.IShapeSource.EndGetShapesSession">
- <summary>
- Should be called when done making repeated calls to GetShapes to free internal resources.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IShapeSource.FeatureType">
- <summary>
- This is most likely set once per source.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.LineShape">
- <summary>
- LineShape
- </summary>
- </member>
- <member name="M:DotSpatial.Data.LineShape.Intersects(DotSpatial.Data.ShapeRange,DotSpatial.Data.ShapeRange)">
- <summary>
- Calculates the intersection of a polygon shape without relying on the NTS geometry
- </summary>
- <param name="lineShape"></param>
- <param name="otherShape"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.LineShape.IntersectsVertex(DotSpatial.Data.ShapeRange,DotSpatial.Data.ShapeRange)">
- <summary>
- Tests to see if any vertices from the other shape are coincident with a segment from this line shape.
- </summary>
- <param name="lineShape"></param>
- <param name="otherShape"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.LineShape.SegmentsIntersect(DotSpatial.Data.ShapeRange,DotSpatial.Data.ShapeRange)">
- <summary>
- Returns true if any segment from a line or polygon shape interesect any segments from the line or polygon shape.
- </summary>
- <param name="lineShape">A Line or Polygon shape</param>
- <param name="otherShape">Another line or polygon shape</param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Data.LineShape.Epsilon">
- <summary>
- Gets or sets the precision for calculating equality, but this is just a re-direction to Vertex.Epsilon
- </summary>
- </member>
- <member name="T:DotSpatial.Data.LineShapefileFeatureSource">
- <summary>
- This class is strictly the vector access code. This does not handle
- the attributes, which must be handled independantly.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.ShapefileFeatureSource">
- <summary>
- Provides common functionality for all ShapefileFeatureSource classes (Point, Line, Polygon)
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ShapefileFeatureSource.#ctor(System.String)">
- <summary>
- Sets the fileName and creates a new ShapefileFeatureSource for the specified file.
- </summary>
- <param name="fileName">The fileName to work with.</param>
- </member>
- <member name="M:DotSpatial.Data.ShapefileFeatureSource.#ctor(System.String,System.Boolean,System.Boolean)">
- <summary>
- Sets the fileName and creates a new PolygonshapefileFeatureSource for the specified file (and builds spatial index if requested)
- </summary>
- <param name="fileName"></param>
- <param name="useSpatialIndexing"></param>
- <param name="trackDeletedRows"></param>
- </member>
- <member name="M:DotSpatial.Data.ShapefileFeatureSource.Delete">
- <summary>
- This deletes the files with any extension and the same base fileName.
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ShapefileFeatureSource.Quadtree">
- <summary>
- Spatial index for faster searches
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ShapefileFeatureSource.Add(DotSpatial.Data.IFeature)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Data.ShapefileFeatureSource.RemoveAt(System.Int32)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Data.ShapefileFeatureSource.AddRange(System.Collections.Generic.IEnumerable{DotSpatial.Data.IFeature})">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Data.ShapefileFeatureSource.Select(System.String,DotSpatial.Topology.IEnvelope,System.Int32@,System.Int32)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Data.ShapefileFeatureSource.SearchAndModifyAttributes(DotSpatial.Topology.IEnvelope,System.Int32,DotSpatial.Data.FeatureSourceRowEditEvent)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Data.ShapefileFeatureSource.EditAttributes(System.Int32,System.Data.DataRow)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Data.ShapefileFeatureSource.EditAttributes(System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.Int32,System.Data.DataRow}})">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Data.ShapefileFeatureSource.UpdateExtents">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Data.ShapefileFeatureSource.Open(System.String)">
- <summary>
- Create a ShapefileFeatureSource of the appropriate type
- </summary>
- <param name="filename"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.ShapefileFeatureSource.Open(System.String,System.Boolean,System.Boolean)">
- <summary>
- Create a ShapefileFeatureSource of the appropriate type spatial indexing
- </summary>
- <param name="filename"></param>
- <param name="useSpatialIndexing"></param>
- <param name="trackDeletedRows"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.ShapefileFeatureSource.UpdateHeader(DotSpatial.Data.ShapefileHeader,DotSpatial.Topology.IBasicGeometry)">
- <summary>
- Update the header to include the feature extent
- </summary>
- <param name="header"></param>
- <param name="feature"></param>
- </member>
- <member name="M:DotSpatial.Data.ShapefileFeatureSource.UpdateHeader(DotSpatial.Data.ShapefileHeader,DotSpatial.Topology.IBasicGeometry,System.Boolean)">
- <summary>
- Update the header to include the feature extent
- </summary>
- <param name="header"></param>
- <param name="feature"></param>
- <param name="writeHeaderFiles"> </param>
- </member>
- <member name="M:DotSpatial.Data.ShapefileFeatureSource.UpdateExtents(DotSpatial.Data.IShapeSource)">
- <summary>
- Update header extents from the geometries in a IShapeSource
- </summary>
- <param name="src"></param>
- </member>
- <member name="M:DotSpatial.Data.ShapefileFeatureSource.Select(DotSpatial.Data.IShapeSource,System.String,DotSpatial.Topology.IEnvelope,System.Int32@,System.Int32)">
- <summary>
- Select the features in an IShapeSource
- </summary>
- <param name="sr"></param>
- <param name="filterExpression"></param>
- <param name="envelope"></param>
- <param name="startIndex"></param>
- <param name="maxCount"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.ShapefileFeatureSource.SearchAndModifyAttributes(DotSpatial.Data.IShapeSource,DotSpatial.Topology.IEnvelope,System.Int32,DotSpatial.Data.FeatureSourceRowEditEvent)">
- <summary>
- Conditionally modify attributes as searched in a single pass via client supplied callback.
- </summary>
- <param name="sr">ShapeSource for this feature source</param>
- <param name="envelope">The envelope for vector filtering.</param>
- <param name="chunkSize">Number of shapes to request from the ShapeSource in each chunk</param>
- <param name="featureEditCallback">Callback on each feature</param>
- </member>
- <member name="M:DotSpatial.Data.ShapefileFeatureSource.WriteHeader(DotSpatial.Data.ShapefileHeader,System.String)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Data.ShapefileFeatureSource.AppendBasicGeometry(DotSpatial.Data.ShapefileHeader,DotSpatial.Topology.IBasicGeometry,System.Int32)">
- <summary>
- Append the geometry to the shapefile
- </summary>
- <param name="header"></param>
- <param name="feature"></param>
- <param name="numFeatures"></param>
- </member>
- <member name="M:DotSpatial.Data.ShapefileFeatureSource.CreateShapeSource">
- <summary>
- Create an appropriate ShapeSource for this FeatureSource
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Data.ShapefileFeatureSource.Filename">
- <summary>
- Gets or sets the Filename of this polygon shapefile.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapefileFeatureSource.PageSize">
- <summary>
- The integer maximum number of records to return in a single page of results.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapefileFeatureSource.SpatialIndex">
- <summary>
- Gets the spatial index if any
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapefileFeatureSource.FeatureType">
- <summary>
- Get the feature type supported by this feature source
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapefileFeatureSource.ShapeType">
- <summary>
- Get the shape type (without M or Z) supported by this feature source
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapefileFeatureSource.ShapeTypeM">
- <summary>
- Get the shape type (with M, and no Z) supported by this feature source
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapefileFeatureSource.ShapeTypeZ">
- <summary>
- Get the shape type (with M and Z) supported by this feature source
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapefileFeatureSource.Extent">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Data.ShapefileFeatureSource.AttributeTable">
- <summary>
- Gets the AttributeTable for this feature source including DeletedRows
- </summary>
- </member>
- <member name="M:DotSpatial.Data.LineShapefileFeatureSource.#ctor(System.String)">
- <summary>
- Sets the fileName and creates a new LineShapefileFeatureSource for the specified file.
- </summary>
- <param name="fileName">The fileName to work with.</param>
- </member>
- <member name="M:DotSpatial.Data.LineShapefileFeatureSource.#ctor(System.String,System.Boolean,System.Boolean)">
- <summary>
- Sets the fileName and creates a new LineShapefileFeatureSource for the specified file (and builds spatial index if requested)
- </summary>
- <param name="fileName"></param>
- <param name="useSpatialIndexing"></param>
- <param name="trackDeletedRows"></param>
- </member>
- <member name="M:DotSpatial.Data.LineShapefileFeatureSource.AppendBasicGeometry(DotSpatial.Data.ShapefileHeader,DotSpatial.Topology.IBasicGeometry,System.Int32)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Data.LineShapefileFeatureSource.CreateShapeSource">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Data.LineShapefileFeatureSource.UpdateExtents">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Data.LineShapefileFeatureSource.Select(System.String,DotSpatial.Topology.IEnvelope,System.Int32@,System.Int32)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.LineShapefileFeatureSource.SearchAndModifyAttributes(DotSpatial.Topology.IEnvelope,System.Int32,DotSpatial.Data.FeatureSourceRowEditEvent)">
- <inheritdoc/>
- </member>
- <member name="P:DotSpatial.Data.LineShapefileFeatureSource.FeatureType">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Data.LineShapefileFeatureSource.ShapeType">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Data.LineShapefileFeatureSource.ShapeTypeM">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Data.LineShapefileFeatureSource.ShapeTypeZ">
- <inheritdocs/>
- </member>
- <member name="T:DotSpatial.Data.LineShapefileShapeSource">
- <summary>
- Retrieves specific shapes.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.ShapefileShapeSource">
- <summary>
- Common functionality for retrieving specific shapes.
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ShapefileShapeSource._shx">
- <summary>
- Cached contents of shape index file
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ShapefileShapeSource.#ctor(System.String)">
- <summary>
- Creates a new instance of the ShapefileShapeSource with the specified
- shapefile as the source.
- </summary>
- <param name="fileName"></param>
- </member>
- <member name="M:DotSpatial.Data.ShapefileShapeSource.#ctor(System.String,DotSpatial.Topology.Index.ISpatialIndex,DotSpatial.Data.ShapefileIndexFile)">
- <summary>
- Creates a new instance of the ShapefileShapeSource with the specified
- shapefile as the source and supplied spatial and shape indices.
- </summary>
- <param name="fileName"></param>
- <param name="spatialIndex"></param>
- <param name="shx"></param>
- </member>
- <member name="M:DotSpatial.Data.ShapefileShapeSource.GetShapeCount">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Data.ShapefileShapeSource.GetShapes(System.Int32@,System.Int32,DotSpatial.Topology.IEnvelope)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Data.ShapefileShapeSource.GetShapes(System.Int32[])">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Data.ShapefileShapeSource.EndGetShapesSession">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Data.ShapefileShapeSource.CacheShapeIndexFile">
- <summary>
- Cache Index File in memory so we don't have to read it in every call to GetShapes
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.ShapefileShapeSource.GetShapeAtIndex(System.IO.FileStream,DotSpatial.Data.ShapefileIndexFile,DotSpatial.Data.ShapefileHeader,System.Int32,DotSpatial.Topology.IEnvelope)">
- <summary>
- Get the shape at the specified index. Must be implemented by all shape sources derived from ShapefileShapeSource
- </summary>
- <param name="fs"></param>
- <param name="shx"></param>
- <param name="header"></param>
- <param name="shp"></param>
- <param name="envelope"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Data.ShapefileShapeSource.Filename">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Data.ShapefileShapeSource.ShapeType">
- <summary>
- Get the shape type (without M or Z) supported by this shape source
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapefileShapeSource.ShapeTypeM">
- <summary>
- Get the shape type (with M, and no Z) supported by this shape source
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapefileShapeSource.ShapeTypeZ">
- <summary>
- Get the shape type (with M and Z) supported by this shape source
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapefileShapeSource.FeatureType">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Data.LineShapefileShapeSource.#ctor(System.String)">
- <summary>
- Creates a new instance of the LineShapefileShapeSource with the specified line
- shapefile as the source.
- </summary>
- <param name="fileName">The string fileName</param>
- </member>
- <member name="M:DotSpatial.Data.LineShapefileShapeSource.#ctor(System.String,DotSpatial.Topology.Index.ISpatialIndex,DotSpatial.Data.ShapefileIndexFile)">
- <summary>
- Creates a new instance of the LineShapefileShapeSource with the specified polygon shapefile as the source and provided indices
- </summary>
- <param name="fileName"></param>
- <param name="spatialIndex"></param>
- <param name="shx"></param>
- </member>
- <member name="M:DotSpatial.Data.LineShapefileShapeSource.GetShapeAtIndex(System.IO.FileStream,DotSpatial.Data.ShapefileIndexFile,DotSpatial.Data.ShapefileHeader,System.Int32,DotSpatial.Topology.IEnvelope)">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Data.LineShapefileShapeSource.ShapeType">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Data.LineShapefileShapeSource.ShapeTypeM">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Data.LineShapefileShapeSource.ShapeTypeZ">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Data.LineShapefileShapeSource.FeatureType">
- <inheritdocs/>
- </member>
- <member name="T:MiscUtil.Linq.ExpressionUtil">
- <summary>
- General purpose Expression utilities
- </summary>
- </member>
- <member name="M:MiscUtil.Linq.ExpressionUtil.CreateExpression``2(System.Func{System.Linq.Expressions.Expression,System.Linq.Expressions.UnaryExpression})">
- <summary>
- Create a function delegate representing a unary operation
- </summary>
- <typeparam name="TArg1">The parameter type</typeparam>
- <typeparam name="TResult">The return type</typeparam>
- <param name="body">Body factory</param>
- <returns>Compiled function delegate</returns>
- </member>
- <member name="M:MiscUtil.Linq.ExpressionUtil.CreateExpression``3(System.Func{System.Linq.Expressions.Expression,System.Linq.Expressions.Expression,System.Linq.Expressions.BinaryExpression})">
- <summary>
- Create a function delegate representing a binary operation
- </summary>
- <typeparam name="TArg1">The first parameter type</typeparam>
- <typeparam name="TArg2">The second parameter type</typeparam>
- <typeparam name="TResult">The return type</typeparam>
- <param name="body">Body factory</param>
- <returns>Compiled function delegate</returns>
- </member>
- <member name="M:MiscUtil.Linq.ExpressionUtil.CreateExpression``3(System.Func{System.Linq.Expressions.Expression,System.Linq.Expressions.Expression,System.Linq.Expressions.BinaryExpression},System.Boolean)">
- <summary>
- Create a function delegate representing a binary operation
- </summary>
- <typeparam name="TArg1">The first parameter type</typeparam>
- <typeparam name="TArg2">The second parameter type</typeparam>
- <typeparam name="TResult">The return type</typeparam>
- <param name="body">Body factory</param>
- <param name="castArgsToResultOnFailure">If no matching operation is possible, attempt to convert
- TArg1 and TArg2 to TResult for a match? For example, there is no
- "decimal operator /(decimal, int)", but by converting TArg2 (int) to
- TResult (decimal) a match is found.</param>
- <returns>
- Compiled function delegate
- </returns>
- </member>
- <member name="T:MiscUtil.Operator">
- <summary>
- The Operator class provides easy access to the standard operators
- (addition, etc) for generic types, using type inference to simplify
- usage.
- </summary>
- </member>
- <member name="M:MiscUtil.Operator.HasValue``1(``0)">
- <summary>
- Indicates if the supplied value is non-null,
- for reference-types or Nullable<T>
- </summary>
- <returns>True for non-null values, else false</returns>
- </member>
- <member name="M:MiscUtil.Operator.AddIfNotNull``1(``0@,``0)">
- <summary>
- Increments the accumulator only
- if the value is non-null. If the accumulator
- is null, then the accumulator is given the new
- value; otherwise the accumulator and value
- are added.
- </summary>
- <param name="accumulator">The current total to be incremented (can be null)</param>
- <param name="value">The value to be tested and added to the accumulator</param>
- <returns>True if the value is non-null, else false - i.e.
- "has the accumulator been updated?"</returns>
- </member>
- <member name="M:MiscUtil.Operator.Negate``1(``0)">
- <summary>
- Evaluates unary negation (-) for the given type; this will throw
- an InvalidOperationException if the type T does not provide this operator, or for
- Nullable<TInner> if TInner does not provide this operator.
- </summary>
- </member>
- <member name="M:MiscUtil.Operator.Not``1(``0)">
- <summary>
- Evaluates bitwise not (~) for the given type; this will throw
- an InvalidOperationException if the type T does not provide this operator, or for
- Nullable<TInner> if TInner does not provide this operator.
- </summary>
- </member>
- <member name="M:MiscUtil.Operator.Or``1(``0,``0)">
- <summary>
- Evaluates bitwise or (|) for the given type; this will throw
- an InvalidOperationException if the type T does not provide this operator, or for
- Nullable<TInner> if TInner does not provide this operator.
- </summary>
- </member>
- <member name="M:MiscUtil.Operator.And``1(``0,``0)">
- <summary>
- Evaluates bitwise and (&) for the given type; this will throw
- an InvalidOperationException if the type T does not provide this operator, or for
- Nullable<TInner> if TInner does not provide this operator.
- </summary>
- </member>
- <member name="M:MiscUtil.Operator.Xor``1(``0,``0)">
- <summary>
- Evaluates bitwise xor (^) for the given type; this will throw
- an InvalidOperationException if the type T does not provide this operator, or for
- Nullable<TInner> if TInner does not provide this operator.
- </summary>
- </member>
- <member name="M:MiscUtil.Operator.Convert``2(``0)">
- <summary>
- Performs a conversion between the given types; this will throw
- an InvalidOperationException if the type T does not provide a suitable cast, or for
- Nullable<TInner> if TInner does not provide this cast.
- </summary>
- </member>
- <member name="M:MiscUtil.Operator.Add``1(``0,``0)">
- <summary>
- Evaluates binary addition (+) for the given type; this will throw
- an InvalidOperationException if the type T does not provide this operator, or for
- Nullable<TInner> if TInner does not provide this operator.
- </summary>
- </member>
- <member name="M:MiscUtil.Operator.AddAlternative``2(``0,``1)">
- <summary>
- Evaluates binary addition (+) for the given type(s); this will throw
- an InvalidOperationException if the type T does not provide this operator, or for
- Nullable<TInner> if TInner does not provide this operator.
- </summary>
- </member>
- <member name="M:MiscUtil.Operator.Subtract``1(``0,``0)">
- <summary>
- Evaluates binary subtraction (-) for the given type; this will throw
- an InvalidOperationException if the type T does not provide this operator, or for
- Nullable<TInner> if TInner does not provide this operator.
- </summary>
- </member>
- <member name="M:MiscUtil.Operator.SubtractAlternative``2(``0,``1)">
- <summary>
- Evaluates binary subtraction(-) for the given type(s); this will throw
- an InvalidOperationException if the type T does not provide this operator, or for
- Nullable<TInner> if TInner does not provide this operator.
- </summary>
- </member>
- <member name="M:MiscUtil.Operator.Multiply``1(``0,``0)">
- <summary>
- Evaluates binary multiplication (*) for the given type; this will throw
- an InvalidOperationException if the type T does not provide this operator, or for
- Nullable<TInner> if TInner does not provide this operator.
- </summary>
- </member>
- <member name="M:MiscUtil.Operator.MultiplyAlternative``2(``0,``1)">
- <summary>
- Evaluates binary multiplication (*) for the given type(s); this will throw
- an InvalidOperationException if the type T does not provide this operator, or for
- Nullable<TInner> if TInner does not provide this operator.
- </summary>
- </member>
- <member name="M:MiscUtil.Operator.Divide``1(``0,``0)">
- <summary>
- Evaluates binary division (/) for the given type; this will throw
- an InvalidOperationException if the type T does not provide this operator, or for
- Nullable<TInner> if TInner does not provide this operator.
- </summary>
- </member>
- <member name="M:MiscUtil.Operator.DivideAlternative``2(``0,``1)">
- <summary>
- Evaluates binary division (/) for the given type(s); this will throw
- an InvalidOperationException if the type T does not provide this operator, or for
- Nullable<TInner> if TInner does not provide this operator.
- </summary>
- </member>
- <member name="M:MiscUtil.Operator.Equal``1(``0,``0)">
- <summary>
- Evaluates binary equality (==) for the given type; this will throw
- an InvalidOperationException if the type T does not provide this operator, or for
- Nullable<TInner> if TInner does not provide this operator.
- </summary>
- </member>
- <member name="M:MiscUtil.Operator.NotEqual``1(``0,``0)">
- <summary>
- Evaluates binary inequality (!=) for the given type; this will throw
- an InvalidOperationException if the type T does not provide this operator, or for
- Nullable<TInner> if TInner does not provide this operator.
- </summary>
- </member>
- <member name="M:MiscUtil.Operator.GreaterThan``1(``0,``0)">
- <summary>
- Evaluates binary greater-than (>) for the given type; this will throw
- an InvalidOperationException if the type T does not provide this operator, or for
- Nullable<TInner> if TInner does not provide this operator.
- </summary>
- </member>
- <member name="M:MiscUtil.Operator.LessThan``1(``0,``0)">
- <summary>
- Evaluates binary less-than (<) for the given type; this will throw
- an InvalidOperationException if the type T does not provide this operator, or for
- Nullable<TInner> if TInner does not provide this operator.
- </summary>
- </member>
- <member name="M:MiscUtil.Operator.GreaterThanOrEqual``1(``0,``0)">
- <summary>
- Evaluates binary greater-than-on-eqauls (>=) for the given type; this will throw
- an InvalidOperationException if the type T does not provide this operator, or for
- Nullable<TInner> if TInner does not provide this operator.
- </summary>
- </member>
- <member name="M:MiscUtil.Operator.LessThanOrEqual``1(``0,``0)">
- <summary>
- Evaluates binary less-than-or-equal (<=) for the given type; this will throw
- an InvalidOperationException if the type T does not provide this operator, or for
- Nullable<TInner> if TInner does not provide this operator.
- </summary>
- </member>
- <member name="M:MiscUtil.Operator.DivideInt32``1(``0,System.Int32)">
- <summary>
- Evaluates integer division (/) for the given type; this will throw
- an InvalidOperationException if the type T does not provide this operator, or for
- Nullable<TInner> if TInner does not provide this operator.
- </summary><remarks>
- This operation is particularly useful for computing averages and
- similar aggregates.
- </remarks>
- </member>
- <member name="T:MiscUtil.Operator`2">
- <summary>
- Provides standard operators (such as addition) that operate over operands of
- different types. For operators, the return type is assumed to match the first
- operand.
- </summary>
- <seealso cref="T:MiscUtil.Operator`1"/>
- <seealso cref="T:MiscUtil.Operator"/>
- </member>
- <member name="P:MiscUtil.Operator`2.Convert">
- <summary>
- Returns a delegate to convert a value between two types; this delegate will throw
- an InvalidOperationException if the type T does not provide a suitable cast, or for
- Nullable<TInner> if TInner does not provide this cast.
- </summary>
- </member>
- <member name="P:MiscUtil.Operator`2.Add">
- <summary>
- Returns a delegate to evaluate binary addition (+) for the given types; this delegate will throw
- an InvalidOperationException if the type T does not provide this operator, or for
- Nullable<TInner> if TInner does not provide this operator.
- </summary>
- </member>
- <member name="P:MiscUtil.Operator`2.Subtract">
- <summary>
- Returns a delegate to evaluate binary subtraction (-) for the given types; this delegate will throw
- an InvalidOperationException if the type T does not provide this operator, or for
- Nullable<TInner> if TInner does not provide this operator.
- </summary>
- </member>
- <member name="P:MiscUtil.Operator`2.Multiply">
- <summary>
- Returns a delegate to evaluate binary multiplication (*) for the given types; this delegate will throw
- an InvalidOperationException if the type T does not provide this operator, or for
- Nullable<TInner> if TInner does not provide this operator.
- </summary>
- </member>
- <member name="P:MiscUtil.Operator`2.Divide">
- <summary>
- Returns a delegate to evaluate binary division (/) for the given types; this delegate will throw
- an InvalidOperationException if the type T does not provide this operator, or for
- Nullable<TInner> if TInner does not provide this operator.
- </summary>
- </member>
- <member name="T:MiscUtil.Operator`1">
- <summary>
- Provides standard operators (such as addition) over a single type
- </summary>
- <seealso cref="T:MiscUtil.Operator"/>
- <seealso cref="T:MiscUtil.Operator`2"/>
- </member>
- <member name="P:MiscUtil.Operator`1.Zero">
- <summary>
- Returns the zero value for value-types (even full Nullable<TInner>) - or null for reference types
- </summary>
- </member>
- <member name="P:MiscUtil.Operator`1.Negate">
- <summary>
- Returns a delegate to evaluate unary negation (-) for the given type; this delegate will throw
- an InvalidOperationException if the type T does not provide this operator, or for
- Nullable<TInner> if TInner does not provide this operator.
- </summary>
- </member>
- <member name="P:MiscUtil.Operator`1.Not">
- <summary>
- Returns a delegate to evaluate bitwise not (~) for the given type; this delegate will throw
- an InvalidOperationException if the type T does not provide this operator, or for
- Nullable<TInner> if TInner does not provide this operator.
- </summary>
- </member>
- <member name="P:MiscUtil.Operator`1.Or">
- <summary>
- Returns a delegate to evaluate bitwise or (|) for the given type; this delegate will throw
- an InvalidOperationException if the type T does not provide this operator, or for
- Nullable<TInner> if TInner does not provide this operator.
- </summary>
- </member>
- <member name="P:MiscUtil.Operator`1.And">
- <summary>
- Returns a delegate to evaluate bitwise and (&) for the given type; this delegate will throw
- an InvalidOperationException if the type T does not provide this operator, or for
- Nullable<TInner> if TInner does not provide this operator.
- </summary>
- </member>
- <member name="P:MiscUtil.Operator`1.Xor">
- <summary>
- Returns a delegate to evaluate bitwise xor (^) for the given type; this delegate will throw
- an InvalidOperationException if the type T does not provide this operator, or for
- Nullable<TInner> if TInner does not provide this operator.
- </summary>
- </member>
- <member name="P:MiscUtil.Operator`1.Add">
- <summary>
- Returns a delegate to evaluate binary addition (+) for the given type; this delegate will throw
- an InvalidOperationException if the type T does not provide this operator, or for
- Nullable<TInner> if TInner does not provide this operator.
- </summary>
- </member>
- <member name="P:MiscUtil.Operator`1.Subtract">
- <summary>
- Returns a delegate to evaluate binary subtraction (-) for the given type; this delegate will throw
- an InvalidOperationException if the type T does not provide this operator, or for
- Nullable<TInner> if TInner does not provide this operator.
- </summary>
- </member>
- <member name="P:MiscUtil.Operator`1.Multiply">
- <summary>
- Returns a delegate to evaluate binary multiplication (*) for the given type; this delegate will throw
- an InvalidOperationException if the type T does not provide this operator, or for
- Nullable<TInner> if TInner does not provide this operator.
- </summary>
- </member>
- <member name="P:MiscUtil.Operator`1.Divide">
- <summary>
- Returns a delegate to evaluate binary division (/) for the given type; this delegate will throw
- an InvalidOperationException if the type T does not provide this operator, or for
- Nullable<TInner> if TInner does not provide this operator.
- </summary>
- </member>
- <member name="P:MiscUtil.Operator`1.Equal">
- <summary>
- Returns a delegate to evaluate binary equality (==) for the given type; this delegate will throw
- an InvalidOperationException if the type T does not provide this operator, or for
- Nullable<TInner> if TInner does not provide this operator.
- </summary>
- </member>
- <member name="P:MiscUtil.Operator`1.NotEqual">
- <summary>
- Returns a delegate to evaluate binary inequality (!=) for the given type; this delegate will throw
- an InvalidOperationException if the type T does not provide this operator, or for
- Nullable<TInner> if TInner does not provide this operator.
- </summary>
- </member>
- <member name="P:MiscUtil.Operator`1.GreaterThan">
- <summary>
- Returns a delegate to evaluate binary greater-then (>) for the given type; this delegate will throw
- an InvalidOperationException if the type T does not provide this operator, or for
- Nullable<TInner> if TInner does not provide this operator.
- </summary>
- </member>
- <member name="P:MiscUtil.Operator`1.LessThan">
- <summary>
- Returns a delegate to evaluate binary less-than (<) for the given type; this delegate will throw
- an InvalidOperationException if the type T does not provide this operator, or for
- Nullable<TInner> if TInner does not provide this operator.
- </summary>
- </member>
- <member name="P:MiscUtil.Operator`1.GreaterThanOrEqual">
- <summary>
- Returns a delegate to evaluate binary greater-than-or-equal (>=) for the given type; this delegate will throw
- an InvalidOperationException if the type T does not provide this operator, or for
- Nullable<TInner> if TInner does not provide this operator.
- </summary>
- </member>
- <member name="P:MiscUtil.Operator`1.LessThanOrEqual">
- <summary>
- Returns a delegate to evaluate binary less-than-or-equal (<=) for the given type; this delegate will throw
- an InvalidOperationException if the type T does not provide this operator, or for
- Nullable<TInner> if TInner does not provide this operator.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.PointShape">
- <summary>
- PointShape
- </summary>
- </member>
- <member name="M:DotSpatial.Data.PointShape.Intersects(DotSpatial.Data.ShapeRange,DotSpatial.Data.ShapeRange)">
- <summary>
- Calculates the intersection of a polygon shape without relying on the NTS geometry
- </summary>
- <param name="pointShape"></param>
- <param name="otherShape"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.PointShape.VerticesIntersect(DotSpatial.Data.ShapeRange,DotSpatial.Data.ShapeRange)">
- <summary>
- Returns true if any vertices overlap
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Data.PointShape.Epsilon">
- <summary>
- Gets or sets the precision for calculating equality, but this is just a re-direction to Vertex.Epsilon
- </summary>
- </member>
- <member name="T:DotSpatial.Data.PointShapefileFeatureSource">
- <summary>
- This class is strictly the vector access code. This does not handle
- the attributes, which must be handled independantly.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.PointShapefileFeatureSource.#ctor(System.String)">
- <summary>
- Sets the fileName and creates a new PointShapefileFeatureSource for the specified file.
- </summary>
- <param name="fileName">The fileName to work with.</param>
- </member>
- <member name="M:DotSpatial.Data.PointShapefileFeatureSource.#ctor(System.String,System.Boolean,System.Boolean)">
- <summary>
- Sets the fileName and creates a new PointshapefileFeatureSource for the specified file (and builds spatial index if requested)
- </summary>
- <param name="fileName"></param>
- <param name="useSpatialIndexing"></param>
- <param name="trackDeletedRows"></param>
- </member>
- <member name="M:DotSpatial.Data.PointShapefileFeatureSource.AppendBasicGeometry(DotSpatial.Data.ShapefileHeader,DotSpatial.Topology.IBasicGeometry,System.Int32)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Data.PointShapefileFeatureSource.CreateShapeSource">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Data.PointShapefileFeatureSource.UpdateExtents">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Data.PointShapefileFeatureSource.Select(System.String,DotSpatial.Topology.IEnvelope,System.Int32@,System.Int32)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.PointShapefileFeatureSource.SearchAndModifyAttributes(DotSpatial.Topology.IEnvelope,System.Int32,DotSpatial.Data.FeatureSourceRowEditEvent)">
- <inheritdoc/>
- </member>
- <member name="P:DotSpatial.Data.PointShapefileFeatureSource.FeatureType">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Data.PointShapefileFeatureSource.ShapeType">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Data.PointShapefileFeatureSource.ShapeTypeM">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Data.PointShapefileFeatureSource.ShapeTypeZ">
- <inheritdocs/>
- </member>
- <member name="T:DotSpatial.Data.PointShapefileShapeSource">
- <summary>
- Retrieves specific shapes.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.PointShapefileShapeSource.#ctor(System.String)">
- <summary>
- Creates a new instance of the PointShapefileShapeSource with the specified point
- shapefile as the source.
- </summary>
- <param name="fileName">The string fileName</param>
- </member>
- <member name="M:DotSpatial.Data.PointShapefileShapeSource.#ctor(System.String,DotSpatial.Topology.Index.ISpatialIndex,DotSpatial.Data.ShapefileIndexFile)">
- <summary>
- Creates a new instance of the PointShapefileShapeSource with the specified polygon shapefile as the source and provided indices
- </summary>
- <param name="fileName"></param>
- <param name="spatialIndex"></param>
- <param name="shx"></param>
- </member>
- <member name="M:DotSpatial.Data.PointShapefileShapeSource.GetShapeAtIndex(System.IO.FileStream,DotSpatial.Data.ShapefileIndexFile,DotSpatial.Data.ShapefileHeader,System.Int32,DotSpatial.Topology.IEnvelope)">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Data.PointShapefileShapeSource.ShapeType">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Data.PointShapefileShapeSource.ShapeTypeM">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Data.PointShapefileShapeSource.ShapeTypeZ">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Data.PointShapefileShapeSource.FeatureType">
- <inheritdocs/>
- </member>
- <member name="T:DotSpatial.Data.PolygonShape">
- <summary>
- Polygon contains algorithms for the case where the current feature type is a polygon. The shape may be single or multi-part.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.PolygonShape.Intersects(DotSpatial.Data.ShapeRange,DotSpatial.Data.ShapeRange)">
- <summary>
- Calculates the intersection of a polygon shape without relying on the NTS geometry
- </summary>
- <param name="polygonShape"></param>
- <param name="otherShape"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.PolygonShape.ContainsVertex(DotSpatial.Data.ShapeRange,DotSpatial.Data.ShapeRange)">
- <summary>
- This cycles through all the vertices, which are stored as {X1, Y1, X2, Y2...Xn, Yn} and tests
- if any of those vertices falls within the polygon shape.
- </summary>
- <param name="polygonShape"></param>
- <param name="otherShape"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.PolygonShape.ContainsVertex(DotSpatial.Data.ShapeRange,DotSpatial.Data.PartRange)">
- <summary>
- For each coordinate in the other part, if it falls in the extent of this polygon, a
- ray crossing test is used for point in polygon testing. If it is not in the extent,
- it is skipped.
- </summary>
- <param name="polygonShape">The part of the polygon to analyze polygon</param>
- <param name="otherPart">The other part</param>
- <returns>Boolean, true if any coordinate falls inside the polygon</returns>
- </member>
- <member name="P:DotSpatial.Data.PolygonShape.Epsilon">
- <summary>
- Gets or sets the precision for calculating equality, but this is just a re-direction to Vertex.Epsilon
- </summary>
- </member>
- <member name="T:DotSpatial.Data.DataFormat">
- <summary>
- DataFormats
- </summary>
- </member>
- <member name="F:DotSpatial.Data.DataFormat.Vector">
- <summary>
- Lines, Points and Polygons make up standard static vector formats.
- These are drawn dynamically based on the symbolizer.
- </summary>
- </member>
- <member name="F:DotSpatial.Data.DataFormat.Raster">
- <summary>
- Rasters are grids of integers, doubles, floats, or other numeric value types.
- These can be symbolized and represented as images, but not drawn directly.
- </summary>
- </member>
- <member name="F:DotSpatial.Data.DataFormat.Image">
- <summary>
- Images specifically have pixels coordinates that store a color.
- These are drawn directly.
- </summary>
- </member>
- <member name="F:DotSpatial.Data.DataFormat.Custom">
- <summary>
- This represents an extended format that does not have a formal definition in DotSpatial.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.DataManager">
- <summary>
- This can be used as a component to work as a DataManager. This also provides the
- very important DefaultDataManager property, which is where the developer controls
- what DataManager should be used for their project.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IDataManager">
- <summary>
- IDataManager
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IDataManager.GetFileFormat(System.String)">
- <summary>
- This can help determine what kind of file format a file is, without actually opening the file.
- </summary>
- <param name="fileName">The string fileName to test</param>
- <returns>A DataFormats enum</returns>
- </member>
- <member name="M:DotSpatial.Data.IDataManager.GetFeatureType(System.String)">
- <summary>
- Instead of opening the specified file, this simply determines the correct
- provider, and requests that the provider check the feature type for vector
- formats.
- </summary>
- <param name="fileName">The string fileName to test</param>
- <returns>A FeatureTypes enum</returns>
- </member>
- <member name="M:DotSpatial.Data.IDataManager.GetSupportedExtensions(System.String)">
- <summary>
- Checks a dialog filter and returns a list of just the extensions.
- </summary>
- <param name="dialogFilter">The Dialog Filter to read extensions from</param>
- <returns>A list of extensions</returns>
- </member>
- <member name="M:DotSpatial.Data.IDataManager.OpenFile(System.String)">
- <summary>
- Attempts to call the open fileName method for any IDataProvider plugin
- that matches the extension on the string.
- </summary>
- <param name="fileName">A String fileName to attempt to open.</param>
- </member>
- <member name="M:DotSpatial.Data.IDataManager.OpenFile(System.String,System.Boolean)">
- <summary>
- Attempts to call the open fileName method for any IDataProvider plugin
- that matches the extension on the string.
- </summary>
- <param name="fileName">A String fileName to attempt to open.</param>
- <param name="inRam">A boolean value that if true will attempt to force a load of the data into memory. This value overrides the property on this DataManager.</param>
- </member>
- <member name="M:DotSpatial.Data.IDataManager.OpenFile(System.String,System.Boolean,DotSpatial.Data.IProgressHandler)">
- <summary>
- Attempts to call the open fileName method for any IDataProvider plugin
- that matches the extension on the string.
- </summary>
- <param name="fileName">A String fileName to attempt to open.</param>
- <param name="inRam">A boolean value that if true will attempt to force a load of the data into memory. This value overrides the property on this DataManager.</param>
- <param name="progressHandler">Specifies the progressHandler to receive progress messages. This value overrides the property on this DataManager.</param>
- </member>
- <member name="M:DotSpatial.Data.IDataManager.OpenImage(System.String)">
- <summary>
- Opens the file as an Image and returns an IImageData object for interacting with the file.
- </summary>
- <param name="fileName">The string fileName</param>
- <returns>An IImageData object</returns>
- </member>
- <member name="M:DotSpatial.Data.IDataManager.OpenImage(System.String,DotSpatial.Data.IProgressHandler)">
- <summary>
- Opens the file as an Image and returns an IImageData object
- </summary>
- <param name="fileName">The string fileName to open</param>
- <param name="progressHandler">The progressHandler to receive progress updates</param>
- <returns>An IImageData</returns>
- </member>
- <member name="M:DotSpatial.Data.IDataManager.OpenRaster(System.String)">
- <summary>
- Opens the specified fileName, returning an IRaster. This will return null if a manager
- either returns the wrong data format.
- </summary>
- <param name="fileName">The string fileName to open</param>
- <returns>An IRaster loaded from the specified file.</returns>
- </member>
- <member name="M:DotSpatial.Data.IDataManager.OpenRaster(System.String,System.Boolean,DotSpatial.Data.IProgressHandler)">
- <summary>
- Opens the specified fileName, returning an IRaster. This will return null if a manager
- either returns the wrong data format.
- </summary>
- <param name="fileName">The string fileName to open</param>
- <param name="inRam">boolean, true if this should be loaded into ram</param>
- <param name="prog">a progress interface</param>
- <returns>An IRaster loaded from the specified file</returns>
- </member>
- <member name="M:DotSpatial.Data.IDataManager.OpenVector(System.String,System.Boolean,DotSpatial.Data.IProgressHandler)">
- <summary>
- Opens a specified file as an IFeatureSet
- </summary>
- <param name="fileName">The string fileName to open</param>
- <param name="inRam">boolean, true if this should be loaded into ram</param>
- <param name="prog">a progress interface</param>
- <returns>An IFeatureSet loaded from the specified file</returns>
- </member>
- <member name="M:DotSpatial.Data.IDataManager.CreateImage(System.String,System.Int32,System.Int32,DotSpatial.Data.ImageBandType)">
- <summary>
- Creates a new image using an appropriate data provider
- </summary>
- <param name="fileName">The string fileName to open an image for</param>
- <param name="numRows">The integer number of rows</param>
- <param name="numColumns">The integer number of columns</param>
- <param name="bandType">The color band type.</param>
- <returns>An IImageData interface allowing access to image data</returns>
- </member>
- <member name="M:DotSpatial.Data.IDataManager.CreateImage(System.String,System.Int32,System.Int32,System.Boolean,DotSpatial.Data.ImageBandType)">
- <summary>
- Creates a new image using an appropriate data provider
- </summary>
- <param name="fileName">The string fileName to open an image for</param>
- <param name="numRows">The integer number of rows</param>
- <param name="numColumns">The integer number of columns</param>
- <param name="inRam">Boolean, true if the entire file should be created in memory</param>
- <param name="bandType">The color band type.</param>
- <returns>An IImageData interface allowing access to image data</returns>
- </member>
- <member name="M:DotSpatial.Data.IDataManager.CreateImage(System.String,System.Int32,System.Int32,System.Boolean,DotSpatial.Data.IProgressHandler,DotSpatial.Data.ImageBandType)">
- <summary>
- Creates a new image using an appropriate data provider
- </summary>
- <param name="fileName">The string fileName to open an image for</param>
- <param name="numRows">The integer number of rows</param>
- <param name="numColumns">The integer number of columns</param>
- <param name="inRam">Boolean, true if the entire file should be created in memory</param>
- <param name="progHandler">A Progress handler</param>
- <param name="bandType">The color band type.</param>
- <returns>An IImageData interface allowing access to image data</returns>
-
- </member>
- <member name="M:DotSpatial.Data.IDataManager.CreateVector(System.String,DotSpatial.Topology.FeatureType)">
- <summary>
- Creates a new class of vector that matches the given fileName.
- </summary>
- <param name="fileName">The string fileName from which to create a vector.</param>
- <param name="featureType">Specifies the type of feature for this vector file</param>
- <returns>An IFeatureSet that allows working with the dataset.</returns>
- </member>
- <member name="M:DotSpatial.Data.IDataManager.CreateVector(System.String,DotSpatial.Topology.FeatureType,DotSpatial.Data.IProgressHandler)">
- <summary>
- Creates a new class of vector that matches the given fileName.
- </summary>
- <param name="fileName">The string fileName from which to create a vector.</param>
- <param name="featureType">Specifies the type of feature for this vector file</param>
- <param name="progHandler">Overrides the default progress handler with the specified progress handler</param>
- <returns>An IFeatureSet that allows working with the dataset.</returns>
- </member>
- <member name="M:DotSpatial.Data.IDataManager.CreateRaster(System.String,System.String,System.Int32,System.Int32,System.Int32,System.Type,System.String[])">
- <summary>
- Creates a new raster using the specified raster provider and the Data Manager's Progress Handler,
- as well as its LoadInRam property.
- </summary>
- <param name="name">The fileName of the new file to create.</param>
- <param name="driverCode">The string code identifying the driver to use to create the raster</param>
- <param name="xSize">The number of columns in the raster</param>
- <param name="ySize">The number of rows in the raster</param>
- <param name="numBands">The number of bands in the raster</param>
- <param name="dataType">The data type for the raster</param>
- <param name="options">Any additional, driver specific options for creation</param>
- <returns>An IRaster representing the created raster.</returns>
- </member>
- <member name="P:DotSpatial.Data.IDataManager.DataProviders">
- <summary>
- Gets or sets the list of IDataProviders that should be used in the project.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IDataManager.DialogReadFilter">
- <summary>
- Gets or sets the dialog read filter to use for opening data files.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IDataManager.DialogWriteFilter">
- <summary>
- Gets or sets the dialog write filter to use for saving data files.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IDataManager.LoadInRam">
- <summary>
- Sets the default condition for how this data manager should try to load layers.
- This will be overridden if the inRam property is specified as a parameter.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IDataManager.RasterReadFilter">
- <summary>
- Gets or sets the dialog read filter to use for opening data files that are specifically raster formats.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IDataManager.RasterWriteFilter">
- <summary>
- Gets or sets the dialog write filter to use for saving raster files.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IDataManager.VectorReadFilter">
- <summary>
- Gets or sets the dialog read filter to use for opening vector files.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IDataManager.VectorWriteFilter">
- <summary>
- Gets or sets the dialog write filter to use for saving vector files.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IDataManager.ImageReadFilter">
- <summary>
- Gets or sets the dialog read filter to use for opening image files.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IDataManager.ImageWriteFilter">
- <summary>
- Gets or sets the dialog write filter to use for saving image files.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IDataManager.PreferredProviders">
- <summary>
- Gets or sets a dictionary of IDataProviders keyed by the extension. The
- standard order is to try to load the data using a PreferredProvider. If that
- fails, then it will check the list of dataProviders, and finally, if that fails,
- it will check the plugin Data Providers in directories.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IDataManager.ProgressHandler">
- <summary>
- Gets or sets a progress handler for any open operations that are intiated by this
- DataManager.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IDataManager.DirectoryProvidersLoaded">
- <summary>
- Occurs after the directory providers have been loaded into the project.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.DataManager.#ctor">
- <summary>
- Creates a new instance of the DataManager class. A data manager is more or less
- just a list of data providers to use. The very important
- DataManager.DefaultDataManager property controls which DataManager will be used
- to load data. By default, each DataManager sets itself as the default in its
- constructor.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.DataManager.CreateVector(System.String,DotSpatial.Topology.FeatureType)">
- <summary>
- Creates a new class of vector that matches the given fileName.
- </summary>
- <param name="fileName">The string fileName from which to create a vector.</param>
- <param name="featureType">Specifies the type of feature for this vector file</param>
- <returns>An IFeatureSet that allows working with the dataset.</returns>
- </member>
- <member name="M:DotSpatial.Data.DataManager.CreateVector(System.String,DotSpatial.Topology.FeatureType,DotSpatial.Data.IProgressHandler)">
- <summary>
- Creates a new class of vector that matches the given fileName.
- </summary>
- <param name="fileName">The string fileName from which to create a vector.</param>
- <param name="featureType">Specifies the type of feature for this vector file</param>
- <param name="progHandler">Overrides the default progress handler with the specified progress handler</param>
- <returns>An IFeatureSet that allows working with the dataset.</returns>
- <exception cref="T:System.ArgumentNullException">Raised when fileName is null.</exception>
- <exception cref="T:System.IO.IOException">Raised when suitable DataProvider not found.</exception>
- </member>
- <member name="M:DotSpatial.Data.DataManager.GetSupportedExtensions(System.String)">
- <summary>
- Checks a dialog filter and returns a list of just the extensions.
- </summary>
- <param name="dialogFilter">The Dialog Filter to read extensions from</param>
- <returns>A list of extensions</returns>
- </member>
- <member name="M:DotSpatial.Data.DataManager.GetFileFormat(System.String)">
- <summary>
- This can help determine what kind of file format a file is, without actually opening the file.
- </summary>
- <param name="fileName"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.DataManager.GetFeatureType(System.String)">
- <summary>
- Instead of opening the specified file, this simply determines the correct
- provider, and requests that the provider check the feature type for vector
- formats.
- </summary>
- <param name="fileName"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.DataManager.OpenRaster(System.String)">
- <summary>
- Opens the specified fileName, returning an IRaster. This will return null if a manager
- either returns the wrong data format.
- </summary>
- <param name="fileName">The string fileName to open</param>
- <returns>An IRaster loaded from the specified file.</returns>
- </member>
- <member name="M:DotSpatial.Data.DataManager.OpenRaster(System.String,System.Boolean,DotSpatial.Data.IProgressHandler)">
- <summary>
- Opens the specified fileName, returning an IRaster. This will return null if a manager
- either returns the wrong data format.
- </summary>
- <param name="fileName">The string fileName to open</param>
- <param name="inRam">boolean, true if this should be loaded into ram</param>
- <param name="prog">a progress interface</param>
- <returns>An IRaster loaded from the specified file</returns>
- </member>
- <member name="M:DotSpatial.Data.DataManager.OpenVector(System.String,System.Boolean,DotSpatial.Data.IProgressHandler)">
- <summary>
- Opens a specified file as an IFeatureSet
- </summary>
- <param name="fileName">The string fileName to open</param>
- <param name="inRam">boolean, true if this should be loaded into ram</param>
- <param name="prog">a progress interface</param>
- <returns>An IFeatureSet loaded from the specified file</returns>
- </member>
- <member name="M:DotSpatial.Data.DataManager.OpenImage(System.String)">
- <summary>
- Opens the file as an Image and returns an IImageData object for interacting with the file.
- </summary>
- <param name="fileName">The string fileName</param>
- <returns>An IImageData object</returns>
- </member>
- <member name="M:DotSpatial.Data.DataManager.OpenImage(System.String,DotSpatial.Data.IProgressHandler)">
- <summary>
- Opens the file as an Image and returns an IImageData object
- </summary>
- <param name="fileName">The string fileName to open</param>
- <param name="progressHandler">The progressHandler to receive progress updates</param>
- <returns>An IImageData</returns>
- </member>
- <member name="M:DotSpatial.Data.DataManager.OpenFile(System.String)">
- <summary>
- Attempts to call the open fileName method for any IDataProvider plugin
- that matches the extension on the string.
- </summary>
- <param name="fileName">A String fileName to attempt to open.</param>
- </member>
- <member name="M:DotSpatial.Data.DataManager.OpenFile(System.String,System.Boolean)">
- <summary>
- Attempts to call the open fileName method for any IDataProvider plugin
- that matches the extension on the string.
- </summary>
- <param name="fileName">A String fileName to attempt to open.</param>
- <param name="inRam">A boolean value that if true will attempt to force a load of the data into memory. This value overrides the property on this DataManager.</param>
- </member>
- <member name="M:DotSpatial.Data.DataManager.OpenFile(System.String,System.Boolean,DotSpatial.Data.IProgressHandler)">
- <summary>
- Attempts to call the open fileName method for any IDataProvider plugin
- that matches the extension on the string.
- </summary>
- <param name="fileName">A String fileName to attempt to open.</param>
- <param name="inRam">A boolean value that if true will attempt to force a load of the data into memory. This value overrides the property on this DataManager.</param>
- <param name="progressHandler">Specifies the progressHandler to receive progress messages. This value overrides the property on this DataManager.</param>
- </member>
- <member name="M:DotSpatial.Data.DataManager.CreateImage(System.String,System.Int32,System.Int32,DotSpatial.Data.ImageBandType)">
- <summary>
- Creates a new image using an appropriate data provider
- </summary>
- <param name="fileName">The string fileName to open an image for</param>
- <param name="width">The integer width in pixels</param>
- <param name="height">The integer height in pixels</param>
- <param name="bandType">The band color type</param>
- <returns>An IImageData interface allowing access to image data</returns>
- </member>
- <member name="M:DotSpatial.Data.DataManager.CreateImage(System.String,System.Int32,System.Int32,System.Boolean,DotSpatial.Data.ImageBandType)">
- <summary>
- Creates a new image using an appropriate data provider
- </summary>
- <param name="fileName">The string fileName to open an image for</param>
- <param name="width">The integer width in pixels</param>
- <param name="height">The integer height in pixels</param>
- <param name="inRam">Boolean, true if the entire file should be created in memory</param>
- <param name="bandType">The band color type</param>
- <returns>An IImageData interface allowing access to image data</returns>
- </member>
- <member name="M:DotSpatial.Data.DataManager.CreateImage(System.String,System.Int32,System.Int32,System.Boolean,DotSpatial.Data.IProgressHandler,DotSpatial.Data.ImageBandType)">
- <summary>
- Creates a new image using an appropriate data provider
- </summary>
- <param name="fileName">The string fileName to open an image for</param>
- <param name="width">The integer width in pixels</param>
- <param name="height">The integer height in pixels</param>
- <param name="inRam">Boolean, true if the entire file should be created in memory</param>
- <param name="progHandler">A Progress handler</param>
- <param name="bandType">The band color type</param>
- <returns>An IImageData interface allowing access to image data</returns>
- </member>
- <member name="M:DotSpatial.Data.DataManager.CreateRaster(System.String,System.String,System.Int32,System.Int32,System.Int32,System.Type,System.String[])">
- <summary>
- Creates a new raster using the specified raster provider and the Data Manager's Progress Handler,
- as well as its LoadInRam property.
- </summary>
- <param name="name">The fileName of the new file to create.</param>
- <param name="driverCode">The string code identifying the driver to use to create the raster. If no code is specified
- the manager will attempt to match the extension with a code specified in the Dialog write filter. </param>
- <param name="xSize">The number of columns in the raster</param>
- <param name="ySize">The number of rows in the raster</param>
- <param name="numBands">The number of bands in the raster</param>
- <param name="dataType">The data type for the raster</param>
- <param name="options">Any additional, driver specific options for creation</param>
- <returns>An IRaster representing the created raster.</returns>
- </member>
- <member name="M:DotSpatial.Data.DataManager.OpenFileAsIRaster(System.String,System.Boolean,DotSpatial.Data.IProgressHandler)">
- <summary>
- Opens the file making sure it can be returned as an IRaster.
- </summary>
- <param name="fileName">Name of the file.</param>
- <param name="inRam">if set to <c>true</c> [in ram].</param>
- <param name="progressHandler">The progress handler.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.DataManager.OnProvidersLoaded(System.Collections.Generic.IEnumerable{DotSpatial.Data.IDataProvider})">
- <summary>
- Triggers the DirectoryProvidersLoaded event
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataManager.DefaultDataManager">
- <summary>
- Gets or sets the implementation of IDataManager for the project to use when
- accessing data. This is THE place where the DataManager can be replaced
- by a different data manager. If you add this data manager to your
- project, this will automatically set itself as the DefaultDataManager.
- However, since each DM will do this, you may have to control this manually
- if you add more than one DataManager to the project in order to set the
- one that will be chosen.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataManager.DataProviders">
- <summary>
- Gets or sets the list of IDataProviders that should be used in the project.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataManager.DialogReadFilter">
- <summary>
- Gets or sets the dialog read filter to use for opening data files.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataManager.DialogWriteFilter">
- <summary>
- Gets or sets the dialog write filter to use for saving data files.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataManager.RasterReadFilter">
- <summary>
- Gets or sets the dialog read filter to use for opening data files that are specifically raster formats.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataManager.RasterWriteFilter">
- <summary>
- Gets or sets the dialog write filter to use for saving data files.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataManager.VectorReadFilter">
- <summary>
- Gets or sets the dialog read filter to use for opening data files.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataManager.VectorWriteFilter">
- <summary>
- Gets or sets the dialog write filter to use for saving data files.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataManager.ImageReadFilter">
- <summary>
- Gets or sets the dialog read filter to use for opening data files.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataManager.ImageWriteFilter">
- <summary>
- Gets or sets the dialog write filter to use for saving data files.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataManager.LoadInRam">
- <summary>
- Sets the default condition for how this data manager should try to load layers.
- This will be overridden if the inRam property is specified as a parameter.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataManager.PreferredProviders">
- <summary>
- Gets or sets a dictionary of IDataProviders with corresponding extensions. The
- standard order is to try to load the data using a PreferredProvider. If that
- fails, then it will check the list of dataProviders, and finally, if that fails,
- it will check the plugin Data Providers in directories.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataManager.ProgressHandler">
- <summary>
- Gets or sets a progress handler for any open operations that are intiated by this
- DataManager and don't override this value with an IProgressHandler specified in the parameters.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.DataManager.DirectoryProvidersLoaded">
- <summary>
- Occurs after the directory providers have been loaded into the project.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.DataProviderEventArgs">
- <summary>
- DataProviders
- </summary>
- </member>
- <member name="M:DotSpatial.Data.DataProviderEventArgs.#ctor(System.Collections.Generic.IEnumerable{DotSpatial.Data.IDataProvider})">
- <summary>
- Creates a new instance of DataProviders
- </summary>
- <param name="providers">Specifies a list of IDataProviders</param>
- </member>
- <member name="P:DotSpatial.Data.DataProviderEventArgs.Providers">
- <summary>
- Gets the list of providers for this event.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.RasterFileMode">
- <summary>
- Clarifies how the file should be used
- </summary>
- </member>
- <member name="F:DotSpatial.Data.RasterFileMode.Read">
- <summary>
- Read will attempt to read the file if it exists and throw an exception if the file is not found
- </summary>
- </member>
- <member name="F:DotSpatial.Data.RasterFileMode.Write">
- <summary>
- Write will create a new file, overwriting it if it previously exists.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.PolygonShapefileFeatureSource">
- <summary>
- This class is strictly the vector access code. This does not handle
- the attributes, which must be handled independantly.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.PolygonShapefileFeatureSource.#ctor(System.String)">
- <summary>
- Sets the fileName and creates a new PolygonshapefileFeatureSource for the specified file.
- </summary>
- <param name="fileName">The fileName to work with.</param>
- </member>
- <member name="M:DotSpatial.Data.PolygonShapefileFeatureSource.#ctor(System.String,System.Boolean,System.Boolean)">
- <summary>
- Sets the fileName and creates a new PolygonshapefileFeatureSource for the specified file (and builds spatial index if requested)
- </summary>
- <param name="fileName"></param>
- <param name="useSpatialIndexing"></param>
- <param name="trackDeletedRows"></param>
- </member>
- <member name="M:DotSpatial.Data.PolygonShapefileFeatureSource.AppendBasicGeometry(DotSpatial.Data.ShapefileHeader,DotSpatial.Topology.IBasicGeometry,System.Int32)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.PolygonShapefileFeatureSource.CreateShapeSource">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Data.PolygonShapefileFeatureSource.UpdateExtents">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Data.PolygonShapefileFeatureSource.Select(System.String,DotSpatial.Topology.IEnvelope,System.Int32@,System.Int32)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.PolygonShapefileFeatureSource.SearchAndModifyAttributes(DotSpatial.Topology.IEnvelope,System.Int32,DotSpatial.Data.FeatureSourceRowEditEvent)">
- <inheritdoc/>
- </member>
- <member name="P:DotSpatial.Data.PolygonShapefileFeatureSource.FeatureType">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Data.PolygonShapefileFeatureSource.ShapeType">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Data.PolygonShapefileFeatureSource.ShapeTypeM">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Data.PolygonShapefileFeatureSource.ShapeTypeZ">
- <inheritdocs/>
- </member>
- <member name="T:DotSpatial.Data.PolygonShapefileShapeSource">
- <summary>
- Retrieves specific shapes.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.PolygonShapefileShapeSource.#ctor(System.String)">
- <summary>
- Creates a new instance of the PolygonShapefileShapeSource with the specified polygon
- shapefile as the source.
- </summary>
- <param name="fileName">The string fileName</param>
- </member>
- <member name="M:DotSpatial.Data.PolygonShapefileShapeSource.#ctor(System.String,DotSpatial.Topology.Index.ISpatialIndex,DotSpatial.Data.ShapefileIndexFile)">
- <summary>
- Creates a new instance of the PolygonShapefileShapeSource with the specified polygon shapefile as the source and provided indices
- </summary>
- <param name="fileName"></param>
- <param name="spatialIndex"></param>
- <param name="shx"></param>
- </member>
- <member name="M:DotSpatial.Data.PolygonShapefileShapeSource.GetShapeAtIndex(System.IO.FileStream,DotSpatial.Data.ShapefileIndexFile,DotSpatial.Data.ShapefileHeader,System.Int32,DotSpatial.Topology.IEnvelope)">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Data.PolygonShapefileShapeSource.ShapeType">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Data.PolygonShapefileShapeSource.ShapeTypeM">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Data.PolygonShapefileShapeSource.ShapeTypeZ">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Data.PolygonShapefileShapeSource.FeatureType">
- <inheritdocs/>
- </member>
- <member name="T:DotSpatial.Data.ProgressMeter">
- <summary>
- This handles the methodology of progress messaging in one place to make it easier to update.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ProgressMeter.#ctor">
- <summary>
- Initializes a new progress meter, but doesn't support the IProgressHandler unless one is specified.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ProgressMeter.#ctor(DotSpatial.Data.IProgressHandler)">
- <summary>
- A progress meter can't actually do anything without a progressHandler, which actually displays the status.
- </summary>
- <param name="progressHandler">An IProgressHandler that will actually handle the status messages sent by this meter.</param>
- </member>
- <member name="M:DotSpatial.Data.ProgressMeter.#ctor(DotSpatial.Data.IProgressHandler,System.String)">
- <summary>
- A progress meter that simply keeps track of progress and is capable of sending progress messages.
- This assumes a MaxValue of 100 unless it is changed later.
- </summary>
- <param name="progressHandler">Any valid IProgressHandler that will display progress messages</param>
- <param name="baseMessage">A base message to use as the basic status for this progress handler.</param>
- </member>
- <member name="M:DotSpatial.Data.ProgressMeter.#ctor(DotSpatial.Data.IProgressHandler,System.String,System.Object)">
- <summary>
- A progress meter that simply keeps track of progress and is capable of sending progress messages.
- </summary>
- <param name="progressHandler">Any valid implementation if IProgressHandler that will handle the progress function</param>
- <param name="baseMessage">The message without any progress information.</param>
- <param name="endValue">Percent should show a range between the MinValue and MaxValue. MinValue is assumed to be 0.</param>
- </member>
- <member name="M:DotSpatial.Data.ProgressMeter.Reset">
- <summary>
- Resets the progress meter to the 0 value. This sets the status message to "Ready.".
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ProgressMeter.Next">
- <summary>
- This always increments the CurrentValue by one.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ProgressMeter.SendProgress">
- <summary>
- Sends a progress message to the IProgressHandler interface with the current message and progress
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ProgressMeter.BaseMessage">
- <summary>
- Gets or sets the string message (without the progress element).
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ProgressMeter.Key">
- <summary>
- Gets or sets the string that does not include any mention of progress percentage, but specifies what is occurring.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ProgressMeter.CurrentPercent">
- <summary>
- Gets or sets the current integer progress level from 0 to 100. If a new update is less than or equal to the previous
- value, then no progress will be displayed by the ProgressMeter. Values less than 0 are set to 0. Values greater than
- 100 are set to 100.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ProgressMeter.CurrentValue">
- <summary>
- Gets or sets the current value relative to the specified MaxValue in order to update the progress.
- Setting this will also update OldProgress if there is an integer change in the percentage, and send
- a progress message to the IProgressHandler interface.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ProgressMeter.EndValue">
- <summary>
- The value that defines when the meter should show as 100% complete.
- EndValue can be less than StartValue, but values closer to EndValue
- will show as being closer to 100%.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ProgressMeter.Silent">
- <summary>
- Gets or sets whether the progress meter should send messages to the IProgressHandler.
- By default Silent is false, but setting this to true will disable the messaging portion.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ProgressMeter.StartValue">
- <summary>
- The minimum value defines when the meter should show as 0% complete.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ProgressMeter.StepPercent">
- <summary>
- An integer value that is 1 by default. Ordinarily this will send a progress message only when the integer progress
- has changed by 1 percentage point. For example, if StepPercent were set to 5, then a progress update would only
- be sent out at 5%, 10% and so on. This helps reduce overhead in cases where showing status messages is actually
- the majority of the processing time for the function.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ProgressMeter.PreviousPercent">
- <summary>
- Gets or sets the previous integer progress level from 0 to 100. If a new update is less than or equal to the previous
- value, then no progress will be displayed by the ProgressMeter. Values less than 0 are set to 0. Values greater than
- 100 are set to 100.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ProgressMeter.ProgressHandler">
- <summary>
- Gets or sets the progress handler for this meter
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.ProjExt">
- <summary>
- Extension methods for the IProj interface
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ProjExt.PixelToProj(DotSpatial.Data.IProj,System.Drawing.Point)">
- <summary>
- Converts a single point location into an equivalent geographic coordinate
- </summary>
- <param name="self">This IProj</param>
- <param name="position">The client coordinate relative to the map control</param>
- <returns>The geographic ICoordinate interface</returns>
- </member>
- <member name="M:DotSpatial.Symbology.ProjExt.PixelToProj(DotSpatial.Data.IProj,System.Drawing.Rectangle)">
- <summary>
- Converts a rectangle in pixel coordinates relative to the map control into
- a geographic envelope.
- </summary>
- <param name="self">This IProj</param>
- <param name="rect">The rectangle to convert</param>
- <returns>An IEnvelope interface</returns>
- </member>
- <member name="M:DotSpatial.Symbology.ProjExt.PixelToProj(DotSpatial.Data.IProj,System.Collections.Generic.List{System.Drawing.Rectangle})">
- <summary>
- Projects all of the rectangles int the specified list of rectangles into geographic regions.
- </summary>
- <param name="self">This IProj</param>
- <param name="clipRects">The clip rectangles</param>
- <returns>A List of IEnvelope geographic bounds that correspond to the specified clip rectangles.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.ProjExt.ProjToPixel(DotSpatial.Data.IProj,DotSpatial.Topology.Coordinate)">
- <summary>
- Converts a single geographic location into the equivalent point on the
- screen relative to the top left corner of the map.
- </summary>
- <param name="self">This IProj</param>
- <param name="location">The geographic position to transform</param>
- <returns>A Point with the new location.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.ProjExt.ProjToPixel(DotSpatial.Data.IProj,DotSpatial.Data.Extent)">
- <summary>
- Converts a single geographic envelope into an equivalent Rectangle
- as it would be drawn on the screen.
- </summary>
- <param name="self">This IProj</param>
- <param name="env">The geographic IEnvelope</param>
- <returns>A Rectangle</returns>
- </member>
- <member name="M:DotSpatial.Symbology.ProjExt.ProjToPixel(DotSpatial.Data.IProj,System.Collections.Generic.List{DotSpatial.Data.Extent})">
- <summary>
- Translates all of the geographic regions, forming an equivalent list of rectangles.
- </summary>
- <param name="self">This IProj</param>
- <param name="regions">The list of geographic regions to project</param>
- <returns>A list of pixel rectangles that describe the specified region</returns>
- </member>
- <member name="M:DotSpatial.Symbology.ProjExt.ProjToPixel(DotSpatial.Data.IProj,System.Double)">
- <summary>
- Calculates an integer length distance in pixels that corresponds to the double
- length specified in the image.
- </summary>
- <param name="self">The IProj that this describes</param>
- <param name="distance">The double distance to obtain in pixels</param>
- <returns>The integer distance in pixels</returns>
- </member>
- <member name="T:DotSpatial.Data.RasterBoundDataSet">
- <summary>
- This is an abstract base class that represents a datasets that has a RasterBounds on it, and reprojects
- by using the RasterBounds. This works for Image and Raster implementations.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.DataSet">
- <summary>
- DataSet
- </summary>
- </member>
- <member name="M:DotSpatial.Data.DataSet.ProjectionSupported">
- <summary>
- Gets whether or not projection is based on having the libraries available.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.DataSet.#ctor">
- <summary>
- Creates a new instance of DataSet
- </summary>
- </member>
- <member name="M:DotSpatial.Data.DataSet.Close">
- <summary>
- This can be overridden in specific classes if necessary
- </summary>
- </member>
- <member name="M:DotSpatial.Data.DataSet.Reproject(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Reprojects all of the in-ram vertices of featuresets, or else this
- simply updates the "Bounds" of the image object.
- This will also update the projection to be the specified projection.
- </summary>
- <param name="targetProjection">
- The projection information to reproject the coordinates to.
- </param>
- </member>
- <member name="M:DotSpatial.Data.DataSet.Dispose(System.Boolean)">
- <summary>
- Allows overriding the dispose behavior to handle any resources in addition to what are handled in the
- image data class.
- </summary>
- <param name="disposeManagedResources">A Boolean value that indicates whether the overriding method
- should dispose managed resources, or just the unmanaged ones.</param>
- </member>
- <member name="P:DotSpatial.Data.DataSet.MyExtent">
- <summary>
- Gets or sets the cached extent variable. The public Extent is the virtual accessor,
- and should not be used from a constructor. MyExtent is protected, not virtual,
- and is only visible to inheriting classes, and can be safely set in the constructor.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataSet.ProgressMeter">
- <summary>
- This is an internal place holder to make it easier to pass around a single progress meter
- between methods. This will use lazy instantiation if it is requested before one has
- been created.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataSet.ProjectionString">
- <summary>
- Gets or sets the raw projection string for this dataset. This handles both the
- case where projection is unavailable but a projection string needs to
- be passed around, and the case when a string is not recognized by the
- DotSpatial.Projections library. This is not format restricted, but should match
- the original data source as closely as possible. Setting this will also set
- the Projection if the Projection library is available and the format successfully
- defines a transform by either treating it as an Esri string or a proj4 string.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataSet.CanReproject">
- <summary>
- Gets a value indicating whether the DotSpatial.Projections assembly is loaded
- </summary>
- <returns>Boolean, true if the value can reproject.</returns>
- </member>
- <member name="P:DotSpatial.Data.DataSet.Name">
- <summary>
- Gets or sets the string name
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataSet.Extent">
- <summary>
- Gets or sets the extent for the dataset. Usages to Envelope were replaced
- as they required an explicit using to DotSpatial.Topology which is not
- as intuitive. Extent.ToEnvelope() and new Extent(myEnvelope) convert them.
- This is designed to be a virtual member to be overridden by subclasses,
- and should not be called directly by the constructor of inheriting classes.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataSet.Projection">
- <summary>
- Gets or set the projection string
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataSet.SpaceTimeSupport">
- <summary>
- Gets an enumeration specifying if this data supports time, space, both or neither.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataSet.TypeName">
- <summary>
- Gets or sets the string type name that identifies this dataset
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataSet.ProgressHandler">
- <summary>
- Gets or sets the progress handler to use for internal actions taken by this dataset.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.RasterBoundDataSet.#ctor">
- <summary>
- Creates a new instance of the RasterBoundData object, setting up a default RasterBounds.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.RasterBoundDataSet.OnBoundsChanged(DotSpatial.Data.IRasterBounds)">
- <summary>
- Occurs when the raster bounds of this data class have changed.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.RasterBoundDataSet.Reproject(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- RasterBounds datasets offer a limited sort of reproject on the fly.
- This tries to update the bounds by reprojecting the top left and bottom
- left and top right coordinates and updating the "affine" transform.
- This should not be used if CanReproject is false.
- Greater accuracy can be accomplished using the Projective transform,
- which is planned to be implemented as a toolbox function.
- </summary>
- <param name="targetProjection">The projectionInfo to project to.</param>
- </member>
- <member name="M:DotSpatial.Data.RasterBoundDataSet.Dispose(System.Boolean)">
- <summary>
- Disposes the managed memory objects in the ImageData class, and then forwards
- the Dispose operation to the internal dataset in the base class, if any.
- </summary>
- <param name="disposeManagedResources">Boolean, true if both managed and unmanaged resources should be finalized.</param>
- </member>
- <member name="P:DotSpatial.Data.RasterBoundDataSet.Bounds">
- <summary>
- Gets or sets the image bounds being used to define the georeferencing of the image
- </summary>
- </member>
- <member name="P:DotSpatial.Data.RasterBoundDataSet.Extent">
- <summary>
- Gets or sets the Bounds.Envelope through an Extents property.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.RasterEventArgs">
- <summary>
- An EventArgs specifically tailored to Raster.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.RasterEventArgs.#ctor(DotSpatial.Data.IRaster)">
- <summary>
- Initializes a new instance of the RasterEventArgs class.
- </summary>
- <param name="raster">The IRaster that is involved in this event.</param>
- </member>
- <member name="P:DotSpatial.Data.RasterEventArgs.Raster">
- <summary>
- Gets the Raster associated with this event.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.RowEditEvent">
- <summary>
- Callback specified to AttributeTable.Edit() overload
- </summary>
- <param name="e"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Data.RowEditEventArgs">
- <summary>
- RowEditEvent arguments
- </summary>
- </member>
- <member name="F:DotSpatial.Data.RowEditEventArgs.Columns">
- <summary>
- Column information
- </summary>
- </member>
- <member name="F:DotSpatial.Data.RowEditEventArgs.ByteContent">
- <summary>
- Actual byte content read from dbase
- </summary>
- </member>
- <member name="F:DotSpatial.Data.RowEditEventArgs.Modified">
- <summary>
- One of the SetColumn methods or SetAllColumns has been called
- </summary>
- </member>
- <member name="F:DotSpatial.Data.RowEditEventArgs.RowNumber">
- <summary>
- The row being edited
- </summary>
- </member>
- <member name="M:DotSpatial.Data.RowEditEventArgs.#ctor(System.Int32,DotSpatial.Data.Fields)">
- <summary>
- Constructor
- </summary>
- <param name="recordLength"></param>
- <param name="columns"></param>
- </member>
- <member name="M:DotSpatial.Data.RowEditEventArgs.GetChars">
- <summary>
- Get the entire buffer as a character array
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.RowEditEventArgs.ParseColumn(DotSpatial.Data.Field)">
- <summary>
- Convert the byte data for a column into the appropriate data value
- </summary>
- <param name="field">Column information for data value being parsed</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.RowEditEventArgs.ParseAllColumns">
- <summary>
- Convert the all byte data into an array of data values
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.RowEditEventArgs.SetColumn(DotSpatial.Data.Field,System.Double)">
- <summary>
- Convert value to bytes and place in ByteContent at correct location
- </summary>
- <param name="field">Column information for the conversion</param>
- <param name="value"></param>
- </member>
- <member name="M:DotSpatial.Data.RowEditEventArgs.SetColumn(DotSpatial.Data.Field,System.String)">
- <summary>
- Convert value to bytes and place in ByteContent at correct location
- </summary>
- <param name="field">Column information for the conversion</param>
- <param name="value"></param>
- </member>
- <member name="M:DotSpatial.Data.RowEditEventArgs.SetColumn(DotSpatial.Data.Field,System.Single)">
- <summary>
- Convert value to bytes and place in ByteContent at correct location
- </summary>
- <param name="field">Column information for the conversion</param>
- <param name="value"></param>
- </member>
- <member name="M:DotSpatial.Data.RowEditEventArgs.SetColumn(DotSpatial.Data.Field,System.DBNull)">
- <summary>
- Convert value to bytes and place in ByteContent at correct location
- </summary>
- <param name="field">Column information for the conversion</param>
- <param name="dbNull"></param>
- </member>
- <member name="M:DotSpatial.Data.RowEditEventArgs.SetColumn(DotSpatial.Data.Field,System.Decimal)">
- <summary>
- Convert value to bytes and place in ByteContent at correct location
- </summary>
- <param name="field">Column information for the conversion</param>
- <param name="value"></param>
- </member>
- <member name="M:DotSpatial.Data.RowEditEventArgs.SetColumn(DotSpatial.Data.Field,System.Int64)">
- <summary>
- Convert value to bytes and place in ByteContent at correct location
- </summary>
- <param name="field">Column information for the conversion</param>
- <param name="value"></param>
- </member>
- <member name="M:DotSpatial.Data.RowEditEventArgs.SetColumn(DotSpatial.Data.Field,System.Boolean)">
- <summary>
- Convert value to bytes and place in ByteContent at correct location
- </summary>
- <param name="field">Column information for the conversion</param>
- <param name="value"></param>
- </member>
- <member name="M:DotSpatial.Data.RowEditEventArgs.SetColumn(DotSpatial.Data.Field,System.DateTime)">
- <summary>
- Convert value to bytes and place in ByteContent at correct location
- </summary>
- <param name="field">Column information for the conversion</param>
- <param name="value"></param>
- </member>
- <member name="M:DotSpatial.Data.RowEditEventArgs.SetAllColumns(System.Object[])">
- <summary>
- Convert array of values to bytes and fill ByteContent
- </summary>
- <param name="values"></param>
- </member>
- <member name="T:DotSpatial.Data.ShapeFactory">
- <summary>
- ShapeFactory
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ShapeFactory.#ctor">
- <summary>
- for singleton pattern.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ShapeFactory.CreateMultiPolygonFromCoordinates(System.Collections.Generic.IEnumerable{System.Collections.Generic.IEnumerable{DotSpatial.Topology.Coordinate}})">
- <summary>
- Creates a new multi-part polygon shape. Winding order should control holes.
- </summary>
- <param name="allParts">The list of all the lists of coordinates.</param>
- <returns>A new Multi-Polygon Shape.</returns>
- </member>
- <member name="P:DotSpatial.Data.ShapeFactory.Instance">
- <summary>
- Gets the shared instance of the shape factory;
- </summary>
- </member>
- <member name="T:DotSpatial.Data.ShapefileFeatureSourceQuadtree">
- <summary>
- Spatial index customized for ShapefileFeatureSources.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ShapefileFeatureSourceQuadtree.Insert(DotSpatial.Topology.IEnvelope,System.Int32)">
- <summary>
- Insert the row
- </summary>
- <param name="itemEnv"></param>
- <param name="item"></param>
- </member>
- <member name="M:DotSpatial.Data.ShapefileFeatureSourceQuadtree.Remove(DotSpatial.Topology.IEnvelope,System.Int32)">
- <summary>
- Remove the row
- </summary>
- <param name="itemEnv"></param>
- <param name="item"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.ShapefileFeatureSourceQuadtree.AdjustNodesForDeletedItem(DotSpatial.Topology.Index.Quadtree.NodeBase,System.Int32)">
- <summary>
- When a row is deleted, all other row numbers must be adjusted to compensate for the fact that the shx file gets compressed.
- </summary>
- <param name="node"></param>
- <param name="deletedItem"></param>
- </member>
- <member name="M:DotSpatial.Data.ShapefileFeatureSourceQuadtree.Remove(DotSpatial.Topology.IEnvelope,System.Object)">
- <summary>
- Deprecated. Use Remove(IEnvelope, int item) instead.
- </summary>
- <param name="itemEnv"></param>
- <param name="item"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.ShapefileFeatureSourceQuadtree.Insert(DotSpatial.Topology.IEnvelope,System.Object)">
- <summary>
- Deprecated. Use Insert(IEnvelope, int item) instead.
- </summary>
- <param name="itemEnv"></param>
- <param name="item"></param>
- </member>
- <member name="T:DotSpatial.Data.ShapefileIndexFile">
- <summary>
- Index file class for the .shx file
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ShapefileIndexFile.Open(System.String)">
- <summary>
- Opens the index file of the specified fileName. If the fileName is not the .shx extension,
- then the fileName will be changed too that extension first.
- </summary>
- <param name="fileName"></param>
- </member>
- <member name="M:DotSpatial.Data.ShapefileIndexFile.Save">
- <summary>
- Saves the file back to the original file, or the currently specified "Filename" property.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ShapefileIndexFile.SaveAs(System.String)">
- <summary>
- Saves the file to the specified fileName. If the extension is not a correct shx extension,
- it will be changed to that extensions.
- </summary>
- <param name="fileName"></param>
- </member>
- <member name="M:DotSpatial.Data.ShapefileIndexFile.ReadIndexFile(System.String)">
- <summary>
- Reads the entire index file in order to get a breakdown of how shapes are broken up.
- </summary>
- <param name="fileName">A string fileName of the .shx file to read.</param>
- <returns>A List of ShapeHeaders that give offsets and lengths so that reading can be optimized</returns>
- </member>
- <member name="M:DotSpatial.Data.ShapefileIndexFile.WriteHeader(DotSpatial.Data.ShapefileHeader,System.String,System.Int32)">
- <summary>
- Writes the current content to the specified file.
- </summary>
- <param name="header">The header to write</param>
- <param name="fileName">Basically the same code can be used for the shp and shx files</param>
- <param name="numShapes">The integer number of shapes to write to the file</param>
- </member>
- <member name="P:DotSpatial.Data.ShapefileIndexFile.Header">
- <summary>
- Gets or sets the header
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapefileIndexFile.Filename">
- <summary>
- Gets or sets the fileName
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapefileIndexFile.Shapes">
- <summary>
- Gets or sets the list of shape headers
- </summary>
- </member>
- <member name="T:DotSpatial.Data.ShapefileReader">
- <summary>
- This combines the attribute table with a shape source in order to allow easy creation of
- FeatureTable and FeatureRow constructs.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ShapefileReader.#ctor(System.String)">
- <summary>
- Creates a new ShapefileReader tailored to read a particular file.
- </summary>
- <param name="filename"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.ShapefileReader.Close">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ShapefileReader.GetSchemaTable">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.ShapefileReader.NextResult">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.ShapefileReader.Read">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.ShapefileReader.Dispose">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.ShapefileReader.GetBoolean(System.Int32)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.ShapefileReader.GetByte(System.Int32)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.ShapefileReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.ShapefileReader.GetChar(System.Int32)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.ShapefileReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.ShapefileReader.GetData(System.Int32)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.ShapefileReader.GetDataTypeName(System.Int32)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.ShapefileReader.GetDateTime(System.Int32)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.ShapefileReader.GetDecimal(System.Int32)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.ShapefileReader.GetDouble(System.Int32)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.ShapefileReader.GetFieldType(System.Int32)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.ShapefileReader.GetFloat(System.Int32)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.ShapefileReader.GetGuid(System.Int32)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.ShapefileReader.GetInt16(System.Int32)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.ShapefileReader.GetInt32(System.Int32)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.ShapefileReader.GetInt64(System.Int32)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.ShapefileReader.GetName(System.Int32)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.ShapefileReader.GetOrdinal(System.String)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.ShapefileReader.GetString(System.Int32)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.ShapefileReader.GetValue(System.Int32)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.ShapefileReader.GetValues(System.Object[])">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.ShapefileReader.IsDBNull(System.Int32)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.ShapefileReader.AdvancePage">
- <summary>
- Resets the count, so that reading may continue.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ShapefileReader.Open">
- <summary>
- Ensures that the files can be opened for reading.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapefileReader.Filename">
- <summary>
- Gets or sets the name of the shapefile.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapefileReader.Fields">
- <summary>
- Gets or sets the array of string field names to access. If this is null or empty, then all the fields are returned.
- Fields listed here that do not occur in the shapefile will be ignored.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapefileReader.FilterExpression">
- <summary>
- Gets or sets the string filter expression. This is only the "Where" criteria, and doesn't include any other advanced SQL implmenetation.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapefileReader.OrderBy">
- <summary>
- Gets or sets a string fieldname to support sorting.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapefileReader.PageSize">
- <summary>
- Gets the integer number of the maximum number of results to generate from a shapefile.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapefileReader.Count">
- <summary>
- Gets the count of members returned so far.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapefileReader.Offset">
- <summary>
- Gets the long row offset where reading should begin. This will advance
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapefileReader.Depth">
- <summary>
- Shapefiles don't support nested tables.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapefileReader.IsClosed">
- <inheritdoc/>
- </member>
- <member name="P:DotSpatial.Data.ShapefileReader.RecordsAffected">
- <summary>
- Read only reader has no affect on records here.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapefileReader.FieldCount">
- <inheritdoc/>
- </member>
- <member name="P:DotSpatial.Data.ShapefileReader.Item(System.String)">
- <inheritdoc/>
- </member>
- <member name="P:DotSpatial.Data.ShapefileReader.Item(System.Int32)">
- <inheritdoc/>
- </member>
- <member name="T:DotSpatial.Data.ShapeReader">
- <summary>
- A class for cycling pages of shapes from a large dataset
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ShapeReader.#ctor(DotSpatial.Data.IShapeSource)">
- <summary>
- Creates a new reader class for paging through a shape source.
- </summary>
- <param name="source">The IShapeSource to cycle through.</param>
- </member>
- <member name="M:DotSpatial.Data.ShapeReader.GetEnumerator">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Data.ShapeReader.PageSize">
- <summary>
- Gets or sets the integer count of shapes that should be allowed to appear on a single page of results.
- This is the maximum, and the actual number of shapes may be considerably smaller than this.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapeReader.Envelope">
- <summary>
- Gets or sets the envelope. If this is null, then no envelope is used.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapeReader.FeatureType">
- <summary>
- Gets the feature type of the feature source.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.ShapeReader.Enumerator">
- <summary>
- Creates an enumerator for pages of shapes returned as dictionaries.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ShapeReader.Enumerator.#ctor(DotSpatial.Data.ShapeReader)">
- <summary>
- Creates ShapePageSet.Enumerator which can be used to cycle very large datasets.
- </summary>
- <param name="parent"></param>
- </member>
- <member name="M:DotSpatial.Data.ShapeReader.Enumerator.Dispose">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Data.ShapeReader.Enumerator.MoveNext">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Data.ShapeReader.Enumerator.Reset">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Data.ShapeReader.Enumerator.Current">
- <inheritdocs/>
- </member>
- <member name="T:DotSpatial.Data.ShapeRelateType">
- <summary>
- Controls whether only intersecting shapes should be used or whether all shapes should be used.
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ShapeRelateType.All">
- <summary>
- All shapes will be used
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ShapeRelateType.Intersecting">
- <summary>
- Only intersecting shapes will be used
- </summary>
- </member>
- <member name="T:DotSpatial.Data.CulturePreferences">
- <summary>
- CulturePreferences
- </summary>
- </member>
- <member name="F:DotSpatial.Data.CulturePreferences.CultureInformation">
- <summary>
- This culture information is useful for things like Number Formatting.
- This defaults to CurrentCulture, but can be specified through preferences or
- whatever.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.BufferedBinaryReader">
- <summary>
- The buffered binary reader was originally designed by Ted Dunsford to make shapefile reading more
- efficient, but ostensibly could be used for other binary reading exercises. To use this class,
- simply specify the BufferSize in bytes that you would like to use and begin reading values.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.BufferedBinaryReader.#ctor(System.String)">
- <summary>
- Creates a new instance of BufferedBinaryReader.
- </summary>
- <param name="fileName">The string path of a file to open using this BufferedBinaryReader.</param>
- </member>
- <member name="M:DotSpatial.Data.BufferedBinaryReader.#ctor(System.String,DotSpatial.Data.IProgressHandler)">
- <summary>
- Creates a new instance of BufferedBinaryReader, and specifies where to send progress messages.
- </summary>
- <param name="fileName">The string path of a file to open using this BufferedBinaryReader.</param>
- <param name="progressHandler">Any implementation of IProgressHandler for receiving progress messages.</param>
- </member>
- <member name="M:DotSpatial.Data.BufferedBinaryReader.Close">
- <summary>
- Closes the internal binary reader and underlying file, but does not free
- the buffer that is in memory. For that, call the dispose method.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.BufferedBinaryReader.Dispose">
- <summary>
- This will not close the file, so be sure to close before calling Dispose.
- This will dispose the file stream and set the buffer to null.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.BufferedBinaryReader.FillBuffer">
- <summary>
- Instructs the reader to fill its buffer with data. This only does something
- if the buffer is not loaded yet. This method is optional since the first
- effort at reading the file will automatically load the buffer.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.BufferedBinaryReader.FillBuffer(System.Int32)">
- <summary>
- This method will both assign a new maximum buffer size to the reader and
- force the reader to load the values into memory. This is unnecessary
- unless you plan on closing the file before reading values from this class.
- Even if values are loaded, this will assign the MaxBufferSize property
- so that future buffers have the specified size.
- </summary>
- <param name="maxBufferSize">An integer buffer size to assign to the maximum buffer size before reading values.</param>
- </member>
- <member name="M:DotSpatial.Data.BufferedBinaryReader.Seek(System.Int64,System.IO.SeekOrigin)">
- <summary>
- Uses the seek method to quickly reach a desired location to begin reading.
- This will not buffer or read values. If the new position is beyond the end
- of the current buffer, the next read will load a new buffer.
- </summary>
- <param name="offset">A 64 bit integer specifying where to skip to in the file.</param>
- <param name="origin">A System.IO.SeekOrigin enumeration specifying how to estimate the location.</param>
- </member>
- <member name="M:DotSpatial.Data.BufferedBinaryReader.ReadBool">
- <summary>
- Reads a boolean form the buffer, automatcially loading the next buffer if necessary.
- </summary>
- <returns>A boolean value converted from bytes in the file.</returns>
- </member>
- <member name="M:DotSpatial.Data.BufferedBinaryReader.ReadChar">
- <summary>
- Reads a character from two bytes in the buffer, automatically loading the next buffer if necessary.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.BufferedBinaryReader.ReadChars(System.Int32)">
- <summary>
- Reads an array of character from two bytes in the buffer, automatically loading
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.BufferedBinaryReader.ReadDouble(System.Boolean)">
- <summary>
- Reads a double-precision floating point from 8 bytes in the buffer, automatically loading the next buffer if necessary.
- </summary>
- <param name="isLittleEndian">Boolean, true if the value should be returned with little endian byte ordering.</param>
- <returns>A double value converted from bytes in the file.</returns>
- </member>
- <member name="M:DotSpatial.Data.BufferedBinaryReader.ReadVertices(System.Int32)">
- <summary>
- Reads double precision X and Y values that are interwoven
- </summary>
- <param name="count"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.BufferedBinaryReader.ReadDoubles(System.Int32)">
- <summary>
- Reads the specified number of doubles into an array
- This uses Buffer.CopyBlock, and seems to work ok
- for little-endian in windows.
- </summary>
- <param name="count">The count of doubles</param>
- <returns>An array of doubles</returns>
- </member>
- <member name="M:DotSpatial.Data.BufferedBinaryReader.ReadIntegers(System.Int32)">
- <summary>
- Reads the specified number of integers into an array
- </summary>
- <param name="count">The integer count of integers to read</param>
- <returns>An array of the specified integers and length equal to count</returns>
- </member>
- <member name="M:DotSpatial.Data.BufferedBinaryReader.ReadInt32">
- <summary>
- By default, this will use little Endian ordering.
- </summary>
- <returns>An Int32 converted from the file.</returns>
- </member>
- <member name="M:DotSpatial.Data.BufferedBinaryReader.ReadInt32(System.Boolean)">
- <summary>
- Reads an integer from the file, using the isLittleEndian argument
- to decide whether to flip the bits or not.
- </summary>
- <param name="isLittleEndian">Boolean, true if the value should be returned with little endian byte ordering.</param>
- <returns>an Int32 value converted from bytes in the file.</returns>
- </member>
- <member name="M:DotSpatial.Data.BufferedBinaryReader.ReadInt16">
- <summary>
- Reads a short, sixteen bit integer as bytes in little-endian order
- </summary>
- <returns>A short value</returns>
- </member>
- <member name="M:DotSpatial.Data.BufferedBinaryReader.ReadSingle">
- <summary>
- Reads a single-precision floading point from 4 bytes in the buffer, automatically loading the next buffer if necessary.
- This assumes the value should be little endian.
- </summary>
- <returns>A single-precision floating point converted from four bytes</returns>
- </member>
- <member name="M:DotSpatial.Data.BufferedBinaryReader.ReadSingle(System.Boolean)">
- <summary>
- Reads a single-precision floading point from 4 bytes in the buffer, automatically loading the next buffer if necessary.
- </summary>
- <param name="isLittleEndian">Boolean, true if the value should be returned with little endian byte ordering.</param>
- <returns>A single-precision floating point converted from four bytes</returns>
- </member>
- <member name="M:DotSpatial.Data.BufferedBinaryReader.ReadBytes(System.Int32)">
- <summary>
- Reads the specified number of bytes. This will throw an exception
- if a number of bytes is specified that exeeds the file length.
- </summary>
- <param name="byteCount">The integer count of the bytes.</param>
- <returns>An array of bytes</returns>
- </member>
- <member name="M:DotSpatial.Data.BufferedBinaryReader.Read(System.Byte[],System.Int32,System.Int32)">
- <summary>
- copies count bytes from the internal buffer to the specified buffer index as the starting point in the specified buffer.
- </summary>
- <param name="buffer">A previously dimensioned array of byte values to fill with data</param>
- <param name="index">The index in the argument array to start pasting values to</param>
- <param name="count">The number of values to copy into the parameter buffer</param>
- </member>
- <member name="M:DotSpatial.Data.BufferedBinaryReader.OnFinishedReading">
- <summary>
- Fires the FinishedReading event.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.BufferedBinaryReader.OnFinishedBuffering">
- <summary>
- Fires the FinishedBuffering event.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.BufferedBinaryReader.ProgressMeter">
- <summary>
- Gets the progress meter.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.BufferedBinaryReader.BufferOffset">
- <summary>
- Gets a long integer specifying the starting position of the currently loaded buffer
- relative to the start of the file. A value of -1 indicates that no buffer is
- currently loaded.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.BufferedBinaryReader.BufferSize">
- <summary>
- Gets an integer value specifying the size of the buffer currently loaded into memory.
- This will either be the MaxBufferSize, or a smaller buffer representing a smaller
- remainder existing in the file.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.BufferedBinaryReader.IsBufferLoaded">
- <summary>
- Gets a boolean indicating whether there is currently any information loaded into the buffer.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.BufferedBinaryReader.IsFinishedReading">
- <summary>
- Gets a boolean value once the offset has reached the end of the file,
- and every byte value has been read from the file.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.BufferedBinaryReader.IsFinishedBuffering">
- <summary>
- Gets a boolean value once the entire file has been loaded into memory.
- This usually will occur before any reading even takes place.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.BufferedBinaryReader.FileLength">
- <summary>
- Gets the length in bytes of the file being read.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.BufferedBinaryReader.FileOffset">
- <summary>
- Gets the current read position in the file in bytes.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.BufferedBinaryReader.FileRemainder">
- <summary>
- Gets a long value specifying how many bytes have not yet been read in the file.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.BufferedBinaryReader.MaxBufferSize">
- <summary>
- Gets or sets the buffer size to read in chunks. This does not
- describe the size of the actual
- </summary>
- </member>
- <member name="P:DotSpatial.Data.BufferedBinaryReader.ProgressBaseMessage">
- <summary>
- Gets or sets the progress message that has no percentage as part of it.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.BufferedBinaryReader.ReadOffset">
- <summary>
- This acts like a placeholder on the buffer and indicates where reading will begin (relative to the start of the buffer)
- </summary>
- </member>
- <member name="E:DotSpatial.Data.BufferedBinaryReader.FinishedReading">
- <summary>
- Occurs when this reader has read every byte from the file.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.BufferedBinaryReader.FinishedBuffering">
- <summary>
- Occurs when the end of the last portion of the file has been
- loaded into the file and the file has been closed.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.BufferedBinaryWriter">
- <summary>
- The buffered binary reader was originally designed by Ted Dunsford to make shapefile reading more
- efficient, but ostensibly could be used for other binary reading exercises. To use this class,
- simply specify the BufferSize in bytes that you would like to use and begin reading values.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.BufferedBinaryWriter.#ctor(System.String)">
- <summary>
- Creates a new instance of BufferedBinaryReader.
- </summary>
- <param name="fileName">The string path of a file to open using this BufferedBinaryReader.</param>
- </member>
- <member name="M:DotSpatial.Data.BufferedBinaryWriter.#ctor(System.String,DotSpatial.Data.IProgressHandler,System.Int64)">
- <summary>
- Creates a new instance of BufferedBinaryWriter, and specifies where to send progress messages.
- </summary>
- <param name="fileName">The string path of a file to open using this BufferedBinaryReader.</param>
- <param name="progressHandler">Any implementation of IProgressHandler for receiving progress messages.</param>
- <param name="expectedByteCount">A long specifying the number of bytes that will be written for the purposes of tracking progress</param>
- </member>
- <member name="M:DotSpatial.Data.BufferedBinaryWriter.Close">
- <summary>
- Finishes writing whatever is in memory to the file, closes the
- internal binary writer, the underlying file, clears the memory
- and disposes the filestream.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.BufferedBinaryWriter.PasteBuffer">
- <summary>
- Forces the buffer to paste all its existing values into the file, but does not
- advance the buffer, or in fact do anything to the buffer. It does advance
- the position of the file index.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.BufferedBinaryWriter.Seek(System.Int64,System.IO.SeekOrigin)">
- <summary>
- This seeks both in the file AND in the buffer. This is used to write only
- desired portions of a buffer that is in memory to a file.
- </summary>
- <param name="offset">A 64 bit integer specifying where to skip to in the file.</param>
- <param name="origin">A System.IO.SeekOrigin enumeration specifying how to estimate the location.</param>
- </member>
- <member name="M:DotSpatial.Data.BufferedBinaryWriter.Write(System.Boolean)">
- <summary>
- Reads a boolean form the buffer, automatcially loading the next buffer if necessary.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.BufferedBinaryWriter.Write(System.Char)">
- <summary>
- Reads a character from two bytes in the buffer, automatically loading the next buffer if necessary.
- </summary>
- <param name="value">A character to write to the buffer, and eventually the file</param>
- </member>
- <member name="M:DotSpatial.Data.BufferedBinaryWriter.Write(System.Char[])">
- <summary>
- Reads an array of character from two bytes in the buffer, automatically loading
- </summary>
- </member>
- <member name="M:DotSpatial.Data.BufferedBinaryWriter.Write(System.Double)">
- <summary>
- Reads a double from the buffer, automatically loading the next buffer if necessary.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.BufferedBinaryWriter.Write(System.Double,System.Boolean)">
- <summary>
- Writes a double-precision floating point to 8 bytes in the buffer, automatically loading the next buffer if necessary.
- </summary>
- <param name="value">A double-precision floating point decimal value to write as 8 bytes.</param>
- <param name="isLittleEndian">Boolean, true if the value should be returned with little endian byte ordering.</param>
- </member>
- <member name="M:DotSpatial.Data.BufferedBinaryWriter.Write(System.Double[])">
- <summary>
- Writes the specified array of doubles to the file.
- </summary>
- <param name="values">The values to write.</param>
- </member>
- <member name="M:DotSpatial.Data.BufferedBinaryWriter.Write(System.Int32[])">
- <summary>
- Writes the specified array of integers to the file.
- </summary>
- <param name="values">The values to write.</param>
- </member>
- <member name="M:DotSpatial.Data.BufferedBinaryWriter.Write(System.Int32)">
- <summary>
- By default, this will use little Endian ordering.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.BufferedBinaryWriter.Write(System.Int32,System.Boolean)">
- <summary>
- Reads an integer from the file, using the isLittleEndian argument
- to decide whether to flip the bits or not.
- </summary>
- <param name="value">A 32-bit integer to write as 4 bytes in the buffer.</param>
- <param name="isLittleEndian">Boolean, true if the value should be returned with little endian byte ordering.</param>
- </member>
- <member name="M:DotSpatial.Data.BufferedBinaryWriter.Write(System.Int16)">
- <summary>
- Writes an Int16 to the buffer.
- </summary>
- <param name="value">An Int16 to convert into 2 bytes to write to the buffer.</param>
- </member>
- <member name="M:DotSpatial.Data.BufferedBinaryWriter.Write(System.Single)">
- <summary>
- Writes a single-precision floading point to 4 bytes in the buffer, automatically loading the next buffer if necessary.
- This assumes the value should be little endian.
- </summary>
- <param name="value">A Single to convert to 4 bytes to write to the buffer.</param>
- </member>
- <member name="M:DotSpatial.Data.BufferedBinaryWriter.Write(System.Single,System.Boolean)">
- <summary>
- Reads a single-precision floading point from 4 bytes in the buffer, automatically loading the next buffer if necessary.
- </summary>
- <param name="value">A single-precision floating point converted from four bytes</param>
- <param name="isLittleEndian">Boolean, true if the value should be returned with little endian byte ordering.</param>
- </member>
- <member name="M:DotSpatial.Data.BufferedBinaryWriter.Write(System.Byte[])">
- <summary>
- Writes the specified bytes to the buffer, advancing the buffer automatically if necessary.
- </summary>
- <param name="value">An array of byte values to write to the buffer.</param>
- </member>
- <member name="P:DotSpatial.Data.BufferedBinaryWriter.Buffer">
- <summary>
- Gets or sets the actual array of bytes currently in the buffer
- </summary>
- </member>
- <member name="P:DotSpatial.Data.BufferedBinaryWriter.BufferOffset">
- <summary>
- Gets a long integer specifying the starting position of the currently loaded buffer
- relative to the start of the file. A value of -1 indicates that no buffer is
- currently loaded.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.BufferedBinaryWriter.BufferSize">
- <summary>
- Gets an integer value specifying the size of the buffer currently loaded into memory.
- This will either be the MaxBufferSize, or a smaller buffer representing a smaller
- remainder existing in the file.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.BufferedBinaryWriter.IsBufferLoaded">
- <summary>
- Gets a boolean indicating whether there is currently any information loaded into the buffer.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.BufferedBinaryWriter.FileOffset">
- <summary>
- Gets the current read position in the file in bytes.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.BufferedBinaryWriter.MaxBufferSize">
- <summary>
- Gets or sets the buffer size to read in chunks. This does not
- describe the size of the actual
- </summary>
- </member>
- <member name="P:DotSpatial.Data.BufferedBinaryWriter.ProgressMeter">
- <summary>
- Gets or sets the progress meter that is directly linked to the progress handler.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.BufferedBinaryWriter.ProgressHandler">
- <summary>
- Gets or sets the progress handler for this binary writer
- </summary>
- </member>
- <member name="P:DotSpatial.Data.BufferedBinaryWriter.WriteOffset">
- <summary>
- This acts like a placeholder on the buffer and indicates where reading will begin (relative to the start of the buffer)
- </summary>
- </member>
- <member name="T:DotSpatial.Data.ILog">
- <summary>
- LogException
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ILog.Log">
- <summary>
- Actually logs the exception. This happens after the message has been set in the constructors of the classes of this exception.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.DataStrings">
- <summary>
- A strongly-typed resource class, for looking up localized strings, etc.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataStrings.ResourceManager">
- <summary>
- Returns the cached ResourceManager instance used by this class.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataStrings.Culture">
- <summary>
- Overrides the current thread's CurrentUICulture property for all
- resource lookups using this strongly typed resource class.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataStrings.Argument_Null_S">
- <summary>
- Looks up a localized string similar to The argument %S cannot be null..
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataStrings.ArgumentCannotBeNegative_S">
- <summary>
- Looks up a localized string similar to The argument %S cannot be negative..
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataStrings.ArgumentNull_S">
- <summary>
- Looks up a localized string similar to The argument %S was null. Try testing for the null case before calling this method..
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataStrings.ArgumentOfWrongType_S1_S2">
- <summary>
- Looks up a localized string similar to The argument %S1 was incorrect for %S2..
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataStrings.CalculatingStatistics">
- <summary>
- Looks up a localized string similar to Calculating Statistics.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataStrings.CannotCopyToSelf_S">
- <summary>
- Looks up a localized string similar to The fileName %S cannot be copied to itself..
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataStrings.CopyingValues">
- <summary>
- Looks up a localized string similar to Copying Values.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataStrings.CurrentElementNotSpecified">
- <summary>
- Looks up a localized string similar to The current element was not defined. Before attempting to read the element, first assign the value of the current XML Element to read..
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataStrings.EndOfFile">
- <summary>
- Looks up a localized string similar to Cannot read past the end of the file..
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataStrings.FeatureTypeMismatch">
- <summary>
- Looks up a localized string similar to The FeatureType of the feature you are trying to add does not match the feature type of this featureset..
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataStrings.FeaturetypeUnspecified">
- <summary>
- Looks up a localized string similar to The FeatureType was not specified. Please specify a featuretype before attempting to call this method..
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataStrings.FileExists_S">
- <summary>
- Looks up a localized string similar to The fileName %S already exists. Do you wish to overwrite it?.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataStrings.FileNotFound_S">
- <summary>
- Looks up a localized string similar to The fileName %S was not found..
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataStrings.FileNotLines_S">
- <summary>
- Looks up a localized string similar to The fileName %S contains a feature type other than lines..
- </summary>
- </member>
- <!-- Badly formed XML comment ignored for member "P:DotSpatial.Data.DataStrings.FileNotMultipoints_S" -->
- <!-- Badly formed XML comment ignored for member "P:DotSpatial.Data.DataStrings.FileNotPoints_S" -->
- <member name="P:DotSpatial.Data.DataStrings.FileNotPolygons_S">
- <summary>
- Looks up a localized string similar to The fileName %S contains a feature type other than polygons..
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataStrings.FileTypeNotSupported">
- <summary>
- Looks up a localized string similar to The specified file type is not supported..
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataStrings.HfaEnumerationNotFound">
- <summary>
- Looks up a localized string similar to Attepted to set the enumeration field to the value '%s', which is not known..
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataStrings.HfaFieldTypeException">
- <summary>
- Looks up a localized string similar to The specified charcter '%S' was not a known field type: 124cCesStlLfdmMbox".
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataStrings.HfaInvalidCountException">
- <summary>
- Looks up a localized string similar to The number of rows and number of columns must both be greater than 0, but the header for this item returned %S1 rows and %S2 columns..
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataStrings.HfaNotCompressedException">
- <summary>
- Looks up a localized string similar to You must first compress the data before accessing this value..
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataStrings.HfaPointerInsertNotSupportedException">
- <summary>
- Looks up a localized string similar to Insertion via SetInstValue() is not yet supported for pointers..
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataStrings.IndexingErrorIn_S">
- <summary>
- Looks up a localized string similar to There was an error while attempting to index %S.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataStrings.IO_FileNotFound_S">
- <summary>
- Looks up a localized string similar to The file %S could not be found..
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataStrings.NotImplemented">
- <summary>
- Looks up a localized string similar to This has not yet been implemented..
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataStrings.NumberException_TooLarge_S">
- <summary>
- Looks up a localized string similar to The value %S was too large to encode with 18 ASCII characters..
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataStrings.NumberException_TooSmall_S">
- <summary>
- Looks up a localized string similar to The value %S was too small to be encoded with 18 ASCII characters..
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataStrings.ParseFailed_S">
- <summary>
- Looks up a localized string similar to The value you entered could not be parsed into a %S. Make sure the value is in the valid range..
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataStrings.PngInsuficientLengthException">
- <summary>
- Looks up a localized string similar to The desired length of %S1 was too long. The total length was %S2 and the offset was %S3..
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataStrings.PngInvalidSignatureException">
- <summary>
- Looks up a localized string similar to The beginning eight bytes of the specified file did not match the png signature..
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataStrings.PyramidByteMismatchException">
- <summary>
- Looks up a localized string similar to The number of bytes should be 4 * rows * cols since only ARGB format is supported..
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataStrings.PyramidHeaderException">
- <summary>
- Looks up a localized string similar to The header has not been defined for the image scale you are attempting to access..
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataStrings.PyramidOutOfBoundsException">
- <summary>
- Looks up a localized string similar to The rows or columns would extend beyond the specified number of columns or rows for the specified scale..
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataStrings.RasterRequiresCast">
- <summary>
- Looks up a localized string similar to To work with anything other than an in-memory raster window, you must first cast this raster to the correct data format..
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataStrings.RastersNeedSameCellSize">
- <summary>
- Looks up a localized string similar to The rasters must have equally sized cells to use this method..
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataStrings.RasterTooLarge">
- <summary>
- Looks up a localized string similar to The specified raster would be too large to store in memory..
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataStrings.ReadingValuesFrom_S">
- <summary>
- Looks up a localized string similar to Reading values from %S.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DataStrings.WritingValues_S">
- <summary>
- Looks up a localized string similar to Writing values to %S.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.BoxStatistics">
- <summary>
- Box-plot: Tukey 1977
- Basically it is like subdividing the data into 4 quartiles,
- denoted like Q1, Q2, Q3, Q4.
- -------
- Low Outlier (less than the Quartile - 3/2 Interquartile range)
- Q1 (Q1 - 3/2 the Interquartile range to Q1
- Q2 (Quartile 1 to Median)
- Q3 (Median to Quartile 3)
- Q4 (Q3 to Q3 + 3/2 the Interquartile range
- High Outlier (Greater than Q3 plus the interquartile range
- </summary>
- </member>
- <member name="F:DotSpatial.Data.BoxStatistics.HighMedian">
- <summary>
- The median between the median and the highest value.
- This separates the third and fourth quartiles.
- </summary>
- </member>
- <member name="F:DotSpatial.Data.BoxStatistics.HighWisker">
- <summary>
- The highest value that is not considered an outlier.
- If the values are not numeric, this will be the Maximum.
- </summary>
- </member>
- <member name="F:DotSpatial.Data.BoxStatistics.LowMedian">
- <summary>
- The median between the lowest value and the median value.
- This separates the first quartile from the second.
- </summary>
- </member>
- <member name="F:DotSpatial.Data.BoxStatistics.LowWhisker">
- <summary>
- The lowest value that is not considered to be an outlier.
- If the values are not numeric, this will be the minimum.
- </summary>
- </member>
- <member name="F:DotSpatial.Data.BoxStatistics.Median">
- <summary>
- The Median value (the value of the middle member)
- </summary>
- </member>
- <member name="T:DotSpatial.Data.CoordinateType">
- <summary>
- CoordinateTypes
- </summary>
- </member>
- <member name="F:DotSpatial.Data.CoordinateType.Regular">
- <summary>
- X and Y coordinates only
- </summary>
- </member>
- <member name="F:DotSpatial.Data.CoordinateType.M">
- <summary>
- M values are available
- </summary>
- </member>
- <member name="F:DotSpatial.Data.CoordinateType.Z">
- <summary>
- Z values are available
- </summary>
- </member>
- <member name="T:DotSpatial.Data.DataTableStatisticsExt">
- <summary>
- DataTableStatisticsEM
- </summary>
- </member>
- <member name="M:DotSpatial.Data.DataTableStatisticsExt.GetBoxStatistics(System.Data.DataTable,System.String)">
- <summary>
- Inspects the members of the data Table, focusing on the named field. It calculates
- the median of the values in the named field.
- </summary>
- <param name="self"></param>
- <param name="fieldName"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Data.EndPointInteraction">
- <summary>
- Used by Segment.ClosestPointTo() to detail how the input point interacts with the line segment
- </summary>
- </member>
- <member name="F:DotSpatial.Data.EndPointInteraction.OnLine">
- <summary>
- The vertex found is on the line segment and between P1 and P2
- </summary>
- </member>
- <member name="F:DotSpatial.Data.EndPointInteraction.PastP1">
- <summary>
- The vertex found is beyond the end of P1
- </summary>
- </member>
- <member name="F:DotSpatial.Data.EndPointInteraction.PastP2">
- <summary>
- The vertex found is beyond the end of P2
- </summary>
- </member>
- <member name="F:DotSpatial.Data.EndPointInteraction.P1equalsP2">
- <summary>
- P1 equals P2 so the segment cannot be extended into an infinite line the closest vertex is P1/P2
- </summary>
- </member>
- <member name="T:DotSpatial.Data.CacheTypes">
- <summary>
- Clarifies whether a value is cached in a local variable or updated dynamically
- </summary>
- </member>
- <member name="F:DotSpatial.Data.CacheTypes.Cached">
- <summary>
- The value is cached locally, rather than calculated on the fly
- </summary>
- </member>
- <member name="F:DotSpatial.Data.CacheTypes.Dynamic">
- <summary>
- The value is calculated each type, rather than using a local cache
- </summary>
- </member>
- <member name="T:DotSpatial.Data.ByteOrder">
- <summary>
- Byte order
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ByteOrder.BigEndian">
- <summary>
- Big Endian
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ByteOrder.LittleEndian">
- <summary>
- Little Endian
- </summary>
- </member>
- <member name="T:DotSpatial.Data.VectorFileType">
- <summary>
- Filetypes
- </summary>
- </member>
- <member name="F:DotSpatial.Data.VectorFileType.INVALID">
- <summary>
- An unrecognized file format
- </summary>
- </member>
- <member name="F:DotSpatial.Data.VectorFileType.Shapefile">
- <summary>
- The Esri Shapefile format (*.shp)
- </summary>
- </member>
- <member name="F:DotSpatial.Data.VectorFileType.CSV">
- <summary>
- Comma separated values (*.csv)
- </summary>
- </member>
- <member name="F:DotSpatial.Data.VectorFileType.GML">
- <summary>
- Google Markup Language (a variant of the Keyhole Markup Language) (*.gml)
- </summary>
- </member>
- <member name="F:DotSpatial.Data.VectorFileType.MapInfo">
- <summary>
- MapInfo format (*.tab)
- </summary>
- </member>
- <member name="F:DotSpatial.Data.VectorFileType.MicrostationDGN">
- <summary>
- CAD format (Design) (*.dgn)
- </summary>
- </member>
- <member name="F:DotSpatial.Data.VectorFileType.S57">
- <summary>
- S-57 published by International Hydrographic Organization (IHO). (*.000)
- </summary>
- </member>
- <member name="F:DotSpatial.Data.VectorFileType.SDTS">
- <summary>
- Spatial Data Transfer Standard (*.sdts)
- </summary>
- </member>
- <member name="F:DotSpatial.Data.VectorFileType.UKNTF">
- <summary>
- ?
- </summary>
- </member>
- <member name="F:DotSpatial.Data.VectorFileType.TIGER">
- <summary>
- Topologically Integrated Geographic Encoding and Referencing (*.tig)
- </summary>
- </member>
- <member name="F:DotSpatial.Data.VectorFileType.PostgreSQL">
- <summary>
- ?
- </summary>
- </member>
- <member name="F:DotSpatial.Data.VectorFileType.ODBC">
- <summary>
- MS Excel ODBC Query File? (*.DQY)
- maybe ODBC Data Source file? (*.DSN)
- </summary>
- </member>
- <member name="F:DotSpatial.Data.VectorFileType.PGeo">
- <summary>
- ?
- </summary>
- </member>
- <member name="F:DotSpatial.Data.VectorFileType.AVC">
- <summary>
- ArcInfo Vector Coverage
- </summary>
- </member>
- <member name="F:DotSpatial.Data.VectorFileType.VRT">
- <summary>
- Geospatial Data Abstraction Library (GDAL) File (*.VRT)
- </summary>
- </member>
- <member name="F:DotSpatial.Data.VectorFileType.REC">
- <summary>
- Record file? (*.REC)
- </summary>
- </member>
- <member name="T:DotSpatial.Data.Field">
- <summary>
- This represents the column information for one column of a shapefile.
- This specifies precision as well as the typical column information.
- </summary>
- </member>
- <member name="F:DotSpatial.Data.Field._decimalCount">
- <summary>
- Represents the number of decimals to preserve after a 0.
- </summary>
- </member>
- <member name="F:DotSpatial.Data.Field._length">
- <summary>
- The length of a field in bytes
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Field.#ctor">
- <summary>
- Creates a new default field empty field - needed for datatable copy and clone methods.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Field.#ctor(System.Data.DataColumn)">
- <summary>
- Creates a new default field given the specified DataColumn. Numeric types
- default to a size of 255, but will be shortened during the save opperation.
- The default decimal count for double and long is 0, for Currency is 2, for float is
- 3, and for double is 8. These can be changed by changing the DecimalCount property.
- </summary>
- <param name="inColumn">A System.Data.DataColumn to create a Field from</param>
- </member>
- <member name="M:DotSpatial.Data.Field.#ctor(System.String)">
- <summary>
- Creates a new instance of a field given only a column name
- </summary>
- <param name="inColumnName">The string Column Name for the new field</param>
- </member>
- <member name="M:DotSpatial.Data.Field.#ctor(System.String,System.Type)">
- <summary>
- Creates a new Field with a specific name for a specified data type
- </summary>
- <param name="inColumnName">The string name of the column</param>
- <param name="inDataType">The System.Type describing the datatype of the field</param>
- </member>
- <member name="M:DotSpatial.Data.Field.#ctor(System.String,DotSpatial.Data.FieldDataType)">
- <summary>
- Creates a new field with a specific name and using a simplified enumeration of possible types.
- </summary>
- <param name="inColumnName">the string column name.</param>
- <param name="type">The type enumeration that clarifies which basic data type to use.</param>
- </member>
- <member name="M:DotSpatial.Data.Field.#ctor(System.String,System.Char,System.Byte,System.Byte)">
- <summary>
- This creates a new instance. Since the data type is
- </summary>
- <param name="columnName"></param>
- <param name="typeCode"></param>
- <param name="length"></param>
- <param name="decimalCount"></param>
- </member>
- <member name="M:DotSpatial.Data.Field.SetupDecimalCount">
- <summary>
- Internal method that decides an appropriate decimal count, given a data column
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Field.TypeCharacter">
- <summary>
- This is the single character dBase code. Only some of these are supported with Esri.
- C - Character (Chars, Strings, objects - as ToString(), and structs - as )
- D - Date (DateTime)
- T - Time (DateTime)
- N - Number (Short, Integer, Long, Float, Double, byte)
- L - Logic (True-False, Yes-No)
- F - Float
- B - Double
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Field.DecimalCount">
- <summary>
- Gets or sets the number of places to keep after the 0 in number formats.
- As far as dbf fields are concerned, all numeric datatypes use the same
- database number format.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Field.Length">
- <summary>
- The character length of the field
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Field.DataAddress">
- <summary>
- The offset of the field on a row in the file
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Field.NumberConverter">
- <summary>
- Number Converter associated with this field.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.FieldDataType">
- <summary>
- FieldDataTypes stores some very simplistic data types to help novices get started more easily.
- </summary>
- </member>
- <member name="F:DotSpatial.Data.FieldDataType.Integer">
- <summary>
- 32 Bit integer data type
- </summary>
- </member>
- <member name="F:DotSpatial.Data.FieldDataType.Double">
- <summary>
- Double precision floating point data type
- </summary>
- </member>
- <member name="F:DotSpatial.Data.FieldDataType.String">
- <summary>
- String data type
- </summary>
- </member>
- <member name="T:DotSpatial.Data.BitmapGrid">
- <summary>
- This is not a data class exactly, but instead is for making it easier to modify byte values of a 32 bit ARGB
- bitmap, but doesn't require a file.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.BitmapGrid.#ctor(System.Drawing.Image)">
- <summary>
- Creates a new instance of MemoryBitmapGrid
- </summary>
- </member>
- <member name="M:DotSpatial.Data.BitmapGrid.#ctor(System.Int32,System.Int32)">
- <summary>
- Creates a blank image grid.
- </summary>
- <param name="numRows"></param>
- <param name="numCols"></param>
- </member>
- <member name="M:DotSpatial.Data.BitmapGrid.Clone">
- <summary>
- Creates a clone of this memory bitmap grid by basically cloning the bitmap itself
- and then building a new BitmapGrid around the clone.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.BitmapGrid.GetEnumerator">
- <summary>
- Gets an enumerator for cycling through the color values.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.BitmapGrid.Copy">
- <summary>
- Creates a disconnected duplicate of this BitmapGrid
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.BitmapGrid.Clear">
- <summary>
- Clears the byte values in the grid, replacing them with 0.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.BitmapGrid.Dispose">
- <summary>
- Disposes the unmanaged aspect of the bmp
- </summary>
- </member>
- <member name="M:DotSpatial.Data.BitmapGrid.Fill(System.Drawing.Color)">
- <summary>
- Erases over any current content in the values, and copies the
- byte values of the specified color in its place.
- </summary>
- <param name="fillColor">The color to fill the image with</param>
- </member>
- <member name="M:DotSpatial.Data.BitmapGrid.ConvertToBitmap(System.Drawing.Image)">
- <summary>
- Tests the specified bitmap to verify that it is both a Bitmap and in ARGB pixel format.
- If it is anything different, then this returns a newly created bitmap with a copy drawn
- onto it.
- </summary>
- <param name="source"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.BitmapGrid.Difference(DotSpatial.Data.BitmapGrid)">
- <summary>
- This will calculate the difference. The width and height of the new grid will be the larger
- of the rows and columns between the compare grid and this grid. Values outside the range
- of one of the grids will simply be filled in as the value stored in the other grid. Because
- byte values can't be negative, the difference will be the absolute value.
- </summary>
- <param name="compare"></param>
- <returns>A BitmapGrid with byte values calculated by taking the difference between the two grids.</returns>
- </member>
- <member name="M:DotSpatial.Data.BitmapGrid.Difference(DotSpatial.Data.BitmapGrid,System.Boolean)">
- <summary>
- By default, all the bands have a difference comparison done. This may not have the desired effect
- because the alpha channel for most colors is actually just 255. The mathematical difference would
- be zero, resulting in an output image that, while being the actual difference, is essentially
- entirely invisibile (except where the images don't overlap.)
- </summary>
- <param name="compare"></param>
- <param name="ignoreAlpha"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.BitmapGrid.GetColor(System.Int32,System.Int32)">
- <summary>
- Gets a color structure for the specified row and column.
- </summary>
- <param name="row">The zero based integer row index to get the color from</param>
- <param name="col">The zero based integer column index to get the color from</param>
- <returns>A System.Color structure created from the byte values in the values array</returns>
- </member>
- <member name="M:DotSpatial.Data.BitmapGrid.Matches(DotSpatial.Data.BitmapGrid)">
- <summary>
- Compares the bytes of this grid to the bytes of another grid. If the measurements
- of the other grid don't match this, then this returns false.
- </summary>
- <param name="otherGrid">The other BitmapGrid to test against</param>
- <returns>Boolean, true if the bytes are the same in each case.</returns>
- </member>
- <member name="M:DotSpatial.Data.BitmapGrid.Randomize">
- <summary>
- Replaces all the byte values of this grid with randomly generated values.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.BitmapGrid.SetColor(System.Int32,System.Int32,System.Drawing.Color)">
- <summary>
- Sets the color structure by copying the byte ARGB values into the values array.
- </summary>
- <param name="row">The integer row index to copy values to</param>
- <param name="col">The integer column index to copy values to</param>
- <param name="color">The color structure to turn into bytes</param>
- </member>
- <member name="P:DotSpatial.Data.BitmapGrid.BitmapImage">
- <summary>
- Setting this will automatically replace the byte array. Getting this will
- automatically convert the bytes back into bitmap form.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.BitmapGrid.Height">
- <summary>
- Gets the integer height of the bitmap in this grid in pixels.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.BitmapGrid.Stride">
- <summary>
- gets the integer stride, or number of actual bytes in a single row. This is not always the
- same as the number of columns.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.BitmapGrid.Values">
- <summary>
- Gets or sets the array of bytes directly. Setting this can be
- dangerous and is not recommended. Setting individual values in the
- array is perfectly acceptable, since it won't interfere with
- the stride or number of bytes expected.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.BitmapGrid.Width">
- <summary>
- Gets the current width (number of columns) of the bitmap in pixels.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.BitmapGrid.BitmapGridEnumerator">
- <summary>
- Cycles through the values of a BitmapGrid starting at the top left corner and moving in row major
- fashion, (raster-scan fashion, moving across end then down.)
- </summary>
- </member>
- <member name="M:DotSpatial.Data.BitmapGrid.BitmapGridEnumerator.#ctor(DotSpatial.Data.BitmapGrid)">
- <summary>
- Creates a new instance of a BitmapGridEnumerator based on the specified parentGrid. This
- automatically ignores any bytes in the range past the "width".
- </summary>
- <param name="parentGrid">The parent grid to cycle through the values of</param>
- </member>
- <member name="M:DotSpatial.Data.BitmapGrid.BitmapGridEnumerator.Dispose">
- <summary>
- This does nothing
- </summary>
- </member>
- <member name="M:DotSpatial.Data.BitmapGrid.BitmapGridEnumerator.MoveNext">
- <summary>
- Advances the color to the next position
- </summary>
- <returns>Boolean, false if there were no more cells in the image</returns>
- </member>
- <member name="M:DotSpatial.Data.BitmapGrid.BitmapGridEnumerator.Reset">
- <summary>
- Resets the enumeration to the top left corner of the image.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.BitmapGrid.BitmapGridEnumerator.Current">
- <summary>
- Gets the current color value from this grid
- </summary>
- </member>
- <member name="T:DotSpatial.Data.DotNetImageProvider">
- <summary>
- DotNetImageProvider uses the standard image object to support basic image types through standard in-ram treatments.
- Images are not responsible for producing grid values that can be represented symbolically.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IImageDataProvider">
- <summary>
- IImageProvider
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IDataProvider">
- <summary>
- IDataProvider is what you implement to expand the data handling methods of DotSpatial
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IDataProvider.Open(System.String)">
- <summary>
- This open method is only called if this plugin has been given priority for one
- of the file extensions supported in the DialogReadFilter property supplied by
- this control. Failing to provide a DialogReadFilter will result in this plugin
- being added to the list of DataProviders being supplied under the Add Other Data
- option in the file menu.
- </summary>
- <param name="name">A string specifying the complete path and extension of the file to open.</param>
- <returns>A List of IDataSets to be added to the Map. These can also be groups of datasets.</returns>
- </member>
- <member name="P:DotSpatial.Data.IDataProvider.DialogReadFilter">
- <summary>
- Gets a dialog read filter that lists each of the file type descriptions and file extensions, delimited
- by the | symbol. Each will appear in DotSpatial's open file dialog filter, preceded by the name provided
- on this object.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IDataProvider.DialogWriteFilter">
- <summary>
- Gets a dialog filter that lists each of the file type descriptions and extensions for a Save File Dialog.
- Each will appear in DotSpatial's open file dialog filter, preceded by the name provided on this object.
- In addition, the same extension mapping will be used in order to pair a string driver code to the
- extension.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IDataProvider.Name">
- <summary>
- Gets a preferably short name that identifies this data provider. Example might be GDAL.
- This will be prepended to each of the DialogReadFilter members from this plugin.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IDataProvider.ProgressHandler">
- <summary>
- Gets or sets the progress handler to use.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IDataProvider.Description">
- <summary>
- This provides a basic description of what your provider does.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IImageDataProvider.Create(System.String,System.Int32,System.Int32,System.Boolean,DotSpatial.Data.IProgressHandler,DotSpatial.Data.ImageBandType)">
- <summary>
- Creates a new instance of an Image.
- </summary>
- <param name="fileName">The string fileName to use</param>
- <param name="width">The integer width in pixels</param>
- <param name="height">The integer height in pixels</param>
- <param name="inRam">Boolean, true if the entire contents should be stored in memory</param>
- <param name="progHandler">A Progress handler to use</param>
- <param name="band">The ImageBandType clarifying how to organize the raster bands.</param>
- <returns>A New IImageData object allowing access to the content of the image</returns>
- </member>
- <member name="M:DotSpatial.Data.IImageDataProvider.Open(System.String)">
- <summary>
- Opens a new Image with the specified fileName
- </summary>
- <param name="fileName">The string file to open</param>
- <returns>An IImageData object</returns>
- </member>
- <member name="M:DotSpatial.Data.DotNetImageProvider.Create(System.String,System.Int32,System.Int32,System.Boolean,DotSpatial.Data.IProgressHandler,DotSpatial.Data.ImageBandType)">
- <summary>
- Creates a new instance of an Image.
- </summary>
- <param name="fileName">The string fileName to use</param>
- <param name="width">The integer width in pixels</param>
- <param name="height">The integer height in pixels</param>
- <param name="inRam">Boolean, true if the entire contents should be stored in memory</param>
- <param name="progHandler">A Progress handler to use</param>
- <param name="band">.Net type ignores this for now.</param>
- <returns>
- A New IImageData object allowing access to the content of the image
- </returns>
- </member>
- <member name="M:DotSpatial.Data.DotNetImageProvider.Open(System.String)">
- <summary>
- Opens a new Image with the specified fileName
- </summary>
- <param name="fileName">The string file to open</param>
- <returns>An IImageData object</returns>
- </member>
- <member name="P:DotSpatial.Data.DotNetImageProvider.DialogReadFilter">
- <summary>
- Gets a dialog read filter that lists each of the file type descriptions and file extensions, delimeted
- by the | symbol. Each will appear in DotSpatial's open file dialog filter, preceeded by the name provided
- on this object.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DotNetImageProvider.DialogWriteFilter">
- <summary>
- Gets a dialog filter that lists each of the file type descriptions and extensions for a Save File Dialog.
- Each will appear in DotSpatial's open file dialog filter, preceeded by the name provided on this object.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DotNetImageProvider.Name">
- <summary>
- Gets a prefereably short name that identifies this data provider. Example might be GDAL.
- This will be prepended to each of the DialogReadFilter members from this plugin.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DotNetImageProvider.Description">
- <summary>
- This provides a basic description of what your provider does.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.DotNetImageProvider.ProgressHandler">
- <summary>
- Gets or sets the progress handler
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IImageCoverage">
- <summary>
- An Image Coverage just consists of several images that can be thought of as a single image region.
- Queries for pixel values for a region will simply return the first value in the set that is not
- completely transparent.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IImageSet">
- <summary>
- IImageSet is simple interface that gives some basic information that is common between tiled images and
- the more general image coverages
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IImageSet.GetBitmap(DotSpatial.Data.Extent,System.Drawing.Size)">
- <summary>
- Uses the geographic envelope and the specified pixelSize in order to calculate an
- appropriate bitmap for display based on the various images in this set.
- </summary>
- <param name="envelope">The geographic bounds to display</param>
- <param name="pixelSize">The pixelSize of the bitmap to display</param>
- <returns>A Bitmap showing the appropriate size and dimensions of the image</returns>
- </member>
- <member name="M:DotSpatial.Data.IImageSet.GetImages">
- <summary>
- This is very generic, but allows the user to cycle through the images currently in the image set,
- regardless of whether they are in a list or an array or other data structure.
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Data.IImageSet.Count">
- <summary>
- Gets the count of the images in the image set
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IImageCoverage.Images">
- <summary>
- Gets or sets the list of tiles.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IImageData">
- <summary>
- IImageData
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IImageData.CopyBitmapToValues">
- <summary>
- Forces the image to read values from the graphic image format to the byte array format
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IImageData.CopyValues(DotSpatial.Data.IImageData)">
- <summary>
- Copies the values from the specified source image.
- </summary>
- <param name="source">
- The source image to copy values from.
- </param>
- </member>
- <member name="M:DotSpatial.Data.IImageData.CopyValuesToBitmap">
- <summary>
- Forces the image to copy values from the byte array format to the image format.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IImageData.GetColor(System.Int32,System.Int32)">
- <summary>
- Creates a color structure from the byte values in the values array that correspond to the
- specified position.
- </summary>
- <param name="row">
- The integer row index for the pixel.
- </param>
- <param name="column">
- The integer column index for the pixel.
- </param>
- <returns>
- A Color.
- </returns>
- </member>
- <member name="M:DotSpatial.Data.IImageData.Open">
- <summary>
- Opens the file, assuming that the fileName has already been specified
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IImageData.Save">
- <summary>
- Saves the image and associated world file to the current fileName.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IImageData.SaveAs(System.String)">
- <summary>
- Saves the image to a new fileName.
- </summary>
- <param name="fileName">
- The string fileName to save the image to.
- </param>
- </member>
- <member name="M:DotSpatial.Data.IImageData.SetBitmap(System.Drawing.Bitmap)">
- <summary>
- Sets the bitmap being used for this dataset
- </summary>
- <param name="image">
- </param>
- </member>
- <member name="M:DotSpatial.Data.IImageData.GetColorPalette">
- <summary>
- This is only used in the palette indexed band type.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IImageData.SetColorPalette(System.Collections.Generic.IEnumerable{System.Drawing.Color})">
- <summary>
- This should update the palette cached and in the file.
- </summary>
- <param name="value"></param>
- </member>
- <member name="M:DotSpatial.Data.IImageData.SetColor(System.Int32,System.Int32,System.Drawing.Color)">
- <summary>
- Sets the color value into the byte array based on the row and column position of the pixel.
- </summary>
- <param name="row">
- The integer row index of the pixel to set the color of.
- </param>
- <param name="column">
- The integer column index of the pixel to set the color of
- </param>
- <param name="col">
- The color to copy values from
- </param>
- </member>
- <member name="M:DotSpatial.Data.IImageData.ReadBlock(System.Int32,System.Int32,System.Int32,System.Int32)">
- <summary>
- Gets a block of data directly, converted into a bitmap.
- </summary>
- <param name="xOffset">The zero based integer column offset from the left</param>
- <param name="yOffset">The zero based integer row offset from the top</param>
- <param name="xSize">The integer number of pixel columns in the block. </param>
- <param name="ySize">The integer number of pixel rows in the block.</param>
- <returns>A Bitmap that is xSize, ySize.</returns>
- </member>
- <member name="M:DotSpatial.Data.IImageData.WriteBlock(System.Drawing.Bitmap,System.Int32,System.Int32)">
- <summary>
- Saves a bitmap of data as a continuous block into the specified location.
- </summary>
- <param name="value">The bitmap value to save.</param>
- <param name="xOffset">The zero based integer column offset from the left</param>
- <param name="yOffset">The zero based integer row offset from the top</param>
- </member>
- <member name="M:DotSpatial.Data.IImageData.UpdateOverviews">
- <summary>
- Finalizes the blocks. In the case of a pyramid image, this forces recalculation of the
- various overlays. For GDAL images, this may do nothing, since the overlay recalculation
- may be on the fly. For InRam images this does nothing.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IImageData.BytesPerPixel">
- <summary>
- Gets or sets an integer indicating how many bytes exist for each pixel.
- Eg. 32 ARGB = 4, 24 RGB = 3, 16 bit GrayScale = 2
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IImageData.Filename">
- <summary>
- Gets or sets the fileName.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IImageData.Height">
- <summary>
- Gets the image height in pixels
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IImageData.NumBands">
- <summary>
- Gets or sets the number of bands that are in the image.
- One band is a gray valued image, 3 bands for color RGB and 4 bands
- for ARGB.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IImageData.Stride">
- <summary>
- Gets or sets the stride in bytes.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IImageData.Values">
- <summary>
- Gets a one dimensional array of byte values
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IImageData.Width">
- <summary>
- Gets the image width in pixels
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IImageData.WorldFile">
- <summary>
- Gets or sets the world file that stores the georeferencing information for this image.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IImageData.BandType">
- <summary>
- Gets or sets the interpretation for the image bands. This currently is only for GDAL images.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IImageSource">
- <summary>
- IImageSource
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IImageSource.ReadWindow(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
- <summary>
- Returns the data from the file in the form of ARGB bytes.
- </summary>
- <param name="startRow">The zero based integer index of the first row (Y)</param>
- <param name="startColumn">The zero based integer index of the first column (X)</param>
- <param name="numRows">The number of rows to read</param>
- <param name="numColumns">The number of columns to read</param>
- <param name="overview">The integer overview. 0 for the original image. Each successive index divides the length and height in half. </param>
- <returns>A Byte of values in ARGB order and in row-major raster-scan sequence</returns>
- </member>
- <member name="M:DotSpatial.Data.IImageSource.GetBitmap(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
- <summary>
- This returns the window of data as a bitmap.
- </summary>
- <param name="startRow">The zero based integer index of the first row (Y)</param>
- <param name="startColumn">The zero based integer index of the first column (X)</param>
- <param name="numRows">The number of rows to read</param>
- <param name="numColumns">The number of columns to read</param>
- <param name="overview">The integer overview. 0 for the original image. Each successive index divides the length and height in half. </param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Data.IImageSource.Bounds">
- <summary>
- Gets or sets the bounds
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IImageSource.NumRows">
- <summary>
- Gets the number of rows
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IImageSource.NumColumns">
- <summary>
- Gets the total number of columns
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IImageSource.NumOverviews">
- <summary>
- Gets the number of overviews, not counting the original image
- </summary>
- </member>
- <member name="T:DotSpatial.Data.ImageCoverage">
- <summary>
- TiledImage is a class for actually controlling the data in several tiles. This does not supply
- direct accessors for
- modifying the bytes directly, and instead expects the user to edit the image on a tile-by-tile basis. However,
- the GetBitmap method will produce a representation of the envelope scaled to the specified window.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ImageCoverage.#ctor">
- <summary>
- Creates a new instance of TiledImage
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ImageCoverage.GetBitmap(DotSpatial.Data.Extent,System.Drawing.Size)">
- <summary>
- Gets the bitmap for the specified geographic envelope scaled to fit on a bitmap of the specified size in pixels.
- </summary>
- <param name="envelope"></param>
- <param name="pixelSize"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.ImageCoverage.GetImages">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Data.ImageCoverage.Open">
- <summary>
- Cycles through each of the images and calls the open method on each one.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ImageCoverage.Save">
- <summary>
- Cycles through each of the images and calls the save method on each one
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ImageCoverage.FileName">
- <summary>
- Gets or sets the Filename
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ImageCoverage.Count">
- <inheritdoc />
- </member>
- <member name="P:DotSpatial.Data.ImageCoverage.Extent">
- <inheritdoc />
- </member>
- <member name="P:DotSpatial.Data.ImageCoverage.Images">
- <inheritdoc />
- </member>
- <member name="T:DotSpatial.Data.ImageData">
- <summary>
- ImageData (not named Image because of conflicting with the Dot Net Image object)
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ImageData.#ctor">
- <summary>
- Creates a new instance of ImageData
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ImageData.CopyValues(DotSpatial.Data.IImageData)">
- <summary>
- Copies the values from the specified source image.
- </summary>
- <param name="source">The source image to copy values from.</param>
- </member>
- <member name="M:DotSpatial.Data.ImageData.GetBitmap">
- <summary>
- Attempts to create a bitmap for the entire image. This may cause memory exceptions.
- </summary>
- <returns>A Bitmap of the image.</returns>
- </member>
- <member name="M:DotSpatial.Data.ImageData.SetBitmap(System.Drawing.Bitmap)">
- <summary>
- Sets the bitmap being used for this dataset
- </summary>
- <param name="image"></param>
- </member>
- <member name="M:DotSpatial.Data.ImageData.GetBitmap(DotSpatial.Data.Extent,System.Drawing.Size)">
- <summary>
- The geographic envelope gives the region that the image should be created for.
- The window gives the corresponding pixel dimensions for the image, so that
- images matching the resolution of the screen can be used.
- </summary>
- <param name="envelope">The geographic extents to retrieve data for</param>
- <param name="size">The rectangle that defines the size of the drawing area in pixels</param>
- <returns>A bitmap captured from the main image </returns>
- </member>
- <member name="M:DotSpatial.Data.ImageData.GetBitmap(DotSpatial.Data.Extent,System.Drawing.Rectangle)">
- <summary>
- The geographic envelope gives the region that the image should be created for.
- The window gives the corresponding pixel dimensions for the image, so that
- images matching the resolution of the screen can be used.
- </summary>
- <param name="envelope">The geographic extents to retrieve data for</param>
- <param name="window">The rectangle that defines the size of the drawing area in pixels</param>
- <returns>A bitmap captured from the main image </returns>
- </member>
- <member name="M:DotSpatial.Data.ImageData.Open">
- <summary>
- Opens the file, assuming that the fileName has already been specified
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ImageData.CopyBitmapToValues">
- <summary>
- Forces the image to read values from the graphic image format to the byte array format
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ImageData.Save">
- <summary>
- Saves the image and associated world file to the current fileName.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ImageData.SaveAs(System.String)">
- <summary>
- Saves the image to a new fileName.
- </summary>
- <param name="fileName">The string fileName to save the image to.</param>
- </member>
- <member name="M:DotSpatial.Data.ImageData.CopyValuesToBitmap">
- <summary>
- Forces the image to copy values from the byte array format to the image format.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ImageData.Create(System.String,System.Int32,System.Int32,DotSpatial.Data.ImageBandType)">
- <summary>
- Creates a new image and world file, placing the default bounds at the origin, with one pixel per unit.
- </summary>
- <param name="fileName">The string fileName</param>
- <param name="width">The integer width</param>
- <param name="height">The integer height</param>
- <param name="bandType">The color band type</param>
- </member>
- <member name="M:DotSpatial.Data.ImageData.Open(System.String)">
- <summary>
- Opens the file with the specified fileName
- </summary>
- <param name="fileName">The string fileName to open</param>
- </member>
- <member name="M:DotSpatial.Data.ImageData.GetColor(System.Int32,System.Int32)">
- <summary>
- Creates a color structure from the byte values in the values array that correspond to the
- specified position.
- </summary>
- <param name="row">The integer row index for the pixel.</param>
- <param name="column">The integer column index for the pixel.</param>
- <returns>A Color.</returns>
- </member>
- <member name="M:DotSpatial.Data.ImageData.SetColor(System.Int32,System.Int32,System.Drawing.Color)">
- <summary>
- Sets the color value into the byte array based on the row and column position of the pixel.
- </summary>
- <param name="row">The integer row index of the pixel to set the color of.</param>
- <param name="column">The integer column index of the pixel to set the color of </param>
- <param name="col">The color to copy values from</param>
- </member>
- <member name="M:DotSpatial.Data.ImageData.ReadBlock(System.Int32,System.Int32,System.Int32,System.Int32)">
- <summary>
- Gets a block of data directly, converted into a bitmap.
- </summary>
- <param name="xOffset">The zero based integer column offset from the left</param>
- <param name="yOffset">The zero based integer row offset from the top</param>
- <param name="xSize">The integer number of pixel columns in the block. </param>
- <param name="ySize">The integer number of pixel rows in the block.</param>
- <returns>A Bitmap that is xSize, ySize.</returns>
- </member>
- <member name="M:DotSpatial.Data.ImageData.WriteBlock(System.Drawing.Bitmap,System.Int32,System.Int32)">
- <summary>
- Saves a bitmap of data as a continuous block into the specified location.
- Be sure to call UpdateOverviews after writing all blocks in pyramid images.
- </summary>
- <param name="value">The bitmap value to save.</param>
- <param name="xOffset">The zero based integer column offset from the left</param>
- <param name="yOffset">The zero based integer row offset from the top</param>
- </member>
- <member name="M:DotSpatial.Data.ImageData.UpdateOverviews">
- <summary>
- Finalizes the blocks. In the case of a pyramid image, this forces recalculation of the
- various overlays. For GDAL images, this may do nothing, since the overlay recalculation
- may be on the fly. For InRam images this does nothing.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ImageData.GetColorPalette">
- <summary>
- This is only used in the palette indexed band type.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ImageData.SetColorPalette(System.Collections.Generic.IEnumerable{System.Drawing.Color})">
- <summary>
- This should update the palette cached and in the file.
- </summary>
- <param name="value"></param>
- </member>
- <member name="M:DotSpatial.Data.ImageData.OnBoundsChanged(DotSpatial.Data.IRasterBounds)">
- <summary>
- Occurs when the bounds have been set.
- </summary>
- <param name="bounds">The new bounds.</param>
- </member>
- <member name="M:DotSpatial.Data.ImageData.Dispose(System.Boolean)">
- <summary>
- Disposes the managed memory objects in the ImageData class, and then forwards
- the Dispose operation to the internal dataset in the base class, if any.
- </summary>
- <param name="disposeManagedResources">Boolean, true if both managed and unmanaged resources should be finalized.</param>
- </member>
- <member name="P:DotSpatial.Data.ImageData.ColorPalette">
- <summary>
- Gets or sets the color palette
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ImageData.BytesPerPixel">
- <summary>
- Gets or sets an integer indicating how many bytes exist for each pixel.
- Eg. 32 ARGB = 4, 24 RGB = 3, 16 bit GrayScale = 2
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ImageData.Filename">
- <summary>
- Gets or sets the fileName.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ImageData.Height">
- <summary>
- Gets the image height in pixels
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ImageData.NumBands">
- <summary>
- Gets or sets the number of bands that are in the image. One band is a gray valued image, 3 bands for color RGB and 4 bands
- for ARGB.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ImageData.Stride">
- <summary>
- Gets or sets the stride in bytes.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ImageData.Values">
- <summary>
- Gets a one dimensional array of byte values
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ImageData.Width">
- <summary>
- Gets the image width in pixels
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ImageData.WorldFile">
- <summary>
- Gets or sets the world file that stores the georeferencing information for this image.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ImageData.BandType">
- <summary>
- Gets or sets the interpretation for the image bands. This currently is only for GDAL images.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.ITiledImage">
- <summary>
- ITiledImage
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ITiledImage.Bounds">
- <summary>
- Gets or sets the bounds for this image
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ITiledImage.Filename">
- <summary>
- Gets or sets the fileName for this tiled image.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ITiledImage.Height">
- <summary>
- Gets or sets the integer height in pixels for the combined image at its maximum resolution
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ITiledImage.Stride">
- <summary>
- Gets the stride, or total width in pixels of the byte data, which might not match exactly with the visible width.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ITiledImage.TileWidth">
- <summary>
- Gets the tile width
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ITiledImage.TileHeight">
- <summary>
- Gets the tile height
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ITiledImage.Width">
- <summary>
- Gets or sets the integer pixel width for the combined image at its maximum resolution.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ITiledImage.WorldFile">
- <summary>
- Gets or sets the WorldFile for this set of tiles.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.InRamImageData">
- <summary>
- MWImageData
- </summary>
- </member>
- <member name="F:DotSpatial.Data.InRamImageData._myImage">
- <summary>
- The _my image.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.InRamImageData.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Data.InRamImageData"/> class.
- Creates an empty ImageData to be created or loaded
- </summary>
- </member>
- <member name="M:DotSpatial.Data.InRamImageData.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Data.InRamImageData"/> class.
- Creates a new MWImageData class from the specified fileName.
- </summary>
- <param name="fileName">
- The string filename.
- </param>
- </member>
- <member name="M:DotSpatial.Data.InRamImageData.#ctor(System.Drawing.Image)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Data.InRamImageData"/> class.
- Creates the bitmap from the raw image specified. The bounds should be set on this later.
- </summary>
- <param name="rawImage">
- The raw image.
- </param>
- </member>
- <member name="M:DotSpatial.Data.InRamImageData.#ctor(System.Drawing.Bitmap,DotSpatial.Data.Extent)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Data.InRamImageData"/> class.
- Uses a bitmap and a geographic envelope in order to define a new imageData object.
- </summary>
- <param name="rawImage">
- The raw image.
- </param>
- <param name="bounds">
- The envelope bounds.
- </param>
- </member>
- <member name="M:DotSpatial.Data.InRamImageData.#ctor(System.Int32,System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Data.InRamImageData"/> class.
- Constructs a new ImageData of the specified width and height.
- </summary>
- <param name="width">
- The integer width in pixels.
- </param>
- <param name="height">
- The integer height in pixels.
- </param>
- </member>
- <member name="M:DotSpatial.Data.InRamImageData.Close">
- <summary>
- Closes the image content.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.InRamImageData.CopyBitmapToValues">
- <summary>
- Forces the image to read values from the graphic image format to the byte array format
- </summary>
- </member>
- <member name="M:DotSpatial.Data.InRamImageData.CopyValues(DotSpatial.Data.IImageData)">
- <summary>
- Copies the values from the specified source image.
- </summary>
- <param name="source">
- The source image to copy values from.
- </param>
- </member>
- <member name="M:DotSpatial.Data.InRamImageData.CopyValuesToBitmap">
- <summary>
- Forces the image to copy values from the byte array format to the image format.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.InRamImageData.Create(System.String,System.Int32,System.Int32,DotSpatial.Data.ImageBandType)">
- <summary>
- Creates a new image and world file, placing the default bounds at the origin, with one pixel per unit.
- </summary>
- <param name="fileName">
- The string fileName
- </param>
- <param name="width">
- The integer width
- </param>
- <param name="height">
- The integer height
- </param>
- <param name="bandType">The ImageBandType that clarifies how the separate bands are layered in the image.</param>
- </member>
- <member name="M:DotSpatial.Data.InRamImageData.GetBitmap">
- <summary>
- Returns the internal bitmap in this case. In other cases, this may have to be constructed
- from the unmanaged memory content.
- </summary>
- <returns>
- A Bitmap that represents the entire image.
- </returns>
- </member>
- <member name="M:DotSpatial.Data.InRamImageData.GetBitmap(DotSpatial.Data.Extent,System.Drawing.Rectangle)">
- <summary>
- The geographic envelope gives the region that the image should be created for.
- The window gives the corresponding pixel dimensions for the image, so that
- images matching the resolution of the screen can be used.
- </summary>
- <param name="envelope">
- The geographic extents to retrieve data for
- </param>
- <param name="window">
- The rectangle that defines the size of the drawing area in pixels
- </param>
- <returns>
- A bitmap captured from the main image
- </returns>
- </member>
- <member name="M:DotSpatial.Data.InRamImageData.Open">
- <summary>
- Opens the file, assuming that the fileName has already been specified using a Dot Net Image object
- </summary>
- </member>
- <member name="M:DotSpatial.Data.InRamImageData.Save">
- <summary>
- Saves the current image and world file.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.InRamImageData.SaveAs(System.String)">
- <summary>
- Saves the image to the specified fileName
- </summary>
- <param name="fileName">
- The string fileName to save this as
- </param>
- </member>
- <member name="M:DotSpatial.Data.InRamImageData.SetBitmap(System.Drawing.Bitmap)">
- <summary>
- Sets the bitmap
- </summary>
- <param name="image">
- </param>
- </member>
- <member name="M:DotSpatial.Data.InRamImageData.Dispose(System.Boolean)">
- <summary>
- Release any unmanaged memory objects
- </summary>
- <param name="disposeManagedResources">
- The dispose Managed Resources.
- </param>
- </member>
- <member name="M:DotSpatial.Data.InRamImageData.MemorySetup">
- <summary>
- The memory setup.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.InRamImageData.ReadBlock(System.Int32,System.Int32,System.Int32,System.Int32)">
- <summary>
- Gets a block of data directly, converted into a bitmap.
- </summary>
- <param name="xOffset">The zero based integer column offset from the left</param>
- <param name="yOffset">The zero based integer row offset from the top</param>
- <param name="xSize">The integer number of pixel columns in the block. </param>
- <param name="ySize">The integer number of pixel rows in the block.</param>
- <returns>A Bitmap that is xSize, ySize.</returns>
- </member>
- <member name="M:DotSpatial.Data.InRamImageData.OnBoundsChanged(DotSpatial.Data.IRasterBounds)">
- <summary>
- Extends the normal bounds changing behavior to also update the world file.
- </summary>
- <param name="bounds">Updates the world file.</param>
- </member>
- <member name="M:DotSpatial.Data.InRamImageData.WriteBlock(System.Drawing.Bitmap,System.Int32,System.Int32)">
- <summary>
- Saves a bitmap of data as a continuous block into the specified location.
- </summary>
- <param name="value">The bitmap value to save.</param>
- <param name="xOffset">The zero based integer column offset from the left</param>
- <param name="yOffset">The zero based integer row offset from the top</param>
- </member>
- <member name="T:DotSpatial.Data.BitDepth">
- <summary>
- BitDepth
- </summary>
- </member>
- <member name="F:DotSpatial.Data.BitDepth.One">
- <summary>
- One bit per band pixel
- </summary>
- </member>
- <member name="F:DotSpatial.Data.BitDepth.Two">
- <summary>
- Two bits per band pixel
- </summary>
- </member>
- <member name="F:DotSpatial.Data.BitDepth.Four">
- <summary>
- Four bits per band pixel
- </summary>
- </member>
- <member name="F:DotSpatial.Data.BitDepth.Eight">
- <summary>
- Eight bits per band pixel (normal)
- </summary>
- </member>
- <member name="F:DotSpatial.Data.BitDepth.Sixteen">
- <summary>
- Sixteen bits per band pixel
- </summary>
- </member>
- <member name="T:DotSpatial.Data.ColorType">
- <summary>
- ColorType
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ColorType.Greyscale">
- <summary>
- Each pixel is a greyscale sample
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ColorType.Truecolor">
- <summary>
- Each pixel is an RGB triple
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ColorType.Indexed">
- <summary>
- Each pixel is a palette index
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ColorType.GreyscaleAlpha">
- <summary>
- Each pixel is a greyscale sample followed by an alpha sample
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ColorType.TruecolorAlpha">
- <summary>
- EAch pixel is an RGB triple followed by an alhpa sample
- </summary>
- </member>
- <member name="T:DotSpatial.Data.Crc32">
- <summary>
- CRC32
- </summary>
- </member>
- <member name="F:DotSpatial.Data.Crc32._table">
- <summary>
- A table of values
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Crc32.GetCrcOld(System.Byte[])">
- <summary>
- Calculates the CRC-32-IEEE 802.3 Checkzum for png according to:
- x^32 + x^26 + x^23 + x^22 + x^16 + + x^12 + x^11 + x^10 + x^8 + x^7 + x^5 + x^4 + x^2 + x + 1
- </summary>
- <param name="value"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Crc32.ComputeChecksum(System.Byte[])">
- <summary>
- Computes the Checksum
- </summary>
- <param name="bytes"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Crc32.ComputeChecksumBytes(System.Byte[])">
- <summary>
- Computes the checksum bytes
- </summary>
- <param name="bytes"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Crc32.CreateTable2">
- <summary>
- Creates a table of checksum values
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Crc32.GetCrc2(System.Byte[])">
- <summary>
- Calculates the CRC-32-IEEE 802.3 Checkzum for png according to:
- x^32 + x^26 + x^23 + x^22 + x^16 + + x^12 + x^11 + x^10 + x^8 + x^7 + x^5 + x^4 + x^2 + x + 1
- </summary>
- <param name="value"></param>
- <returns>A UInt32 value stored in a long because UINT32 is not CLS compliant</returns>
- </member>
- <member name="M:DotSpatial.Data.Crc32.UpdateCrc(System.UInt32,System.Byte[],System.Int32)">
- <summary>
- Updates the running CRC
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Crc32.CreateTable">
- <summary>
- Creates the table according to the png specification
- </summary>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Data.Deflate">
- <summary>
- Deflated data content is widely understood by gzip utilities, but this system is specifically designed to work
- with png data format, and so will only work with code 8 compression strategy.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Deflate.Compress(System.Byte[])">
- <summary>
- Compress
- </summary>
- <param name="values"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Deflate.Decompress(System.Byte[])">
- <summary>
- Decompress
- </summary>
- <param name="values"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Data.InterlaceMethod">
- <summary>
- InterlaceMethods
- </summary>
- </member>
- <member name="F:DotSpatial.Data.InterlaceMethod.NoInterlacing">
- <summary>
- No interlacing
- </summary>
- </member>
- <member name="F:DotSpatial.Data.InterlaceMethod.Adam7">
- <summary>
- Adam7 interlacing
- </summary>
- </member>
- <member name="T:DotSpatial.Data.MwPng">
- <summary>
- mw.png provides read-write support for a png format that also can provide overviews etc.
- This cannot work with any possible png file, but rather provides at least one common
- format that can be used natively for large files that is better at compression than
- just storing the values directly.
- http://www.w3.org/TR/2003/REC-PNG-20031110/#11PLTE
- </summary>
- </member>
- <member name="M:DotSpatial.Data.MwPng.Write(System.Drawing.Bitmap,System.String)">
- <summary>
- For testing, see if we can write a png ourself that can be opened by .Net png.
- </summary>
- <param name="image">The image to write to png format</param>
- <param name="fileName">The string fileName</param>
- </member>
- <member name="M:DotSpatial.Data.MwPng.Read(System.String)">
- <summary>
- Reads a fileName into the specified bitmap.
- </summary>
- <param name="fileName"></param>
- <returns></returns>
- <exception cref="T:DotSpatial.Data.PngInvalidSignatureException">If the file signature doesn't match the png file signature</exception>
- </member>
- <member name="M:DotSpatial.Data.MwPng.SignatureIsValid(System.Byte[])">
- <summary>
- </summary>
- <param name="signature"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.MwPng.ToBytesAsUInt32(System.Int64)">
- <summary>
- Writes an in Big-endian Uint format.
- </summary>
- <param name="value"></param>
- </member>
- <member name="M:DotSpatial.Data.MwPng.Filter(System.Byte[],System.Int32,System.Int32,System.Int32)">
- <summary>
- Many rows may be evaluated by this process, but the first value in the array should
- be aligned with the left side of the image.
- </summary>
- <param name="refData">The original bytes to apply the PaethPredictor to.</param>
- <param name="offset">The integer offset in the array where the filter should begin application. If this is 0, then
- it assumes that there is no previous scan-line to work with.</param>
- <param name="length">The number of bytes to filter, starting at the specified offset. This should be evenly divisible by the width.</param>
- <param name="width">The integer width of a scan-line for grabbing the c and b bytes</param>
- <returns>The entire length of bytes starting with the specified offset</returns>
- </member>
- <member name="M:DotSpatial.Data.MwPng.UnFilter(System.Byte[],System.Int32,System.Int32,System.Int32)">
- <summary>
- Unfilters the data in order to reconstruct the original values.
- </summary>
- <param name="filterStream">The filtered but decompressed bytes</param>
- <param name="offset">the integer offset where reconstruction should begin</param>
- <param name="length">The integer length of bytes to deconstruct</param>
- <param name="width">The integer width of a scan-line in bytes (not counting any filter type bytes.</param>
- <returns></returns>
- <exception cref="T:DotSpatial.Data.PngInsuficientLengthException"></exception>
- </member>
- <member name="M:DotSpatial.Data.MwPng.PaethPredictor(System.Byte,System.Byte,System.Byte)">
- <summary>
- B C - For the current pixel X, use the best fit from B, C or A to predict X.
- A X
- </summary>
- <param name="a"></param>
- <param name="b"></param>
- <param name="c"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Data.PngHeader">
- <summary>
- PngHeader
- </summary>
- </member>
- <member name="F:DotSpatial.Data.PngHeader.CompressionMethod">
- <summary>
- At this time, the only compression method recognized is 0 - deflate/inflate with a
- sliding window of at most 32768 bytes
- </summary>
- </member>
- <member name="F:DotSpatial.Data.PngHeader.FilterMethod">
- <summary>
- At this time, only filter method 0 is outlined in the international standards.
- (adaptive filtering with 5 basic filter types)
- </summary>
- </member>
- <member name="M:DotSpatial.Data.PngHeader.#ctor(System.Int32,System.Int32)">
- <summary>
- Creates a new instance of PngHeader
- </summary>
- </member>
- <member name="M:DotSpatial.Data.PngHeader.Write(System.IO.Stream)">
- <summary>
- Writes the byte-format of this png image header chunk to
- </summary>
- <param name="stream"></param>
- </member>
- <member name="M:DotSpatial.Data.PngHeader.ToBytes">
- <summary>
- Returns the image header in bytes.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.PngHeader.WriteAsUint32(System.Byte[],System.Int32,System.Int64)">
- <summary>
- Writes an integer in Big-endian Uint format.
- </summary>
- <param name="array"></param>
- <param name="offset"></param>
- <param name="value"></param>
- </member>
- <member name="M:DotSpatial.Data.PngHeader.Write(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Writes an integer in Big-endian Uint format.
- </summary>
- <param name="array"></param>
- <param name="offset"></param>
- <param name="value"></param>
- </member>
- <member name="M:DotSpatial.Data.PngHeader.FromBytes(System.IO.Stream)">
- <summary>
- Reads the important content from the stream of bytes
- </summary>
- <param name="stream"></param>
- </member>
- <member name="P:DotSpatial.Data.PngHeader.BitDepth">
- <summary>
- Gets or sets the bit depth. Depending on the Color Type, not all are allowed:
- Greyscale - 1, 2, 4, 8, 16
- Truecolor - 8, 16
- Indexed - 1, 2, 4, 8
- Greyscale/alpha - 8, 16
- TrueColor/alpha - 8, 16
- </summary>
- </member>
- <member name="P:DotSpatial.Data.PngHeader.ColorType">
- <summary>
- Gets or sets the color type.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.PngHeader.Width">
- <summary>
- Gets or sets the width
- </summary>
- </member>
- <member name="P:DotSpatial.Data.PngHeader.Height">
- <summary>
- Gets or sets the height
- </summary>
- </member>
- <member name="P:DotSpatial.Data.PngHeader.InterlaceMethod">
- <summary>
- Gets or sets the interlacing method used for this image.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.PngInsuficientLengthException">
- <summary>
- PngInsuficientLengthException
- </summary>
- </member>
- <member name="M:DotSpatial.Data.PngInsuficientLengthException.#ctor(System.Int32,System.Int32,System.Int32)">
- <summary>
- Creates a new instance of PngInsuficientLengthException
- </summary>
- </member>
- <member name="T:DotSpatial.Data.PngInvalidSignatureException">
- <summary>
- PngInvalidSignatureException
- </summary>
- </member>
- <member name="M:DotSpatial.Data.PngInvalidSignatureException.#ctor">
- <summary>
- Creates a new instance of PngInvalidSignatureException
- </summary>
- </member>
- <member name="T:DotSpatial.Data.PyramidByteMismatchException">
- <summary>
- PyramidByteMismatch
- </summary>
- </member>
- <member name="T:DotSpatial.Data.PyramidException">
- <summary>
- PyramidException
- </summary>
- </member>
- <member name="M:DotSpatial.Data.PyramidException.#ctor(System.String)">
- <summary>
- Creates a new instance of PyramidException
- </summary>
- </member>
- <member name="M:DotSpatial.Data.PyramidByteMismatchException.#ctor">
- <summary>
- Creates a new instance of PyramidByteMismatch
- </summary>
- </member>
- <member name="T:DotSpatial.Data.PyramidHeader">
- <summary>
- PyramidHeader
- </summary>
- </member>
- <member name="M:DotSpatial.Data.PyramidHeader.HeaderSize">
- <summary>
- Calculates the header size for this
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Data.PyramidHeader.ImageHeaders">
- <summary>
- Gets or sets the array that encompasses all of the basic header content
- necessary for working with this image.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.PyramidImage">
- <summary>
- The Pyramid Image is designed with the expectation that the image will be too big to access all at once.
- It is stored with multiple resolutions in a "mwi or DotSpatial Image" format. It is raw bytes in argb order.
- The header content is stored in xml format.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.PyramidImage.#ctor">
- <summary>
- Creates a new instance of PyramidImage
- </summary>
- </member>
- <member name="M:DotSpatial.Data.PyramidImage.#ctor(System.String)">
- <summary>
- Creates a new PyramidImage by reading in the header content for the specified fileName.
- </summary>
- <param name="fileName"></param>
- </member>
- <member name="M:DotSpatial.Data.PyramidImage.#ctor(System.String,DotSpatial.Data.IRasterBounds)">
- <summary>
- Creates a new Pyramid image, and uses the raster bounds to specify the number or rows and columns.
- No data is written at this time.
- </summary>
- <param name="fileName"></param>
- <param name="bounds"></param>
- </member>
- <member name="M:DotSpatial.Data.PyramidImage.GetBitmap">
- <summary>
- For big images this won't work, but this gets the 0 scale original image as a bitmap.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.PyramidImage.GetBitmap(DotSpatial.Data.Extent,System.Drawing.Rectangle)">
- <summary>
- For big images the scale that is just one step larger than the specified window will be used.
- </summary>
- <param name="envelope"></param>
- <param name="window"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.PyramidImage.Open">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.PyramidImage.CreateHeaders">
- <summary>
- Creates the headers using the existing RasterBounds for this image
- </summary>
- </member>
- <member name="M:DotSpatial.Data.PyramidImage.CreateHeaders(DotSpatial.Data.RasterBounds)">
- <summary>
- This takes an original image and calculates the header content for all the lower resolution tiles.
- This does not actually write the bytes for those images.
- </summary>
- <param name="originalImage">The raster bounds for the original image.</param>
- </member>
- <member name="M:DotSpatial.Data.PyramidImage.CreateHeaders(System.Int32,System.Int32,System.Double[])">
- <summary>
- This takes an original image and calculates the header content for all the lower resolution tiles.
- This does not actually write the bytes for those images.
- </summary>
- <param name="numRows">The number of rows in the original image</param>
- <param name="numColumns">The number of columns in the original image</param>
- <param name="affineCoefficients">
- the array of doubles in ABCDEF order
- X' = A + Bx + Cy
- Y' = D + Ex + Fy
- </param>
- </member>
- <member name="M:DotSpatial.Data.PyramidImage.CreatePyramids2">
- <summary>
- This assumes that the base image has been written to the file. This will now attempt to calculate
- the down-sampled images.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.PyramidImage.CreatePyramids">
- <summary>
- This assumes that the base image has been written to the file. This will now attempt to calculate
- the down-sampled images.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.PyramidImage.DownSample(System.Byte[])">
- <summary>
- downsamples this row by selecting every other byte
- </summary>
- <param name="row"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.PyramidImage.Blur(System.Byte[],System.Byte[],System.Byte[])">
- <summary>
- This is normally weighted for calculations for the middle row. If the top or bottom row
- is null, it will use mirror symetry by grabbing values from the other row instead.
- </summary>
- <param name="r1"></param>
- <param name="r2"></param>
- <param name="r3"></param>
- </member>
- <member name="M:DotSpatial.Data.PyramidImage.ReadWindow(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
- <summary>
- This writes a window of byte values (ARGB order) to the file. This assumes that the headers already exist.
- If the headers have not been created or the bounds extend beyond the header numRows and numColumns for the
- specified scale, this will throw an exception.
- </summary>
- <param name="startRow">The integer start row</param>
- <param name="startColumn">The integer start column</param>
- <param name="numRows">The integer number of rows in the window</param>
- <param name="numColumns">The integer number of columns in the window</param>
- <param name="scale">The integer scale. 0 is the original image.</param>
- <returns>The bytes created by this process</returns>
- <exception cref="T:DotSpatial.Data.PyramidUndefinedHeaderException">Occurs when attempting to write data before the headers are defined</exception>
- <exception cref="T:DotSpatial.Data.PyramidOutOfBoundsException">Occurs if the range specified is outside the bounds for the specified image scale</exception>
- </member>
- <member name="M:DotSpatial.Data.PyramidImage.WriteWindow(System.Byte[],System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
- <summary>
- This writes a window of byte values (ARGB order) to the file. This assumes that the headers already exist.
- If the headers have not been created or the bounds extend beyond the header numRows and numColumns for the
- specified scale, this will throw an exception.
- </summary>
- <param name="bytes">The byte array</param>
- <param name="startRow">The integer start row</param>
- <param name="startColumn">The integer start column</param>
- <param name="numRows">The integer number of rows in the window</param>
- <param name="numColumns">The integer number of columns in the window</param>
- <param name="scale">The integer scale. 0 is the original image.</param>
- <exception cref="T:DotSpatial.Data.PyramidUndefinedHeaderException">Occurs when attempting to write data before the headers are defined</exception>
- <exception cref="T:DotSpatial.Data.PyramidOutOfBoundsException">Occurs if the range specified is outside the bounds for the specified image scale</exception>
- </member>
- <member name="M:DotSpatial.Data.PyramidImage.WriteWindow(System.Byte[],System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,DotSpatial.Data.ProgressMeter)">
- <summary>
- This writes a window of byte values (ARGB order) to the file. This assumes that the headers already exist.
- If the headers have not been created or the bounds extend beyond the header numRows and numColumns for the
- specified scale, this will throw an exception.
- </summary>
- <param name="bytes">The byte array</param>
- <param name="startRow">The integer start row</param>
- <param name="startColumn">The integer start column</param>
- <param name="numRows">The integer number of rows in the window</param>
- <param name="numColumns">The integer number of columns in the window</param>
- <param name="scale">The integer scale. 0 is the original image.</param>
- <param name="pm">The progress meter to advance by row. Calls Next() for each row.</param>
- <exception cref="T:DotSpatial.Data.PyramidUndefinedHeaderException">Occurs when attempting to write data before the headers are defined</exception>
- <exception cref="T:DotSpatial.Data.PyramidOutOfBoundsException">Occurs if the range specified is outside the bounds for the specified image scale</exception>
- </member>
- <member name="M:DotSpatial.Data.PyramidImage.ReadHeader(System.String)">
- <summary>
- Reads the header only from the specified mwi file. The header is in xml format.
- This is a test. We may have to jurry rig the thing to ensure it ignores the actual
- image content.
- </summary>
- <param name="fileName">Whether this is the mwi or mwh file, this reads the mwh file for the fileName.</param>
- </member>
- <member name="M:DotSpatial.Data.PyramidImage.WriteHeader(System.String)">
- <summary>
- Writes the header to the specified fileName.
- </summary>
- <param name="fileName">The string fileName to write the header to.</param>
- </member>
- <member name="M:DotSpatial.Data.PyramidImage.ReadBlock(System.Int32,System.Int32,System.Int32,System.Int32)">
- <summary>
- Gets a block of data directly, converted into a bitmap. This is a general
- implementation, so assumes you are reading and writing to the 0 scale.
- This is always in ARGB format.
- </summary>
- <param name="xOffset">The zero based integer column offset from the left</param>
- <param name="yOffset">The zero based integer row offset from the top</param>
- <param name="xSize">The integer number of pixel columns in the block. </param>
- <param name="ySize">The integer number of pixel rows in the block.</param>
- <returns>A Bitmap that is xSize, ySize.</returns>
- </member>
- <member name="M:DotSpatial.Data.PyramidImage.WriteBlock(System.Drawing.Bitmap,System.Int32,System.Int32)">
- <summary>
- Saves a bitmap of data as a continuous block into the specified location. This
- is a general implementation, so assumes you are reading and writing to the 0 scale.
- This should be in ARGB pixel format or it will fail.
- </summary>
- <param name="value">The bitmap value to save.</param>
- <param name="xOffset">The zero based integer column offset from the left</param>
- <param name="yOffset">The zero based integer row offset from the top</param>
- </member>
- <member name="M:DotSpatial.Data.PyramidImage.UpdateOverviews">
- <summary>
- Updates overviews. In the case of a Pyramid image, this recalculates the values.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.PyramidImage.Header">
- <summary>
- Gets or sets the pyramid image header
- </summary>
- </member>
- <member name="T:DotSpatial.Data.PyramidImageHeader">
- <summary>
- PyramidImageHeader
- </summary>
- </member>
- <member name="M:DotSpatial.Data.PyramidImageHeader.SetAffine(System.Double[],System.Int32)">
- <summary>
- Scale is an integer value that starts at 0 for the original image and represents the number of
- times the number of columns and number of rows are divided by 2.
- </summary>
- <param name="affine">The affine array of the original, unmodified image</param>
- <param name="scale">The integer scale starting at 0 for the original image, and increasing by one for each down-sampling</param>
- </member>
- <member name="M:DotSpatial.Data.PyramidImageHeader.SetNumRows(System.Int32,System.Int32)">
- <summary>
- Sets the number of rows based on the integer scale
- </summary>
- <param name="originalNumRows"></param>
- <param name="scale">integer starts at 0 for the original image</param>
- </member>
- <member name="M:DotSpatial.Data.PyramidImageHeader.SetNumColumns(System.Int32,System.Int32)">
- <summary>
- Sets the number of columns based on the integer scale
- </summary>
- <param name="originalNumColumns"></param>
- <param name="scale">integer starts at 0 for the original image</param>
- </member>
- <member name="P:DotSpatial.Data.PyramidImageHeader.Offset">
- <summary>
- Offsets
- </summary>
- </member>
- <member name="P:DotSpatial.Data.PyramidImageHeader.NumRows">
- <summary>
- Integer number of rows
- </summary>
- </member>
- <member name="P:DotSpatial.Data.PyramidImageHeader.NumColumns">
- <summary>
- Integer number of columns
- </summary>
- </member>
- <member name="P:DotSpatial.Data.PyramidImageHeader.Affine">
- <summary>
- Gets or sets the affine coefficients for this image in ABCDEF order
- X' = A + BX + CY
- Y' = D + EX + FY
- </summary>
- </member>
- <member name="T:DotSpatial.Data.PyramidOutOfBoundsException">
- <summary>
- PyramidOutOfBoundsException
- </summary>
- </member>
- <member name="M:DotSpatial.Data.PyramidOutOfBoundsException.#ctor">
- <summary>
- Creates a new instance of PyramidOutOfBoundsException
- </summary>
- </member>
- <member name="T:DotSpatial.Data.PyramidUndefinedHeaderException">
- <summary>
- PyramidUndefinedHeader
- </summary>
- </member>
- <member name="M:DotSpatial.Data.PyramidUndefinedHeaderException.#ctor">
- <summary>
- Creates a new instance of PyramidUndefinedHeader
- </summary>
- </member>
- <member name="T:DotSpatial.Data.TileCollection">
- <summary>
- TileCollection
- </summary>
- </member>
- <member name="M:DotSpatial.Data.TileCollection.GetEnumerator">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Data.TileCollection.#ctor(System.Int32,System.Int32)">
- <summary>
- Creates a new instance of TileCollection
- </summary>
- </member>
- <member name="M:DotSpatial.Data.TileCollection.SetTileBounds(System.Double[])">
- <summary>
- Calls a method that calculates the propper image bounds for each of the extents of the tiles,
- given the affine coefficients for the whole image.
- </summary>
- <param name="affine"> x' = A + Bx + Cy; y' = D + Ex + Fy</param>
- </member>
- <member name="M:DotSpatial.Data.TileCollection.GetTileWidth(System.Int32)">
- <summary>
- Gets the width of the tile
- </summary>
- <param name="col"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.TileCollection.GetTileHeight(System.Int32)">
- <summary>
- Gets the height of the tile
- </summary>
- <param name="row"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.TileCollection.NumTilesWide">
- <summary>
- Gets the number of tiles in the X direction
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.TileCollection.NumTilesTall">
- <summary>
- Gets the integer number of tiles in the Y direction
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Data.TileCollection.Height">
- <summary>
- Gets or sets the integer height in pixels for the combined image at its maximum resolution
- </summary>
- </member>
- <member name="P:DotSpatial.Data.TileCollection.Width">
- <summary>
- Gets or sets the integer pixel width for the combined image at its maximum resolution.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.TileCollection.Tiles">
- <summary>
- Gets or sets the 2D array of tiles
- </summary>
- </member>
- <member name="P:DotSpatial.Data.TileCollection.TileWidth">
- <summary>
- The width of the standard sized tile (not counting the remainder)
- </summary>
- </member>
- <member name="P:DotSpatial.Data.TileCollection.TileHeight">
- <summary>
- The height of the standard sized tile, not counting the remainder.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.TileCollection.NumTiles">
- <summary>
- The total number of tiles
- </summary>
- </member>
- <member name="T:DotSpatial.Data.TileCollection.TileCollectionEnumerator">
- <summary>
- Enumerates the collection of tiles
- </summary>
- </member>
- <member name="M:DotSpatial.Data.TileCollection.TileCollectionEnumerator.#ctor(DotSpatial.Data.TileCollection)">
- <summary>
- Creates a new instance of hte TileCollectionEnumerator
- </summary>
- <param name="parent">The parent tileCollection</param>
- </member>
- <member name="M:DotSpatial.Data.TileCollection.TileCollectionEnumerator.Dispose">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Data.TileCollection.TileCollectionEnumerator.MoveNext">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Data.TileCollection.TileCollectionEnumerator.Reset">
- <inheritdoc />
- </member>
- <member name="P:DotSpatial.Data.TileCollection.TileCollectionEnumerator.Current">
- <inheritdoc />
- </member>
- <member name="T:DotSpatial.Data.TiledImage">
- <summary>
- TiledImage is a special kind of image coverage where the images specifically form tiles that
- are adjacent and perfectly aligned to represent a larger image.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.TiledImage.#ctor(System.String)">
- <summary>
- Creates a new instance of the TiledImage where the fileName is specified.
- This doesn't actually open the file until the Open method is called.
- </summary>
- <param name="fileName"></param>
- </member>
- <member name="M:DotSpatial.Data.TiledImage.#ctor(System.Int32,System.Int32)">
- <summary>
- Creates a new instance of TiledImage
- </summary>
- </member>
- <member name="M:DotSpatial.Data.TiledImage.Open">
- <summary>
- This should be overridden with custom file handling
- </summary>
- </member>
- <member name="M:DotSpatial.Data.TiledImage.GetBitmap(DotSpatial.Data.Extent,System.Drawing.Size)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Data.TiledImage.Close">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Data.TiledImage.Init(System.Int32,System.Int32)">
- <summary>
- Even if this TiledImage has already been constructed, we can initialize the tile collection later.
- </summary>
- <param name="width"></param>
- <param name="height"></param>
- </member>
- <member name="M:DotSpatial.Data.TiledImage.SetTileBounds(System.Double[])">
- <summary>
- Calls a method that calculates the proper image bounds for each of the extents of the tiles,
- given the affine coefficients for the whole image.
- </summary>
- <param name="affine"> x' = A + Bx + Cy; y' = D + Ex + Fy</param>
- </member>
- <member name="M:DotSpatial.Data.TiledImage.CopyValues(DotSpatial.Data.IImageData)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Data.TiledImage.GetBitmap">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Data.TiledImage.GetBitmap(DotSpatial.Data.Extent,System.Drawing.Rectangle)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Data.TiledImage.GetColor(System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Data.TiledImage.CopyBitmapToValues">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Data.TiledImage.Save">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Data.TiledImage.SaveAs(System.String)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Data.TiledImage.SetColor(System.Int32,System.Int32,System.Drawing.Color)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Data.TiledImage.CopyValuesToBitmap">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Data.TiledImage.SetBitmap(System.Drawing.Bitmap)">
- <summary>
- Not Implemented
- </summary>
- <param name="image"></param>
- </member>
- <member name="M:DotSpatial.Data.TiledImage.GetColorPalette">
- <summary>
- Not Implemented.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.TiledImage.SetColorPalette(System.Collections.Generic.IEnumerable{System.Drawing.Color})">
- <summary>
- Not Implemented
- </summary>
- <param name="value"></param>
- </member>
- <member name="M:DotSpatial.Data.TiledImage.ReadBlock(System.Int32,System.Int32,System.Int32,System.Int32)">
- <summary>
- Not implemented
- </summary>
- <param name="xOffset"></param>
- <param name="yOffset"></param>
- <param name="xSize"></param>
- <param name="ySize"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.TiledImage.WriteBlock(System.Drawing.Bitmap,System.Int32,System.Int32)">
- <summary>
- Not Implemented
- </summary>
- <param name="value"></param>
- <param name="xOffset"></param>
- <param name="yOffset"></param>
- </member>
- <member name="M:DotSpatial.Data.TiledImage.UpdateOverviews">
- <summary>
- Not implemented
- </summary>
- </member>
- <member name="M:DotSpatial.Data.TiledImage.GetImages">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Data.TiledImage.Dispose(System.Boolean)">
- <inheritdoc />
- </member>
- <member name="P:DotSpatial.Data.TiledImage.Tiles">
- <summary>
- Gets or sets the array of tiles used for this
- </summary>
- </member>
- <member name="P:DotSpatial.Data.TiledImage.TileCollection">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Data.TiledImage.Filename">
- <inheritdoc />
- </member>
- <member name="P:DotSpatial.Data.TiledImage.Height">
- <inheritdoc />
- </member>
- <member name="P:DotSpatial.Data.TiledImage.Stride">
- <inheritdoc />
- </member>
- <member name="P:DotSpatial.Data.TiledImage.Width">
- <inheritdoc />
- </member>
- <member name="P:DotSpatial.Data.TiledImage.NumBands">
- <summary>
- Gets or sets the number of bands
- </summary>
- </member>
- <member name="P:DotSpatial.Data.TiledImage.BytesPerPixel">
- <inheritdoc />
- </member>
- <member name="P:DotSpatial.Data.TiledImage.Values">
- <inheritdoc />
- </member>
- <member name="P:DotSpatial.Data.TiledImage.BandType">
- <summary>
- Not Implemented
- </summary>
- </member>
- <member name="P:DotSpatial.Data.TiledImage.TileWidth">
- <inheritdoc />
- </member>
- <member name="P:DotSpatial.Data.TiledImage.TileHeight">
- <inheritdoc />
- </member>
- <member name="P:DotSpatial.Data.TiledImage.Count">
- <inheritdoc />
- </member>
- <member name="P:DotSpatial.Data.TiledImage.Extent">
- <inheritdoc />
- </member>
- <member name="P:DotSpatial.Data.TiledImage.WorldFile">
- <summary>
- Gets or sets the WorldFile for this set of tiles.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.WorldFile">
- <summary>
- WorldFiles complement images, giving georeference information for those images. The basic idea is to calculate
- everything based on the top left corner of the image.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.WorldFile.#ctor">
- <summary>
- Creates a new instance of WorldFile
- </summary>
- </member>
- <member name="M:DotSpatial.Data.WorldFile.#ctor(System.String)">
- <summary>
- Automatically creates a new worldfile based on the specified image fileName.
- </summary>
- <param name="imageFilename">Attempts to open the fileName for the world file for the image if it exists.</param>
- </member>
- <member name="M:DotSpatial.Data.WorldFile.GetExtension(System.Drawing.Imaging.ImageFormat)">
- <summary>
- Returns the string extensions that accompanies one of the dot net image formats.
- </summary>
- <param name="format">The Imaging.ImageFormat for the image itself</param>
- <returns>The string extension</returns>
- </member>
- <member name="M:DotSpatial.Data.WorldFile.GenerateFilename(System.String)">
- <summary>
- Given the fileName of an image, this creates a new fileName with the appropriate extension.
- This will also set the fileName of this world file to that extension.
- </summary>
- <param name="imageFilename">The fileName of the image</param>
- <returns>the fileName of the world file</returns>
- </member>
- <member name="M:DotSpatial.Data.WorldFile.Open">
- <summary>
- Opens the worldfile specified by the Filename property and loads the values
- </summary>
- </member>
- <member name="M:DotSpatial.Data.WorldFile.Open(System.String)">
- <summary>
- Opens an existing worldfile based on the specified fileName
- </summary>
- <param name="fileName"></param>
- </member>
- <member name="M:DotSpatial.Data.WorldFile.Save">
- <summary>
- Saves the current affine coordinates to the current fileName
- </summary>
- </member>
- <member name="M:DotSpatial.Data.WorldFile.SaveAs(System.String)">
- <summary>
- Saves the current coordinates to a file
- </summary>
- <param name="fileName">Gets or sets the fileName to use for an image</param>
- </member>
- <member name="M:DotSpatial.Data.WorldFile.ToMatrix">
- <summary>
- Creates a Matrix that is in float coordinates that represents this world file
- </summary>
- <returns>A Matrix that transforms an image to the geographic coordinates</returns>
- </member>
- <member name="P:DotSpatial.Data.WorldFile.Affine">
- <summary>
- gets the coordinates in the Affine order:
- X' = [0] + [1] X + [2] Y
- Y' = [3] + [4] X + [5] Y
- </summary>
- </member>
- <member name="P:DotSpatial.Data.WorldFile.Filename">
- <summary>
- Gets or sets the fileName to use for this world file.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.WorldFile.CellHeight">
- <summary>
- Gets or sets the cellHeight
- </summary>
- </member>
- <member name="P:DotSpatial.Data.WorldFile.CellWidth">
- <summary>
- Gets or sets the cellWidth
- </summary>
- </member>
- <member name="P:DotSpatial.Data.WorldFile.TopLeftX">
- <summary>
- Gets or sets longitude or X position corresponding to the center of the cell in the top left corner of the image
- </summary>
- </member>
- <member name="P:DotSpatial.Data.WorldFile.TopLeftY">
- <summary>
- Gets or sets the latitude or Y position corresponding to the center of the cell in the top left corner of the image
- </summary>
- </member>
- <member name="P:DotSpatial.Data.WorldFile.HorizontalSkew">
- <summary>
- Gets or sets how much the longitude or X position of a cell in the image depends on the row position of the cell.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.WorldFile.VerticalSkew">
- <summary>
- Gets or sets how much the latitude or Y position of a cell in the image depends on the column position of the cell.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.WorldFile.DialogFilter">
- <summary>
- Gets a string list of file extensions that might apply to world files.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.HfaCoordinate">
- <summary>
- Coordinate
- </summary>
- </member>
- <member name="F:DotSpatial.Data.HfaCoordinate.X">
- <summary>
- Coordinate x-value
- </summary>
- </member>
- <member name="F:DotSpatial.Data.HfaCoordinate.Y">
- <summary>
- coordinate y-value
- </summary>
- </member>
- <member name="T:DotSpatial.Data.HfaDatum">
- <summary>
- Datum
- </summary>
- </member>
- <member name="M:DotSpatial.Data.HfaDatum.#ctor">
- <summary>
- Creates a new instance of Datum
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaDatum.Name">
- <summary>
- Gets or sets the name of the datum
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaDatum.Type">
- <summary>
- Gets or sets the datum type
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaDatum.Params">
- <summary>
- Gets or sets the parameters for the Parametric datum type
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaDatum.GridName">
- <summary>
- Gets or sets the string name of the grid file
- </summary>
- </member>
- <member name="T:DotSpatial.Data.HfaDatumType">
- <summary>
- HfaDatumType
- </summary>
- </member>
- <member name="F:DotSpatial.Data.HfaDatumType.Parametric">
- <summary>
- The datum info is 7 doubles
- </summary>
- </member>
- <member name="F:DotSpatial.Data.HfaDatumType.Grid">
- <summary>
- The datum info is a name
- </summary>
- </member>
- <member name="F:DotSpatial.Data.HfaDatumType.Regression">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Data.HfaDatumType.None">
- <summary>
- No Datum info
- </summary>
- </member>
- <member name="T:DotSpatial.Data.HfaEPRJ">
- <summary>
- ERDAS Projection Codes
- </summary>
- </member>
- <member name="T:DotSpatial.Data.HfaEPT">
- <summary>
- EPT ERDAS DATA TYPES
- </summary>
- </member>
- <member name="F:DotSpatial.Data.HfaEPT.U1">
- <summary>
- Unsigned 1 bit
- </summary>
- </member>
- <member name="F:DotSpatial.Data.HfaEPT.U2">
- <summary>
- Unsigned 2 bit
- </summary>
- </member>
- <member name="F:DotSpatial.Data.HfaEPT.U4">
- <summary>
- Unsigned 4 bit
- </summary>
- </member>
- <member name="F:DotSpatial.Data.HfaEPT.U8">
- <summary>
- Unsigned 8 bit
- </summary>
- </member>
- <member name="F:DotSpatial.Data.HfaEPT.S8">
- <summary>
- Signed 8 bit
- </summary>
- </member>
- <member name="F:DotSpatial.Data.HfaEPT.U16">
- <summary>
- Unsigned 16 bit
- </summary>
- </member>
- <member name="F:DotSpatial.Data.HfaEPT.S16">
- <summary>
- Signed 16 bit
- </summary>
- </member>
- <member name="F:DotSpatial.Data.HfaEPT.U32">
- <summary>
- Unsigned 32 bit
- </summary>
- </member>
- <member name="F:DotSpatial.Data.HfaEPT.S32">
- <summary>
- Signed 32 bit
- </summary>
- </member>
- <member name="F:DotSpatial.Data.HfaEPT.Single">
- <summary>
- Single precisions 32 bit floating point
- </summary>
- </member>
- <member name="F:DotSpatial.Data.HfaEPT.Double">
- <summary>
- Double precision 64 bit floating point
- </summary>
- </member>
- <member name="F:DotSpatial.Data.HfaEPT.Char64">
- <summary>
- 64 bit character?
- </summary>
- </member>
- <member name="F:DotSpatial.Data.HfaEPT.Char128">
- <summary>
- 128 bit character?
- </summary>
- </member>
- <member name="T:DotSpatial.Data.HfaExt">
- <summary>
- Extension Methods useful for the DotSpatial.Data.Img content
- </summary>
- </member>
- <member name="M:DotSpatial.Data.HfaExt.ExtractTo(System.String,System.Int32@,System.String)">
- <summary>
- A common task seems to be parsing the text up to a certain delimiter
- starting from a certain index, and then advancing the string pointer.
- This advances the index, extracting the string up to the point of the
- specified delimeter, or the end of the string, and advancing the string
- past the delimeter itself. If the index is equal to the length,
- then you are at the end of the string.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.HfaExt.ExtractInteger(System.String)">
- <summary>
- Given a string, this reads digits into a numeric value.
- </summary>
- <param name="input">The string to read the integer from</param>
- <returns>An integer read from the string</returns>
- </member>
- <member name="M:DotSpatial.Data.HfaExt.ExtractTo(System.String,System.String,System.String@)">
- <summary>
- This variant of the ExtractTo algorithm effectively splits the string into teh content
- before the delimeter and after the delimeter, not counting the delimeter.
- </summary>
- <param name="input">The string input</param>
- <param name="delimeter">The string delimeter</param>
- <param name="remainder">the string remainder</param>
- </member>
- <member name="M:DotSpatial.Data.HfaExt.SkipTo(System.String,System.String)">
- <summary>
- This method returns a substring based on the next occurance of the
- specified delimeter.
- </summary>
- <param name="input">The string input</param>
- <param name="delimeter">The delimeter</param>
- </member>
- <member name="T:DotSpatial.Data.Hfa">
- <summary>
- Hfa
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Hfa.GetBitCount(DotSpatial.Data.HfaEPT)">
- <summary>
- Gets the bitcount of a single member of the specified data type.
- </summary>
- <param name="dataType">The data type to get the byte count of</param>
- <returns>An integer that represents the bit count of the specified type</returns>
- </member>
- <member name="M:DotSpatial.Data.Hfa.LittleEndian(System.Byte[])">
- <summary>
- Reverses the byte order on Big-Endian systems like Unix to conform with the
- HFA standard of little endian.
- </summary>
- <param name="value"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Hfa.ReadType(System.Byte[],System.Int64)">
- <summary>
- Return ReadType
- </summary>
- <param name="data"></param>
- <param name="offset"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Hfa.ReadInt16(System.Byte[],System.Int64)">
- <summary>
- Given the byte array, this reads four bytes and converts this to a 32 bit integer.
- This always uses little endian byte order.
- </summary>
- <param name="data"></param>
- <param name="offset"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Hfa.ReadUInt16(System.Byte[],System.Int64)">
- <summary>
- Given the byte array, this reads four bytes and converts this to a 16 bit unsigned short integer.
- This always uses little endian byte order.
- </summary>
- <param name="data"></param>
- <param name="offset"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Hfa.ReadInt32(System.Byte[],System.Int64)">
- <summary>
- Given the byte array, this reads four bytes and converts this to a 32 bit integer.
- This always uses little endian byte order.
- </summary>
- <param name="data"></param>
- <param name="offset"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Hfa.ReadSingle(System.Byte[],System.Int64)">
- <summary>
- Given the byte array, this reads four bytes and converts this to a 32 bit floating point value
- This always uses little endian byte order.
- </summary>
- <param name="data"></param>
- <param name="offset"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Hfa.ReadDouble(System.Byte[],System.Int64)">
- <summary>
- Given the byte array, this reads four bytes and converts this to a 64 bit floating point value
- This always uses little endian byte order.
- </summary>
- <param name="data"></param>
- <param name="offset"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Hfa.ReadUInt32(System.Byte[],System.Int64)">
- <summary>
- Given the byte array, this reads four bytes and converts this to a 32 bit unsigned integer.
- This always uses little endian byte order.
- </summary>
- <param name="data"></param>
- <param name="offset"></param>
- <returns>A UInt32 value stored in a long because UInt32 is not CLS Compliant</returns>
- </member>
- <member name="M:DotSpatial.Data.Hfa.LittleEndianAsUint32(System.Int64)">
- <summary>
- Obtains the 4 byte equivalent for 32 bit Unsigned Integer values
- </summary>
- <param name="value">The unsigned integer value to convert into bytes</param>
- <returns>The bytes in LittleEndian standard, regardless of the system architecture</returns>
- </member>
- <member name="M:DotSpatial.Data.Hfa.LittleEndian(System.Int32)">
- <summary>
- Obtains the 4 byte equivalent for 32 bit Integer values
- </summary>
- <param name="value">The unsigned integer value to convert into bytes</param>
- <returns>The bytes in LittleEndian standard, regardless of the system architecture</returns>
- </member>
- <member name="M:DotSpatial.Data.Hfa.LittleEndian(System.Single)">
- <summary>
- Obtains the 4 byte equivalent for 32bit floating point values
- </summary>
- <param name="value">The unsigned integer value to convert into bytes</param>
- <returns>The bytes in LittleEndian standard, regardless of the system architecture</returns>
- </member>
- <member name="M:DotSpatial.Data.Hfa.LittleEndian(System.Double)">
- <summary>
- Obtains the 8 byte equivalent for 64 bit floating point values
- </summary>
- <param name="value">The unsigned integer value to convert into bytes</param>
- <returns>The bytes in LittleEndian standard, regardless of the system architecture</returns>
- </member>
- <member name="M:DotSpatial.Data.Hfa.LittleEndianAsUShort(System.Int32)">
- <summary>
- Gets the 2 byte equivalent of an unsigned short in little endian format
- </summary>
- <param name="value"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Hfa.LittleEndian(System.Int16)">
- <summary>
- Gets the 2 byte equivalent of a short in little endian format
- </summary>
- <param name="value"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Data.HfaAccess">
- <summary>
- HfaAccess
- </summary>
- </member>
- <member name="F:DotSpatial.Data.HfaAccess.ReadOnly">
- <summary>
- Read Only with no update access
- </summary>
- </member>
- <member name="F:DotSpatial.Data.HfaAccess.Update">
- <summary>
- Read/Write access
- </summary>
- </member>
- <member name="T:DotSpatial.Data.HfaCompress">
- <summary>
- HfaCompress - Development on hold, commented out to reduce warnings
- </summary>
- </member>
- <member name="T:DotSpatial.Data.HfaDictionary">
- <summary>
- HfaDictionary
- </summary>
- </member>
- <member name="M:DotSpatial.Data.HfaDictionary.#ctor(System.String)">
- <summary>
- Creates a new instance of HfaDictionary
- </summary>
- </member>
- <member name="M:DotSpatial.Data.HfaDictionary.AddType(DotSpatial.Data.HfaType)">
- <summary>
- Adds the type using the TypeName as the key
- </summary>
- <param name="type">The type to add</param>
- </member>
- <member name="M:DotSpatial.Data.HfaDictionary.Dump(System.IO.Stream)">
- <summary>
- Writes all the elements from this dictionary to the specified stream.
- </summary>
- <param name="fp"></param>
- </member>
- <member name="M:DotSpatial.Data.HfaDictionary.GetItemSize(System.Char)">
- <summary>
- Given a character type, this calculates a size. This was originally
- on the Dictionary, but I moved this to the HfaInfo instead.
- </summary>
- <param name="charType"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Data.HfaEntry">
- <summary>
- HfaEntry
- </summary>
- </member>
- <member name="M:DotSpatial.Data.HfaEntry.#ctor(DotSpatial.Data.HfaInfo,System.Int64,DotSpatial.Data.HfaEntry,DotSpatial.Data.HfaEntry)">
- <summary>
- Creates a new instance of HfaEntry from the file
- </summary>
- </member>
- <member name="M:DotSpatial.Data.HfaEntry.#ctor(DotSpatial.Data.HfaInfo,System.String,System.String,DotSpatial.Data.HfaEntry)">
- <summary>
- Create a new instance of the entry with the intention that it would
- be written to disk later
- </summary>
- <param name="hfaIn"></param>
- <param name="name"></param>
- <param name="typename"></param>
- <param name="parent"></param>
- </member>
- <member name="M:DotSpatial.Data.HfaEntry.#ctor">
- <summary>
- Creates a new instance of HfaEntry
- </summary>
- </member>
- <member name="M:DotSpatial.Data.HfaEntry.LoadData">
- <summary>
- Loads the data bytes for this element from the file
- </summary>
- </member>
- <member name="M:DotSpatial.Data.HfaEntry.GetFirstChildName(System.String)">
- <summary>
- Parses a name which may have an unwanted : or multiple sub-tree
- names separated with periods.
- </summary>
- <param name="name"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.HfaEntry.GetSubtreeName(System.String)">
- <summary>
- If this is null, then there is no further subtree
- </summary>
- <param name="name"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.HfaEntry.GetNamedChild(System.String)">
- <summary>
- This parses a complete "path" separated by periods in order
- to search for a specific child node.
- </summary>
- <param name="name"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.HfaEntry.GetFirstChild">
- <summary>
- Gets or sets the HfaEntry that is the child
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaEntry.IsDirty">
- <summary>
- Gets or sets a boolean indicating if this is changed
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaEntry.FilePos">
- <summary>
- Gets or sets the long integer file position
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaEntry.Hfa">
- <summary>
- Gets or sets the HFA Info
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaEntry.Parent">
- <summary>
- Gets or sets the hfa parent
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaEntry.Prev">
- <summary>
- Gets or sets the previous entry
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaEntry.NextPos">
- <summary>
- Gets or sets the long integer position of the next entry in the file
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaEntry.Next">
- <summary>
- Gets or sets the HfaEntry that is the next entry
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaEntry.ChildPos">
- <summary>
- Gets or sets the long position of the child
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaEntry.Name">
- <summary>
- Gets or sets the 64 character name of the entry
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaEntry.TypeName">
- <summary>
- gets or sets the 32 character typestring
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaEntry.Type">
- <summary>
- Gets or sets the type for this entry
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaEntry.DataPos">
- <summary>
- The GUInt32 Data Position of this entry
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaEntry.DataSize">
- <summary>
- The GUInt32 Data Size of this entry
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaEntry.Data">
- <summary>
- Gets the data for this entry
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaEntry.Children">
- <summary>
- Gets or sets the collection of all the children.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaEntry.Child">
- <summary>
- Gets or sets the first child belonging to this entry.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.HfaEnumerationNotFoundException">
- <summary>
- HfaEnumerationNotFoundException
- </summary>
- </member>
- <member name="M:DotSpatial.Data.HfaEnumerationNotFoundException.#ctor(System.String)">
- <summary>
- Creates a new instance of HfaEnumerationNotFoundException
- </summary>
- </member>
- <member name="T:DotSpatial.Data.HfaField">
- <summary>
- HfaField
- </summary>
- </member>
- <member name="M:DotSpatial.Data.HfaField.CompleteDefn(DotSpatial.Data.HfaDictionary)">
- <summary>
-
- </summary>
- <param name="dict"></param>
- </member>
- <member name="M:DotSpatial.Data.HfaField.Dump(System.IO.Stream)">
- <summary>
- This writes formatted content for this field to the specified IO stream.
- </summary>
- <param name="stream">The stream to write to.</param>
- </member>
- <member name="M:DotSpatial.Data.HfaField.DumpInstValue(System.IO.Stream,System.Byte[],System.Int64,System.Int32,System.String)">
- <summary>
-
- </summary>
- <param name="fpOut"></param>
- <param name="data"></param>
- <param name="dataOffset"></param>
- <param name="dataSize"></param>
- <param name="prefix"></param>
- </member>
- <member name="M:DotSpatial.Data.HfaField.SetInstValue(System.String,System.Int32,System.Byte[],System.Int64,System.Int32,System.Char,System.Object)">
- <summary>
- SetInstValue
- </summary>
- <param name="sField"></param>
- <param name="indexValue"></param>
- <param name="data"></param>
- <param name="dataOffset"></param>
- <param name="dataSize"></param>
- <param name="reqType"></param>
- <param name="value"></param>
- <exception cref="T:DotSpatial.Data.HfaPointerInsertNotSupportedException">Attempting to insert a pointer is not supported.</exception>
- <exception cref="T:DotSpatial.Data.HfaEnumerationNotFoundException">Occurs if the specified value is not a valid member of the enumeration for this field.</exception>
- </member>
- <member name="M:DotSpatial.Data.HfaField.GetInstBytes(System.Byte[],System.Int64)">
- <summary>
- Scans through the array and estimates the byte size of the field in this case.
- </summary>
- <param name="data"></param>
- <param name="dataOffset"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.HfaField.GetInstCount(System.Byte[],System.Int64)">
- <summary>
- Gets the count for a particular instance of a field. This will normally be
- the built in value, but for variable fields, this is extracted from the
- data itself.
- </summary>
- <param name="data"></param>
- <param name="dataOffset"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.HfaField.ExtractInstValue(System.String,System.Int32,System.Byte[],System.Int64,System.Int32,System.Char,System.Object@,System.Int32@)">
- <summary>
-
- </summary>
- <param name="pszField"></param>
- <param name="nIndexValue"></param>
- <param name="data"></param>
- <param name="dataOffset"></param>
- <param name="nDataSize"></param>
- <param name="reqType"></param>
- <param name="pReqReturn"></param>
- <param name="extraOffset">This is used in the case of 'object' pointers where the indexed object is further in the data block.</param>
- <returns></returns>
- <exception cref="T:DotSpatial.Data.HfaInvalidCountException">Occurs if the count is less than zero for the header of a block of base data</exception>
- </member>
- <member name="M:DotSpatial.Data.HfaField.Initialize(System.String)">
- <summary>
- Parses the input string into a valid HfaField, or returns null
- if one could not be created.
- </summary>
- <param name="input"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Data.HfaField.NumBytes">
- <summary>
- Gets or sets the short integer number of bytes
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaField.ItemCount">
- <summary>
- Gets or sets the short integer item count
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaField.Pointer">
- <summary>
- Gets or sets '\0', '*' or 'p'
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaField.ItemType">
- <summary>
- Gets or sets 1|2|4|e|...
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaField.ItemObjectTypeString">
- <summary>
- If ItemType == 'o'
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaField.ItemObjectType">
- <summary>
- Gets or sets the item object type
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaField.EnumNames">
- <summary>
- Normally null unless this is an enum
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaField.FieldName">
- <summary>
- Gets or sets the field name
- </summary>
- </member>
- <member name="T:DotSpatial.Data.HfaInfo">
- <summary>
- HfaInfo
- </summary>
- </member>
- <member name="M:DotSpatial.Data.HfaInfo.#ctor">
- <summary>
- Creates a new instance of HfaInfo
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaInfo.Access">
- <summary>
- Gets or sets the access type
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaInfo.Dictionary">
- <summary>
- Gets or sets a dictionary for looking up types based on string type names.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaInfo.Path">
- <summary>
- The directory path
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaInfo.Filename">
- <summary>
- The string fileName sans path
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaInfo.IgeFilename">
- <summary>
- sans path
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaInfo.EndOfFile">
- <summary>
- End of file
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaInfo.RootPos">
- <summary>
- Root position
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaInfo.DictionaryPos">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaInfo.EntryHeaderLength">
- <summary>
- The entry header length
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaInfo.Version">
- <summary>
- The integer version
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaInfo.TreeDirty">
- <summary>
- Boolean, true if the tree has changed
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaInfo.Fp">
- <summary>
- The file stream
- </summary>
- </member>
- <member name="T:DotSpatial.Data.HfaInvalidCountException">
- <summary>
- HfaInvalidCountException
- </summary>
- </member>
- <member name="M:DotSpatial.Data.HfaInvalidCountException.#ctor(System.Int32,System.Int32)">
- <summary>
- Creates a new instance of HfaInvalidCountException
- </summary>
- </member>
- <member name="T:DotSpatial.Data.HfaNotCompressedException">
- <summary>
- HfaNotCompressedException
- </summary>
- </member>
- <member name="M:DotSpatial.Data.HfaNotCompressedException.#ctor">
- <summary>
- Creates a new instance of HfaNotCompressedException
- </summary>
- </member>
- <member name="T:DotSpatial.Data.HfaPointerInsertNotSupportedException">
- <summary>
- HfaPointerInsertNotSupportedException
- </summary>
- </member>
- <member name="M:DotSpatial.Data.HfaPointerInsertNotSupportedException.#ctor">
- <summary>
- Creates a new instance of HfaPointerInsertNotSupportedException
- </summary>
- </member>
- <member name="T:DotSpatial.Data.HfaType">
- <summary>
- HfaType
- </summary>
- </member>
- <member name="M:DotSpatial.Data.HfaType.CompleteDefn(DotSpatial.Data.HfaDictionary)">
- <summary>
- Completes the defenition of this type based on the existing dictionary
- </summary>
- <param name="dictionary"></param>
- </member>
- <member name="M:DotSpatial.Data.HfaType.Dump(System.IO.Stream)">
- <summary>
- This function writes content to the file for this entire type by writing
- the type name and number of bytes, followed by cycling through and writing each
- of the fields.
- </summary>
- <param name="stream"></param>
- </member>
- <member name="M:DotSpatial.Data.HfaType.DumpInstValue(System.IO.Stream,System.Byte[],System.Int64,System.Int32,System.String)">
- <summary>
- Triggers a dump on all the fields of this type.
- </summary>
- <param name="fpOut"></param>
- <param name="data"></param>
- <param name="dataOffset"></param>
- <param name="dataSize"></param>
- <param name="pszPrefix"></param>
- </member>
- <member name="M:DotSpatial.Data.HfaType.ExtractInstValue(System.String,System.Byte[],System.Int64,System.Int32,System.Char,System.Object@)">
- <summary>
- Extracts the value form the byte array
- </summary>
- <param name="fieldPath"></param>
- <param name="data"></param>
- <param name="dataOffset"></param>
- <param name="dataSize"></param>
- <param name="reqType"></param>
- <param name="reqReturn"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.HfaType.GetInstBytes(System.Byte[],System.Int64)">
- <summary>
- Gets the number of bytes for this type by adding up the byte contribution from each of its fields.
- </summary>
- <param name="data">The array of bytes to scan.</param>
- <param name="dataOffset">The integer index in the array where scanning should begin.</param>
- <returns>The integer count.</returns>
- </member>
- <member name="M:DotSpatial.Data.HfaType.GetInstCount(System.String,System.Byte[],System.Int64,System.Int32)">
- <summary>
- Attempts to find the specified field in the field path and extracts the size of the specified field in bytes
- </summary>
- <param name="fieldPath"></param>
- <param name="data"></param>
- <param name="dataOffset"></param>
- <param name="dataSize"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.HfaType.Intialize(System.String)">
- <summary>
- Originally Initialize
- </summary>
- <param name="input">The input string that contains content for this type</param>
- <returns>The remaining string content, unless this fails in which case this may return null</returns>
- </member>
- <member name="M:DotSpatial.Data.HfaType.SetInstValue(System.String,System.Byte[],System.Int64,System.Int32,System.Char,System.Object)">
- <summary>
-
- </summary>
- <param name="fieldPath"></param>
- <param name="data"></param>
- <param name="dataOffset"></param>
- <param name="dataSize"></param>
- <param name="reqType"></param>
- <param name="value"></param>
- </member>
- <member name="P:DotSpatial.Data.HfaType.NumBytes">
- <summary>
- The short integer number of bytes
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaType.FieldCount">
- <summary>
- The short integer number of fields
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaType.TypeName">
- <summary>
- The type name
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaType.Fields">
- <summary>
- Gets or sets the list of fields
- </summary>
- </member>
- <member name="T:DotSpatial.Data.HfaFieldTypeException">
- <summary>
- HfaTypeException
- </summary>
- </member>
- <member name="M:DotSpatial.Data.HfaFieldTypeException.#ctor(System.Char)">
- <summary>
- Creates a new instance of HfaTypeException
- </summary>
- </member>
- <member name="T:DotSpatial.Data.HfaMapInfo">
- <summary>
- MapInfo
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaMapInfo.LowerRightCenter">
- <summary>
- Gets or sets the map coordinats of the center of the lower right pixel
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaMapInfo.PixelSize">
- <summary>
- Gets or sets the size of a single pixel in map units
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaMapInfo.ProName">
- <summary>
- Gets or sets the string Projection Name
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaMapInfo.Units">
- <summary>
- Gets or sets the map units
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaMapInfo.UpperLeftCenter">
- <summary>
- Gets or sets the map coordinates of center of upper left pixel
- </summary>
- </member>
- <member name="T:DotSpatial.Data.HfaNAD">
- <summary>
- NAD
- </summary>
- </member>
- <member name="F:DotSpatial.Data.HfaNAD.NAD27">
- <summary>
- Use the North American Datum 1927
- </summary>
- </member>
- <member name="F:DotSpatial.Data.HfaNAD.NAD83">
- <summary>
- Use the North American Datum 1983
- </summary>
- </member>
- <member name="F:DotSpatial.Data.HfaNAD.HARN">
- <summary>
- Use the North America Datum High Accuracy Reference Network
- </summary>
- </member>
- <member name="T:DotSpatial.Data.HfaProParameters">
- <summary>
- ProParameters
- </summary>
- </member>
- <member name="M:DotSpatial.Data.HfaProParameters.#ctor">
- <summary>
- Creates a new instance of the ProParameters class
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaProParameters.ProExeName">
- <summary>
- Gets or sets the string exectable name for external projectiosn
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaProParameters.ProName">
- <summary>
- Gets or sets the string projection name
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaProParameters.ProNumber">
- <summary>
- Gets or sets the projection number for internal projections
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaProParameters.ProParams">
- <summary>
- Projection parameters array in the GCTP form
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaProParameters.ProType">
- <summary>
- Gets or sets the projection type
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaProParameters.ProZone">
- <summary>
- Gets or sets the projection zone (UTM, SP only)
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaProParameters.ProSpheroid">
- <summary>
- The projection spheroid
- </summary>
- </member>
- <member name="T:DotSpatial.Data.HfaProType">
- <summary>
- ProType
- </summary>
- </member>
- <member name="F:DotSpatial.Data.HfaProType.Internal">
- <summary>
- Indicates that hte projection is built into the eprj package as function calls
- </summary>
- </member>
- <member name="F:DotSpatial.Data.HfaProType.External">
- <summary>
- Indicates that hte projection is accessible as an exteranl executable
- </summary>
- </member>
- <member name="T:DotSpatial.Data.HfaSize">
- <summary>
- Size
- </summary>
- </member>
- <member name="F:DotSpatial.Data.HfaSize.Height">
- <summary>
- pixelsize height
- </summary>
- </member>
- <member name="F:DotSpatial.Data.HfaSize.Width">
- <summary>
- pixelsize width
- </summary>
- </member>
- <member name="T:DotSpatial.Data.HfaSpheroid">
- <summary>
- Spheroid
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaSpheroid.A">
- <summary>
- Gets or sets the semi-major axis of the ellipsoid
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaSpheroid.B">
- <summary>
- Gets or sets the semi-minor axis of the ellipsoid
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaSpheroid.ESquared">
- <summary>
- Gets or sets the eccentricity squared
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaSpheroid.Radius">
- <summary>
- Gets or sets the radius of the sphere
- </summary>
- </member>
- <member name="P:DotSpatial.Data.HfaSpheroid.SphereName">
- <summary>
- Gets or sets the string name o the ellipsoid
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IDataLayer">
- <summary>
- IDataLayer
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IDataLayer.CommitTransaction">
- <summary>
- This should finalize the transaction, saving changes to the database or disk
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IDataLayer.CreateFeature(DotSpatial.Data.IFeature)">
- <summary>
- Creates a feature
- </summary>
- <param name="feature"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.IDataLayer.CreateShape(DotSpatial.Data.Shape,System.Data.DataRow)">
- <summary>
- Creates a feature from a shape and some data row values.
- </summary>
- <param name="shape"></param>
- <param name="attributes"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.IDataLayer.CreateField(DotSpatial.Data.Field)">
- <summary>
- Creates a new field for this data layer in the data source
- </summary>
- <param name="fld"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.IDataLayer.DeleteFeature(System.Int32)">
- <summary>
- Deletes the feature at the specified index location
- </summary>
- <param name="fid">The fid</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.IDataLayer.Dispose">
- <summary>
- Disposes any unmanaged memory objects
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IDataLayer.GetFeature(System.Int32)">
- <summary>
- Gets the feature at the specified index
- </summary>
- <param name="fid"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.IDataLayer.GetShape(System.Int32)">
- <summary>
- Gets the shape
- </summary>
- <param name="fid"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.IDataLayer.GetFeatureCount">
- <summary>
- Gets the features
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.IDataLayer.GetFidColumn">
- <summary>
- Gets the name of the feature ID column
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.IDataLayer.GetGeometryColumn">
- <summary>
- Gets the string name of the geometry column
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.IDataLayer.GetFields">
- <summary>
- Returns the field definitions as an array of fields.
- </summary>
- <returns>An array of field objects that encompass the schema</returns>
- </member>
- <member name="M:DotSpatial.Data.IDataLayer.RollbackTransaction">
- <summary>
- Rolls back the transactions
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.IDataLayer.GetSpatialRef">
- <summary>
- Gets the projection information associated with this projection
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.IDataLayer.SetFeature(System.Int32,DotSpatial.Data.IFeature)">
- <summary>
- sets the specified feature
- </summary>
- <param name="fid"></param>
- <param name="feature"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.IDataLayer.SetShape(System.Int32,DotSpatial.Data.Shape,System.Data.DataRow)">
- <summary>
- Sets the shape
- </summary>
- <param name="fid"></param>
- <param name="shape"></param>
- <param name="values"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.IDataLayer.SetSpatialFilterRect(System.Double,System.Double,System.Double,System.Double)">
- <summary>
- Sets the spatial filter by using the specified rectangular extents instead of a geometry.
- </summary>
- <param name="xMin">The minimum value in the X direction.</param>
- <param name="yMin">The minimum value in the Y direction.</param>
- <param name="xMax">The maximum value in the X direction.</param>
- <param name="yMax">The maximum value in the Y direction.</param>
- <returns>Boolean, true if hte spatial filter rectangle is set.</returns>
- </member>
- <member name="M:DotSpatial.Data.IDataLayer.StartTransaction">
- <summary>
- Starts the transaction
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IDataLayer.SyncToDisk">
- <summary>
- Syncrhonize to disk
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IDataLayer.TestCapability">
- <summary>
- Test Capability
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IDataLayer.Extent">
- <summary>
- Gets the extent of the data layer
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IDataLayer.Name">
- <summary>
- Gets the name of this layer
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IDataLayer.SpatialFilter">
- <summary>
- Gets or sets the spatial filter so that only members that intersect with the specified
- geometry will be returned.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.PluginInfo">
- <summary>
- PluginInfo
- </summary>
- </member>
- <member name="M:DotSpatial.Data.PluginInfo.#ctor">
- <summary>
- Creates a new instance of PluginInfo
- </summary>
- </member>
- <member name="M:DotSpatial.Data.PluginInfo.#ctor(System.String,System.String)">
- <summary>
- Creates a new instance of a PluginInfo class with the specified parameters
- </summary>
- <param name="inSettings"></param>
- <param name="inKey"></param>
- </member>
- <member name="P:DotSpatial.Data.PluginInfo.Settings">
- <summary>
- Settings
- </summary>
- </member>
- <member name="P:DotSpatial.Data.PluginInfo.Key">
- <summary>
- Key
- </summary>
- </member>
- <member name="T:DotSpatial.Data.AffineTransform">
- <summary>
- AffineTransform
- </summary>
- </member>
- <member name="M:DotSpatial.Data.AffineTransform.#ctor(System.Double[])">
- <summary>
- Creates a new instance of AffineTransform
- </summary>
- </member>
- <member name="M:DotSpatial.Data.AffineTransform.CellCenter_ToProj(System.Int32,System.Int32)">
- <summary>
- Given any input row or column, this returns the appropriate geographic location for the
- position of the center of the cell.
- </summary>
- <param name="row">The integer row index from 0 to numRows - 1</param>
- <param name="column">The integer column index from 0 to numColumns - 1</param>
- <returns>The geographic position of the center of the specified cell</returns>
- </member>
- <member name="M:DotSpatial.Data.AffineTransform.CellTopLeft_ToProj(System.Int32,System.Int32)">
- <summary>
- Given the row and column, this returns the geographic position of the top left corner of the cell
- </summary>
- <param name="row">The integer row index from 0 to numRows - 1</param>
- <param name="column">The integer column index from 0 to numColumns - 1</param>
- <returns>The geographic position of the top left corner of the specified cell</returns>
- </member>
- <member name="M:DotSpatial.Data.AffineTransform.CellTopRight_ToProj(System.Int32,System.Int32)">
- <summary>
- Given the row and column, this returns the geographic position of the top right corner of the cell
- </summary>
- <param name="row">The integer row index from 0 to numRows - 1</param>
- <param name="column">The integer column index from 0 to numColumns - 1</param>
- <returns>The geographic position of the top right corner of the specified cell</returns>
- </member>
- <member name="M:DotSpatial.Data.AffineTransform.CellBottomLeft_ToProj(System.Int32,System.Int32)">
- <summary>
- Given the row and column, this returns the geographic position of the bottom left corner of the cell
- </summary>
- <param name="row">The integer row index from 0 to numRows - 1</param>
- <param name="column">The integer column index from 0 to numColumns - 1</param>
- <returns>The geographic position of the bottom left corner of the specified cell</returns>
- </member>
- <member name="M:DotSpatial.Data.AffineTransform.CellBottomRight_ToProj(System.Int32,System.Int32)">
- <summary>
- Given the row and column, this returns the geographic position of the bottom right corner of the cell
- </summary>
- <param name="row">The integer row index from 0 to numRows - 1</param>
- <param name="column">The integer column index from 0 to numColumns - 1</param>
- <returns>The geographic position of the bottom right corner of the specified cell</returns>
- </member>
- <member name="M:DotSpatial.Data.AffineTransform.TransfromToCorner(System.Int32,System.Int32)">
- <summary>
- Given the row and column, this returns new affine coefficients transformed to that cell
- </summary>
- <param name="startRow">The integer row index from 0 to numRows - 1</param>
- <param name="startColumn">The integer column index from 0 to numColumns - 1</param>
- <returns>Transoformed affine coefficients</returns>
- </member>
- <member name="M:DotSpatial.Data.AffineTransform.ProjToCell(DotSpatial.Topology.Coordinate)">
- <summary>
- Returns the row and column index.
- </summary>
- <param name="location">Gets or sets the ICoordinate</param>
- <returns>An RcIndex that shows the best row or column index for the specified coordinate.</returns>
- </member>
- <member name="P:DotSpatial.Data.AffineTransform.Coefficients">
- <summary>
- Gets or sets the array of coefficients for this transform
- </summary>
- </member>
- <member name="T:DotSpatial.Data.BinaryRasterProvider">
- <summary>
- BinaryDataProvider
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IRasterProvider">
- <summary>
- A DataProvider that is specific to raster formats.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IRasterProvider.Create(System.String,System.String,System.Int32,System.Int32,System.Int32,System.Type,System.String[])">
- <summary>
- This create new method implies that this provider has the priority for creating a new file.
- An instance of the dataset should be created and then returned. By this time, the fileName
- will already be checked to see if it exists, and deleted if the user wants to overwrite it.
- </summary>
- <param name="name">The string fileName for the new instance.</param>
- <param name="driverCode">The string short name of the driver for creating the raster.</param>
- <param name="xSize">The number of columns in the raster.</param>
- <param name="ySize">The number of rows in the raster.</param>
- <param name="numBands">The number of bands to create in the raster.</param>
- <param name="dataType">The data type to use for the raster.</param>
- <param name="options">The options to be used.</param>
- <returns>An IRaster</returns>
- </member>
- <member name="M:DotSpatial.Data.IRasterProvider.Open(System.String)">
- <summary>
- This open method is only called if this plugin has been given priority for one
- of the file extensions supported in the DialogReadFilter property supplied by
- this control. Failing to provide a DialogReadFilter will result in this plugin
- being added to the list of DataProviders being supplied under the Add Other Data
- option in the file menu.
- </summary>
- <param name="fileName">A string specifying the complete path and extension of the file to open.</param>
- <returns>An IDataSet to be added to the Map. These can also be groups of datasets.</returns>
- </member>
- <member name="M:DotSpatial.Data.BinaryRasterProvider.Open(System.String)">
- <summary>
- This open method is only called if this plugin has been given priority for one
- of the file extensions supported in the DialogReadFilter property supplied by
- this control. Failing to provide a DialogReadFilter will result in this plugin
- being added to the list of DataProviders being supplied under the Add Other Data
- option in the file menu.
- </summary>
- <param name="fileName">A string specifying the complete path and extension of the file to open.</param>
- <returns>An IDataSet to be added to the Map. These can also be groups of datasets.</returns>
- </member>
- <member name="M:DotSpatial.Data.BinaryRasterProvider.Create(System.String,System.String,System.Int32,System.Int32,System.Int32,System.Type,System.String[])">
- <summary>
- This create new method implies that this provider has the priority for creating a new file.
- An instance of the dataset should be created and then returned. By this time, the fileName
- will already be checked to see if it exists, and deleted if the user wants to overwrite it.
- </summary>
- <param name="name">The string fileName for the new instance</param>
- <param name="driverCode">The string short name of the driver for creating the raster</param>
- <param name="xSize">The number of columns in the raster</param>
- <param name="ySize">The number of rows in the raster</param>
- <param name="numBands">The number of bands to create in the raster</param>
- <param name="dataType">The data type to use for the raster</param>
- <param name="options">The options to be used.</param>
- <returns>An IRaster</returns>
- </member>
- <member name="M:DotSpatial.Data.BinaryRasterProvider.Open">
- <summary>
- A Non-File based open. If no DialogReadFilter is provided, DotSpatial will call
- this method when this plugin is selected from the Add Other Data option in the
- file menu.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.BinaryRasterProvider.GetDataType(System.String)">
- <summary>
- Reads a binary header to determine the appropriate data type
- </summary>
- </member>
- <member name="P:DotSpatial.Data.BinaryRasterProvider.DialogReadFilter">
- <summary>
- Gets a dialog read filter that lists each of the file type descriptions and file extensions, delimeted
- by the | symbol. Each will appear in DotSpatial's open file dialog filter, preceeded by the name provided
- on this object.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.BinaryRasterProvider.DialogWriteFilter">
- <summary>
- Gets a dialog filter that lists each of the file type descriptions and extensions for a Save File Dialog.
- Each will appear in DotSpatial's open file dialog filter, preceeded by the name provided on this object.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.BinaryRasterProvider.Name">
- <summary>
- Gets a prefereably short name that identifies this data provider. Example might be GDAL.
- This will be prepended to each of the DialogReadFilter members from this plugin.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.BinaryRasterProvider.Description">
- <summary>
- This is a basic description that will fall next to your plugin in the Add Other Data dialog.
- This will only be shown if your plugin does not supply a DialogReadFilter.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.BinaryRasterProvider.ProgressHandler">
- <summary>
- Gets or sets the control or method that should report on progress
- </summary>
- </member>
- <member name="T:DotSpatial.Data.RasterBoundsExt">
- <summary>
- RasterBoundsEM
- </summary>
- </member>
- <member name="M:DotSpatial.Data.RasterBoundsExt.Area(DotSpatial.Data.IRasterBounds)">
- <summary>
- Calculates the area of this envelope. Because the word Area,
- like Volume, is dimension specific, this method only looks
- at the X and Y ordinates, and requires at least 2 ordinates.
- </summary>
- <param name="self">The IEnvelope to use with this method</param>
- <returns>The 2D area as a double value.</returns>
- </member>
- <member name="M:DotSpatial.Data.RasterBoundsExt.Bottom(DotSpatial.Data.IRasterBounds)">
- <summary>
- Gets the minY, which is Y - Height.
- </summary>
- <param name="self">The <c>IRasterBounds</c> that this calculation is for.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.RasterBoundsExt.ExpandBy(DotSpatial.Data.IRasterBounds,System.Double)">
- <summary>
- Uses the specified distance to expand the envelope by that amount in all dimensions.
- </summary>
- <param name="self">The <c>IRasterBounds</c> that this calculation is for.</param>
- <param name="distance">The double distance to expand in all directions.</param>
- </member>
- <member name="M:DotSpatial.Data.RasterBoundsExt.Left(DotSpatial.Data.IRasterBounds)">
- <summary>
- Gets the left value for this rectangle. This should be the
- X coordinate, but is added for clarity.
- </summary>
- <param name="self">The <c>IRasterBounds</c> that this calculation is for.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.RasterBoundsExt.Right(DotSpatial.Data.IRasterBounds)">
- <summary>
- Gets the right value, which is X + Width.
- </summary>
- <param name="self">The <c>IRasterBounds</c> that this calculation is for.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.RasterBoundsExt.Top(DotSpatial.Data.IRasterBounds)">
- <summary>
- Gets the maxY value, which should be Y.
- </summary>
- <param name="self">The <c>IRasterBounds</c> that this calculation is for.</param>
- <returns>The double value representing the Max Y value of this rectangle</returns>
- </member>
- <member name="M:DotSpatial.Data.RasterBoundsExt.OpenWorldFile(DotSpatial.Data.IRasterBounds,System.String)">
- <summary>
- Use the Open method instead of this extension. This only provides
- a default behavior that can optionally be used by implementers
- of the IRasterBounds interface.
- </summary>
- <param name="bounds">The bounds to open</param>
- <param name="fileName">The *.wld or *.**w world file to open</param>
- </member>
- <member name="M:DotSpatial.Data.RasterBoundsExt.SaveWorldFile(DotSpatial.Data.IRasterBounds)">
- <summary>
- Use the Save method instead of this extension. This only provides
- a default behavior that can optionally be used by implementers
- of the IRasterBounds interface.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.RasterBoundsExt.ResampleTransform(DotSpatial.Data.IRasterBounds,System.Int32,System.Int32)">
- <summary>
- Generates a new version of the affine transform that will
- cover the same region, but using the specified number of
- rows and columns instead.
- </summary>
- <param name="bounds">The raster bounds to resample</param>
- <param name="numRows">The new number of rows </param>
- <param name="numColumns">The new number of columns</param>
- <returns>
- X = [0] + [1] * Column + [2] * Row
- Y = [3] + [4] * Column + [5] * Row
- </returns>
- </member>
- <member name="M:DotSpatial.Data.RasterBoundsExt.SaveAs(DotSpatial.Data.IRasterBounds,System.String)">
- <summary>
- Attempts to save the affine coefficients to the specified worldfile file name
- </summary>
- <param name="bounds">The bounds to save</param>
- <param name="fileName">The fileName to save this bounds to</param>
- </member>
- <member name="M:DotSpatial.Data.RasterBoundsExt.Get_AffineMatrix(DotSpatial.Data.IRasterBounds)">
- <summary>
- Converts creates a float precisions drawing matrix from the double precision affine
- coordinates. The Matrix can be manipulated and then set back. Some precision will
- be lost, however, as only floats are supported.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.RasterBoundsExt.Set_AffineMatrix(DotSpatial.Data.IRasterBounds,System.Drawing.Drawing2D.Matrix)">
- <summary>
- Re-defines the double precision affine transform values based on the specified
- system.Drawing.Matrix.
- </summary>
- <param name="bounds">The bounds to adjust based on the matrix</param>
- <param name="matrix">The matrix to use as a guide for adjustments.</param>
- </member>
- <member name="M:DotSpatial.Data.RasterBoundsExt.BottomLeft(DotSpatial.Data.IRasterBounds)">
- <summary>
- Images can be skewed, so this gets the point that actually defines the bottom left
- corner of the data in geographic coordinates
- </summary>
- </member>
- <member name="M:DotSpatial.Data.RasterBoundsExt.BottomRight(DotSpatial.Data.IRasterBounds)">
- <summary>
- Images can be skewed, so this gets the point that actually defines the bottom right
- corner of the data in geographic coordinates
- </summary>
- </member>
- <member name="M:DotSpatial.Data.RasterBoundsExt.TopLeft(DotSpatial.Data.IRasterBounds)">
- <summary>
- Images can be skewed, so this gets the point that actually defines the top left
- corner of the data in geographic coordinates
- </summary>
- <param name="bounds">The IRasterBounds to obtain the top left of</param>
- </member>
- <member name="M:DotSpatial.Data.RasterBoundsExt.TopRight(DotSpatial.Data.IRasterBounds)">
- <summary>
- Images can be skewed, so this gets the point that actually defines the top right
- corner of the data in geographic coordinates
- </summary>
- </member>
- <member name="M:DotSpatial.Data.RasterBoundsExt.CellCenter_ToProj(DotSpatial.Data.IRasterBounds,System.Int32,System.Int32)">
- <summary>
- Given any input row or column, this returns the appropriate geographic location for the
- position of the center of the cell.
- </summary>
- <param name="bounds">The raster bounds to perform the calculation on</param>
- <param name="row">The integer row index from 0 to numRows - 1</param>
- <param name="column">The integer column index from 0 to numColumns - 1</param>
- <returns>The geographic position of the center of the specified cell</returns>
- </member>
- <member name="M:DotSpatial.Data.RasterBoundsExt.CellTopLeft_ToProj(DotSpatial.Data.IRasterBounds,System.Int32,System.Int32)">
- <summary>
- Given the row and column, this returns the geographic position of the top left corner of the cell
- </summary>
- <param name="bounds">The raster bounds to perform the calculation on</param>
- <param name="row">The integer row index from 0 to numRows - 1</param>
- <param name="column">The integer column index from 0 to numColumns - 1</param>
- <returns>The geographic position of the top left corner of the specified cell</returns>
- </member>
- <member name="M:DotSpatial.Data.RasterBoundsExt.CellTopRight_ToProj(DotSpatial.Data.IRasterBounds,System.Int32,System.Int32)">
- <summary>
- Given the row and column, this returns the geographic position of the top right corner of the cell
- </summary>
- <param name="bounds">The raster bounds to perform the calculation on</param>
- <param name="row">The integer row index from 0 to numRows - 1</param>
- <param name="column">The integer column index from 0 to numColumns - 1</param>
- <returns>The geographic position of the top right corner of the specified cell</returns>
- </member>
- <member name="M:DotSpatial.Data.RasterBoundsExt.CellBottomLeft_ToProj(DotSpatial.Data.IRasterBounds,System.Int32,System.Int32)">
- <summary>
- Given the row and column, this returns the geographic position of the bottom left corner of the cell
- </summary>
- <param name="bounds">The raster bounds to perform the calculation on</param>
- <param name="row">The integer row index from 0 to numRows - 1</param>
- <param name="column">The integer column index from 0 to numColumns - 1</param>
- <returns>The geographic position of the bottom left corner of the specified cell</returns>
- </member>
- <member name="M:DotSpatial.Data.RasterBoundsExt.CellBottomRight_ToProj(DotSpatial.Data.IRasterBounds,System.Int32,System.Int32)">
- <summary>
- Given the row and column, this returns the geographic position of the bottom right corner of the cell
- </summary>
- <param name="bounds">The raster bounds to perform the calculation on</param>
- <param name="row">The integer row index from 0 to numRows - 1</param>
- <param name="column">The integer column index from 0 to numColumns - 1</param>
- <returns>The geographic position of the bottom right corner of the specified cell</returns>
- </member>
- <member name="M:DotSpatial.Data.RasterBoundsExt.ProjToCell(DotSpatial.Data.IRasterBounds,DotSpatial.Topology.Coordinate)">
- <summary>
- Returns the row col index
- </summary>
- <param name="bounds">The raster bounds to perform the calculation on</param>
- <param name="location">Gets or sets the ICoordinate</param>
- <returns>An RcIndex that shows the best row or column index for the specified coordinate.</returns>
- </member>
- <member name="M:DotSpatial.Data.RasterBoundsExt.CellsContainingExtent(DotSpatial.Data.IRasterBounds,DotSpatial.Data.Extent)">
- <summary>
- The affine transform can make figuring out what rows and columns are needed from the original image
- in order to correctly fill a geographic extent challenging. This attempts to handle that back projection
- problem. It returns a System.Drawing.Rectangle in pixel (cell) coordinates that is completely contains
- the geographic extents, but is not larger than the bounds of the underlying image.
- If geographic extent fully contains extent of IRasterBounds, than returns rectangle which contains full raster image.
- If geographic extent partially contains extent of IRasterBounds, than returns rectangle which contains needed edges of full raster image.
- It back projects all four corners of the extent and returns the bounding rectangle clipped by the image rectangle.
- </summary>
- <param name="self">Instance of <see cref="T:DotSpatial.Data.IRasterBounds"/></param>
- <param name="extent">Extent to test.</param>
- <returns>Rectangle in pixel (cell) coordinates.</returns>
- </member>
- <member name="T:DotSpatial.Data.RasterExt">
- <summary>
- A new model, now that we support 3.5 framework and extension methods that are essentially
- derived characteristics away from the IRaster interface, essentially reducing it
- to the simplest interface possible for future implementers, while extending the most
- easy-to-find functionality to the users.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.RasterExt.ContainsFeature(DotSpatial.Data.IRaster,DotSpatial.Data.IFeature)">
- <summary>
- determine if the shape is partially inside grid extents
- </summary>
- <returns>false, if the shape is completely outside grid extents
- true, if it's at least partially inside </returns>
- </member>
- <member name="M:DotSpatial.Data.RasterExt.IsFullyWindowed(DotSpatial.Data.IRaster)">
- <summary>
- Gets a boolean that is true if the Window extents contain are all the information for the raster.
- In otherwords, StartRow = StartColumn = 0, EndRow = NumRowsInFile - 1, and EndColumn = NumColumnsInFile - 1
- </summary>
- </member>
- <member name="M:DotSpatial.Data.RasterExt.MoveTo(DotSpatial.Data.IRaster,DotSpatial.Topology.Coordinate)">
- <summary>
- This doesn't change the data, but instead performs a translation where the upper left coordinate
- is specified in world coordinates.
- </summary>
- <param name="raster">Moves this raster so that the upper left coordinate will match the specified position. The skew and cellsize will remain unaltered</param>
- <param name="position">The location to move the upper left corner of the raster to in world coordinates.</param>
- </member>
- <member name="M:DotSpatial.Data.RasterExt.Rotate(DotSpatial.Data.IRaster,System.Single)">
- <summary>
- Rotates the geospatial reference points for this image by rotating the affine coordinates.
- The center for this rotation will be the center of the image.
- </summary>
- <param name="raster">The raster to rotate</param>
- <param name="degrees">The angle in degrees to rotate the image counter clockwise.</param>
- </member>
- <member name="M:DotSpatial.Data.RasterExt.RotateAt(DotSpatial.Data.IRaster,System.Single,DotSpatial.Topology.Coordinate)">
- <summary>
- Rotates the geospatial reference points for this image by rotating the affine coordinates.
- The center for this rotation will be the center of the image.
- </summary>
- <param name="raster">The raster to rotate about the specified coordinate</param>
- <param name="degrees">The angle in degrees to rotate the image counterclockwise.</param>
- <param name="center">The point that marks the center of the desired rotation in geographic coordiantes.</param>
- </member>
- <member name="M:DotSpatial.Data.RasterExt.Scale(DotSpatial.Data.IRaster,System.Single,System.Single)">
- <summary>
- This method uses a matrix transform to adjust the scale. The precision of using
- a Drawing2D transform is float precision, so some accuracy may be lost.
- </summary>
- <param name="raster">The raster to apply the scale transform to</param>
- <param name="scaleX">The multiplier to adjust the geographic extents of the raster in the X direction</param>
- <param name="scaleY">The multiplier to adjust the geographic extents of the raster in the Y direction</param>
- </member>
- <member name="M:DotSpatial.Data.RasterExt.Shear(DotSpatial.Data.IRaster,System.Single,System.Single)">
- <summary>
- This method uses a matrix transform to adjust the shear. The precision of using
- a Drawing2D transform is float precision, so some accuracy may be lost.
- </summary>
- <param name="raster">The raster to apply the transform to</param>
- <param name="shearX">The floating point horizontal shear factor</param>
- <param name="shearY">The floating ponit vertical shear factor</param>
- </member>
- <member name="M:DotSpatial.Data.RasterExt.Translate(DotSpatial.Data.IRaster,DotSpatial.Topology.Coordinate)">
- <summary>
- Applies a translation transform to the georeferenced coordinates on this raster.
- </summary>
- <param name="raster">The raster to apply the translation to</param>
- <param name="shift">An ICoordinate with shear values</param>
- </member>
- <member name="M:DotSpatial.Data.RasterExt.GetNearestValue(DotSpatial.Data.IRaster,DotSpatial.Topology.Coordinate)">
- <summary>
- Retrieves the data from the cell that is closest to the specified coordinates. This will
- return a No-Data value if the specified coordintes are outside of the grid.
- </summary>
- <param name="raster">The raster to get the value from</param>
- <param name="location">A valid implementation of Icoordinate specifying the geographic location.</param>
- <returns>The value of type T of the cell that has a center closest to the specified coordinates</returns>
- </member>
- <member name="M:DotSpatial.Data.RasterExt.GetNearestValue(DotSpatial.Data.IRaster,System.Double,System.Double)">
- <summary>
- Retrieves the data from the cell that is closest to the specified coordinates. This will
- return a No-Data value if the specified coordintes are outside of the grid.
- </summary>
- <param name="raster">The raster to get the value from</param>
- <param name="x">The longitude or horizontal coordinate</param>
- <param name="y">The latitude or vertical coordinate</param>
- <returns>The double value of the cell that has a center closest to the specified coordinates</returns>
- </member>
- <member name="M:DotSpatial.Data.RasterExt.SetNearestValue(DotSpatial.Data.IRaster,System.Double,System.Double,System.Double)">
- <summary>
- Retrieves the location from the cell that is closest to the specified coordinates. This will
- do nothing if the specified coordinates are outside of the raster.
- </summary>
- <param name="raster">The IRaster to set the value for</param>
- <param name="x">The longitude or horizontal coordinate</param>
- <param name="y">The latitude or vertical coordinate</param>
- <param name="value">The value to assign to the nearest cell to the specified location</param>
- </member>
- <member name="M:DotSpatial.Data.RasterExt.SetNearestValue(DotSpatial.Data.IRaster,DotSpatial.Topology.Coordinate,System.Double)">
- <summary>
- Retrieves the location from the cell that is closest to the specified coordinates. This will
- do nothing if the specified coordinates are outside of the raster.
- </summary>
- <param name="raster">The IRaster to set the value for</param>
- <param name="location">An Icoordinate specifying the location</param>
- <param name="value">The value to assign to the nearest cell to the specified location</param>
- </member>
- <member name="M:DotSpatial.Data.RasterExt.CellToProj(DotSpatial.Data.IRaster,DotSpatial.Data.RcIndex)">
- <summary>
- Extends the IRaster interface to return the coordinate of the center of a row column position.
- </summary>
- <param name="raster">The raster interface to extend</param>
- <param name="position">The zero based integer index of the row and column of the cell to locate</param>
- <returns>The geographic location of the center of the specified cell</returns>
- </member>
- <member name="M:DotSpatial.Data.RasterExt.CellToProj(DotSpatial.Data.IRaster,System.Int32,System.Int32)">
- <summary>
- Extends the IRaster interface to return the coordinate of the center of a row column position.
- </summary>
- <param name="raster">The raster interface to extend</param>
- <param name="row">The zero based integer index of the row of the cell to locate</param>
- <param name="col">The zero based integer index of the column of the cell to locate</param>
- <returns>The geographic location of the center of the specified cell</returns>
- </member>
- <member name="M:DotSpatial.Data.RasterExt.ProjToCell(DotSpatial.Data.IRaster,DotSpatial.Topology.Coordinate)">
- <summary>
- Extends the IRaster interface to return the zero based integer row and column indices
- </summary>
- <param name="raster">The raster interface to extend</param>
- <param name="location">The geographic coordinate describing the latitude and longitude</param>
- <returns>The RcIndex that describes the zero based integer row and column indices</returns>
- </member>
- <member name="M:DotSpatial.Data.RasterExt.ProjToCell(DotSpatial.Data.IRaster,System.Double,System.Double)">
- <summary>
- Extends the IRaster interface to return the zero based integer row and column indices
- </summary>
- <param name="raster">The raster interface to extend</param>
- <param name="x">A double precision floating point describing the longitude</param>
- <param name="y">A double precision floating point describing the latitude</param>
- <returns>The RcIndex that describes the zero based integer row and column indices</returns>
- </member>
- <member name="T:DotSpatial.Data.BgdRaster`1">
- <summary>
- BgdRaster
- </summary>
- </member>
- <member name="T:DotSpatial.Data.Raster`1">
- <summary>
- Raster
- </summary>
- </member>
- <member name="T:DotSpatial.Data.Raster">
- <summary>
- Handles the native file functions for float grids, without relying on GDAL.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IRaster">
- <summary>
- A general
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IRaster.Copy">
- <summary>
- This only works for in-ram rasters. This basically makes a new raster that has all the same
- in memory values
- </summary>
- <returns>An IRaster that is a duplicate of this class</returns>
- </member>
- <member name="M:DotSpatial.Data.IRaster.Copy(System.String,System.Boolean)">
- <summary>
- Creates a duplicate version of this file. If copyValues is set to false, then a raster of NoData values is created
- that has the same georeferencing information as the source file of this Raster, even if this raster is just a window.
- </summary>
- <param name="fileName">The string fileName specifying where to create the new file.</param>
- <param name="copyValues">If this is false, the same size and georeferencing values are used, but they are all set to NoData.</param>
- </member>
- <member name="M:DotSpatial.Data.IRaster.GetStatistics">
- <summary>
- Even if this is a window, this will cause this raster to show statistics calculated from the entire file.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IRaster.GetValues(System.Collections.Generic.IEnumerable{System.Int64})">
- <summary>
- Most raster methods are optimized for reading in lines or blocks at a time. This one is designed
- to be used for scattered points.
- </summary>
- <param name="indices">The zero based integer index that is Row * NumColumnsInFile + Column</param>
- <returns>The list of double values</returns>
- </member>
- <member name="M:DotSpatial.Data.IRaster.ReadBlock(System.Int32,System.Int32,System.Int32,System.Int32)">
- <summary>
- Returns a subset from the file that includes only the specified offsets. The result is a raster,
- and the extents are calculated, but the row and column values are in terms of the window,
- not the original raster. The band can be controlled by setting the "Current Band" first.
- </summary>
- <param name="xOff">X axis or horizontal offset (0 based from left)</param>
- <param name="yOff">Y axis or vertical offset (0 based from top)</param>
- <param name="sizeX">Number of columns</param>
- <param name="sizeY">Number of rows</param>
- <returns>An IRaster created from the appropriate type;.</returns>
- </member>
- <member name="M:DotSpatial.Data.IRaster.WriteBlock(DotSpatial.Data.IRaster,System.Int32,System.Int32,System.Int32,System.Int32)">
- <summary>
- This writes the values to the file, even if the IRaster has more values than the xSize or ySize
- stipulate, and even if the source raster has values of a different type.
- </summary>
- <param name="blockValues">The IRaster that contains data values to write to the file</param>
- <param name="xOff">The 0 based integer horizontal offset from the left</param>
- <param name="yOff">The 0 based integer vertical offset from the top</param>
- <param name="xSize">The integer number of columns to write</param>
- <param name="ySize">The integer number of rows to write</param>
- </member>
- <member name="M:DotSpatial.Data.IRaster.Save">
- <summary>
- Saves changes from any values that are in memory to the file. This will preserve the existing
- structure and attempt to only write values to the parts of the file that match the loaded window.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IRaster.SaveAs(System.String)">
- <summary>
- This will save whatever is specified in the startRow, endRow, startColumn, endColumn bounds
- to a new file with the specified fileName.
- </summary>
- <param name="fileName">The string fileName to save the current raster to.</param>
- </member>
- <member name="M:DotSpatial.Data.IRaster.SetData(DotSpatial.Data.IRaster)">
- <summary>
- This code is required to allow a new format to save data from an old format quickly.
- It essentially quickly transfers the underlying data values to the new raster.
- </summary>
- <param name="original"></param>
- </member>
- <member name="M:DotSpatial.Data.IRaster.ToRaster``1">
- <summary>
- Gets this raster (or its Internal Raster) as the appropriately typed raster
- so that strong typed access methods are available, instead of just the
- regular methods, or null if the type is incorrect. (Check datatype property).
- </summary>
- <typeparam name="T">The type (int, short, float, etc.)</typeparam>
- <returns>The Raster<T> where T are value types like int, short and float. Returns null if the type is wrong.</returns>
- </member>
- <member name="M:DotSpatial.Data.IRaster.WriteHeader">
- <summary>
- Instructs the raster to write only the header content. This is especially useful if you just want to update
- the extents or the projection of the raster, without changing the data values.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IRaster.CategoryNames">
- <summary>
- A raster can contain predefined names for its categories
- </summary>
- <returns>null if raster has no category names</returns>
- </member>
- <member name="M:DotSpatial.Data.IRaster.CategoryColors">
- <summary>
- A raster can contain predefined colors for its categories, for example NLCD GeoTIFF has a palette
- </summary>
- <returns>null if raster has no category colors</returns>
- </member>
- <member name="P:DotSpatial.Data.IRaster.ByteSize">
- <summary>
- Gets the integer size of each data member of the raster in bytes.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IRaster.Bands">
- <summary>
- Gets or sets the list of bands, which are in turn rasters. The rasters
- contain only one band each, instead of the list of all the bands like the
- parent raster.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IRaster.CellHeight">
- <summary>
- The geographic height of a cell the projected units. Setting this will
- automatically adjust the affine coefficient to a negative value.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IRaster.CellWidth">
- <summary>
- The geographic width of a cell in the projected units
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IRaster.CurrentBand">
- <summary>
- This provides a zero-based integer band index that specifies which of the internal bands
- is currently being used for requests for data.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IRaster.CustomFileType">
- <summary>
- This does nothing unless the FileType property is set to custom.
- In such a case, this string allows new file types to be managed.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IRaster.DataType">
- <summary>
- This reveals the underlying data type
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IRaster.DriverCode">
- <summary>
- Gets or sets a short string to identify which driver to use. This is primarilly used by GDAL rasters.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IRaster.EndColumn">
- <summary>
- The integer column index for the right column of this raster. Most of the time this will
- be NumColumns - 1. However, if this raster is a window taken from a larger raster, then
- it will be the index of the endColumn from the window.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IRaster.EndRow">
- <summary>
- The integer row index for the end row of this raster. Most of the time this will
- be numRows - 1. However, if this raster is a window taken from a larger raster, then
- it will be the index of the endRow from the window.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IRaster.Filename">
- <summary>
- Gets the complete path and fileName of the current file
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IRaster.FileType">
- <summary>
- Gets the file type of this grid.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IRaster.IsInRam">
- <summary>
- Gets a boolean that is true if the data for this raster is in memory.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IRaster.Maximum">
- <summary>
- Gets the maximum data value, not counting no-data values in the grid.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IRaster.Mean">
- <summary>
- Gets the mean of the non-NoData values in this grid. If the data is not InRam, then
- the GetStatistics method must be called before these values will be correct.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IRaster.Minimum">
- <summary>
- Gets the minimum data value that is not classified as a no data value in this raster.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IRaster.NoDataValue">
- <summary>
- A float showing the no-data values
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IRaster.Notes">
- <summary>
- For binary rasters this will get cut to only 256 characters.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IRaster.NumBands">
- <summary>
- Gets the number of bands. In most traditional grid formats, this is 1. For RGB images,
- this would be 3. Some formats may have many bands.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IRaster.NumColumns">
- <summary>
- Gets the horizontal count of the cells in the raster.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IRaster.NumColumnsInFile">
- <summary>
- Gets the integer count of columns in the file, as opposed to the
- number represented by this raster, which might just represent a window.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IRaster.NumRows">
- <summary>
- Gets the vertical count of the cells in the raster.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IRaster.NumRowsInFile">
- <summary>
- Gets the number of rows in the source file, as opposed to the number
- represented by this raster, which might just represent part of a file.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IRaster.NumValueCells">
- <summary>
- Gets the count of the cells that are not no-data. If the data is not InRam, then
- you will have to first call the GetStatistics() method to gain meaningul values.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IRaster.Options">
- <summary>
- Gets or sets the string array of options to use when saving this raster.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IRaster.Rows">
- <summary>
- Gets a list of the rows in this raster that can be accessed independantly.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IRaster.StartColumn">
- <summary>
- The integer column index for the left column of this raster. Most of the time this will
- be 0. However, if this raster is a window taken from a file, then
- it will be the row index in the file for the top row of this raster.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IRaster.StartRow">
- <summary>
- The integer row index for the top row of this raster. Most of the time this will
- be 0. However, if this raster is a window taken from a file, then
- it will be the row index in the file for the left row of this raster.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IRaster.StdDeviation">
- <summary>
- Gets the standard deviation of all the Non-nodata cells. If the data is not InRam,
- then you will have to first call the GetStatistics() method to get meaningful values.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IRaster.Tag">
- <summary>
- This is provided for future developers to link this raster to other entities.
- It has no function internally, so it can be manipulated safely.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IRaster.Value">
- <summary>
- Gets or sets the value on the CurrentBand given a row and column undex
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IRaster.Xllcenter">
- <summary>
- The horizontal or longitude coordinate for the lower left cell in the grid
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IRaster.Yllcenter">
- <summary>
- The vertical or latitude coordinate for the lower left cell in the grid
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IRaster.Sample">
- <summary>
- This doesn't perform calculations, but is simply a place holder where sample
- values can be stored and retrieved as a cache.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IRaster.FileExists">
- <summary>
- Occurs when attempting to copy or save to a fileName that already exists. A developer can tap into this event
- in order to display an appropriate message. A cancel property allows the developer (and ultimately the user)
- decide if the specified event should ultimately be cancelled.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Raster.#ctor">
- <summary>
- Set up the default values
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Raster.Clone">
- <summary>
- Creates a memberwise clone of this object. Reference types will be copied, but
- they will still point to the same original object. So a clone of this raster
- is pointing to the same underlying array of values etc.
- </summary>
- <returns>A Raster clone of this raster.</returns>
- </member>
- <member name="M:DotSpatial.Data.Raster.Copy">
- <summary>
- Creates a new IRaster that has the identical characteristics and in-ram data to the original.
- </summary>
- <returns>A Copy of the original raster.</returns>
- </member>
- <member name="M:DotSpatial.Data.Raster.Copy(System.String,System.Boolean)">
- <summary>
- Creates a duplicate version of this file. If copyValues is set to false, then a raster of NoData values is created
- that has the same georeferencing information as the source file of this Raster, even if this raster is just a window.
- </summary>
- <param name="fileName">The string fileName specifying where to create the new file.</param>
- <param name="copyValues">If this is false, the same size and georeferencing values are used, but they are all set to NoData.</param>
- </member>
- <member name="M:DotSpatial.Data.Raster.GetValues(System.Collections.Generic.IEnumerable{System.Int64})">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.Raster.GetStatistics">
- <summary>
- Even if this is a window, this will cause this raster to show statistics calculated from the entire file.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Raster.Save">
- <summary>
- Saves the values to a the same file that was created or loaded.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Raster.SaveAs(System.String)">
- <summary>
- Saves the curretn raster to the specified file. The current driver code and options are used.
- </summary>
- <param name="fileName">The string fileName to save the raster to.</param>
- </member>
- <member name="M:DotSpatial.Data.Raster.ReadBlock(System.Int32,System.Int32,System.Int32,System.Int32)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.Raster.WriteBlock(DotSpatial.Data.IRaster,System.Int32,System.Int32,System.Int32,System.Int32)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.Raster.SetData(DotSpatial.Data.IRaster)">
- <summary>
- This code is empty, but can be overridden in subtypes
- </summary>
- <param name="original"></param>
- </member>
- <member name="M:DotSpatial.Data.Raster.WriteHeader">
- <summary>
- Instructs the file to write header changes only. This is espcially useful for changing the
- extents without altering the actual raster values themselves.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Raster.Create(System.String,System.String,System.Int32,System.Int32,System.Int32,System.Type,System.String[])">
- <summary>
- This create new method implies that this provider has the priority for creating a new file.
- An instance of the dataset should be created and then returned. By this time, the fileName
- will already be checked to see if it exists, and deleted if the user wants to overwrite it.
- </summary>
- <param name="name">The string fileName for the new instance.</param>
- <param name="driverCode">The string short name of the driver for creating the raster.</param>
- <param name="xSize">The number of columns in the raster.</param>
- <param name="ySize">The number of rows in the raster.</param>
- <param name="numBands">The number of bands to create in the raster.</param>
- <param name="dataType">The data type to use for the raster.</param>
- <param name="options">The options to be used.</param>
- </member>
- <member name="M:DotSpatial.Data.Raster.GetNoDataCellCount">
- <summary>
- Gets the no data cell count. Calls GetStatistics() internally.
- </summary>
- <returns>The number of cells which are equal to NoDataValue.</returns>
- </member>
- <member name="M:DotSpatial.Data.Raster.Open(System.String)">
- <summary>
- Opens the specified fileName. The DefaultDataManager will determine the best type of raster to handle the specified
- file based on the fileName or characteristics of the file.
- </summary>
- <param name="fileName">The string fileName of the raster to open.</param>
- </member>
- <member name="M:DotSpatial.Data.Raster.Open">
- <summary>
- Opens the specified fileName. The DefaultDataManager will determine the best type of raster to handle the specified
- file based on the fileName or characteristics of the file.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Raster.SaveAs(System.String,System.String)">
- <summary>
- Saves the current raster to the specified file, using the specified driver, but with the
- options currently specified in the Options property.
- </summary>
- <param name="fileName">The string fileName to save this raster as</param>
- <param name="driverCode">The string driver code.</param>
- </member>
- <member name="M:DotSpatial.Data.Raster.SaveAs(System.String,System.String,System.String[])">
- <summary>
- Saves the current raster to the specified file.
- </summary>
- <param name="fileName">The string fileName to save the current raster to.</param>
- <param name="driverCode">The driver code to use.</param>
- <param name="options">the string array of options that depend on the format.</param>
- </member>
- <member name="M:DotSpatial.Data.Raster.CategoryNames">
- <summary>
- By default, Raster does not have any CategoryNames, but this can be overridden
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Raster.CategoryColors">
- <summary>
- By default, Raster does not have any CategoryColors, but this can be overridden
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Raster.ToRaster``1">
- <summary>
- Gets this raster (or its Internal Raster) as the appropriately typed raster
- so that strong typed access methods are available, instead of just the
- regular methods.
- </summary>
- <typeparam name="T">The type (int, short, float, etc.)</typeparam>
- <returns>The Raster<T> where T are value types like int, short, float"/></returns>
- </member>
- <member name="M:DotSpatial.Data.Raster.Dispose(System.Boolean)">
- <summary>
- Overrides dispose to correctly handle disposing the objects at the raster level.
- </summary>
- <param name="disposeManagedResources"></param>
- </member>
- <member name="M:DotSpatial.Data.Raster.OnFileExists(System.String)">
- <summary>
- Fires the FileExists method. If this returns true, then the action should be cancelled.
- </summary>
- <param name="fileName">The fileName to write to</param>
- <returns>Boolean, true if the user doesn't want to overwrite</returns>
- </member>
- <member name="M:DotSpatial.Data.Raster.ToIntRaster">
- <summary>
- Gets this raster (or its Internal Raster) as the appropriately typed raster
- so that strong typed access methods are available, instead of just the
- regular methods.
- </summary>
- <returns>A Raster<short></returns>
- </member>
- <member name="M:DotSpatial.Data.Raster.ToShortRaster">
- <summary>
- Gets this raster (or its Internal Raster) as the appropriately typed raster
- so that strong typed access methods are available, instead of just the
- regular methods.
- </summary>
- <returns>A Raster<short></returns>
- </member>
- <member name="M:DotSpatial.Data.Raster.ToFloatRaster">
- <summary>
- Gets this raster (or its Internal Raster) as the appropriately typed raster
- so that strong typed access methods are available, instead of just the
- regular methods.
- </summary>
- <returns>A Raster<short></returns>
- </member>
- <member name="M:DotSpatial.Data.Raster.CreateRaster(System.String,System.String,System.Int32,System.Int32,System.Int32,System.Type,System.String[])">
- <summary>
- This create new method implies that this provider has the priority for creating a new file.
- An instance of the dataset should be created and then returned. By this time, the fileName
- will already be checked to see if it exists, and deleted if the user wants to overwrite it.
- </summary>
- <param name="name">The string fileName for the new instance.</param>
- <param name="driverCode">The string short name of the driver for creating the raster.</param>
- <param name="xSize">The number of columns in the raster.</param>
- <param name="ySize">The number of rows in the raster.</param>
- <param name="numBands">The number of bands to create in the raster.</param>
- <param name="dataType">The data type to use for the raster.</param>
- <param name="options">The options to be used.</param>
- <returns>An IRaster</returns>
- </member>
- <member name="M:DotSpatial.Data.Raster.GetGridFileType(System.String)">
- <summary>
- For DotSpatial style binary grids, this returns the filetype
- </summary>
- <param name="filename">The fileName with extension to test</param>
- <returns>A GridFileTypes enumeration listing which file type this is</returns>
- </member>
- <member name="M:DotSpatial.Data.Raster.OpenFile(System.String)">
- <summary>
- This is significantly m
- </summary>
- <param name="fileName">The string full path for the fileName to open</param>
- <returns>A Raster object which is actually one of the type specific rasters, like FloatRaster.</returns>
- </member>
- <member name="M:DotSpatial.Data.Raster.OpenFile(System.String,System.Boolean)">
- <summary>
- Returns a native raster of the appropriate file type and data type by parsing the fileName.
- </summary>
- <param name="fileName">The string fileName to attempt to open with a native format</param>
- <param name="inRam">The boolean value.</param>
- <returns>An IRaster which has been opened to the specified file.</returns>
- </member>
- <member name="M:DotSpatial.Data.Raster.OpenFile(System.String,System.Boolean,DotSpatial.Data.IProgressHandler)">
- <summary>
- Returns a native raster of the appropriate file type and data type by parsing the fileName.
- </summary>
- <param name="fileName">The string fileName to attempt to open with a native format</param>
- <param name="inRam">The boolean value.</param>
- <param name="progressHandler">An overriding progress manager for this process</param>
- <returns>An IRaster which has been opened to the specified file.</returns>
- </member>
- <member name="E:DotSpatial.Data.Raster.FileExists">
- <summary>
- Occurs when attempting to copy or save to a fileName that already exists. A developer can tap into this event
- in order to display an appropriate message. A cancel property allows the developer (and ultimately the user)
- decide if the specified event should ultimately be cancelled.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Raster.Sample">
- <summary>
- Gets or sets a statistical sampling. This is designed to cache a small,
- representative sample of no more than about 10,000 values. This property
- does not automatically produce the sample, and so this can be null.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Raster.LineSpace">
- <summary>
- A parameter for accessing some GDAL data. This frequently does nothing and is usually 0.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Raster.PixelSpace">
- <summary>
- A parameter for accessing GDAL. This frequently does nothing and is usually 0.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Raster.ByteSize">
- <summary>
- Gets the size of each raster element in bytes.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Raster.Bands">
- <summary>
- Gets or sets the list of bands, which are in turn rasters. The rasters
- contain only one band each, instead of the list of all the bands like the
- parent raster.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Raster.CellHeight">
- <summary>
- The geographic height of a cell the projected units. Setting this will
- automatically adjust the affine coefficient to a negative value.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Raster.CellWidth">
- <summary>
- The geographic width of a cell in the projected units
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Raster.CurrentBand">
- <summary>
- This provides a zero-based integer band index that specifies which of the internal bands
- is currently being used for requests for data.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Raster.CustomFileType">
- <summary>
- This does nothing unless the FileType property is set to custom.
- In such a case, this string allows new file types to be managed.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Raster.DataType">
- <summary>
- This returns the RasterDataTypes enumeration clarifying the underlying data type for this raster.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Raster.DriverCode">
- <summary>
- Gets or sets the driver code for this raster.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Raster.EndColumn">
- <summary>
- The integer column index for the right column of this raster. Most of the time this will
- be NumColumns - 1. However, if this raster is a window taken from a larger raster, then
- it will be the index of the endColumn from the window.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Raster.EndRow">
- <summary>
- The integer row index for the end row of this raster. Most of the time this will
- be numRows - 1. However, if this raster is a window taken from a larger raster, then
- it will be the index of the endRow from the window.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Raster.Filename">
- <summary>
- Gets or Sets the complete path and fileName of the current file
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Raster.FileType">
- <summary>
- Returns the grid file type. Only Binary or ASCII are supported natively, without GDAL.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Raster.IsInRam">
- <summary>
- Gets or sets a boolean that is true if the data for this raster is in memory.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Raster.Maximum">
- <summary>
- Gets the maximum data value, not counting no-data values in the grid.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Raster.Mean">
- <summary>
- Gets the mean of the non-NoData values in this grid. If the data is not InRam, then
- the GetStatistics method must be called before these values will be correct.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Raster.Minimum">
- <summary>
- Gets the minimum data value that is not classified as a no data value in this raster.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Raster.NoDataValue">
- <summary>
- A double showing the no-data value for this raster.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Raster.Notes">
- <summary>
- For binary rasters this will get cut to only 256 characters.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Raster.NumBands">
- <summary>
- Gets the number of bands. In most traditional grid formats, this is 1. For RGB images,
- this would be 3. Some formats may have many bands.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Raster.NumColumns">
- <summary>
- Gets the horizontal count of the cells in the raster.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Raster.NumColumnsInFile">
- <summary>
- Gets the integer count of the number of columns in the source or file that this
- raster is a window from. (Usually this will be the same as NumColumns)
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Raster.NumRows">
- <summary>
- Gets the vertical count of the cells in the raster.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Raster.NumRowsInFile">
- <summary>
- Gets the integer count of the number of rows in the source or file that this
- raster is a window from. (Usually this will be the same as NumColumns.)
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Raster.NumValueCells">
- <summary>
- Gets the count of the cells that are not no-data. If the data is not InRam, then
- you will have to first call the GetStatistics() method to gain meaningul values.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Raster.Options">
- <summary>
- An extra string array of options that exist for support of some types of GDAL supported raster drivers
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Raster.Rows">
- <summary>
- Gets a list of the rows in this raster that can be accessed independantly.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Raster.StartColumn">
- <summary>
- The integer column index for the left column of this raster. Most of the time this will
- be 0. However, if this raster is a window taken from a file, then
- it will be the row index in the file for the top row of this raster.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Raster.StartRow">
- <summary>
- The integer row index for the top row of this raster. Most of the time this will
- be 0. However, if this raster is a window taken from a file, then
- it will be the row index in the file for the left row of this raster.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Raster.StdDeviation">
- <summary>
- Gets the standard deviation of all the Non-nodata cells. If the data is not InRam,
- then you will have to first call the GetStatistics() method to get meaningful values.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Raster.Tag">
- <summary>
- This is provided for future developers to link this raster to other entities.
- It has no function internally, so it can be manipulated safely.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Raster.Value">
- <summary>
- Gets or sets the value on the CurrentBand given a row and column undex
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Raster.Xllcenter">
- <summary>
- Gets or sets the X position of the lower left data cell.
- Setting this will adjust only the _affine[0] coefficient to ensure that the
- lower left corner ends up in the specified location, while keeping all the
- other affine coefficients the same. This is like a horizontal Translate
- that locks into place the center of the lower left corner of the image.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Raster.Yllcenter">
- <summary>
- Gets or sets the Y position of the lower left data cell.
- Setting this will adjust only the _affine[0] coefficient to ensure that the
- lower left corner ends up in the specified location, while keeping all the
- other affine coefficients the same. This is like a horizontal Translate
- that locks into place the center of the lower left corner of the image.
- </summary>
- </member>
- <member name="F:DotSpatial.Data.Raster`1.Data">
- <summary>
- The actual data values, stored as a jagged array of values of type T
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Raster`1.#ctor">
- <summary>
- Creates a new instance of Raster
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Raster`1.#ctor(System.Int32,System.Int32,DotSpatial.Data.ValueGrid{`0})">
- <summary>
- Creates an raster of data type T
- </summary>
- <param name="numRows">The number of rows in the raster</param>
- <param name="numColumns">The number of columns in the raster</param>
- <param name="valueGrid">The default ValueGrid only supports standard numeric types, but if a different kind of value grid is needed, this allows it.</param>
- </member>
- <member name="M:DotSpatial.Data.Raster`1.#ctor(System.Int32,System.Int32)">
- <summary>
- Creates a raster of data type T.
- </summary>
- <param name="numRows">The number of rows in the raster</param>
- <param name="numColumns">The number of columns in the raster</param>
- </member>
- <member name="M:DotSpatial.Data.Raster`1.SetData(DotSpatial.Data.IRaster)">
- <summary>
- Used especially by the "save as" situation, this simply creates a new reference pointer for the actual data values.
- </summary>
- <param name="original"></param>
- </member>
- <member name="M:DotSpatial.Data.Raster`1.Initialize">
- <summary>
- Calls the basic setup for the raster
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Raster`1.Dispose(System.Boolean)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.Raster`1.Copy">
- <summary>
- Creates a deep copy of this raster object so that the data values can be manipulated without
- interfering with the original raster.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Raster`1.CopyWindow(System.String,System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean,System.Boolean)">
- <summary>
- This creates a completely new raster from the windowed domain on the original raster. This new raster
- will not have a source file, and values like NumRowsInFile will correspond to the in memory version.
- All the values will be copied to the new source file. InRam must be true at this level.
- </summary>
- <param name="fileName"></param>
- <param name="startRow">The 0 based integer index of the top row to copy from this raster. If this raster is itself a window, 0 represents the startRow from the file.</param>
- <param name="endRow">The integer index of the bottom row to copy from this raster. The largest allowed value is NumRows - 1.</param>
- <param name="startColumn">The 0 based integer index of the leftmost column to copy from this raster. If this raster is a window, 0 represents the startColumn from the file.</param>
- <param name="endColumn">The 0 based integer index of the rightmost column to copy from this raster. The largest allowed value is NumColumns - 1</param>
- <param name="copyValues">If this is true, the values are saved to the file. If this is false and the data can be loaded into Ram, no file handling is done. Otherwise, a file of NoData values is created.</param>
- <param name="inRam">Boolean. If this is true and the window is small enough, a copy of the values will be loaded into memory.</param>
- <returns>An implementation of IRaster</returns>
- </member>
- <member name="M:DotSpatial.Data.Raster`1.GetStatistics">
- <summary>
- Gets the statistics all the values. If the entire content is not currently in-ram,
- ReadRow will be used to read individual lines and performing the calculations.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Raster`1.GetWindow(System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean)">
- <summary>
- This creates an IN MEMORY ONLY window from the in-memory window of this raster. If, however, the requested range
- is outside of what is contained in the in-memory portions of this raster, an appropriate cast
- is required to ensure that you have the correct File handling, like a BinaryRaster etc.
- </summary>
- <param name="startRow">The 0 based integer index of the top row to get from this raster. If this raster is itself a window, 0 represents the startRow from the file.</param>
- <param name="endRow">The integer index of the bottom row to get from this raster. The largest allowed value is NumRows - 1.</param>
- <param name="startColumn">The 0 based integer index of the leftmost column to get from this raster. If this raster is a window, 0 represents the startColumn from the file.</param>
- <param name="endColumn">The 0 based integer index of the rightmost column to get from this raster. The largest allowed value is NumColumns - 1</param>
- <param name="inRam">Boolean. If this is true and the window is small enough, a copy of the values will be loaded into memory.</param>
- <returns>An implementation of IRaster</returns>
- </member>
- <member name="M:DotSpatial.Data.Raster`1.GetWindowStatistics">
- <summary>
- Obtains only the statistics for the small window specified by startRow, endRow etc.
- this only works if the window is also InRam.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Raster`1.Open">
- <summary>
- Prevent the base raster "factory" style open function from working in subclasses.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Raster`1.Save">
- <summary>
- This saves content from memory stored in the Data field to the file using whatever
- file format the file already exists as.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Raster`1.ReadRow(System.Int32)">
- <summary>
- Reads a specific
- </summary>
- <param name="row"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Raster`1.ReadRaster">
- <summary>
- This method reads the values from the entire band into an array and returns the array as a single array.
- This assumes 0 offsets, the size of the entire image, and 0 for the pixel or line space.
- </summary>
- <returns>An array of values of type T, in row major order</returns>
- </member>
- <member name="M:DotSpatial.Data.Raster`1.GetValuesT(System.Collections.Generic.IEnumerable{System.Int64})">
- <summary>
- Most reading is optimized to read in a block at a time and process it. This method is designed
- for seeking through the file. It should work faster than the buffered methods in cases where
- an unusually arranged collection of values are required. Sorting the list before calling
- this should significantly improve performance.
- </summary>
- <param name="indices">A list or array of long values that are (Row * NumRowsInFile + Column)</param>
- </member>
- <member name="M:DotSpatial.Data.Raster`1.GetValues(System.Collections.Generic.IEnumerable{System.Int64})">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.Raster`1.ReadBlock(System.Int32,System.Int32,System.Int32,System.Int32)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.Raster`1.ReadRaster(System.Int32,System.Int32,System.Int32,System.Int32)">
- <summary>
- This Method should be overrridden by classes, and provides the primary ability.
- </summary>
- <param name="xOff">The horizontal offset of the area to read values from.</param>
- <param name="yOff">The vertical offset of the window to read values from.</param>
- <param name="sizeX">The number of values to read into the buffer.</param>
- <param name="sizeY">The vertical size of the window to read into the buffer.</param>
- <returns>The jagged array of raster values of type T.</returns>
- </member>
- <member name="M:DotSpatial.Data.Raster`1.WriteRow(`0[],System.Int32)">
- <summary>
- Reads a specific
- </summary>
- <param name="buffer">The one dimensional array of values containing all the data for this particular content.</param>
- <param name="row">The integer row to write to the raster</param>
- </member>
- <member name="M:DotSpatial.Data.Raster`1.WriteRaster(`0[][])">
- <summary>
- This method reads the values from the entire band into an array and returns the array as a single array.
- This assumes 0 offsets, the size of the entire image, and 0 for the pixel or line space.
- </summary>
- <param name="buffer">The one dimensional array of values containing all the data for this particular content.</param>
- </member>
- <member name="M:DotSpatial.Data.Raster`1.WriteRaster(`0[][],System.Int32,System.Int32,System.Int32,System.Int32)">
- <summary>
- This method reads the values from the entire band into an array and returns the array as a single array.
- This specifies a window where the xSize and ySize specified and 0 is used for the pixel and line space.
- </summary>
- <param name="buffer">The one dimensional array of values containing all the data for this particular content.</param>
- <param name="xOff">The horizontal offset of the area to read values from.</param>
- <param name="yOff">The vertical offset of the window to read values from.</param>
- <param name="xSize">The number of values to read into the buffer.</param>
- <param name="ySize">The vertical size of the window to read into the buffer.</param>
- </member>
- <member name="M:DotSpatial.Data.Raster`1.WriteBlock(DotSpatial.Data.IRaster,System.Int32,System.Int32,System.Int32,System.Int32)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.Raster`1.UpdateHeader">
- <summary>
- During a save opperation, this instructs the program to perform any writing that is not handled by
- the write raster content.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Raster`1.ValuesT">
- <summary>
- This is the same as the "Value" member except that it is type specific.
- This also supports the "ToDouble" method.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Raster`1.ByteSize">
- <summary>
- Gets the size of each raster element in bytes.
- </summary>
- <remarks>
- This only works for a few numeric types, and will return 0 if it is not identifiable as one
- of these basic types: byte, short, int, long, float, double, decimal, sbyte, ushort, uint, ulong, bool.
- </remarks>
- </member>
- <member name="M:DotSpatial.Data.BgdRaster`1.#ctor">
- <summary>
- A BgdRaster in created this way probably expects to open a file using the "Open" method,
- which allows for progress handlers or other things to be set before what might be a
- time consuming read-value process.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.BgdRaster`1.#ctor(System.Int32,System.Int32)">
- <summary>
- Creates a new instance of a BGD raster, attempting to store the entire structure in memory if possible.
- </summary>
- <param name="numRows"></param>
- <param name="numColumns"></param>
- </member>
- <member name="M:DotSpatial.Data.BgdRaster`1.#ctor(System.String,System.Int32,System.Int32)">
- <summary>
- This creates a new BGD raster.
- </summary>
- <param name="fileName"></param>
- <param name="numRows"></param>
- <param name="numColumns"></param>
- </member>
- <member name="M:DotSpatial.Data.BgdRaster`1.ReadRaster(System.Int32,System.Int32,System.Int32,System.Int32)">
- <summary>
- This Method should be overrridden by classes, and provides the primary ability.
- </summary>
- <param name="xOff">The horizontal offset of the area to read values from.</param>
- <param name="yOff">The vertical offset of the window to read values from.</param>
- <param name="sizeX">The number of values to read into the buffer.</param>
- <param name="sizeY">The vertical size of the window to read into the buffer.</param>
- <returns>A jagged array of type T.</returns>
- </member>
- <member name="M:DotSpatial.Data.BgdRaster`1.GetValuesT(System.Collections.Generic.IEnumerable{System.Int64})">
- <summary>
- Most reading is optimized to read in a block at a time and process it. This method is designed
- for seeking through the file. It should work faster than the buffered methods in cases where
- an unusually arranged collection of values are required. Sorting the list before calling
- this should significantly improve performance.
- </summary>
- <param name="indices">A list or array of long values that are (Row * NumRowsInFile + Column)</param>
- </member>
- <member name="M:DotSpatial.Data.BgdRaster`1.WriteRaster(`0[][],System.Int32,System.Int32,System.Int32,System.Int32)">
- <summary>
- Writes the bgd content from the specified jagged array of values to the file.
- </summary>
- <param name="buffer">The data</param>
- <param name="xOff">The horizontal offset</param>
- <param name="yOff">The vertical offset</param>
- <param name="xSize">The number of values to write horizontally</param>
- <param name="ySize">The number of values to write vertically</param>
- </member>
- <member name="M:DotSpatial.Data.BgdRaster`1.Copy(System.String,System.Boolean)">
- <summary>
- Copies the raster header, and if copyValues is true, the values to the specified file </summary>
- <param name="fileName">The full path of the file to copy content to to</param>
- <param name="copyValues">Boolean, true if this should copy values as well as just header information</param>
- </member>
- <member name="M:DotSpatial.Data.BgdRaster`1.Open">
- <summary>
- Opens the specified file
- </summary>
- </member>
- <member name="M:DotSpatial.Data.BgdRaster`1.Save">
- <summary>
- Saves the content from this file using the current fileName and header information
- </summary>
- </member>
- <member name="M:DotSpatial.Data.BgdRaster`1.Write(System.String)">
- <summary>
- If no file exists, this writes the header and no-data values. If a file exists, it will assume
- that data already has been filled in the file and will attempt to insert the data values
- as a window into the file. If you want to create a copy of the file and values, just use
- System.IO.File.Copy, it almost certainly would be much more optimized.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.BgdRaster`1.WriteHeader">
- <summary>
- Writes the header to the fileName
- </summary>
- </member>
- <member name="M:DotSpatial.Data.BgdRaster`1.WriteHeader(System.String)">
- <summary>
- The string fileName where this will begin to write data by clearing the existing file
- </summary>
- </member>
- <member name="M:DotSpatial.Data.BgdRaster`1.ReadHeader(System.String)">
- <summary>
- Writes the header, regardless of which subtype of binary raster this is written for
- </summary>
- <param name="fileName">The string fileName specifying what file to load</param>
- </member>
- <member name="P:DotSpatial.Data.BgdRaster`1.HeaderSize">
- <summary>
- Gets the size of the header. There is one no-data value in the header.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IValueGrid">
- <summary>
- An inteface specification for any of the multiple types of IDataBlock.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IValueGrid.Item(System.Int32,System.Int32)">
- <summary>
- Gets or sets a value at the 0 row, 0 column index.
- </summary>
- <param name="row">The 0 based vertical row index from the top</param>
- <param name="column">The 0 based horizontal column index from the left</param>
- <returns>An object reference to the actual value in the data member.</returns>
- </member>
- <member name="P:DotSpatial.Data.IValueGrid.Updated">
- <summary>
- Boolean, gets or sets the flag indicating if the values have been changed
- since the last time this flag was set to false.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ValueGrid`1.#ctor(DotSpatial.Data.Raster{`0})">
- <summary>
- Constructing an ObjectGrid this way assumes the values are not in ram and will
- simply buffer 3 rows.
- </summary>
- <param name="sourceRaster"></param>
- </member>
- <member name="M:DotSpatial.Data.ValueGrid`1.ToDouble(`0)">
- <summary>
- This involves boxing and unboxing as well as a convert to double, but IConvertible was
- not CLS Compliant, so we were always getting warnings about it. I am trying to make
- all the code CLS Compliant to remove warnings.
- </summary>
- <param name="value"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Data.ValueGrid`1.Item(System.Int32,System.Int32)">
- <summary>
- Gets or sets a value at the 0 row, 0 column index.
- </summary>
- <param name="row">The 0 based vertical row index from the top</param>
- <param name="column">The 0 based horizontal column index from the left</param>
- <returns>An object reference to the actual value in the data member.</returns>
- </member>
- <member name="P:DotSpatial.Data.ValueGrid`1.Updated">
- <summary>
- This is just a boolean flag that is set to true when the values
- are updated. It is the responsibility of the user to set this
- value to false again when the situation warents it.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.BinaryRaster`1">
- <summary>
- This basically demonstrates how you would combine a type with a calculator in order to
- construct a Binary Raster for the Integer type. It is effectively the same as
- constructing a new BinaryRaster and specifying the parameter types int and IntCalculator.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.BinaryRaster`1.#ctor">
- <summary>
- Creates a completely empty raster that can be custom configured
- </summary>
- </member>
- <member name="M:DotSpatial.Data.BinaryRaster`1.#ctor(System.String,System.Int32,System.Int32)">
- <summary>
- Creates a new BinaryRaster with the specified rows and columns.
- If if the raster is less than 64 Million cells, it will be created only in memory,
- and a Save method should be called when ready to save it to a file. Otherwise, it creates a blank file with
- NoData values...which start out as 0.
- </summary>
- <param name="fileName">The fileName to write to</param>
- <param name="numRows">Integer number of rows</param>
- <param name="numColumns">Integer number of columns</param>
- </member>
- <member name="M:DotSpatial.Data.BinaryRaster`1.#ctor(System.String,System.Int32,System.Int32,System.Boolean)">
- <summary>
- Creates a new BinaryRaster with the specified rows and columns.
- If inRam is true and the raster is less than 64 Million cells, it will be created only in memory,
- and a Save method should be called when ready to save it to a file. Otherwise, it creates a blank file with
- NoData values.
- </summary>
- <param name="fileName">The fileName to write to</param>
- <param name="numRows">Integer number of rows</param>
- <param name="numColumns">Integer number of columns</param>
- <param name="inRam">If this is true and the raster is small enough, it will load this into memory and not save anything to the file.</param>
- </member>
- <member name="M:DotSpatial.Data.BinaryRaster`1.Copy(System.String,System.Boolean)">
- <summary>
- Creates a duplicate version of this file. If copyValues is set to false, then a raster of NoData values is created
- that has the same georeferencing information as the source file of this Raster, even if this raster is just a window.
- If the specified fileName exists, rather than throwing an exception or taking an "overwrite" parameter, this
- will throw the FileExists event, and cancel the copy if the cancel argument is set to true.
- </summary>
- <param name="fileName">The string fileName specifying where to create the new file.</param>
- <param name="copyValues">If this is false, the same size and georeferencing values are used, but they are all set to NoData.</param>
- </member>
- <member name="M:DotSpatial.Data.BinaryRaster`1.CopyWindow(System.String,System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean,System.Boolean)">
- <summary>
- This creates a completely new raster from the windowed domain on the original raster. This new raster
- will have a separate source file, and values like NumRowsInFile will correspond to the newly created file.
- All the values will be copied to the new source file. If inRam = true and the new raster is small enough,
- the raster values will be loaded into memory.
- </summary>
- <param name="fileName"></param>
- <param name="startRow">The 0 based integer index of the top row to copy from this raster. If this raster is itself a window, 0 represents the startRow from the file.</param>
- <param name="endRow">The integer index of the bottom row to copy from this raster. The largest allowed value is NumRows - 1.</param>
- <param name="startColumn">The 0 based integer index of the leftmost column to copy from this raster. If this raster is a window, 0 represents the startColumn from the file.</param>
- <param name="endColumn">The 0 based integer index of the rightmost column to copy from this raster. The largest allowed value is NumColumns - 1</param>
- <param name="copyValues">If this is true, the values are saved to the file. If this is false and the data can be loaded into Ram, no file handling is done. Otherwise, a file of NoData values is created.</param>
- <param name="inRam">Boolean. If this is true and the window is small enough, a copy of the values will be loaded into memory.</param>
- <returns>An implementation of IRaster</returns>
- </member>
- <member name="M:DotSpatial.Data.BinaryRaster`1.GetStatistics">
- <summary>
- Gets the statistics for the entire file, not just the window portion specified for this raster.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.BinaryRaster`1.GetWindow(System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean)">
- <summary>
- This creates a window from this raster. The window will still save to the same
- source file, but only has access to a small window of data, so it can be loaded like a buffer.
- The georeferenced extents will be for the new window, not the original raster. startRow and endRow
- will exist in the new raster, however, so that it knows how to copy values back to the original raster.
- </summary>
- <param name="startRow">The 0 based integer index of the top row to get from this raster. If this raster is itself a window, 0 represents the startRow from the file.</param>
- <param name="endRow">The integer index of the bottom row to get from this raster. The largest allowed value is NumRows - 1.</param>
- <param name="startColumn">The 0 based integer index of the leftmost column to get from this raster. If this raster is a window, 0 represents the startColumn from the file.</param>
- <param name="endColumn">The 0 based integer index of the rightmost column to get from this raster. The largest allowed value is NumColumns - 1</param>
- <param name="inRam">Boolean. If this is true and the window is small enough, a copy of the values will be loaded into memory.</param>
- <returns>An implementation of IRaster</returns>
- </member>
- <member name="M:DotSpatial.Data.BinaryRaster`1.GetWindowStatistics">
- <summary>
- Obtains only the statistics for the small window specified by startRow, endRow etc.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.BinaryRaster`1.Open">
- <summary>
- Opens the specified file into this raster.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.BinaryRaster`1.Open(System.String,System.Boolean)">
- <summary>
- Opens a new instance of the BinaryRaster
- </summary>
- <param name="fileName">The string fileName of the raster file to open</param>
- <param name="inRam">Boolean, indicates whether or not the values for the raster should be loaded into memory</param>
- </member>
- <member name="M:DotSpatial.Data.BinaryRaster`1.OpenWindow(System.String,System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean)">
- <summary>
- This converts this object into a raster defined by the specified window dimensions.
- </summary>
- <param name="fileName">The string fileName to open</param>
- <param name="startRow">The integer row index to become the first row to load into this raster.</param>
- <param name="endRow">The 0 based integer row index to become the last row included in this raster.</param>
- <param name="startColumn">The 0 based integer column index for the first column of the raster.</param>
- <param name="endColumn">The 0 based integer column index for the last column to include in this raster.</param>
- <param name="inRam">Boolean. If this is true and the window is small enough, this will load the window into ram.</param>
- </member>
- <member name="M:DotSpatial.Data.BinaryRaster`1.PasteRaster(DotSpatial.Data.Raster{`0},System.Int32,System.Int32)">
- <summary>
- Copies the contents from the specified sourceRaster into this sourceRaster. If both rasters are InRam, this does not affect the files.
- </summary>
- <param name="sourceRaster">The raster of values to paste into this raster. If the CellWidth and CellHeight values do not match between the files,
- an exception will be thrown. If the sourceRaster overlaps with the edge of this raster, only the intersecting region will be
- pasted.</param>
- <param name="startRow">Specifies the row in this raster where the top row of the sourceRaster will be pasted </param>
- <param name="startColumn">Specifies the column in this raster where the left column of the sourceRaster will be pasted.</param>
- </member>
- <member name="M:DotSpatial.Data.BinaryRaster`1.Read">
- <summary>
- Reads the the contents for the "window" specified by the start and end values
- for the rows and columns.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.BinaryRaster`1.ReadHeader(System.String)">
- <summary>
- Writes the header, regardless of which subtype of binary raster this is written for
- </summary>
- <param name="fileName">The string fileName specifying what file to load</param>
- </member>
- <member name="M:DotSpatial.Data.BinaryRaster`1.WriteHeader(System.String)">
- <summary>
- The string fileName where this will begin to write data by clearing the existing file
- </summary>
- <param name="fileName">a fileName to write data to</param>
- </member>
- <member name="M:DotSpatial.Data.BinaryRaster`1.WriteValue(System.Int32,System.Int32,System.Int32)">
- <summary>
- This would be a horrible choice for any kind of serious process, but is provided as
- a way to write values directly to the file.
- </summary>
- <param name="row">The 0 based integer row index for the file to write to.</param>
- <param name="column">The 0 based column index for the file to write to.</param>
- <param name="value">The actual value to write.</param>
- </member>
- <member name="M:DotSpatial.Data.BinaryRaster`1.Save">
- <summary>
- Saves the values in memory to the disk.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.BinaryRaster`1.Write(System.String)">
- <summary>
- If no file exists, this writes the header and no-data values. If a file exists, it will assume
- that data already has been filled in the file and will attempt to insert the data values
- as a window into the file. If you want to create a copy of the file and values, just use
- System.IO.File.Copy, it almost certainly would be much more optimized.
- </summary>
- <param name="fileName">The string fileName to write values to.</param>
- </member>
- <member name="P:DotSpatial.Data.BinaryRaster`1.ByteSize">
- <summary>
- Returns the size of T in bytes. This should be overridden, but
- exists as a "just-in-case" implementation that works for structs,
- but definitely won't work correctly for objects.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.BinaryRaster`1.FileType">
- <summary>
- All the binary rasters use the Binary file type
- </summary>
- </member>
- <member name="P:DotSpatial.Data.BinaryRaster`1.NumBands">
- <summary>
- This is always 1 band
- </summary>
- </member>
- <member name="P:DotSpatial.Data.BinaryRaster`1.HeaderSize">
- <summary>
- Gets the size of the header. There is one no-data value in the header.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.RasterEnumerator`1">
- <summary>
- RasterEnumerator
- </summary>
- </member>
- <member name="M:DotSpatial.Data.RasterEnumerator`1.#ctor(System.Collections.Generic.List{DotSpatial.Data.Raster{`0}})">
- <summary>
- Creates a new instance of RasterEnumerator
- </summary>
- <param name="list">The list to build an enumarator for</param>
- </member>
- <member name="M:DotSpatial.Data.RasterEnumerator`1.Dispose">
- <summary>
- Disposes any unmanaged memory objects
- </summary>
- </member>
- <member name="M:DotSpatial.Data.RasterEnumerator`1.MoveNext">
- <summary>
- Advances the enumerator to the next member.
- </summary>
- <returns>A boolean which is false if there are no more members in the list.</returns>
- </member>
- <member name="M:DotSpatial.Data.RasterEnumerator`1.Reset">
- <summary>
- Resets the enumerator to the position before the start of the list.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.RasterEnumerator`1.Current">
- <summary>
- Retrieves the current IntRaster from this calculator.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IRasterBounds">
- <summary>
- IRasterBounds
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IRasterBounds.Copy">
- <summary>
- Returns a deep copy of this raster bounds object.
- </summary>
- <returns>An IRasterBounds interface.</returns>
- </member>
- <member name="M:DotSpatial.Data.IRasterBounds.Open(System.String)">
- <summary>
- This is the overridable open method that should be used.
- The OpenWorldFile method is called by our RasterBounds class,
- but this allows custom files to be loaded and saved.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IRasterBounds.Save">
- <summary>
- This is the overridable save method that should be used.
- The OpenWorldFile method is called by our RasterBounds class,
- but this allows custom files to be loaded and saved.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IRasterBounds.AffineCoefficients">
- <summary>
- Gets or sets the double affine coefficients that control the world-file
- positioning of this image. X' and Y' are real world coords.
- X' = [0] + [1] * Column + [2] * Row
- Y' = [3] + [4] * Column + [5] * Row
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IRasterBounds.CellWidth">
- <summary>
- Gets or sets the desired width per cell. This will keep the skew the same, but
- will adjust both the column based and row based width coefficients in order
- to match the specified cell width. This can be thought of as the width
- of a bounding box that contains an entire grid cell, no matter if it is skewed.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IRasterBounds.CellHeight">
- <summary>
- Gets or sets the desired height per cell. This will keep the skew the same, but
- will adjust both the column based and row based height coefficients in order
- to match the specified cell height. This can be thought of as the height
- of a bounding box that contains an entire grid cell, no matter if it is skewed.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IRasterBounds.Extent">
- <summary>
- Gets or sets the rectangular confines for this envelope. The skew will remain
- the same when setting this, but the image will be translated and stretched
- to fit in the specified envelope.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IRasterBounds.NumRows">
- <summary>
- Gets the number of rows in the raster.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IRasterBounds.NumColumns">
- <summary>
- Gets the number of columns in the raster.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IRasterBounds.WorldFile">
- <summary>
- Gets or sets the world file name. This won't do anything until the "Load" or "Save" methods are called.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IValueRow">
- <summary>
- A public interface definition for a single row of values that should be supported
- by any of the generic data row types.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IValueRow.Item(System.Int32)">
- <summary>
- Gets or sets the value in the position of column.
- </summary>
- <param name="cell">The 0 based integer column index to access on this row.</param>
- <returns>An object reference to the actual data value, which can be many types.</returns>
- </member>
- <member name="T:DotSpatial.Data.RasterBounds">
- <summary>
- RasterBounds
- </summary>
- </member>
- <member name="M:DotSpatial.Data.RasterBounds.#ctor">
- <summary>
- Creates a new RasterBounds
- </summary>
- </member>
- <member name="M:DotSpatial.Data.RasterBounds.#ctor(System.Int32,System.Int32,System.String)">
- <summary>
- Attempts to read the very simple 6 number world file associated with an image
- </summary>
- <param name="numRows">The number of rows in this raster</param>
- <param name="numColumns">The number of columns in this raster</param>
- <param name="worldFileName">A world file to attempt to read</param>
- </member>
- <member name="M:DotSpatial.Data.RasterBounds.#ctor(System.Int32,System.Int32,System.Double[])">
- <summary>
- Creates a new instance of the RasterBounds class
- </summary>
- <param name="numRows">The number of rows for this raster</param>
- <param name="numColumns">The number of columns for this raster</param>
- <param name="affineCoefficients">The affine coefficients describing the location of this raster.</param>
- </member>
- <member name="M:DotSpatial.Data.RasterBounds.#ctor(System.Int32,System.Int32,DotSpatial.Data.Extent)">
- <summary>
- Creates a new raster bounds that is georeferenced to the specified envelope.
- </summary>
- <param name="numRows">The number of rows</param>
- <param name="numColumns">The number of columns</param>
- <param name="bounds">The bounding envelope</param>
- </member>
- <member name="M:DotSpatial.Data.RasterBounds.Open(System.String)">
- <summary>
- Attempts to load the data from the file listed in WorldFile
- </summary>
- </member>
- <member name="M:DotSpatial.Data.RasterBounds.Save">
- <summary>
- Attempts to save the data to the file listed in WorldFile
- </summary>
- </member>
- <member name="M:DotSpatial.Data.RasterBounds.Clone">
- <summary>
- Returns a duplicate of this object as an object.
- </summary>
- <returns>A duplicate of this object as an object.</returns>
- </member>
- <member name="M:DotSpatial.Data.RasterBounds.Copy">
- <summary>
- Creates a duplicate of this RasterBounds class.
- </summary>
- <returns>A RasterBounds that has the same properties but does not point to the same internal array.</returns>
- </member>
- <member name="P:DotSpatial.Data.RasterBounds.AffineCoefficients">
- <summary>
- Gets or sets the double affine coefficients that control the world-file
- positioning of this image. X' and Y' are real world coords.
- X' = [0] + [1] * Column + [2] * Row
- Y' = [3] + [4] * Column + [5] * Row
- </summary>
- </member>
- <member name="P:DotSpatial.Data.RasterBounds.CellWidth">
- <summary>
- Gets or sets the desired width per cell. This will keep the skew the same, but
- will adjust both the column based and row based width coefficients in order
- to match the specified cell width. This can be thought of as the width
- of a bounding box that contains an entire grid cell, no matter if it is skewed.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.RasterBounds.CellHeight">
- <summary>
- Gets or sets the desired height per cell. This will keep the skew the same, but
- will adjust both the column based and row based height coefficients in order
- to match the specified cell height. This can be thought of as the height
- of a bounding box that contains an entire grid cell, no matter if it is skewed.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.RasterBounds.Extent">
- <summary>
- Gets or sets the rectangular bounding box for this raster.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.RasterBounds.Height">
- <summary>
- Gets or sets the height of the entire bounds. This is derived by considering both the
- column and row based contributions to the overall height. Changing this will keep
- the skew ratio the same, but adjust both portions so that the overall height
- will match the specified height.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.RasterBounds.NumRows">
- <summary>
- Gets the number of rows in the raster.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.RasterBounds.NumColumns">
- <summary>
- Gets the number of columns in the raster.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.RasterBounds.Width">
- <summary>
- Gets or sets the geographic width of this raster. This will include the skew term
- in the width estimate, so it will adjust both the width and the skew coefficient,
- but preserve the ratio of skew to cell width.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.RasterBounds.WorldFile">
- <summary>
- Gets or sets the fileName of the wordfile that describes the geographic coordinates of this raster.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.RasterBounds.X">
- <summary>
- Gets or sets the horizontal placement of the upper left corner of this bounds. Because
- of the skew, this upper left position may not actually be the same as the upper left
- corner of the image itself (_affine[0]). Instead, this is the top left corner of
- the rectangular extent for this raster.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.RasterBounds.Y">
- <summary>
- Gets or sets the vertical placement of the upper left corner of this bounds, which is the
- same as the top. The top left corner of the actual image may not be in this position
- because of skew, but this represents the maximum Y value of the rectangular extents
- that contains the image.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.RasterDataType">
- <summary>
- Data types specific to grids
- </summary>
- </member>
- <member name="F:DotSpatial.Data.RasterDataType.INVALID">
- <summary>
- An invalid data type
- </summary>
- </member>
- <member name="F:DotSpatial.Data.RasterDataType.SHORT">
- <summary>
- Short 16 Bit integers
- </summary>
- </member>
- <member name="F:DotSpatial.Data.RasterDataType.INTEGER">
- <summary>
- 32 Bit Integers (old style long)
- </summary>
- </member>
- <member name="F:DotSpatial.Data.RasterDataType.SINGLE">
- <summary>
- Float or Single
- </summary>
- </member>
- <member name="F:DotSpatial.Data.RasterDataType.DOUBLE">
- <summary>
- Double
- </summary>
- </member>
- <member name="F:DotSpatial.Data.RasterDataType.UNKNOWN">
- <summary>
- Unknown
- </summary>
- </member>
- <member name="F:DotSpatial.Data.RasterDataType.BYTE">
- <summary>
- Byte
- </summary>
- </member>
- <member name="F:DotSpatial.Data.RasterDataType.CUSTOM">
- <summary>
- Specified as the CustomType string
- </summary>
- </member>
- <member name="F:DotSpatial.Data.RasterDataType.LONG">
- <summary>
- Signed 64 Bit Integers
- </summary>
- </member>
- <member name="F:DotSpatial.Data.RasterDataType.USHORT">
- <summary>
- Unsigned short 16 Bit Integers
- </summary>
- </member>
- <member name="F:DotSpatial.Data.RasterDataType.UINTEGER">
- <summary>
- Unsigned 32 Bit Integers
- </summary>
- </member>
- <member name="F:DotSpatial.Data.RasterDataType.ULONG">
- <summary>
- Unsigned 64 Bit Integers
- </summary>
- </member>
- <member name="F:DotSpatial.Data.RasterDataType.SBYTE">
- <summary>
- Signed 8-bit Integers: -128 to 127
- </summary>
- </member>
- <member name="F:DotSpatial.Data.RasterDataType.BOOL">
- <summary>
- Booleans: True(1) or False(0).
- </summary>
- </member>
- <member name="T:DotSpatial.Data.RasterFileType">
- <summary>
- RasterFileTypes
- </summary>
- </member>
- <member name="F:DotSpatial.Data.RasterFileType.ASCII">
- <summary>
- Ascii
- </summary>
- </member>
- <member name="F:DotSpatial.Data.RasterFileType.BIL">
- <summary>
- Binary interlaced Layers
- </summary>
- </member>
- <member name="F:DotSpatial.Data.RasterFileType.BINARY">
- <summary>
- BGD (Original DotSpatial format)
- </summary>
- </member>
- <member name="F:DotSpatial.Data.RasterFileType.DTED">
- <summary>
- DTED
- </summary>
- </member>
- <member name="F:DotSpatial.Data.RasterFileType.ECW">
- <summary>
- Wavelet format
- </summary>
- </member>
- <member name="F:DotSpatial.Data.RasterFileType.ESRI">
- <summary>
- ArcGIS format
- </summary>
- </member>
- <member name="F:DotSpatial.Data.RasterFileType.FLT">
- <summary>
- FLT
- </summary>
- </member>
- <member name="F:DotSpatial.Data.RasterFileType.GeoTiff">
- <summary>
- GeoTiff
- </summary>
- </member>
- <member name="F:DotSpatial.Data.RasterFileType.MrSID">
- <summary>
- SID
- </summary>
- </member>
- <member name="F:DotSpatial.Data.RasterFileType.PAUX">
- <summary>
- AUX
- </summary>
- </member>
- <member name="F:DotSpatial.Data.RasterFileType.PCIDsk">
- <summary>
- PCIDsk
- </summary>
- </member>
- <member name="F:DotSpatial.Data.RasterFileType.SDTS">
- <summary>
- SDTS
- </summary>
- </member>
- <member name="F:DotSpatial.Data.RasterFileType.CUSTOM">
- <summary>
- Custom - specified as string
- </summary>
- </member>
- <member name="T:DotSpatial.Data.RcIndex">
- <summary>
- A Row, Column indexer for some return types.
- </summary>
- </member>
- <member name="F:DotSpatial.Data.RcIndex.Column">
- <summary>
- The zero based integer column index
- </summary>
- </member>
- <member name="F:DotSpatial.Data.RcIndex.Row">
- <summary>
- The zero based integer row index
- </summary>
- </member>
- <member name="M:DotSpatial.Data.RcIndex.#ctor(System.Int32,System.Int32)">
- <summary>
- Creates a new RcIndex structure with the specified coordinates
- </summary>
- <param name="row">The integer row index</param>
- <param name="column">The integer column index</param>
- </member>
- <member name="M:DotSpatial.Data.RcIndex.IsEmpty">
- <summary>
- Gets a boolean that is true if either row or column index has no value
- </summary>
- <returns>Boolean, true if either row or column has no value</returns>
- </member>
- <member name="M:DotSpatial.Data.RcIndex.op_Equality(DotSpatial.Data.RcIndex,DotSpatial.Data.RcIndex)">
- <summary>
- Implements the operator ==.
- </summary>
- <param name="a">A.</param>
- <param name="b">The b.</param>
- <returns>
- The result of the operator.
- </returns>
- </member>
- <member name="M:DotSpatial.Data.RcIndex.op_Inequality(DotSpatial.Data.RcIndex,DotSpatial.Data.RcIndex)">
- <summary>
- Implements the operator !=.
- </summary>
- <param name="a">A.</param>
- <param name="b">The b.</param>
- <returns>
- The result of the operator.
- </returns>
- </member>
- <member name="P:DotSpatial.Data.RcIndex.Empty">
- <summary>
- Returns a new RcIndex that is defined as empty when both indices are int.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Smoother.#ctor(System.Int32,System.Int32,System.Int32,System.Byte[],DotSpatial.Data.IProgressHandler)">
- <summary>
- Creates a new instance of Smoother
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Smoother.#ctor(System.Int32,System.Int32,System.Int32,System.IntPtr,DotSpatial.Data.IProgressHandler)">
- <summary>
- Creates a new instance of Smoother with IntPtr for input array
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Smoother.Smooth">
- <summary>
- Calculates the smoothing by cycling through the values
- </summary>
- </member>
- <member name="T:DotSpatial.Data.ScaleBarInfo">
- <summary>
- ScaleBarInfo
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ScaleBarInfo.BackColor">
- <summary>
- Gets or sets the backcolor
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ScaleBarInfo.ForeColor">
- <summary>
- Gets or sets the forecolor
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ScaleBarInfo.Position">
- <summary>
- Gets or sets what position that the scalebar should load in
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ScaleBarInfo.Unit">
- <summary>
- Gets or sets the unit for the scalebar.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ScaleBarInfo.Visible">
- <summary>
- Gets or sets whether to show the scale bar.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.ScaleBarPosition">
- <summary>
- ScaleBarPositions
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ScaleBarPosition.LowerLeft">
- <summary>
- The scalebar should appear in the lower left corner
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ScaleBarPosition.LowerRight">
- <summary>
- The scalebar should appear in the lower right corner
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ScaleBarPosition.UpperLeft">
- <summary>
- The scalebar should appear in the upper left corner
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ScaleBarPosition.UpperRight">
- <summary>
- The scalebar should apepar int eh upper right corner
- </summary>
- </member>
- <member name="T:DotSpatial.Data.SpaceTimeSupport">
- <summary>
- SpaceTimeSupport
- </summary>
- </member>
- <member name="F:DotSpatial.Data.SpaceTimeSupport.Spatial">
- <summary>
- Spatial (X, Y, Z or M information only)
- </summary>
- </member>
- <member name="F:DotSpatial.Data.SpaceTimeSupport.Temporal">
- <summary>
- Temporal (time information only)
- </summary>
- </member>
- <member name="F:DotSpatial.Data.SpaceTimeSupport.SpatioTemporal">
- <summary>
- SpatioTemporal (time and space information)
- </summary>
- </member>
- <member name="F:DotSpatial.Data.SpaceTimeSupport.Other">
- <summary>
- Other (no temporal or spatial information)
- </summary>
- </member>
- <member name="T:DotSpatial.Data.StatusBarInfo">
- <summary>
- StatusBarInfo
- </summary>
- </member>
- <member name="P:DotSpatial.Data.StatusBarInfo.Alternate">
- <summary>
- Gets or sets the alternate string to show in the event that GetFromProjection is false.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.StatusBarInfo.GetFromProjection">
- <summary>
- Gets or sets a boolean indicating whether or not status bar coordinates should display the unites derived from the projection string.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.StreamExt">
- <summary>
- Stream extensions
- </summary>
- </member>
- <member name="M:DotSpatial.Data.StreamExt.ReadBytes(System.IO.Stream,System.Int32)">
- <summary>
- Attempts to read count of bytes from stream.
- </summary>
- <param name="stream">Input stream.</param>
- <param name="count">Count of bytes.</param>
- <returns>Bytes array.</returns>
- </member>
- <member name="M:DotSpatial.Data.StreamExt.ReadInt32(System.IO.Stream,DotSpatial.Data.Endian)">
- <summary>
- Attempts to read the specified T. If this system is
- doesn't match the specified endian, then this will reverse the array of bytes,
- so that it corresponds with the big-endian format.
- </summary>
- <param name="stream">The stream to read the value from</param>
- <param name="endian">Specifies what endian property should be used.</param>
- <returns>The integer value</returns>
- </member>
- <member name="M:DotSpatial.Data.StreamExt.ReadInt32(System.IO.Stream,System.Int32,DotSpatial.Data.Endian)">
- <summary>
- Reads the specified number of integers. If a value other than the
- systems endian format is specified the values will be reversed.
- </summary>
- <param name="stream">The stream to read from</param>
- <param name="count">The integer count of integers to read</param>
- <param name="endian">The endian order of the bytes.</param>
- <returns>The array of integers that will have count integers.</returns>
- </member>
- <member name="M:DotSpatial.Data.StreamExt.ReadDouble(System.IO.Stream)">
- <summary>
- Reads a double precision value from the stream. If this system
- is not little endian, it will reverse the individual memebrs.
- </summary>
- <param name="stream">The stream to read the values from.</param>
- <returns>A double precision value</returns>
- </member>
- <member name="M:DotSpatial.Data.StreamExt.ReadDouble(System.IO.Stream,System.Int32,DotSpatial.Data.Endian)">
- <summary>
- Reads the specified number of double precision values. If this system
- does not match the specified endian, the bytes will be reversed.
- </summary>
- <param name="stream">The stream to read the values from.</param>
- <param name="count">The integer count of doubles to read.</param>
- <param name="endian">The endian to use.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.StreamExt.WriteBe(System.IO.Stream,System.Int32)">
- <summary>
- Writes the integer as big endian
- </summary>
- <param name="stream">The IO stream </param>
- <param name="value"></param>
- </member>
- <member name="M:DotSpatial.Data.StreamExt.WriteLe(System.IO.Stream,System.Int32)">
- <summary>
- Writes the endian as little endian
- </summary>
- <param name="stream"></param>
- <param name="value"></param>
- </member>
- <member name="M:DotSpatial.Data.StreamExt.WriteLe(System.IO.Stream,System.Int32[],System.Int32,System.Int32)">
- <summary>
- Checks that the endian order is ok for integers and then writes
- the entire array to the stream.
- </summary>
- <param name="stream"></param>
- <param name="values"></param>
- <param name="startIndex"></param>
- <param name="count"></param>
- </member>
- <member name="M:DotSpatial.Data.StreamExt.WriteLe(System.IO.Stream,System.Double)">
- <summary>
- Writes the specified double value to the stream as little endian
- </summary>
- <param name="stream"></param>
- <param name="value"></param>
- </member>
- <member name="M:DotSpatial.Data.StreamExt.WriteLe(System.IO.Stream,System.Double[],System.Int32,System.Int32)">
- <summary>
- Checks that the endian order is ok for doubles and then writes
- the entire array to the stream.
- </summary>
- <param name="stream">The stream to write to</param>
- <param name="values">The double values to write in little endian form</param>
- <param name="startIndex">The integer start index in the double array to begin writing</param>
- <param name="count">The integer count of doubles to write.</param>
- </member>
- <member name="T:DotSpatial.Data.ByteBlock">
- <summary>
- ByteBlock
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ByteBlock.BlockSize">
- <summary>
- The block size of the arrays
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ByteBlock.Blocks">
- <summary>
- All the blocks
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ByteBlock.CurrentBlock">
- <summary>
- The current block index
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ByteBlock.Offset">
- <summary>
- The offset
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ByteBlock.#ctor(System.Int32)">
- <summary>
- Creates a new instance of ByteBlock
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ByteBlock.Read(System.Int32,System.IO.Stream)">
- <summary>
- Reads the number of bytes using the specified reader.
- This handles copying across blocks if necessary.
- </summary>
- <param name="numBytes">The integer number of bytes to read</param>
- <param name="stream">The file or data stream to read from.</param>
- </member>
- <member name="M:DotSpatial.Data.ByteBlock.Read(System.Int32,DotSpatial.Data.BufferedBinaryReader)">
- <summary>
- Reads the number of bytes using the specified reader.
- This handles copying across blocks if necessary.
- </summary>
- <param name="numBytes"></param>
- <param name="reader"></param>
- </member>
- <member name="M:DotSpatial.Data.ByteBlock.IntOffset">
- <summary>
- If the bytes were converted to a single, contiguous integer array, this returns
- the current offset in that array.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.ByteBlock.DoubleOffset">
- <summary>
- If the bytes were converted to a single contiguous double array, this returns
- the offset in that array.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.ByteBlock.Reset">
- <summary>
- Resets the indices
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ByteBlock.ToIntArray">
- <summary>
- Combines all the blocks into a single array of the specified datatype
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.ByteBlock.ToDoubleArray">
- <summary>
- Combines all the blocks into a single array of the specified datatype
- </summary>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Data.Feature">
- <summary>
- A generic vector feature that has the geometry and data components but no drawing information
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IFeature">
- <summary>
- A feature doesn't need to be abstract because the geometry is generic and the other
- properties are all the same. It supports IRenderable so that even if you don't
- know what type of feature this is, you can still tell it to draw itself. You won't
- be able to specify any drawing characteristics from this object however.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IFeature.Copy">
- <summary>
- Creates a deep copy of this feature. the new datarow created will not be connected
- to a data Table, so it should be added to one.
- </summary>
- <returns>Returns a deep copy of this feature as an IFeature</returns>
- </member>
- <member name="M:DotSpatial.Data.IFeature.ToShape">
- <summary>
- Creates a new shape based on this feature by itself.
- </summary>
- <returns>A Shape object</returns>
- </member>
- <member name="M:DotSpatial.Data.IFeature.CopyAttributes(DotSpatial.Data.IFeature)">
- <summary>
- This uses the field names to copy attribute values from the source to this feature.
- Even if columns are missing or if there are extra columns, this method should work.
- </summary>
- <param name="source">The IFeature source to copy attributes from.</param>
- </member>
- <member name="P:DotSpatial.Data.IFeature.DataRow">
- <summary>
- Gets the datarow containing all the attributes related to this geometry
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IFeature.BasicGeometry">
- <summary>
- Gets or sets a valid IBasicGeometry associated with the data elements of this feature.
- This will be enough geometry information to cast into a full fledged geometry
- that can be used in coordination with DotSpatial.Analysis
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IFeature.ContentLength">
- <summary>
- Gets or sets the content length. If the geometry for this shape was loaded from a file, this contains the size
- of this shape in 16-bit words as per the Esri Shapefile specification.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IFeature.EnvelopeSource">
- <summary>
- Gets or sets a DotSpatial.Data.CacheTypes enumeration specifying whether the Envelope property
- returns a cached value in this object or is retrieved directly from the geometry. The
- initial case for Shapefiles is to use a cache. Setting the envelope assumes that you
- are going to use a cached value and will set this to Cached. Setting this to Dynamic
- will cause the Envelope property to reference the geometry.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IFeature.Fid">
- <summary>
- Gets the key that is associated with this feature. This returns -1 if
- this feature is not a member of a feature layer.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IFeature.ParentFeatureSet">
- <summary>
- Gets a reference to the IFeatureLayer that contains this item.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IFeature.RecordNumber">
- <summary>
- An index value that is saved in some file formats.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IFeature.ShapeType">
- <summary>
- When a shape is loaded from a Shapefile, this will identify whether M or Z values are used
- and whether or not the shape is null.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IFeature.ShapeIndex">
- <summary>
- This is simply a quick access to the Vertices list for this specific
- feature. If the Vertices have not yet been defined, this will be null.
- </summary>
- </member>
- <member name="F:DotSpatial.Data.Feature.ComparisonField">
- <summary>
- Gets or sets the column to use when sorting lists of features.
- If this is set to a column not in the field, the FID is used instead.
- This should be assigned before attempting to sort features. Because
- this is static, it only has to be set once, and will affect
- all the individual comparisions until it is set differently.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Feature.#ctor(DotSpatial.Data.Shape)">
- <summary>
- Creates a feature from the specified shape. This will not handle the attribute content,
- which should be handles separately, with full knowledge of the desired schema.
- </summary>
- <param name="shape">The shape to read the vertices from in order to build a proper geometry.</param>
- </member>
- <member name="M:DotSpatial.Data.Feature.#ctor(DotSpatial.Data.Vertex)">
- <summary>
- Creates a complete geometric feature based on a single point. The attribute datarow is null.
- </summary>
- <param name="point">The vertex</param>
- </member>
- <member name="M:DotSpatial.Data.Feature.#ctor(DotSpatial.Topology.Coordinate)">
- <summary>
- Creates a single point feature from a new point.
- </summary>
- <param name="c"></param>
- </member>
- <member name="M:DotSpatial.Data.Feature.#ctor(DotSpatial.Topology.IBasicGeometry)">
- <summary>
- Creates a feature from a geometry
- </summary>
- <param name="geometry">The geometry to turn into a feature</param>
- </member>
- <member name="M:DotSpatial.Data.Feature.#ctor(DotSpatial.Topology.IBasicGeometry,DotSpatial.Data.IFeatureSet)">
- <summary>
- This constructor allows the creation of a feature but will automatically
- add the feature to the parent featureset.
- </summary>
- <param name="geometry">The IBasicGeometry to use for this feature</param>
- <param name="parent">The IFeatureSet to add this feature to.</param>
- </member>
- <member name="M:DotSpatial.Data.Feature.#ctor">
- <summary>
- Constructs a new Feature
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Feature.#ctor(DotSpatial.Topology.FeatureType,System.Collections.Generic.IEnumerable{DotSpatial.Topology.Coordinate})">
- <summary>
- Creates a new instance of a feature, by specifying the feature type enumeration and a
- set of coordinates that can be either a list or an array as long as it is enumerable.
- </summary>
- <param name="featureType">The feature type</param>
- <param name="coordinates">The coordinates to pass</param>
- </member>
- <member name="M:DotSpatial.Data.Feature.System#IComparable{DotSpatial#Data#IFeature}#CompareTo(DotSpatial.Data.IFeature)">
- <summary>
- The FID comparison will be very slow, so this should only be used
- if the ComparisonField property is set. This will allow sorting
- features based on their data-row attributes. The data rows
- do not have to be identical, as long as both contain a column
- with the comparison field.
- </summary>
- <param name="other">The other IFeature to compare to.</param>
- <returns>An integer that controls the sorting based on the values for the specified field name.</returns>
- </member>
- <member name="M:DotSpatial.Data.Feature.GetBasicGeometryN(System.Int32)">
- <summary>
- This returns itself as the first geometry
- </summary>
- <returns>An IBasicGeometry interface</returns>
- <exception cref="T:System.IndexOutOfRangeException">Index cannot be less than 0 or greater than 1</exception>
- </member>
- <member name="M:DotSpatial.Data.Feature.PointInList(DotSpatial.Topology.Coordinate,System.Collections.Generic.IEnumerable{DotSpatial.Topology.Coordinate})">
- <summary>
- Test if a point is in a list of coordinates.
- </summary>
- <param name="testPoint">TestPoint the point to test for.</param>
- <param name="pointList">PointList the list of points to look through.</param>
- <returns>true if testPoint is a point in the pointList list.</returns>
- </member>
- <member name="M:DotSpatial.Data.Feature.DotSpatial#Data#IFeature#Copy">
- <summary>
- Creates a deep copy of this feature.
- </summary>
- <returns>Returns a deep copy of this feature as an IFeature</returns>
- </member>
- <member name="M:DotSpatial.Data.Feature.CopyAttributes(DotSpatial.Data.IFeature)">
- <summary>
- This uses the field names to copy attribute values from the source to this feature.
- Even if columns are missing or if there are extra columns, this method should work.
- </summary>
- <param name="source">The IFeature source to copy attributes from.</param>
- </member>
- <member name="M:DotSpatial.Data.Feature.System#ICloneable#Clone">
- <summary>
- Creates a deep copy of this feature.
- </summary>
- <returns>Returns a deep copy of this feature as an object</returns>
- </member>
- <member name="M:DotSpatial.Data.Feature.UpdateEnvelope">
- <summary>
- Forces the geometry to update its envelope, and then updates the cached envelope of the feature.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Feature.ExportToGml">
- <summary>
- Creates a new GML string describing the location of this point
- </summary>
- <returns>A String representing the Geographic Markup Language version of this point</returns>
- </member>
- <member name="M:DotSpatial.Data.Feature.ToBinary">
- <summary>
- Returns the Well-known Binary representation of this <c>Geometry</c>.
- For a definition of the Well-known Binary format, see the OpenGIS Simple
- Features Specification.
- </summary>
- <returns>The Well-known Binary representation of this <c>Geometry</c>.</returns>
- </member>
- <member name="M:DotSpatial.Data.Feature.ToShape">
- <summary>
- Creates a new shape based on this feature by itself.
- </summary>
- <returns>A Shape object</returns>
- </member>
- <member name="M:DotSpatial.Data.Feature.Copy">
- <summary>
- Copies this feature, creating an independant, but identical feature.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Feature.OnCopy(DotSpatial.Data.Feature)">
- <summary>
- Occurs during the cloning process and this method also duplicates the envelope and basic geometry.
- </summary>
- <param name="copy">The feature being copied</param>
- </member>
- <member name="P:DotSpatial.Data.Feature.NumParts">
- <summary>
- Gets or sets the integer number of parts associated with this feature.
- Setting this will set a cached value on the feature that is separate
- from the geometry and set the NumParts to Cached.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Feature.NumPartsSource">
- <summary>
- Gets or sets a DotSpatial.Data.CacheTypes enumeration. If the value
- is dynamic, then NumParts will be read from the geometry on this feature.
- If it is cached, then the value is separate from the geometry.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Feature.Offset">
- <summary>
- This specifies the offset, if any in the data file
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Feature.BasicGeometry">
- <summary>
- Gets or sets a valid IBasicGeometry associated with the data elements of this feature.
- This will be enough geometry information to cast into a full fledged geometry
- that can be used in coordination with DotSpatial.Analysis
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Feature.ContentLength">
- <summary>
- If the geometry for this shape was loaded from a file, this contains the size
- of this shape in 16-bit words as per the Esri Shapefile specification.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Feature.Coordinates">
- <summary>
- Returns an array of coordinates corresponding to the basic feature.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Feature.DataRow">
- <summary>
- Gets the datarow containing all the attributes related to this geometry.
- This will query the parent feature layer's data Table by FID and then
- cache the value locally. If no parent feature layer exists, then
- this is meaningless. You should create a new Feature by doing
- FeatureLayer.Features.Add(), which will return a new Feature.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Feature.Envelope">
- <summary>
- This is an envelope, but specified by the file, not by calculating from the geometry.
- To obtain a calculated envelope, calling the DynamicEnvelope()
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Feature.EnvelopeSource">
- <summary>
- Gets or sets a DotSpatial.Data.CacheTypes enumeration specifying whether the Envelope property
- returns a cached value in this object or is retrieved directly from the geometry. The
- initial case for Shapefiles is to use a cache. Setting the envelope assumes that you
- are going to use a cached value and will set this to Cached. Setting this to Dynamic
- will cause the Envelope property to reference the geometry.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Feature.FeatureType">
- <summary>
- Returns either Point, Polygon or Line
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Feature.Fid">
- <summary>
- Gets the key that is associated with this feature. This returns -1 if
- this feature is not a member of a feature layer.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Feature.GeometryType">
- <summary>
- Shows the type of geometry for this feature
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Feature.NumGeometries">
- <summary>
- Returns the NumGeometries in the BasicGeometry of this feature
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Feature.NumPoints">
- <summary>
- Gets the integer number of points associated with features.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Feature.RecordNumber">
- <summary>
- An index value that is saved in some file formats.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Feature.ParentFeatureSet">
- <summary>
- Gets a reference to the IFeatureLayer that contains this item.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Feature.ShapeType">
- <summary>
- When a shape is loaded from a Shapefile, this will identify whether M or Z values are used
- and whether or not the shape is null.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Feature.ShapeIndex">
- <summary>
- This is simply a quick access to the Vertices list for this specific
- feature. If the Vertices have not yet been defined, this will be null.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.FeatureExt">
- <summary>
- Extension Methods for the Features
- </summary>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.Area(DotSpatial.Data.IFeature)">
- <summary>
- Calculates the area of the geometric portion of this feature. This is 0 unless the feature
- is a polygon, or multi-polygon.
- </summary>
- <param name="self">The feature to test</param>
- <returns>The double valued area</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.Buffer(DotSpatial.Data.IFeature,System.Double)">
- <summary>
- Generates a new feature from the buffer of this feature. The DataRow of
- the new feature will be null.
- </summary>
- <param name="self">This feature</param>
- <param name="distance">The double distance</param>
- <returns>An IFeature representing the output from the buffer operation</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.Buffer(DotSpatial.Data.IFeature,System.Double,DotSpatial.Topology.BufferStyle)">
- <summary>
- Generates a new feature from the buffer of this feature. The DataRow of
- the new feature will be null.
- </summary>
- <param name="self">This feature</param>
- <param name="distance">The double distance</param>
- <param name="endCapStyle">The end cap style to use</param>
- <returns>An IFeature representing the output from the buffer operation</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.Buffer(DotSpatial.Data.IFeature,System.Double,System.Int32)">
- <summary>
- Generates a new feature from the buffer of this feature. The DataRow of
- the new feature will be null.
- </summary>
- <param name="self">This feature</param>
- <param name="distance">The double distance</param>
- <param name="quadrantSegments">The number of segments to use to approximate a quadrant of a circle</param>
- <returns>An IFeature representing the output from the buffer operation</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.Buffer(DotSpatial.Data.IFeature,System.Double,System.Int32,DotSpatial.Topology.BufferStyle)">
- <summary>
- Generates a new feature from the buffer of this feature. The DataRow of
- the new feature will be null.
- </summary>
- <param name="self">This feature</param>
- <param name="distance">The double distance</param>
- <param name="quadrantSegments">The number of segments to use to approximate a quadrant of a circle</param>
- <param name="endCapStyle">The end cap style to use</param>
- <returns>An IFeature representing the output from the buffer operation</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.Buffer(DotSpatial.Data.IFeature,System.Double,DotSpatial.Data.IFeatureSet)">
- <summary>
- Generates a buffer, but also adds the newly created feature to the specified output featureset.
- This will also compare the field names of the input featureset with the destination featureset.
- If a column name exists in both places, it will copy those values to the destination featureset.
- </summary>
- <param name="self">The feature to calcualate the buffer for.</param>
- <param name="distance">The double distance to use for calculating the buffer</param>
- <param name="destinationFeatureset">The output featureset to add this feature to and use
- as a reference for determining which data columns to copy.</param>
- <returns>The IFeature that represents the buffer feature.</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.Buffer(DotSpatial.Data.IFeature,System.Double,DotSpatial.Topology.BufferStyle,DotSpatial.Data.IFeatureSet)">
- <summary>
- Generates a buffer, but also adds the newly created feature to the specified output featureset.
- This will also compare the field names of the input featureset with the destination featureset.
- If a column name exists in both places, it will copy those values to the destination featureset.
- </summary>
- <param name="self">The feature to calcualate the buffer for.</param>
- <param name="distance">The double distance to use for calculating the buffer</param>
- <param name="endCapStyle">The end cap style to use</param>
- <param name="destinationFeatureset">The output featureset to add this feature to and use
- as a reference for determining which data columns to copy.</param>
- <returns>The IFeature that represents the buffer feature.</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.Buffer(DotSpatial.Data.IFeature,System.Double,System.Int32,DotSpatial.Data.IFeatureSet)">
- <summary>
- Generates a buffer, but also adds the newly created feature to the specified output featureset.
- This will also compare the field names of the input featureset with the destination featureset.
- If a column name exists in both places, it will copy those values to the destination featureset.
- </summary>
- <param name="self">The feature to calcualate the buffer for.</param>
- <param name="distance">The double distance to use for calculating the buffer</param>
- <param name="quadrantSegments">The number of segments to use to approximate a quadrant of a circle</param>
- <param name="destinationFeatureset">The output featureset to add this feature to and use
- as a reference for determining which data columns to copy.</param>
- <returns>The IFeature that represents the buffer feature.</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.Buffer(DotSpatial.Data.IFeature,System.Double,System.Int32,DotSpatial.Topology.BufferStyle,DotSpatial.Data.IFeatureSet)">
- <summary>
- Generates a buffer, but also adds the newly created feature to the specified output featureset.
- This will also compare the field names of the input featureset with the destination featureset.
- If a column name exists in both places, it will copy those values to the destination featureset.
- </summary>
- <param name="self">The feature to calcualate the buffer for.</param>
- <param name="distance">The double distance to use for calculating the buffer</param>
- <param name="quadrantSegments">The number of segments to use to approximate a quadrant of a circle</param>
- <param name="endCapStyle">The end cap style to use</param>
- <param name="destinationFeatureset">The output featureset to add this feature to and use
- as a reference for determining which data columns to copy.</param>
- <returns>The IFeature that represents the buffer feature.</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.Centroid(DotSpatial.Data.IFeature)">
- <summary>
- Returns a feature constructed from the centroid of this feature
- </summary>
- <param name="self">This feature</param>
- <returns>An IFeature that is also a point geometry</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.Contains(DotSpatial.Data.IFeature,DotSpatial.Data.IFeature)">
- <summary>
- Gets a boolean that is true if this feature contains the specified feature
- </summary>
- <param name="self">This feature</param>
- <param name="other">The other feature to test</param>
- <returns>Boolean, true if this feature contains the other feature</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.Contains(DotSpatial.Data.IFeature,DotSpatial.Topology.IGeometry)">
- <summary>
- Gets a boolean that is true if this feature contains the specified feature
- </summary>
- <param name="self">This feature</param>
- <param name="other">The other feature to test</param>
- <returns>Boolean, true if this feature contains the other feature</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.ConvexHull(DotSpatial.Data.IFeature)">
- <summary>
- Calculates a new feature that has a geometry that is the convex hull of this feature.
- </summary>
- <param name="self">This feature</param>
- <returns>A new feature that is the convex hull of this feature.</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.ConvexHull(DotSpatial.Data.IFeature,DotSpatial.Data.IFeatureSet)">
- <summary>
- Calculates a new feature that has a geometry that is the convex hull of this feature.
- This also copies the attributes that are shared between this featureset and the
- specified destination featureset, and adds this feature to the destination featureset.
- </summary>
- <param name="self">This feature</param>
- <param name="destinationFeatureset">The destination featureset to add this feature to</param>
- <returns>The newly created IFeature</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.CoveredBy(DotSpatial.Data.IFeature,DotSpatial.Data.IFeature)">
- <summary>
- Gets a boolean that is true if the geometry of this feature is covered by the geometry
- of the specified feature
- </summary>
- <param name="self">This feature</param>
- <param name="other">The feature to compare this feature to</param>
- <returns>Boolean, true if this feature is covered by the specified feature</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.CoveredBy(DotSpatial.Data.IFeature,DotSpatial.Topology.IGeometry)">
- <summary>
- Gets a boolean that is true if the geometry of this feature is covered by the geometry
- of the specified feature
- </summary>
- <param name="self">This feature</param>
- <param name="other">The feature to compare this feature to</param>
- <returns>Boolean, true if this feature is covered by the specified feature</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.Covers(DotSpatial.Data.IFeature,DotSpatial.Data.IFeature)">
- <summary>
- Gets a boolean that is true if the geometry of this feature covers the geometry
- of the specified feature
- </summary>
- <param name="self">This feature</param>
- <param name="other">The feature to compare this feature to</param>
- <returns>Boolean, true if this feature covers the specified feature</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.Covers(DotSpatial.Data.IFeature,DotSpatial.Topology.IGeometry)">
- <summary>
- Gets a boolean that is true if the geometry of this feature covers the geometry
- of the specified feature
- </summary>
- <param name="self">This feature</param>
- <param name="other">The feature to compare this feature to</param>
- <returns>Boolean, true if this feature covers the specified feature</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.Crosses(DotSpatial.Data.IFeature,DotSpatial.Data.IFeature)">
- <summary>
- Gets a boolean that is true if the geometry of this feature crosses the geometry
- of the specified feature
- </summary>
- <param name="self">This feature</param>
- <param name="other">The feature to compare this feature to</param>
- <returns>Boolean, true if this feature crosses the specified feature</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.Crosses(DotSpatial.Data.IFeature,DotSpatial.Topology.IGeometry)">
- <summary>
- Gets a boolean that is true if the geometry of this feature crosses the geometry
- of the specified feature
- </summary>
- <param name="self">This feature</param>
- <param name="other">The feature to compare this feature to</param>
- <returns>Boolean, true if this feature crosses the specified feature</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.Difference(DotSpatial.Data.IFeature,DotSpatial.Data.IFeature)">
- <summary>
- Creates a new Feature that has a geometry that is the difference between this feature and the specified feature.
- </summary>
- <param name="self">This feature</param>
- <param name="other">The other feature to compare to.</param>
- <returns>A new feature that is the geometric difference between this feature and the specified feature.</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.Difference(DotSpatial.Data.IFeature,DotSpatial.Topology.IGeometry)">
- <summary>
- Creates a new Feature that has a geometry that is the difference between this feature and the specified feature.
- </summary>
- <param name="self">This feature</param>
- <param name="other">The other feature to compare to.</param>
- <returns>A new feature that is the geometric difference between this feature and the specified feature.</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.Difference(DotSpatial.Data.IFeature,DotSpatial.Data.IFeature,DotSpatial.Data.IFeatureSet,DotSpatial.Data.FieldJoinType)">
- <summary>
- Creates a new Feature that has a geometry that is the difference between this feature and the specified feature.
- This also copies the attributes that are shared between this featureset and the
- specified destination featureset, and adds this feature to the destination featureset.
- </summary>
- <param name="self">This feature</param>
- <param name="other">The other feature to compare to.</param>
- <param name="destinationFeatureSet">The featureset to add the new feature to.</param>
- <param name="joinType">This clarifies the overall join strategy being used with regards to attribute fields.</param>
- <returns>A new feature that is the geometric difference between this feature and the specified feature.</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.Disjoint(DotSpatial.Data.IFeature,DotSpatial.Data.IFeature)">
- <summary>
- Gets a boolean that is true if the geometry of this feature is disjoint with the geometry
- of the specified feature
- </summary>
- <param name="self">This feature</param>
- <param name="other">The feature to compare this feature to</param>
- <returns>Boolean, true if this feature is disjoint with the specified feature</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.Disjoint(DotSpatial.Data.IFeature,DotSpatial.Topology.IGeometry)">
- <summary>
- Gets a boolean that is true if the geometry of this feature is disjoint with the geometry
- of the specified feature.
- </summary>
- <param name="self">This feature</param>
- <param name="other">The feature to compare this feature to</param>
- <returns>Boolean, true if this feature is disjoint with the specified feature</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.Distance(DotSpatial.Data.IFeature,DotSpatial.Data.IFeature)">
- <summary>
- Distance between features.
- </summary>
- <param name="self">This feature</param>
- <param name="other">The feature to compare this feature to</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.Distance(DotSpatial.Data.IFeature,DotSpatial.Topology.IGeometry)">
- <summary>
- Gets a boolean that is true if the geometry of this feature is disjoint with the geometry
- of the specified feature
- </summary>
- <param name="self">This feature</param>
- <param name="other">The feature to compare this feature to</param>
- <returns>Boolean, true if this feature is disjoint with the specified feature</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.Intersection(DotSpatial.Data.IFeature,DotSpatial.Data.IFeature)">
- <summary>
- Creates a new Feature that has a geometry that is the intersection between this feature and the specified feature.
- </summary>
- <param name="self">This feature</param>
- <param name="other">The other feature to compare to.</param>
- <returns>A new feature that is the geometric intersection between this feature and the specified feature.</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.Intersection(DotSpatial.Data.IFeature,DotSpatial.Topology.IGeometry)">
- <summary>
- Creates a new Feature that has a geometry that is the intersection between this feature and the specified feature.
- </summary>
- <param name="self">This feature</param>
- <param name="other">The other feature to compare to.</param>
- <returns>A new feature that is the geometric intersection between this feature and the specified feature.</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.Intersection(DotSpatial.Data.IFeature,DotSpatial.Data.IFeature,DotSpatial.Data.IFeatureSet,DotSpatial.Data.FieldJoinType)">
- <summary>
- Creates a new Feature that has a geometry that is the intersection between this feature and the specified feature.
- This also copies the attributes that are shared between this featureset and the
- specified destination featureset, and adds this feature to the destination featureset.
- </summary>
- <param name="self">This feature</param>
- <param name="other">The other feature to compare to.</param>
- <param name="destinationFeatureSet">The featureset to add the new feature to.</param>
- <param name="joinType">This clarifies the overall join strategy being used with regards to attribute fields.</param>
- <returns>A new feature that is the geometric intersection between this feature and the specified feature.</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.Intersects(DotSpatial.Data.IFeature,DotSpatial.Data.IFeature)">
- <summary>
- Gets a boolean that is true if this feature intersects the other feature.
- </summary>
- <param name="self">This feature</param>
- <param name="other">The other feature to test</param>
- <returns>Boolean, true if the two IFeatures intersect</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.Intersects(DotSpatial.Data.IFeature,DotSpatial.Topology.IGeometry)">
- <summary>
- Gets a boolean that is true if this feature intersects the other feature.
- </summary>
- <param name="self">This feature</param>
- <param name="other">The other feature to test</param>
- <returns>Boolean, true if the two IFeatures intersect</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.Intersects(DotSpatial.Data.IFeature,DotSpatial.Topology.Coordinate)">
- <summary>
- This tests the current feature to see if the geometry intersects with the specified
- coordinate.
- </summary>
- <param name="self">This feature</param>
- <param name="coordinate">The coordinate</param>
- <returns>Boolean if the coordinate intersects with this feature</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.IsWithinDistance(DotSpatial.Data.IFeature,DotSpatial.Data.IFeature,System.Double)">
- <summary>
- Gets a boolean that is true if this feature is within the specified distance of the other feature.
- </summary>
- <param name="self">This feature</param>
- <param name="other">The other feature to test</param>
- <param name="distance">The double distance criteria</param>
- <returns>Boolean, true if the other feature is within the specified distance of this feature</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.IsWithinDistance(DotSpatial.Data.IFeature,DotSpatial.Topology.IGeometry,System.Double)">
- <summary>
- Gets a boolean that is true if this feature is within the specified distance of the other feature.
- </summary>
- <param name="self">This feature</param>
- <param name="other">The other feature to test</param>
- <param name="distance">The double distance criteria</param>
- <returns>Boolean, true if the other feature is within the specified distance of this feature</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.Overlaps(DotSpatial.Data.IFeature,DotSpatial.Data.IFeature)">
- <summary>
- Gets a boolean that is true if this feature overlaps the specified feature
- </summary>
- <param name="self">This feature</param>
- <param name="other">The other feature to test</param>
- <returns>Boolean, true if the two IFeatures overlap</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.Overlaps(DotSpatial.Data.IFeature,DotSpatial.Topology.IGeometry)">
- <summary>
- Gets a boolean that is true if this feature overlaps the specified feature
- </summary>
- <param name="self">This feature</param>
- <param name="other">The other feature to test</param>
- <returns>Boolean, true if the two IFeatures overlap</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.Relates(DotSpatial.Data.IFeature,DotSpatial.Data.IFeature,System.String)">
- <summary>
- Gets a boolean that is true if the relationship between this feature and the other feature
- matches the relationship matrix specified by other
- </summary>
- <param name="self">This feature</param>
- <param name="other">The other feature to test</param>
- <param name="intersectionPattern">The string relationship pattern to test</param>
- <returns>Boolean, true if the other feature's relationship to this feature matches the relate expression.</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.Relates(DotSpatial.Data.IFeature,DotSpatial.Topology.IGeometry,System.String)">
- <summary>
- Gets a boolean that is true if the relationship between this feature and the other feature
- matches the relationship matrix specified by other
- </summary>
- <param name="self">This feature</param>
- <param name="other">The other feature to test</param>
- <param name="intersectionPattern">The string relationship pattern to test</param>
- <returns>Boolean, true if the other feature's relationship to this feature matches the relate expression.</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.Rotate(DotSpatial.Data.IFeature,DotSpatial.Topology.Coordinate,System.Double)">
- <summary>
- Rotates the BasicGeometry of the feature by the given radian angle around the given Origin.
- </summary>
- <param name="self">This feature.</param>
- <param name="Origin">The coordinate the feature gets rotated around.</param>
- <param name="radAngle">The rotation angle in radian.</param>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.SymmetricDifference(DotSpatial.Data.IFeature,DotSpatial.Data.IFeature)">
- <summary>
- Creates a new Feature that has a geometry that is the symmetric difference between this feature and the specified feature.
- </summary>
- <param name="self">This feature</param>
- <param name="other">The other feature to compare to.</param>
- <returns>A new feature that is the geometric symmetric difference between this feature and the specified feature.</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.SymmetricDifference(DotSpatial.Data.IFeature,DotSpatial.Topology.IGeometry)">
- <summary>
- Creates a new Feature that has a geometry that is the symmetric difference between this feature and the specified feature.
- </summary>
- <param name="self">This feature</param>
- <param name="other">The other feature to compare to.</param>
- <returns>A new feature that is the geometric symmetric difference between this feature and the specified feature.</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.SymmetricDifference(DotSpatial.Data.IFeature,DotSpatial.Data.IFeature,DotSpatial.Data.IFeatureSet,DotSpatial.Data.FieldJoinType)">
- <summary>
- Creates a new Feature that has a geometry that is the symmetric difference between this feature and the specified feature.
- This also copies the attributes that are shared between this featureset and the
- specified destination featureset, and adds this feature to the destination featureset.
- </summary>
- <param name="self">This feature</param>
- <param name="other">The other feature to compare to.</param>
- <param name="destinationFeatureSet">The featureset to add the new feature to.</param>
- <param name="joinType">This clarifies the overall join strategy being used with regards to attribute fields.</param>
- <returns>A new feature that is the geometric symmetric difference between this feature and the specified feature.</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.Touches(DotSpatial.Data.IFeature,DotSpatial.Data.IFeature)">
- <summary>
- Gets a boolean that is true if this feature touches the specified feature
- </summary>
- <param name="self">This feature</param>
- <param name="other">The other feature to test</param>
- <returns>Boolean, true if the two IFeatures touch</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.Touches(DotSpatial.Data.IFeature,DotSpatial.Topology.IGeometry)">
- <summary>
- Gets a boolean that is true if this feature touches the specified feature
- </summary>
- <param name="self">This feature</param>
- <param name="other">The other feature to test</param>
- <returns>Boolean, true if the two IFeatures touch</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.Union(DotSpatial.Data.IFeature,DotSpatial.Data.IFeature)">
- <summary>
- Creates a new Feature that has a geometry that is the union between this feature and the specified feature.
- </summary>
- <param name="self">This feature</param>
- <param name="other">The other feature to compare to.</param>
- <returns>A new feature that is the geometric union between this feature and the specified feature.</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.Union(DotSpatial.Data.IFeature,DotSpatial.Topology.IGeometry)">
- <summary>
- Creates a new Feature that has a geometry that is the union between this feature and the specified feature.
- </summary>
- <param name="self">This feature</param>
- <param name="other">The other feature to compare to.</param>
- <returns>A new feature that is the geometric union between this feature and the specified feature.</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.Union(DotSpatial.Data.IFeature,DotSpatial.Data.IFeature,DotSpatial.Data.IFeatureSet,DotSpatial.Data.FieldJoinType)">
- <summary>
- Creates a new Feature that has a geometry that is the union between this feature and the specified feature.
- This also copies the attributes that are shared between this featureset and the
- specified destination featureset, and adds this feature to the destination featureset.
- </summary>
- <param name="self">This feature</param>
- <param name="other">The other feature to compare to.</param>
- <param name="destinationFeatureSet">The featureset to add the new feature to.</param>
- <param name="joinType">Clarifies how the attributes should be handled during the union</param>
- <returns>A new feature that is the geometric symmetric difference between this feature and the specified feature.</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.Within(DotSpatial.Data.IFeature,DotSpatial.Data.IFeature)">
- <summary>
- Gets a boolean that is true if this feature is within the specified feature
- </summary>
- <param name="self">This feature</param>
- <param name="other">The other feature to test</param>
- <returns>Boolean, true if this feature is within the specified feature</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureExt.Within(DotSpatial.Data.IFeature,DotSpatial.Topology.IGeometry)">
- <summary>
- Gets a boolean that is true if this feature is within the specified feature
- </summary>
- <param name="self">This feature</param>
- <param name="other">The other feature to test</param>
- <returns>Boolean, true if this feature is within the specified feature</returns>
- </member>
- <member name="T:DotSpatial.Data.FeatureEventArgs">
- <summary>
- FeatureEvent
- </summary>
- </member>
- <member name="M:DotSpatial.Data.FeatureEventArgs.#ctor(DotSpatial.Data.IFeature)">
- <summary>
- Creates a new instance of FeatureEvent
- </summary>
- </member>
- <member name="P:DotSpatial.Data.FeatureEventArgs.Feature">
- <summary>
- Gets the feature being referenced by this event.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.FeatureList">
- <summary>
- A list that keeps track of a "parent" body that is also of type IFeature.
- Whenever a member is added to the list, it sets the parent property.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IFeatureList">
- <summary>
- IFeatureList
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IFeatureList.ResumeEvents">
- <summary>
- Resumes events
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IFeatureList.SuspendEvents">
- <summary>
- Temporarilly disables events
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IFeatureList.ToList">
- <summary>
- This is a re-expression of the features using a strong typed
- list. This may be the inner list or a copy depending on
- implementation.
- </summary>
- <returns>The features as a List of IFeature.</returns>
- </member>
- <member name="E:DotSpatial.Data.IFeatureList.FeatureAdded">
- <summary>
- Occurs when a new feature is added to the list
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IFeatureList.FeatureRemoved">
- <summary>
- Occurs when a feature is removed from the list.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IFeatureList.EventsSuspended">
- <summary>
- Gets or sets whether or not the events have been suspended
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IFeatureList.IncludeAttributes">
- <summary>
- If this is false, then features will be added to the list without copying over attribute Table information.
- This will allow the attributes to be loaded in a more on-demand later.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IFeatureList.Parent">
- <summary>
- Gets the parent featureset for this list.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.#ctor">
- <summary>
- Instantiates a new instance of a FeatureList where no parent is specified.
- This will basically simply act as a list and will not allow the features
- to be aware of the parent featureset.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.#ctor(DotSpatial.Data.IFeatureSet)">
- <summary>
- Instantiates a new instance of a FeatureList where the ParentFeatureSet
- is specified so that each feature will be aware of its parent.
- </summary>
- <param name="parent">The ParentFeatureSet of the specified item</param>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.Clear">
- <summary>
- Removes all elements from the EventList<IFeature>.
- </summary>
- <exception cref="T:System.ApplicationException">Unable to clear while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.Contains(DotSpatial.Data.IFeature)">
- <summary>
- Determines whether an element is in the System.Collections.Generic.List<IFeature>.
- </summary>
- <param name="item"> The object to locate in the System.Collections.Generic.List<IFeature>. The value can be null for reference types.</param>
- <returns>true if item is found in the System.Collections.Generic.List<IFeature> otherwise, false.</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.GetEnumerator">
- <summary>
- Returns an enumerator that iterates through this list
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.ResumeEvents">
- <summary>
- Resumes events
- </summary>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.SuspendEvents">
- <summary>
- Temporarilly disables events
- </summary>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.ToList">
- <summary>
- Gets the internal list of features. This is quite fast in this case because
- the actual internal data store is a list. This does not create a new collection.
- </summary>
- <returns>The internal list.</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.Reverse(System.Int32,System.Int32)">
- <summary>
- Reverses the order of the elements in the specified range.
- </summary>
- <param name="index">The zero-based starting index of the range to reverse.</param>
- <param name="count">The number of elements in the range to reverse.</param>
- <exception cref="T:System.ArgumentException">index and count do not denote a valid range of elements in the EventList<IFeature>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-count is less than 0.</exception>
- <exception cref="T:System.ApplicationException">Unable to reverse while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.Reverse">
- <summary>
- Reverses the order of the elements in the entire EventList<IFeature>.
- </summary>
- <exception cref="T:System.ApplicationException">Unable to reverse while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.Sort(System.Comparison{DotSpatial.Data.IFeature})">
- <summary>
- Sorts the elements in the entire EventList<IFeature> using the specified System.Comparison<IFeature>.
- </summary>
- <param name="comparison">The System.Comparison<IFeature> to use when comparing elements.</param>
- <exception cref="T:System.ArgumentException">The implementation of comparison caused an error during the sort. For example, comparison might not return 0 when comparing an item with itself.</exception>
- <exception cref="T:System.ArgumentNullException">comparison is null.</exception>
- <exception cref="T:System.ApplicationException">Unable to sort while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.Sort(System.Int32,System.Int32,System.Collections.Generic.IComparer{DotSpatial.Data.IFeature})">
- <summary>
- Sorts the elements in a range of elements in EventList<IFeature> using the specified comparer.
- </summary>
- <param name="index"> The zero-based starting index of the range to sort.</param>
- <param name="count">The length of the range to sort.</param>
- <param name="comparer">The System.Collections.Generic.IComparer<IFeature> implementation to use when comparing elements, or null to use the default comparer System.Collections.Generic.Comparer<IFeature>.Default.</param>
- <exception cref="T:System.ArgumentException">index and count do not specify a valid range in the EventList<IFeature>.-or-The implementation of comparer caused an error during the sort. For example, comparer might not return 0 when comparing an item with itself.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-count is less than 0.</exception>
- <exception cref="T:System.InvalidOperationException"> comparer is null, and the default comparer
- System.Collections.Generic.Comparer<IFeature>.Default cannot find implementation of the System.IComparable<IFeature>
- generic interface or the System.IComparable interface for type IFeature.</exception>
- <exception cref="T:System.ApplicationException">Unable to sort while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.Sort(System.Collections.Generic.IComparer{DotSpatial.Data.IFeature})">
- <summary>
- Sorts the elements in the entire DotSpatial.Interfaces.Framework.IEventList<IFeature> using the specified comparer.
- </summary>
- <param name="comparer"> The System.Collections.Generic.IComparer<IFeature> implementation to use when comparing elements, or null to use the default comparer System.Collections.Generic.Comparer<IFeature>.Default.</param>
- <exception cref="T:System.ArgumentException">The implementation of comparer caused an error during the sort. For example, comparer might not return 0 when comparing an item with itself.</exception>
- <exception cref="T:System.InvalidOperationException">comparer is null, and the default comparer System.Collections.Generic.Comparer<IFeature>.Default cannot find implementation of the System.IComparable<IFeature> generic interface or the System.IComparable interface for type IFeature.</exception>
- <exception cref="T:System.ApplicationException">Unable to sort while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.Sort">
- <summary>
- Sorts the elements in the entire DotSpatial.Interfaces.Framework.IEventList<IFeature> using the default comparer.
- </summary>
- <exception cref="T:System.InvalidOperationException">The default comparer System.Collections.Generic.Comparer<IFeature>.Default cannot find an implementation of the System.IComparable<IFeature> generic interface or the System.IComparable interface for type IFeature.</exception>
- <exception cref="T:System.ApplicationException">Unable to sort while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.CopyTo(DotSpatial.Data.IFeature[],System.Int32)">
- <summary>
- Copies the entire System.Collections.Generic.List<IFeature> to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional System.Array that is the destination of the elements copied from System.Collections.Generic.List<IFeature>. The System.Array must have zero-based indexing.</param>
- <param name="arrayIndex"> The zero-based index in array at which copying begins.</param>
- <exception cref="T:System.ArgumentException">System.ArgumentException: arrayIndex is equal to or greater than the length of array.-or-The number of elements in the source System.Collections.Generic.List<T> is greater than the available space from arrayIndex to the end of the destination array. </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">arrayIndex is less than 0</exception>
- <exception cref="T:System.ArgumentNullException">array is null</exception>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.CopyTo(System.Int32,DotSpatial.Data.IFeature[],System.Int32,System.Int32)">
- <summary>
- Copies a range of elements from the EventList<IFeature> to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="index">The zero-based index in the source EventList<T> at which copying begins</param>
- <param name="array">The one-dimensional System.Array that is the destination of the elements copied from EventList<IFeature>. The System.Array must have zero-based indexing.</param>
- <param name="arrayIndex">The zero-based index in array at which copying begins.</param>
- <param name="count">The number of elements to copy.</param>
- <exception cref="T:System.ArgumentNullException">array is null.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException"> index is less than 0.-or-arrayIndex is less than 0.-or-count is less than 0.</exception>
- <exception cref="T:System.ArgumentException">index is equal to or greater than the EventList<IFeature>.Count of the source EventList<T>.-or-arrayIndex is equal to or greater than the length of array.-or-The number of elements from index to the end of the source EventList<IFeature> is greater than the available space from arrayIndex to the end of the destination array.</exception>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.CopyTo(DotSpatial.Data.IFeature[])">
- <summary>
- Copies the entire EventList<IFeature> to a compatible one-dimensional array, starting at the beginning of the target array.
- </summary>
- <param name="array">The one-dimensional System.Array that is the destination of the elements copied from EventList<IFeature>. The System.Array must have zero-based indexing.</param>
- <exception cref="T:System.ArgumentException">The number of elements in the source EventList<IFeature> is greater than the number of elements that the destination array can contain.</exception>
- <exception cref="T:System.ArgumentNullException">array is null.</exception>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.IncludeFeature(DotSpatial.Data.IFeature,System.Int32)">
- <summary>
- Includes the Feature in the parents DataTable at the given index and raises the FeatureAdded event.
- </summary>
- <param name="item">Feature that gets included.</param>
- <param name="index">Index, where the feature gets included. (-1 = add at the end)</param>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.ExcludeFeature(DotSpatial.Data.IFeature)">
- <summary>
- Removes the given Feature from the parents DataTable and raises the FeatureRemoved event.
- </summary>
- <param name="item">Feature that gets excluded.</param>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.ConvertAll``1(System.Converter{DotSpatial.Data.IFeature,``0})">
- <summary>
- Converts the elements in the current EventList<IFeature> to another type, and returns a list containing the converted elements.
- </summary>
- <typeparam name="TOutput">The output type to convert to</typeparam>
- <param name="converter">A System.Converter<TInput, TOutput> delegate that converts each element from one type to another type.</param>
- <returns>A List<T> of the target type containing the converted elements from the current EventList<T>.</returns>
- <exception cref="T:System.ArgumentNullException">converter is null.</exception>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.Exists(System.Predicate{DotSpatial.Data.IFeature})">
- <summary>
- Determines whether the EventList<IFeature> contains elements that match the conditions defined by the specified predicate.
- </summary>
- <param name="match">The System.Predicate<IFeature> delegate that defines the conditions of the elements to search for.</param>
- <returns>true if the EventList<T> contains one or more elements that match the conditions defined by the specified predicate; otherwise, false.</returns>
- <exception cref="T:System.ArgumentNullException">match is null.</exception>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.GetRange(System.Int32,System.Int32)">
- <summary>
- Creates a shallow copy of a range of elements in the source EventList<IFeature>.
- </summary>
- <param name="index">The zero-based EventList<IFeature> index at which the range starts.</param>
- <param name="count"> The number of elements in the range.</param>
- <returns>A shallow copy of a range of elements in the source EventList<IFeature>.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-count is less than 0.</exception>
- <exception cref="T:System.ArgumentException">index and count do not denote a valid range of elements in the EventList<IFeature>.</exception>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.ToArray">
- <summary>
- Copies the elements of the DotSpatial.Interfaces.Framework.IEventList<IFeature> to a new array.
- </summary>
- <returns>An array containing copies of the elements of the DotSpatial.Interfaces.Framework.IEventList<IFeature>.</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.TrimExcess">
- <summary>
- Sets the capacity to the actual number of elements in the DotSpatial.Interfaces.Framework.IEventList<IFeature>, if that number is less than a threshold value.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.TrueForAll(System.Predicate{DotSpatial.Data.IFeature})">
- <summary>
- Determines whether every element in the DotSpatial.Interfaces.Framework.IEventList<IFeature> matches the conditions defined by the specified predicate.
- </summary>
- <param name="match">The System.Predicate<IFeature> delegate that defines the conditions to check against the elements.</param>
- <returns>true if every element in the DotSpatial.Interfaces.Framework.IEventList<IFeature> matches the conditions defined by the specified predicate; otherwise, false. If the list has no elements, the return value is true.</returns>
- <exception cref="T:System.ArgumentNullException">match is null.</exception>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.IndexOf(DotSpatial.Data.IFeature)">
- <summary>
- Searches for the specified object and returns the zero-based index of the first occurrence within the entire System.Collections.Generic.List<IFeature>.
- </summary>
- <param name="item">The object to locate in the System.Collections.Generic.List<IFeature>. The value can be null for reference types.</param>
- <returns>The zero-based index of the first occurrence of item within the entire System.Collections.Generic.List<IFeature>, if found; otherwise, –1.</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.IndexOf(DotSpatial.Data.IFeature,System.Int32,System.Int32)">
- <summary>
- Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the EventList<IFeature> that starts at the specified index and contains the specified number of elements.
- </summary>
- <param name="item">The object to locate in the EventList<IFeature>. The value can be null for reference types.</param>
- <param name="index"> The zero-based starting index of the search.</param>
- <param name="count">The number of elements in the section to search.</param>
- <returns>The zero-based index of the first occurrence of item within the range of elements in the EventList<IFeature> that starts at index and contains count number of elements, if found; otherwise, –1.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException"> index is outside the range of valid indexes for the EventList<IFeature>.-or-count is less than 0.-or-index and count do not specify a valid section in the EventList<IFeature>.</exception>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.IndexOf(DotSpatial.Data.IFeature,System.Int32)">
- <summary>
- Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the EventList<IFeature> that extends from the specified index to the last element.
- </summary>
- <param name="item">The object to locate in the EventList<IFeature>. The value can be null for reference types.</param>
- <param name="index"> The zero-based starting index of the search.</param>
- <returns>The zero-based index of the first occurrence of item within the range of elements in the EventList<IFeature> that extends from index to the last element, if found; otherwise, –1.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">index is outside the range of valid indexes for the EventList<IFeature>.</exception>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.Insert(System.Int32,DotSpatial.Data.IFeature)">
- <summary>
- Inserts an element into the System.Collections.Generic.List<IFeature> at the specified index.
- </summary>
- <param name="index">The zero-based index at which item should be inserted.</param>
- <param name="item">The object to insert. The value can be null for reference types.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-index is greater than System.Collections.Generic.List<IFeature>.Count.</exception>
- <exception cref="T:System.ApplicationException">Unable to insert while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{DotSpatial.Data.IFeature})">
- <summary>
- Inserts the elements of a collection into the EventList<IFeature> at the specified index.
- </summary>
- <param name="index">The zero-based index at which the new elements should be inserted.</param>
- <param name="collection">The collection whose elements should be inserted into the EventList<IFeature>. The collection itself cannot be null, but it can contain elements that are null, if type IFeature is a reference type.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-index is greater than EventList<IFeature>.Count.</exception>
- <exception cref="T:System.ArgumentNullException">collection is null.</exception>
- <exception cref="T:System.ApplicationException">Unable to insert while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.LastIndexOf(DotSpatial.Data.IFeature,System.Int32,System.Int32)">
- <summary>
- Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the EventList<IFeature> that contains the specified number of elements and ends at the specified index.
- </summary>
- <param name="item">The object to locate in the EventList<IFeature>. The value can be null for reference types.</param>
- <param name="index">The zero-based starting index of the backward search.</param>
- <param name="count">The number of elements in the section to search.</param>
- <returns>The zero-based index of the last occurrence of item within the range of elements in the EventList<IFeature> that contains count number of elements and ends at index, if found; otherwise, –1.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">index is outside the range of valid indexes for the EventList<IFeature>.-or-count is less than 0.-or-index and count do not specify a valid section in the EventList<IFeature>.</exception>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.LastIndexOf(DotSpatial.Data.IFeature,System.Int32)">
- <summary>
- Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the EventList<IFeature> that extends from the first element to the specified index.
- </summary>
- <param name="item">The object to locate in the EventList<IFeature>. The value can be null for reference types.</param>
- <param name="index">The zero-based starting index of the backward search.</param>
- <returns>The zero-based index of the last occurrence of item within the range of elements in the EventList<IFeature> that extends from the first element to index, if found; otherwise, –1.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">index is outside the range of valid indexes for the EventList<IFeature>.</exception>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.LastIndexOf(DotSpatial.Data.IFeature)">
- <summary>
- Searches for the specified object and returns the zero-based index of the last occurrence within the entire EventList<IFeature>.
- </summary>
- <param name="item">The object to locate in the EventList<IFeature>. The value can be null for reference types.</param>
- <returns>The zero-based index of the last occurrence of item within the entire the EventList<IFeature>, if found; otherwise, –1.</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.Remove(DotSpatial.Data.IFeature)">
- <summary>
- Removes the first occurrence of a specific object from the System.Collections.Generic.List<IFeature>.
- </summary>
- <param name="item">The object to remove from the System.Collections.Generic.List<IFeature>. The value can be null for reference types.</param>
- <returns>true if item is successfully removed; otherwise, false. This method also returns false if item was not
- found in the System.Collections.Generic.List<IFeature>.</returns>
- <exception cref="T:System.ApplicationException">Unable to remove while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.RemoveAt(System.Int32)">
- <summary>
- Removes the element at the specified index of the System.Collections.Generic.List<IFeature>.
- </summary>
- <param name="index">The zero-based index of the element to remove.</param>
- <exception cref="T:System.ApplicationException">Unable to remove while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.RemoveAll(System.Predicate{DotSpatial.Data.IFeature})">
- <summary>
- Removes the all the elements that match the conditions defined by the specified predicate.
- </summary>
- <param name="match">The System.Predicate<IFeature> delegate that defines the conditions of the elements to remove.</param>
- <returns>The number of elements removed from the EventList<IFeature></returns>
- <exception cref="T:System.ArgumentNullException">match is null.</exception>
- <exception cref="T:System.ApplicationException">Unable to remove while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.RemoveRange(System.Int32,System.Int32)">
- <summary>
- Removes a range of elements from the EventList<IFeature>.
- </summary>
- <param name="index">The zero-based starting index of the range of elements to remove.</param>
- <param name="count">The number of elements to remove.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-count is less than 0.</exception>
- <exception cref="T:System.ArgumentException">index and count do not denote a valid range of elements in the EventList<IFeature>.</exception>
- <exception cref="T:System.ApplicationException">Unable to remove while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.FindAll(System.Predicate{DotSpatial.Data.IFeature})">
- <summary>
- Retrieves all the elements that match the conditions described by the specified predicate
- </summary>
- <param name="match">The System.Predicate that defines the conditions to search for</param>
- <returns>A List of matches</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.FindIndex(System.Int32,System.Int32,System.Predicate{DotSpatial.Data.IFeature})">
- <summary>
- Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the EventList<IFeature> that starts at the specified index and contains the specified number of elements.
- </summary>
- <param name="startIndex">The zero-based starting index of the search.</param>
- <param name="count">The number of elements in the section to search.</param>
- <param name="match"> The System.Predicate<IFeature> delegate that defines the conditions of the element to search for.</param>
- <returns>The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">startIndex is outside the range of valid indexes for the EventList<IFeature>.-or-count is less than 0.-or-startIndex and count do not specify a valid section in the EventList<IFeature>.</exception>
- <exception cref="T:System.ArgumentNullException">match is null</exception>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.FindIndex(System.Int32,System.Predicate{DotSpatial.Data.IFeature})">
- <summary>
- Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the EventList<IFeature> that extends from the specified index to the last element.
- </summary>
- <param name="startIndex">The zero-based starting index of the search.</param>
- <param name="match">The System.Predicate<IFeature> delegate that defines the conditions of the element to search for.</param>
- <returns>The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">startIndex is outside the range of valid indexes for the EventList<IFeature>.</exception>
- <exception cref="T:System.ArgumentNullException">match is null.</exception>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.FindIndex(System.Predicate{DotSpatial.Data.IFeature})">
- <summary>
- Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the entire EventList<IFeature>.
- </summary>
- <param name="match">The System.Predicate<IFeature> delegate that defines the conditions of the element to search for.</param>
- <returns>The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1.</returns>
- <exception cref="T:System.ArgumentNullException">match is null.</exception>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.FindLast(System.Predicate{DotSpatial.Data.IFeature})">
- <summary>
- Searches for an element that matches the conditions defined by the specified predicate, and returns the last occurrence within the entire EventList<IFeature>.
- </summary>
- <param name="match">The System.Predicate<IFeature> delegate that defines the conditions of the element to search for.</param>
- <returns>The last element that matches the conditions defined by the specified predicate, if found; otherwise, the default value for type IFeature.</returns>
- <exception cref="T:System.ArgumentNullException">match is null."</exception>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.FindLastIndex(System.Int32,System.Int32,System.Predicate{DotSpatial.Data.IFeature})">
- <summary>
- Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the range of elements in the EventList<IFeature> that contains the specified number of elements and ends at the specified index.
- </summary>
- <param name="startIndex">The zero-based starting index of the backward search.</param>
- <param name="count">The number of elements in the section to search.</param>
- <param name="match"></param>
- <returns>The System.Predicate<IFeature> delegate that defines the conditions of the element to search for.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">startIndex is outside the range of valid indexes for the EventList<IFeature>.-or-count is less than 0.-or-startIndex and count do not specify a valid section in the EventList<IFeature>.</exception>
- <exception cref="T:System.ArgumentNullException">match is null.</exception>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.FindLastIndex(System.Int32,System.Predicate{DotSpatial.Data.IFeature})">
- <summary>
- Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the range of elements in the EventList<IFeature> that extends from the first element to the specified index.
- </summary>
- <param name="startIndex"> The zero-based starting index of the backward search.</param>
- <param name="match">The System.Predicate<IFeature> delegate that defines the conditions of the element to search for.</param>
- <returns>The zero-based index of the last occurrence of an element that matches the conditions defined by match, if found; otherwise, –1.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">: startIndex is outside the range of valid indexes for the EventList<IFeature>.</exception>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.FindLastIndex(System.Predicate{DotSpatial.Data.IFeature})">
- <summary>
- Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the entire EventList<IFeature>.
- </summary>
- <param name="match">The System.Predicate<IFeature> delegate that defines the conditions of the element to search for.</param>
- <returns>The zero-based index of the last occurrence of an element that matches the conditions defined by match, if found; otherwise, –1.</returns>
- <exception cref="T:System.ArgumentNullException">match is null.</exception>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.Add(DotSpatial.Data.IFeature)">
- <summary>
- Adds the item to the list, setting the parent to be the list's parent
- </summary>
- <param name="item"></param>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.AddRange(System.Collections.Generic.IEnumerable{DotSpatial.Data.IFeature})">
- <summary>
- Adds the elements of the specified collection to the end of the System.Collections.Generic.List<T>
- </summary>
- <param name="collection">collection: The collection whose elements should be added to the end of the
- System.Collections.Generic.List<T>. The collection itself cannot be null, but it can contain elements that are null,
- if type T is a reference type.</param>
- <exception cref="T:System.ApplicationException">Unable to add while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.BinarySearch(DotSpatial.Data.IFeature)">
- <summary>
- Searches the entire sorted System.Collections.Generic.List<IFeature> for an element using the default comparer and returns the zero-based index of the element.
- </summary>
- <param name="item">The object to locate. The value can be null for reference types.</param>
- <returns>The zero-based index of item in the sorted System.Collections.Generic.List<IFeature>, if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than item or, if there is no larger element, the bitwise complement of System.Collections.Generic.List<IFeature>.Count.</returns>
- <exception cref="T:System.InvalidOperationException">The default comparer System.Collections.Generic.Comparer<IFeature>.Default cannot find an implementation of the System.IComparable<IFeature> generic interface or the System.IComparable interface for type IFeature.</exception>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.OnFeatureAdded(DotSpatial.Data.IFeature)">
- <summary>
- Occurs each time a feature is added to the list. This should only be called
- if suspend events is false.
- </summary>
- <param name="feature">The feature that was added.</param>
- </member>
- <member name="M:DotSpatial.Data.FeatureList.OnFeatureRemoved(DotSpatial.Data.IFeature)">
- <summary>
- Occurs each time a feature is removed from the list. This should only be
- called if suspend events is false.
- </summary>
- <param name="feature">he feature that was removed</param>
- </member>
- <member name="E:DotSpatial.Data.FeatureList.FeatureAdded">
- <summary>
- Occurs when a new feature is added to the list
- </summary>
- </member>
- <member name="E:DotSpatial.Data.FeatureList.FeatureRemoved">
- <summary>
- Occurs when a feature is removed from the list.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.FeatureList.EventsSuspended">
- <summary>
- Gets or sets whether or not the events have been suspended
- </summary>
- </member>
- <member name="P:DotSpatial.Data.FeatureList.Capacity">
- <summary>
- Gets or sets the total number of elements the internal data structure can hold without resizing.
- </summary>
- <returns>
- The number of elements that the DotSpatial.Interfaces.Framework.IEventList<IFeature> can contain before resizing is required.
- </returns>
- <exception cref="T:System.ArgumentOutOfRangeException">DotSpatial.Interfaces.Framework.IEventList<IFeature>.Capacity is set to a value that is less than DotSpatial.Interfaces.Framework.IEventList<IFeature>.Count.</exception>
- </member>
- <member name="P:DotSpatial.Data.FeatureList.Count">
- <summary>
- Gets the count of the members in the list
- </summary>
- </member>
- <member name="P:DotSpatial.Data.FeatureList.Item(System.Int32)">
- <summary>
- The default, indexed value of type IFeature
- </summary>
- <param name="index">The numeric index</param>
- <returns>An object of type IFeature corresponding to the index value specified</returns>
- </member>
- <member name="P:DotSpatial.Data.FeatureList.IsReadOnly">
- <summary>
- Gets a boolean property indicating whether this list can be written to.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.FeatureList.IncludeAttributes">
- <summary>
- If this is false, then features will be added to the list without copying over attribute Table information.
- This will allow the attributes to be loaded in a more on-demand later.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.FeatureList.Parent">
- <summary>
- Gets the parent featureset for this list of features.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.FeatureListExt">
- <summary>
- FeatureListEm
- </summary>
- </member>
- <member name="M:DotSpatial.Data.FeatureListExt.Add(DotSpatial.Data.IFeatureList,DotSpatial.Topology.Coordinate)">
- <summary>
- adding a single coordinate will assume that the feature type should be point for this featureset, even
- if it has not already been specified.
- </summary>
- <param name="self">This IFeatureList</param>
- <param name="point">The point to add to the featureset</param>
- <exception cref="T:DotSpatial.Data.FeatureTypeMismatchException">Thrown when the feature type already exists, there are already features in the featureset and the featuretype is not equal to point.</exception>
- </member>
- <member name="M:DotSpatial.Data.FeatureListExt.Add(DotSpatial.Data.IFeatureList,System.Collections.Generic.IEnumerable{DotSpatial.Topology.Coordinate},DotSpatial.Topology.FeatureType)">
- <summary>
- This adds the coordinates and specifies what sort of feature type should be added.
- </summary>
- <param name="self">This IFeatureList</param>
- <param name="points">The list or array of coordinates to be added after it is built into the appropriate feature.</param>
- <param name="featureType">The feature type.</param>
- </member>
- <member name="M:DotSpatial.Data.FeatureListExt.Add(DotSpatial.Data.IFeatureList,System.Collections.Generic.IEnumerable{DotSpatial.Topology.Coordinate})">
- <summary>
- If the feature type is specified, then this will automatically generate a new feature from the specified coordinates.
- This will not work unless the featuretype is specified.
- </summary>
- <param name="self">This IFeatureList</param>
- <param name="points">
- The list or array of coordinates to build into a new feature.
- If the feature type is point, then this will create separate features for each coordinate.
- For polygons, all the points will be assumed to be in the shell.
- </param>
- <exception cref="T:DotSpatial.Data.UnspecifiedFeaturetypeException">Thrown if the current FeatureType for the shapefile is unspecified.</exception>
- </member>
- <member name="M:DotSpatial.Data.FeatureListExt.Add(DotSpatial.Data.IFeatureList,DotSpatial.Topology.IBasicGeometry)">
- <summary>
- This method will attempt to add the specified geometry to the list.
- If the feature type is currently unspecified, this will specify the feature type.
- </summary>
- <param name="self">This feature list</param>
- <param name="geometry">The geometry to create a new feature from.</param>
- <exception cref="T:DotSpatial.Data.FeatureTypeMismatchException">Thrown if the new geometry does not match the currently specified feature type. </exception>
- </member>
- <member name="T:DotSpatial.Data.FeatureSet">
- <summary>
- Rather than being an abstract base class, this is a "router" class that will
- make decisions based on the file extension or whatever being used and decide the best
- IFeatureSet that matches the specifications.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IFeatureSet">
- <summary>
- A layer contains a list of features of a specific type that matches the geometry type.
- While this supports IRenderable, this merely forwards the drawing instructions to
- each of its members, but does not allow the control of any default layer properties here.
- Calling FeatureDataSource.Open will create a number of layers of the appropriate
- specific type and also create a specific layer type that is derived from this class
- that does expose default "layer" properties, as well as the symbology elements.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IAttributeSource">
- <summary>
- IDataPageRetriever
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IAttributeSource.GetAttributes(System.Int32,System.Int32)">
- <summary>
- Supplies a page of content in the form of a data Table.
- </summary>
- <param name="startIndex">The integer lower page boundary</param>
- <param name="numRows">The integer number of rows to return for the page</param>
- <returns>A DataTable made up with the virtual row content.</returns>
- </member>
- <member name="M:DotSpatial.Data.IAttributeSource.GetAttributes(System.Int32,System.Int32,System.Collections.Generic.IEnumerable{System.String})">
- <summary>
- Reads just the content requested in order to satisfy the paging ability of VirtualMode for the DataGridView
- </summary>
- <param name="startIndex">The integer lower page boundary</param>
- <param name="numRows">The integer number of attribute values to return for the page</param>
- <param name="fieldNames">The list or array of fieldnames to return.</param>
- <returns>A DataTable populated with data rows with only the specified values.</returns>
- </member>
- <member name="M:DotSpatial.Data.IAttributeSource.SetAttributes(System.Int32,System.Data.DataTable)">
- <summary>
- Converts a page of content from a DataTable format, saving it back to the source.
- </summary>
- <param name="startIndex">The 0 based integer index representing the first row in the file (corresponding to the 0 row of the data table)</param>
- <param name="pageValues">The DataTable representing the rows to set. If the row count is larger than the dataset, this will add the rows instead.</param>
- </member>
- <member name="M:DotSpatial.Data.IAttributeSource.NumRows">
- <summary>
- The number of rows
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.IAttributeSource.GetColumn(System.String)">
- <summary>
- Gets the column with the specified name
- </summary>
- <param name="name">the name to search</param>
- <returns>the Field matching the specified name</returns>
- </member>
- <member name="M:DotSpatial.Data.IAttributeSource.GetColumns">
- <summary>
- Gets a copy of the fields used to build the data structure. This is useful for learning
- about the existing fields, but doesn't allow direct changes to the underlying data structure.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IAttributeSource.AddRow(System.Collections.Generic.Dictionary{System.String,System.Object})">
- <summary>
- Saves the new row to the data source and updates the file with new content.
- </summary>
- <param name="values">The values organized against the dictionary of field names.</param>
- </member>
- <member name="M:DotSpatial.Data.IAttributeSource.Edit(System.Int32,System.Collections.Generic.Dictionary{System.String,System.Object})">
- <summary>
- saves a single row to the data source.
- </summary>
- <param name="index">the integer row (or FID) index</param>
- <param name="values">The dictionary of object values by string field name holding the new values to store.</param>
- </member>
- <member name="M:DotSpatial.Data.IAttributeSource.AddRow(System.Data.DataRow)">
- <summary>
- Saves the new row to the data source and updates the file with new content.
- </summary>
- <param name="values">The values organized against the dictionary of field names.</param>
- </member>
- <member name="M:DotSpatial.Data.IAttributeSource.Edit(System.Int32,System.Data.DataRow)">
- <summary>
- saves a single row to the data source.
- </summary>
- <param name="index">the integer row (or FID) index</param>
- <param name="values">The dictionary of object values by string field name holding the new values to store.</param>
- </member>
- <member name="M:DotSpatial.Data.IAttributeSource.GetCounts(System.String[],DotSpatial.Data.ICancelProgressHandler,System.Int32)">
- <summary>
- Given a string expression, this returns the count of the members that satisfy that expression.
- </summary>
- <param name="expressions">The array of string expressions to test</param>
- <param name="progressHandler">The progress handler that might also instruct this step to be canceled.</param>
- <param name="maxSampleSize">The integer maximum sample size from which to draw counts. If this is negative, it will not be used.</param>
- <returns>An array of integer counts of the members that match the expression</returns>
- </member>
- <member name="M:DotSpatial.Data.IFeatureSet.GetColumnNames(System.String)">
- <summary>
- Gets the list of string names available as columns from the specified excel file.
- </summary>
- <param name="xlsFilePath"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.IFeatureSet.Join(System.String,System.String,System.String)">
- <summary>
- For attributes that are small enough to be loaded into a data table, this
- will join attributes from a foreign table (from an excel file). This method
- won't create new rows in this table, so only matching members are brought in,
- but no rows are removed either, so not all rows will receive data.
- </summary>
- <param name="xlsFilePath">The complete path of the file to join</param>
- <param name="localJoinField">The field name to join on in this table</param>
- <param name="xlsJoinField">The field in the foreign table.</param>
- </member>
- <member name="M:DotSpatial.Data.IFeatureSet.AddShape(DotSpatial.Data.Shape)">
- <summary>
- If this featureset is in index mode, this will append the vertices and shapeindex of the shape.
- Otherwise, this will add a new feature based on this shape. If the attributes of the shape are not null,
- this will attempt to append a new datarow It is up to the developer
- to ensure that the object array of attributes matches the this featureset. If the Attributes of this feature are loaded,
- this will add the attributes in ram only. Otherwise, this will attempt to insert the attributes as a
- new record using the "AddRow" method. The schema of the object array should match this featureset's column schema.
- </summary>
- <param name="shape">The shape to add to this featureset.</param>
- </member>
- <member name="M:DotSpatial.Data.IFeatureSet.AddShapes(System.Collections.Generic.IEnumerable{DotSpatial.Data.Shape})">
- <summary>
- Adds any type of list or array of shapes. If this featureset is not in index moded,
- it will add the features to the featurelist and suspend events for faster copying.
- </summary>
- <param name="shapes">An enumerable collection of shapes.</param>
- </member>
- <member name="M:DotSpatial.Data.IFeatureSet.GetFeature(System.Int32)">
- <summary>
- Gets the specified feature by constructing it from the vertices, rather
- than requiring that all the features be created. (which takes up a lot of memory).
- </summary>
- <param name="index">The integer index</param>
- </member>
- <member name="M:DotSpatial.Data.IFeatureSet.GetShape(System.Int32,System.Boolean)">
- <summary>
- Gets a shape at the specified shape index. If the featureset is in
- indexmode, this returns a copy of the shape. If not, it will create
- a new shape based on the specified feature.
- </summary>
- <param name="index">The zero based integer index of the shape.</param>
- <param name="getAttributes">If getAttributes is true, then this also try to get attributes for that shape.
- If attributes are loaded, then it will use the existing datarow. Otherwise, it will read the attributes
- from the file. (This second option is not recommended for large repeats. In such a case, the attributes
- can be set manually from a larger bulk query of the data source.)</param>
- <returns>The Shape object</returns>
- </member>
- <member name="M:DotSpatial.Data.IFeatureSet.FeatureFromRow(System.Data.DataRow)">
- <summary>
- Given a datarow, this will return the associated feature. This FeatureSet
- uses an internal dictionary, so that even if the items are re-ordered
- or have new members inserted, this lookup will still work.
- </summary>
- <param name="row">The DataRow for which to obtaind the feature</param>
- <returns>The feature to obtain that is associated with the specified data row.</returns>
- </member>
- <member name="M:DotSpatial.Data.IFeatureSet.AddFeature(DotSpatial.Topology.IBasicGeometry)">
- <summary>
- Generates a new feature, adds it to the features and returns the value.
- </summary>
- <returns>The feature that was added to this featureset</returns>
- </member>
- <member name="M:DotSpatial.Data.IFeatureSet.AddFid">
- <summary>
- Adds the FID values as a field called FID, but only if the FID field
- does not already exist
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IFeatureSet.CopyFeatures(DotSpatial.Data.IFeatureSet,System.Boolean)">
- <summary>
- Copies all the features from the specified featureset.
- </summary>
- <param name="source">The source IFeatureSet to copy features from.</param>
- <param name="copyAttributes">Boolean, true if the attributes should be copied as well. If this is true,
- and the attributes are not loaded, a FillAttributes call will be made.</param>
- </member>
- <member name="M:DotSpatial.Data.IFeatureSet.CopySubset(System.Collections.Generic.List{System.Int32})">
- <summary>
- Retrieves a subset using exclusively the features matching the specified values.
- </summary>
- <param name="indices">An integer list of indices to copy into the new FeatureSet</param>
- <returns>A FeatureSet with the new items.</returns>
- </member>
- <member name="M:DotSpatial.Data.IFeatureSet.CopySubset(System.String)">
- <summary>
- Copies the subset of specified features to create a new featureset that is restricted to
- just the members specified.
- </summary>
- <param name="filterExpression">The string expression to test.</param>
- <returns>A FeatureSet that has members that only match the specified members.</returns>
- </member>
- <member name="M:DotSpatial.Data.IFeatureSet.CopyTableSchema(DotSpatial.Data.IFeatureSet)">
- <summary>
- Copies only the names and types of the attribute fields, without copying any of the attributes or features.
- </summary>
- <param name="source">The source featureSet to obtain the schema from.</param>
- </member>
- <member name="M:DotSpatial.Data.IFeatureSet.CopyTableSchema(System.Data.DataTable)">
- <summary>
- Copies the Table schema (column names/data types)
- from a DatatTable, but doesn't copy any values.
- </summary>
- <param name="sourceTable">The Table to obtain schema from.</param>
- </member>
- <member name="M:DotSpatial.Data.IFeatureSet.FillAttributes">
- <summary>
- Instructs the shapefile to read all the attributes from the file.
- This may also be a cue to read values from a database.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IFeatureSet.FillAttributes(DotSpatial.Data.IProgressHandler)">
- <summary>
- Instructs the shapefile to read all the attributes from the file.
- This may also be a cue to read values from a database.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IFeatureSet.Find(System.String)">
- <summary>
- Obtains the list of feature indices that match the specified filter expression.
- </summary>
- <param name="filterExpression">The filter expression to find features for.</param>
- <returns>The list of integers that are the FIDs of the specified values.</returns>
- </member>
- <member name="M:DotSpatial.Data.IFeatureSet.InitializeVertices">
- <summary>
- This forces the vertex initialization so that Vertices, ShapeIndices, and the
- ShapeIndex property on each feature will no longer be null.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IFeatureSet.InvalidateVertices">
- <summary>
- Switches a boolean so that the next time that the vertices are requested,
- they must be re-calculated from the feature coordinates.
- </summary>
- <remarks>This only affects reading values from the Vertices cache</remarks>
- </member>
- <member name="M:DotSpatial.Data.IFeatureSet.RemoveShapeAt(System.Int32)">
- <summary>
- Attempts to remove the specified shape.
- </summary>
- <param name="index">
- The integer index of the shape to remove.
- </param>
- <returns>
- Boolean, true if the remove was successful.
- </returns>
- </member>
- <member name="M:DotSpatial.Data.IFeatureSet.RemoveShapesAt(System.Collections.Generic.IEnumerable{System.Int32})">
- <summary>
- Attempts to remove a range of shapes by index. This is optimized to
- work better for large numbers. For one or two, using RemoveShapeAt might
- be faster.
- </summary>
- <param name="indices">
- The enumerable set of indices to remove.
- </param>
- </member>
- <member name="M:DotSpatial.Data.IFeatureSet.SelectIndices(DotSpatial.Data.Extent)">
- <summary>
- Skips the features themselves and uses the shapeindicies instead.
- </summary>
- <param name="region">The region to select members from</param>
- <returns>A list of integer valued shape indices that are selected.</returns>
- </member>
- <member name="M:DotSpatial.Data.IFeatureSet.Save">
- <summary>
- Saves the information in the Layers provided by this datasource onto its existing file location
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IFeatureSet.SaveAs(System.String,System.Boolean)">
- <summary>
- Saves a datasource to the file.
- </summary>
- <param name="fileName">The string fileName location to save to</param>
- <param name="overwrite">Boolean, if this is true then it will overwrite a file of the existing name.</param>
- </member>
- <member name="M:DotSpatial.Data.IFeatureSet.Select(DotSpatial.Data.Extent)">
- <summary>
- returns only the features that have envelopes that
- intersect with the specified envelope.
- </summary>
- <param name="region">The specified region to test for intersect with</param>
- <returns>A List of the IFeature elements that are contained in this region</returns>
- </member>
- <member name="M:DotSpatial.Data.IFeatureSet.Select(DotSpatial.Data.Extent,DotSpatial.Data.Extent@)">
- <summary>
- returns only the features that have envelopes that
- intersect with the specified envelope.
- </summary>
- <param name="region">The specified region to test for intersect with</param>
- <param name="selectedRegion">This returns the geographic extents for the entire selected area.</param>
- <returns>A List of the IFeature elements that are contained in this region</returns>
- </member>
- <member name="M:DotSpatial.Data.IFeatureSet.SelectByAttribute(System.String)">
- <summary>
- The string filter expression to use in order to return the desired features.
- </summary>
- <param name="filterExpression">The features to return.</param>
- <returns>The list of desired features.</returns>
- </member>
- <member name="M:DotSpatial.Data.IFeatureSet.SelectIndexByAttribute(System.String)">
- <summary>
- This version is more tightly integrated to the DataTable and returns the row indices, rather
- than attempting to link the results to features themselves, which may not even exist.
- </summary>
- <param name="filterExpression">The filter expression</param>
- <returns>The list of indices</returns>
- </member>
- <member name="M:DotSpatial.Data.IFeatureSet.UpdateExtent">
- <summary>
- After changing coordinates, this will force the re-calculation of envelopes on a feature
- level as well as on the featureset level.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IFeatureSet.VerticesInvalidated">
- <summary>
- Occurs when the vertices are invalidated, encouraging a re-draw
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IFeatureSet.FeatureAdded">
- <summary>
- Occurs when a new feature is added to the list
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IFeatureSet.FeatureRemoved">
- <summary>
- Occurs when a feature is removed from the list.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IFeatureSet.AttributesPopulated">
- <summary>
- Gets whether or not the attributes have all been loaded into the data table.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IFeatureSet.CoordinateType">
- <summary>
- Gets or sets the coordinate type across the entire featureset.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IFeatureSet.DataTable">
- <summary>
- Gets the DataTable associated with this specific feature.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IFeatureSet.Features">
- <summary>
- Gets the list of all the features that are included in this layer.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IFeatureSet.FeatureGeometryFactory">
- <summary>
- This is an optional GeometryFactory that can be set to control how the geometries on features are
- created. if this is not specified, the default from DotSptaial.Topology is used.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IFeatureSet.FeatureLookup">
- <summary>
- Gets the feature lookup Table itself.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IFeatureSet.FeatureType">
- <summary>
- Gets an enumeration indicating the type of feature represented in this dataset, if any.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IFeatureSet.Filename">
- <summary>
- Gets the string fileName for this feature layer, if any
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IFeatureSet.ShapeIndices">
- <summary>
- These specifically allow the user to make sense of the Vertices array. These are
- fast acting sealed classes and are not meant to be overridden or support clever
- new implementations.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IFeatureSet.IndexMode">
- <summary>
- If this is true, then the ShapeIndices and Vertex values are used,
- and features are created on demand. Otherwise the list of Features
- is used directly.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IFeatureSet.Vertex">
- <summary>
- Gets an array of Vertex structures with X and Y coordinates
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IFeatureSet.Z">
- <summary>
- Z coordinates
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IFeatureSet.M">
- <summary>
- M coordinates
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IFeatureSet.VerticesAreValid">
- <summary>
- Gets a boolean that indicates whether or not the InvalidateVertices has been called
- more recently than the cached vertex array has been built.
- </summary>
- </member>
- <member name="F:DotSpatial.Data.FeatureSet._dataTable">
- <summary>
- The _data table.
- </summary>
- </member>
- <member name="F:DotSpatial.Data.FeatureSet._featureLookup">
- <summary>
- The _feature lookup.
- </summary>
- </member>
- <member name="F:DotSpatial.Data.FeatureSet._features">
- <summary>
- The _features.
- </summary>
- </member>
- <member name="F:DotSpatial.Data.FeatureSet._m">
- <summary>
- The _m.
- </summary>
- </member>
- <member name="F:DotSpatial.Data.FeatureSet._shapeIndices">
- <summary>
- The _shape indices.
- </summary>
- </member>
- <member name="F:DotSpatial.Data.FeatureSet._vertices">
- <summary>
- The _vertices.
- </summary>
- </member>
- <member name="F:DotSpatial.Data.FeatureSet._verticesAreValid">
- <summary>
- The _vertices are valid.
- </summary>
- </member>
- <member name="F:DotSpatial.Data.FeatureSet._z">
- <summary>
- The _z.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Data.FeatureSet"/> class.
- This doesn't do anything exactly because there is no file-specific information yet
- </summary>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.#ctor(DotSpatial.Topology.FeatureType)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Data.FeatureSet"/> class.
- Creates a new FeatureSet
- </summary>
- <param name="featureType">
- The Feature type like point, line or polygon
- </param>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.#ctor(System.Data.DataTable,System.Int32,System.Boolean,DotSpatial.Topology.FeatureType)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Data.FeatureSet"/> class.
- This creates a new featureset by checking each row of the table. If the WKB feature
- type matches the specified featureTypes, then it will copy that.
- </summary>
- <param name="wkbTable">
- </param>
- <param name="wkbColumnIndex">
- </param>
- <param name="indexed">
- </param>
- <param name="type">
- </param>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.#ctor(System.Collections.Generic.IList{DotSpatial.Data.IFeature})">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Data.FeatureSet"/> class.
- Creates a new FeatureSet using a given list of IFeatures.
- This will copy the existing features, rather than removing
- them from their parent feature set.
- </summary>
- <param name="inFeatures">
- The list of IFeatures
- </param>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.AddFeature(DotSpatial.Topology.IBasicGeometry)">
- <summary>
- Generates a new feature, adds it to the features and returns the value.
- </summary>
- <param name="geometry">
- The geometry.
- </param>
- <returns>
- The feature that was added to this featureset
- </returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.DataTableRowDeleted(System.Object,System.Data.DataRowChangeEventArgs)">
- <summary>
- The data table row deleted.
- </summary>
- <param name="sender">
- The sender.
- </param>
- <param name="e">
- The e.
- </param>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.FeaturesFeatureAdded(System.Object,DotSpatial.Data.FeatureEventArgs)">
- <summary>
- The features feature added.
- </summary>
- <param name="sender">
- The sender.
- </param>
- <param name="e">
- The e.
- </param>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.FeaturesFeatureRemoved(System.Object,DotSpatial.Data.FeatureEventArgs)">
- <summary>
- The features feature removed.
- </summary>
- <param name="sender">
- The object sender.
- </param>
- <param name="e">
- The FeatureEventArgs.
- </param>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.AddFid">
- <summary>
- Adds the FID values as a field called FID, but only if the FID field
- does not already exist.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.AddShape(DotSpatial.Data.Shape)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.AddShapes(System.Collections.Generic.IEnumerable{DotSpatial.Data.Shape})">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.CopyFeatures(DotSpatial.Data.IFeatureSet,System.Boolean)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.DotSpatial#Data#IFeatureSet#CopySubset(System.Collections.Generic.List{System.Int32})">
- <summary>
- The copy subset.
- </summary>
- <param name="indices">
- The indices.
- </param>
- <returns>
- </returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.DotSpatial#Data#IFeatureSet#CopySubset(System.String)">
- <summary>
- The copy subset.
- </summary>
- <param name="filterExpression">
- The filter expression.
- </param>
- <returns>
- </returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.CopyTableSchema(DotSpatial.Data.IFeatureSet)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.CopyTableSchema(System.Data.DataTable)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.FeatureFromRow(System.Data.DataRow)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.FillAttributes">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.FillAttributes(DotSpatial.Data.IProgressHandler)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.Find(System.String)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.GetColumnNames(System.String)">
- <summary>
- Gets the list of string names available as columns from the specified excel file.
- </summary>
- <param name="xlsFilePath">
- </param>
- <returns>
- </returns>
- Warning. This method should be moved outside of FeatureSet.
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.GetFeature(System.Int32)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.GetShape(System.Int32,System.Boolean)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.InitializeVertices">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.InvalidateVertices">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.Join(System.String,System.String,System.String)">
- <summary>
- For attributes that are small enough to be loaded into a data table, this
- will join attributes from a foreign table (from an excel file). This method
- won't create new rows in this table, so only matching members are brought in,
- but no rows are removed either, so not all rows will receive data.
- </summary>
- <param name="xlsFilePath">
- The complete path of the file to join
- </param>
- <param name="localJoinField">
- The field name to join on in this table
- </param>
- <param name="xlsJoinField">
- The field in the foreign table.
- </param>
- <returns>
- A modified featureset with the changes.
- </returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.Save">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.SaveAs(System.String,System.Boolean)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.Select(DotSpatial.Data.Extent)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.Select(DotSpatial.Data.Extent,DotSpatial.Data.Extent@)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.SelectByAttribute(System.String)">
- <summary>
- Selects using a string filter expression to obtain the desired features.
- Field names should be in square brackets. Alternately, if the field name of [FID]
- is used, then it will use the row index instead if no FID field is found.
- </summary>
- <param name="filterExpression">
- The features to return.
- </param>
- <returns>
- The list of desired features.
- </returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.SelectIndexByAttribute(System.String)">
- <summary>
- This version is more tightly integrated to the DataTable and returns the row indices, rather
- than attempting to link the results to features themselves, which may not even exist.
- </summary>
- <param name="filterExpression">
- The filter expression
- </param>
- <returns>
- The list of indices
- </returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.SelectIndices(DotSpatial.Data.Extent)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.CopySubset(System.Collections.Generic.List{System.Int32})">
- <summary>
- Retrieves a subset using exclusively the features matching the specified values.
- </summary>
- <param name="indices">
- An integer list of indices to copy into the new FeatureSet.
- </param>
- <returns>
- A FeatureSet with the new items.
- </returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.InvalidateEnvelope">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.Open(System.String)">
- <summary>
- This attempts to open the specified file as a valid IFeatureSet. This will require that
- the default data manager can work with the file format at runtime.
- </summary>
- <param name="fileName">
- The string fileName for this featureset.
- </param>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.OpenFile(System.String)">
- <summary>
- This will return the correct feature type by reading the fileName.
- </summary>
- <param name="fileName">
- A string specifying the file with the extension .shp to open.
- </param>
- <returns>
- A correct featureSet which is exclusively for reading the .shp data
- </returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.OpenFile(System.String,DotSpatial.Data.IProgressHandler)">
- <summary>
- Generates a new FeatureSet, if possible, from the specified fileName.
- </summary>
- <param name="fileName">
- The string fileName to attempt to load into a new FeatureSet.
- </param>
- <param name="progressHandler">
- An IProgressHandler for progress messages
- </param>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.GetLine(System.Int32)">
- <summary>
- Gets the line for the specified index
- </summary>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.GetMultiPoint(System.Int32)">
- <summary>
- Returns a single multipoint feature for the shape at the specified index
- </summary>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.GetPoint(System.Int32)">
- <summary>
- Gets the point for the shape at the specified index
- </summary>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.GetPolygon(System.Int32)">
- <summary>
- If the FeatureType is polygon, this is the code for converting the vertex array
- into a feature.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.AddAttributes(DotSpatial.Data.Shape)">
- <summary>
- handles the attributes while adding a shape
- </summary>
- <param name="shape">
- </param>
- <returns>
- A data row, but only if attributes are populated
- </returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.CopySubset(System.String)">
- <summary>
- Copies the subset of specified features to create a new featureset that is restricted to
- just the members specified.
- </summary>
- <param name="filterExpression">
- The string expression to test.
- </param>
- <returns>
- A FeatureSet that has members that only match the specified members.
- </returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.PointInList(DotSpatial.Topology.Coordinate,System.Collections.Generic.IEnumerable{DotSpatial.Topology.Coordinate})">
- <summary>
- Test if a point is in a list of coordinates.
- </summary>
- <param name="testPoint">
- TestPoint the point to test for.
- </param>
- <param name="pointList">
- PointList the list of points to look through.
- </param>
- <returns>
- true if testPoint is a point in the pointList list.
- </returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.RemoveShapeAt(System.Int32)">
- <summary>
- Attempts to remove the specified shape. If in memory, this will also remove the
- corresponding database row. This has no affect on the underlying datasets.
- To impact those, use the
- </summary>
- <param name="index">
- The integer index o the shape to remove.
- </param>
- <returns>
- Boolean, true if the remove was successful.
- </returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.RemoveShapesAt(System.Collections.Generic.IEnumerable{System.Int32})">
- <summary>
- Attempts to remove a range of shapes by index. This is optimized to
- work better for large numbers. For one or two, using RemoveShapeAt might
- be faster.
- </summary>
- <param name="indices">
- The enumerable set of indices to remove.
- </param>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.Reproject(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Reprojects all of the in-ram vertices of this featureset.
- This will also update the projection to be the specified projection.
- </summary>
- <param name="targetProjection">
- The projection information to reproject the coordinates to.
- </param>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.UpdateExtent">
- <summary>
- After changing coordinates, this will force the re-calculation of envelopes on a feature
- level or test the shapes in index mode to rebuild an Extent.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.RelativePathTo(System.String)">
- <summary>
- Creates a relative path from one file or folder to another.
- </summary>
- <param name="toPath">
- Contains the path that defines the endpoint of the relative path.
- </param>
- <returns>
- The relative path from the start directory to the end path.
- </returns>
- <exception cref="T:System.ArgumentNullException">Occurs when the toPath is NULL</exception>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.MakeRelativePath(System.String,System.String)">
- <summary>
- Creates a relative path from one file or folder to another.
- </summary>
- <param name="fromPath">Contains the directory that defines the start of the relative path.</param>
- <param name="toPath">Contains the path that defines the endpoint of the relative path.</param>
- <returns>The relative path from the start directory to the end path.</returns>
- <exception cref="T:System.ArgumentNullException"></exception>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.FeaturesFromVertices">
- <summary>
- Calculates the features from the shape indices and vertex array.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.OnDataTableExcluded(System.Data.DataTable)">
- <summary>
- Allows the un-wiring of event handlers related to the data Table.
- </summary>
- <param name="dataTable">
- </param>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.OnDataTableIncluded(System.Data.DataTable)">
- <summary>
- Allows the wiring of event handlers related to the data Table.
- </summary>
- <param name="dataTable">
- </param>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.OnExcludeFeatures(DotSpatial.Data.IFeatureList)">
- <summary>
- Occurs when removing the feature list, allowing events to be disconnected
- </summary>
- <param name="features">
- </param>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.OnIncludeFeatures(DotSpatial.Data.IFeatureList)">
- <summary>
- Occurs when setting the feature list, allowing events to be connected
- </summary>
- <param name="features">
- </param>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.AddRow(System.Collections.Generic.Dictionary{System.String,System.Object})">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.AddRow(System.Data.DataRow)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.Edit(System.Int32,System.Collections.Generic.Dictionary{System.String,System.Object})">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.Edit(System.Int32,System.Data.DataRow)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.GetAttributes(System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.GetAttributes(System.Int32,System.Int32,System.Collections.Generic.IEnumerable{System.String})">
- <summary>
- Reads just the content requested in order to satisfy the paging ability of VirtualMode for the DataGridView
- </summary>
- <param name="startIndex">
- The integer lower page boundary.
- </param>
- <param name="numRows">
- The integer number of attribute rows to return for the page.
- </param>
- <param name="fieldNames">
- The list or array of fieldnames to return.
- </param>
- <returns>
- A DataTable populated with data rows with only the specified values.
- </returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.GetColumn(System.String)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.GetColumns">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.GetCounts(System.String[],DotSpatial.Data.ICancelProgressHandler,System.Int32)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.NumRows">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.SetAttributes(System.Int32,System.Data.DataTable)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.OnInitializeVertices">
- <summary>
- Occurs when the vertices are being re-calculated.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.OnVerticesInvalidated">
- <summary>
- Fires the VerticesInvalidated event
- </summary>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.UpdateCoordinates">
- <summary>
- This forces the cached vertices array to be copied back to the individual X and Y values
- of the coordinates themselves.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.FeatureSet.Dispose(System.Boolean)">
- <summary>
- Disposes the unmanaged memory objects.
- </summary>
- <param name="disposeManagedResources">If this is true, managed resources are set to null.</param>
- </member>
- <member name="E:DotSpatial.Data.FeatureSet.FeatureAdded">
- <summary>
- Occurs when a new feature is added to the list
- </summary>
- </member>
- <member name="E:DotSpatial.Data.FeatureSet.FeatureRemoved">
- <summary>
- Occurs when a feature is removed from the list.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.FeatureSet.VerticesInvalidated">
- <summary>
- Occurs when the vertices are invalidated, encouraging a re-draw
- </summary>
- </member>
- <member name="P:DotSpatial.Data.FeatureSet.FilePath">
- <summary>
- Gets or sets the current file path. This is the relative path relative to
- the current project folder. For feature sets coming from a database
- or a web service, the FilePath property is NULL.
- </summary>
- <value>
- The relative file path.
- </value>
- <remarks>This property is used when saving source file information to a DSPX project.</remarks>
- </member>
- <member name="P:DotSpatial.Data.FeatureSet.AttributesPopulated">
- <summary>
- Gets whether or not the attributes have all been loaded into the data table.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.FeatureSet.CoordinateType">
- <summary>
- Gets or sets the coordinate type across the entire featureset.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.FeatureSet.DataTable">
- <summary>
- DataTable is the System.Data.DataTable for all the attributes of this FeatureSet.
- This will call FillAttributes if it is accessed and that has not yet been called.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.FeatureSet.Extent">
- <summary>
- This is the envelope in Extent form. This may be cached.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.FeatureSet.FeatureGeometryFactory">
- <summary>
- This is an optional GeometryFactory that can be set to control how the geometries on features are
- created. The "Feature" prefix allows us to access the static Default instance on GeometryFactory.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.FeatureSet.FeatureLookup">
- <summary>
- Gets the feature lookup Table itself.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.FeatureSet.FeatureType">
- <summary>
- Gets or sets an enumeration specifying whether this
- featureset contains Lines, Points, Polygons or an
- unspecified type.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.FeatureSet.Features">
- <summary>
- A list of the features in this layer
- </summary>
- </member>
- <member name="P:DotSpatial.Data.FeatureSet.Filename">
- <summary>
- Gets or sets the file name of a file based feature set. The file name should be the
- absolute path including the file extension. For feature sets coming from a database
- or a web service, the Filename property is NULL.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.FeatureSet.IndexMode">
- <summary>
- If this is true, then the ShapeIndices and Vertex values are used,
- and features are created on demand. Otherwise the list of Features
- is used directly.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.FeatureSet.M">
- <inheritdoc/>
- </member>
- <member name="P:DotSpatial.Data.FeatureSet.ShapeIndices">
- <summary>
- These specifically allow the user to make sense of the Vertices array. These are
- fast acting sealed classes and are not meant to be overridden or support clever
- new implementations.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.FeatureSet.Vertex">
- <inheritdoc/>
- </member>
- <member name="P:DotSpatial.Data.FeatureSet.VerticesAreValid">
- <summary>
- Gets a Boolean that indicates whether or not the InvalidateVertices has been called
- more recently than the cached vertex array has been built.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.FeatureSet.Z">
- <inheritdoc/>
- </member>
- <member name="T:DotSpatial.Data.FeatureSetExt">
- <summary>
- FeatureSetEM contains extension methods that should work for any IFeatureSet
- </summary>
- </member>
- <member name="M:DotSpatial.Data.FeatureSetExt.Buffer(DotSpatial.Data.IFeatureSet,System.Double,System.Boolean)">
- <summary>
- Creates a new polygon featureset that is created by buffering each of the individual shapes.
- </summary>
- <param name="self">The IFeatureSet to buffer</param>
- <param name="distance">The double distance to buffer</param>
- <param name="copyAttributes">Boolean, if this is true, then the new featureset will have
- the same attributes as the original.</param>
- <returns>The newly created IFeatureSet</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureSetExt.CombinedFields(DotSpatial.Data.IFeatureSet,DotSpatial.Data.IFeatureSet)">
- <summary>
- Generates an empty featureset that has the combined fields from this featureset
- and the specified featureset.
- </summary>
- <param name="self">This featureset</param>
- <param name="other">The other featureset to combine fields with.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureSetExt.Dissolve(DotSpatial.Data.IFeatureSet,System.String)">
- <summary>
- Calculates a union of any features that have a common value in the specified field.
- The output will only contain the specified field. Example: Disolving a county
- shapefile based on state name to produce a single polygon shaped like the state.
- </summary>
- <param name="self">The original featureSet to disolve the features of</param>
- <param name="fieldName">The string field name to use for the disolve operation</param>
- <returns>A featureset where the geometries of features with the same attribute in the specified field have been combined.</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureSetExt.Intersects(DotSpatial.Data.IFeature,DotSpatial.Topology.IEnvelope)">
- <summary>
- Tests to see if this feature intersects with the specified envelope
- </summary>
- <param name="self">This feature</param>
- <param name="env">The envelope to test</param>
- <returns>Boolean, true if the intersection occurs</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureSetExt.UnionShapes(DotSpatial.Data.IFeatureSet,DotSpatial.Data.ShapeRelateType)">
- <summary>
- This method will create a new IFeatureSet with the the shapes that intersect merged into single shapes,
- or else it will return a new featureset where EVERY shape is unioned into a single, multi-part shape.
- </summary>
- <param name="self">The source of features to union</param>
- <param name="style">This controls whether intersecting or all features are unioned</param>
- <returns>An IFeatureSet with the unioned shapes.</returns>
- </member>
- <member name="M:DotSpatial.Data.FeatureSetExt.Intersection(DotSpatial.Data.IFeatureSet,DotSpatial.Data.IFeatureSet,DotSpatial.Data.FieldJoinType,DotSpatial.Data.IProgressHandler)">
- <summary>
- This tests each feature of the input
- </summary>
- <param name="self">This featureSet</param>
- <param name="other">The featureSet to perform intersection with</param>
- <param name="joinType">The attribute join type</param>
- <param name="progHandler">A progress handler for status messages</param>
- <returns>An IFeatureSet with the intersecting features, broken down based on the join Type</returns>
- </member>
- <member name="T:DotSpatial.Data.FeatureTypeMismatchException">
- <summary>
- FeatureTypeMismatchException
- </summary>
- </member>
- <member name="M:DotSpatial.Data.FeatureTypeMismatchException.#ctor">
- <summary>
- Creates a new instance of FeatureTypeMismatchException
- </summary>
- </member>
- <member name="T:DotSpatial.Data.FieldJoinType">
- <summary>
- FieldJoinType
- </summary>
- </member>
- <member name="F:DotSpatial.Data.FieldJoinType.All">
- <summary>
- Output datasets have all fields from both input and output sets. Fields with duplicate field names will be appended with a number.
- Features from this dataset may appear more than once if more than one valid intersection occurs with the features from the
- other featureset.
- </summary>
- </member>
- <member name="F:DotSpatial.Data.FieldJoinType.ForeignOnly">
- <summary>
- The fields will be created from the fields in the other featureset.
- </summary>
- </member>
- <member name="F:DotSpatial.Data.FieldJoinType.LocalOnly">
- <summary>
- All the fields from this FeatureSet are used, and all of the features from the other featureset are considered
- to be a single geometry so that features from this set will appear no more than once in the output set.
- </summary>
- </member>
- <member name="F:DotSpatial.Data.FieldJoinType.None">
- <summary>
- No fields will be copied, but features from this featureset will be considered independantly and added as separate
- features to the output featureset.
- </summary>
- </member>
- <member name="F:DotSpatial.Data.AttributeCache.EditRow">
- <summary>
- The row being edited
- </summary>
- </member>
- <member name="F:DotSpatial.Data.AttributeCache.Pages">
- <summary>
- The pages currently stored in the cache
- </summary>
- </member>
- <member name="M:DotSpatial.Data.AttributeCache.#ctor(DotSpatial.Data.IAttributeSource,System.Int32)">
- <summary>
- Constructs a new Cache object that can create data tables by using a DataPageRetriever
- </summary>
- <param name="dataSupplier">Any structure that implements IDataPageRetriever</param>
- <param name="rowsPerPage">The rows per page</param>
- </member>
- <member name="M:DotSpatial.Data.AttributeCache.GetEnumerator">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Data.AttributeCache.SaveChanges">
- <summary>
- Saves the changes in the edit row to the tabular cache as well as the underlying database
- </summary>
- </member>
- <member name="M:DotSpatial.Data.AttributeCache.RetrieveElement(System.Int32)">
- <summary>
- Obtains the element at the specified index
- </summary>
- <param name="rowIndex"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.AttributeCache.RetrieveElement(System.Int32,System.Int32)">
- <summary>
- Obtains the element at the specified index
- </summary>
- <param name="rowIndex"></param>
- <param name="columnIndex"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Data.AttributeCache.EditRowIndex">
- <summary>
- The integer index of the row being edited
- </summary>
- </member>
- <member name="P:DotSpatial.Data.AttributeCache.NumRows">
- <summary>
- The number of rows in the data supply
- </summary>
- </member>
- <member name="T:DotSpatial.Data.AttributeCache.AttributeCacheEnumerator">
- <summary>
- Enumerates the dictionaries that represent row content stored by field name.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.AttributeCache.AttributeCacheEnumerator.#ctor(DotSpatial.Data.AttributeCache)">
- <summary>
- Creates a new AttributeCacheEnumerator
- </summary>
- <param name="cache"></param>
- </member>
- <member name="M:DotSpatial.Data.AttributeCache.AttributeCacheEnumerator.Dispose">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Data.AttributeCache.AttributeCacheEnumerator.MoveNext">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Data.AttributeCache.AttributeCacheEnumerator.Reset">
- <inheritdoc />
- </member>
- <member name="P:DotSpatial.Data.AttributeCache.AttributeCacheEnumerator.Current">
- <inheritdoc />
- </member>
- <member name="P:DotSpatial.Data.AttributeCache.AttributeCacheEnumerator.System#Collections#IEnumerator#Current">
- <inheritdoc />
- </member>
- <member name="T:DotSpatial.Data.AttributeCache.DataPage">
- <summary>
- Represents one page of data.
- </summary>
- </member>
- <member name="F:DotSpatial.Data.AttributeCache.DataPage.Table">
- <summary>
- The data Table
- </summary>
- </member>
- <member name="M:DotSpatial.Data.AttributeCache.DataPage.#ctor(System.Data.DataTable,System.Int32)">
- <summary>
- A Data page representing one page of data-row values
- </summary>
- <param name="table">The DataTable that controls the content</param>
- <param name="rowIndex">The integer row index</param>
- </member>
- <member name="M:DotSpatial.Data.AttributeCache.DataPage.Contains(System.Int32)">
- <summary>
- Tests to see if the specified index is in this page.
- </summary>
- <param name="index"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.AttributeCache.DataPage.MapToLowerBoundary(System.Int32)">
- <summary>
- Given an arbitrary row index, this calculates what the lower boundary would be for the page containing the index
- </summary>
- <param name="rowIndex"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.AttributeCache.DataPage.MapToUpperBoundary(System.Int32)">
- <summary>
- Given an arbitrary row index, this calculates the upper boundary for the page containing the index
- </summary>
- <param name="rowIndex"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Data.AttributeCache.DataPage.LowestIndex">
- <summary>
- The integer lowest index of the page
- </summary>
- </member>
- <member name="P:DotSpatial.Data.AttributeCache.DataPage.HighestIndex">
- <summary>
- The integer highest index of the page
- </summary>
- </member>
- <member name="T:DotSpatial.Data.AttributePager">
- <summary>
- AttributePager
- </summary>
- </member>
- <member name="M:DotSpatial.Data.AttributePager.#ctor(DotSpatial.Data.IAttributeSource,System.Int32)">
- <summary>
- Creates a new instance of AttributePager
- </summary>
- </member>
- <member name="M:DotSpatial.Data.AttributePager.GetEnumerator">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Data.AttributePager.Dispose">
- <summary>
- Does nothing
- </summary>
- </member>
- <member name="M:DotSpatial.Data.AttributePager.MoveNext">
- <summary>
- Advances to the next attribute
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.AttributePager.Reset">
- <summary>
- reset the attribute pager
- </summary>
- </member>
- <member name="M:DotSpatial.Data.AttributePager.NumPages">
- <summary>
- The integer number of pages
- </summary>
- <returns>the number of pages</returns>
- </member>
- <member name="M:DotSpatial.Data.AttributePager.RowCount(System.Int32)">
- <summary>
- Gets the number of rows on the specified page.
- </summary>
- <param name="pageindex">The page index</param>
- <returns>The number of rows that should be on that page.</returns>
- </member>
- <member name="M:DotSpatial.Data.AttributePager.Row(System.Int32)">
- <summary>
- Loads the appropriate page if it isn't loaded already and returns the DataRow that
- matches the specified index
- </summary>
- <param name="rowIndex">The integer row index</param>
- <returns>The DataRow</returns>
- </member>
- <member name="M:DotSpatial.Data.AttributePager.PageOfRow(System.Int32)">
- <summary>
- Returns the page that the specified row is on
- </summary>
- <param name="rowIndex">The integer row index</param>
- <returns>The page of the row in question</returns>
- </member>
- <member name="P:DotSpatial.Data.AttributePager.Current">
- <summary>
- Gets the current table
- </summary>
- </member>
- <member name="P:DotSpatial.Data.AttributePager.StartIndex">
- <summary>
- Gets the starting row index of the current page.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.AttributePager.PageSize">
- <summary>
- Gets the pages size as a count of the number of rows each data table page should hold
- </summary>
- </member>
- <member name="P:DotSpatial.Data.AttributePager.Item(System.Int32)">
- <summary>
- This returns the data table for the corresponding page index, but also sets the
- Pager so that it is sitting on the specified page index.
- </summary>
- <param name="pageIndex"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Data.AttributeTable">
- <summary>
- A class for controlling the attribute Table related information for a shapefile.
- </summary>
- </member>
- <member name="F:DotSpatial.Data.AttributeTable._isFilling">
- <summary>
- Indicates that the Fill methode is called from inside itself.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.AttributeTable.#ctor">
- <summary>
- Creates a new instance of an attribute Table with no file reference
- </summary>
- </member>
- <member name="M:DotSpatial.Data.AttributeTable.#ctor(System.String)">
- <summary>
- Creates a new AttributeTable with the specified fileName, or opens
- an existing file with that name.
- </summary>
- <param name="fileName"></param>
- </member>
- <member name="M:DotSpatial.Data.AttributeTable.SupplyPageOfData(System.Int32,System.Int32)">
- <summary>
- Reads just the content requested in order to satisfy the paging ability of VirtualMode for the DataGridView
- </summary>
- <param name="lowerPageBoundary"></param>
- <param name="rowsPerPage"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.AttributeTable.SupplyPageOfData(System.Int32,System.Int32,System.String)">
- <summary>
- Reads just the content requested.
- </summary>
- <param name="lowerPageBoundary">starting row</param>
- <param name="rowsPerPage">number of rows to return</param>
- <param name="fieldName">field for which data is to be returned</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.AttributeTable.SupplyPageOfData(System.Int32,System.Int32,System.Collections.Generic.IEnumerable{System.String})">
- <summary>
- Reads just the contents requested. Faster than returning the entire record if you have lots of attributes but only want a few.
- </summary>
- <param name="lowerPageBoundary">starting row</param>
- <param name="rowsPerPage">number of rows to return</param>
- <param name="fieldNames">fields for which data is to be returned</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.AttributeTable.SetAttributes(System.Int32,System.Data.DataTable)">
- <summary>
- Reads just the content requested in order to satisfy the paging ability of VirtualMode for the DataGridView
- </summary>
- <param name="startRow">The 0 based integer index of the start row</param>
- <param name="dataValues">The DataTable with the 0 row corresponding to the start row. If this exceeds the size of the data table, it will add rows.</param>
- </member>
- <member name="M:DotSpatial.Data.AttributeTable.GetAttributes(System.Collections.Generic.IEnumerable{System.Int32})">
- <summary>
- Get a DataTable containing the specified rows
- </summary>
- <param name="rowNumbers"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.AttributeTable.GetFileIndex(System.Int32)">
- <summary>
- Accounts for deleted rows and returns the index as it appears in the file
- </summary>
- <param name="rowIndex"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.AttributeTable.GetRowIndexFromFileIndex(System.Int32)">
- <summary>
- Accounts for deleted rows and adjusts a file index to a row index
- </summary>
- <param name="fileIndex"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.AttributeTable.AddRow(System.Collections.Generic.Dictionary{System.String,System.Object})">
- <summary>
- Saves the new row to the data source and updates the file with new content.
- </summary>
- <param name="values">The values organized against the dictionary of field names.</param>
- </member>
- <member name="M:DotSpatial.Data.AttributeTable.RemoveRowAt(System.Int32)">
- <summary>
- Removes the row at the specified row index from both the table in memory
- and by marking it as deleted in the file. This should work even in cases
- where the file is very large and working as an AttributeSource.
- </summary>
- <param name="index"></param>
- </member>
- <member name="M:DotSpatial.Data.AttributeTable.AddRow(System.Data.DataRow)">
- <summary>
- Saves the new row to the data source and updates the file with new content.
- </summary>
- <param name="values">The values organized against the dictionary of field names.</param>
- </member>
- <member name="M:DotSpatial.Data.AttributeTable.Edit(System.Int32,System.Collections.Generic.Dictionary{System.String,System.Object})">
- <summary>
- saves a single row to the data source.
- </summary>
- <param name="index">the integer row (or FID) index</param>
- <param name="values">The object array holding the new values to store.</param>
- </member>
- <member name="M:DotSpatial.Data.AttributeTable.Edit(System.Int32,System.Data.DataRow)">
- <summary>
- saves a single row to the data source.
- </summary>
- <param name="index">the integer row (or FID) index</param>
- <param name="values">The object array holding the new values to store.</param>
- </member>
- <member name="M:DotSpatial.Data.AttributeTable.Edit(System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.Int32,System.Data.DataRow}})">
- <summary>
- saves a collection of rows to the data source
- </summary>
- <param name="indexDataRowPairs"></param>
- </member>
- <member name="M:DotSpatial.Data.AttributeTable.Edit(System.Collections.Generic.IEnumerable{System.Int32},DotSpatial.Data.RowEditEvent)">
- <summary>
- Edit the specified rows via a client supplied callback
- </summary>
- <param name="indices">rows to edit</param>
- <param name="rowCallback">client supplied callback</param>
- </member>
- <member name="M:DotSpatial.Data.AttributeTable.BeginEdit">
- <summary>
- Setup before calls to OverwriteDataRow
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.AttributeTable.EndEdit">
- <summary>
- Cleanup after finished calling OverwriteDataRow
- </summary>
- </member>
- <member name="M:DotSpatial.Data.AttributeTable.OverwriteDataRow(System.Int32,System.Object,DotSpatial.Data.NumberConverter[])">
- <summary>
- Common code for editing an existing row in the data source
- </summary>
- <param name="index"></param>
- <param name="values"></param>
- <param name="ncs"></param>
- </member>
- <member name="M:DotSpatial.Data.AttributeTable.ReadTableRow(System.Int32,System.Int32,System.Byte[],System.Data.DataTable)">
- <summary>
- Read a single dbase record
- </summary>
- <returns>Returns an IFeature with information appropriate for the current row in the Table</returns>
- </member>
- <member name="M:DotSpatial.Data.AttributeTable.Open(System.String)">
- <summary>
- Reads all the information from the file, including the vector shapes and the database component.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.AttributeTable.Open(System.String,System.Collections.Generic.List{System.Int32})">
- <summary>
- Reads the header and if deletedRows is null, searches file for deletedRows if file size indicates possibility of deleted rows.
- </summary>
- <param name="fileName"></param>
- <param name="deletedRows"></param>
- </member>
- <member name="M:DotSpatial.Data.AttributeTable.Fill(System.Int32)">
- <summary>
- This populates the Table with data from the file.
- </summary>
- <param name="numRows">In the event that the dbf file is not found, this indicates how many blank rows should exist in the attribute Table.</param>
- </member>
- <member name="M:DotSpatial.Data.AttributeTable.Save">
- <summary>
- Attempts to save the file to the path specified by the Filename property.
- This should be the .shp extension.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.AttributeTable.SaveAs(System.String,System.Boolean)">
- <summary>
- Saves this Table to the specified fileName
- </summary>
- <param name="fileName">The string fileName to save to</param>
- <param name="overwrite">A boolean indicating whether or not to write over the file if it exists.</param>
- </member>
- <member name="M:DotSpatial.Data.AttributeTable.ColumnNameExists(System.String)">
- <summary>
- Tests to see if the list of columns contains the specified name or not.
- </summary>
- <param name="name">Name of the column we're looking for.</param>
- <returns>True, if the column exists.</returns>
- </member>
- <member name="M:DotSpatial.Data.AttributeTable.WriteTable">
- <summary>
- This appends the content of one datarow to a dBase file.
- </summary>
- <exception cref="T:System.ArgumentNullException">The columnValues parameter was null</exception>
- <exception cref="T:System.InvalidOperationException">Header records need to be written first.</exception>
- <exception cref="T:System.IO.InvalidDataException">Table property of columnValues parameter cannot be null.</exception>
- </member>
- <member name="M:DotSpatial.Data.AttributeTable.WriteSpaces(System.Int32)">
- <summary>
- Writes a number of spaces equal to numspaces
- </summary>
- <param name="numspaces">The integer number of spaces to write</param>
- </member>
- <member name="M:DotSpatial.Data.AttributeTable.Write(System.Double,System.Int32,System.Int32)">
- <summary>
-
- </summary>
- <param name="number"></param>
- <param name="length"></param>
- <param name="decimalCount"></param>
- </member>
- <member name="M:DotSpatial.Data.AttributeTable.Write(System.Int64,System.Int32,System.Int32)">
- <summary>
- Writes an integer so that it is formatted for dbf. This is still buggy since it is possible to lose info here.
- </summary>
- <param name="number">The long value</param>
- <param name="length">The length of the field.</param>
- <param name="decimalCount">The number of digits after the decimal</param>
- </member>
- <member name="M:DotSpatial.Data.AttributeTable.Write(System.String,System.Int32)">
- <summary>
-
- </summary>
- <param name="text"></param>
- <param name="length"></param>
- </member>
- <member name="M:DotSpatial.Data.AttributeTable.WriteDate(System.DateTime)">
- <summary>
-
- </summary>
- <param name="date"></param>
- </member>
- <member name="M:DotSpatial.Data.AttributeTable.Write(System.Boolean)">
- <summary>
-
- </summary>
- <param name="flag"></param>
- </member>
- <member name="M:DotSpatial.Data.AttributeTable.WriteHeader(System.IO.BinaryWriter)">
- <summary>
- Write the header data to the DBF file.
- </summary>
- <param name="writer"></param>
- </member>
- <member name="M:DotSpatial.Data.AttributeTable.ReadTableRowFromChars(System.Int32,System.IO.BinaryReader)">
- <summary>
- Read a single dbase record
- </summary>
- <returns>Returns an IFeature with information appropriate for the current row in the Table</returns>
- </member>
- <member name="M:DotSpatial.Data.AttributeTable.ParseColumn(DotSpatial.Data.Field,System.Int32,System.Char[],System.Data.DataTable)">
- <summary>
- Parse the character data for one column into an object ready for insertion into a data row
- </summary>
- <param name="field"></param>
- <param name="currentRow"></param>
- <param name="cBuffer"></param>
- <param name="table"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.AttributeTable.ReadTableHeader(System.IO.BinaryReader)">
- <summary>
- Read the header data from the DBF file.
- </summary>
- <param name="reader">BinaryReader containing the header.</param>
- </member>
- <member name="M:DotSpatial.Data.AttributeTable.UpgradeColumn(DotSpatial.Data.Field,System.Type,System.Int32,System.Int32,System.Data.DataTable)">
- <summary>
- This systematically copies all the existing values to a new data column with the same properties,
- but with a new data type. Values that cannot convert will be set to null.
- </summary>
- <param name="oldDataColumn">The old data column to update</param>
- <param name="newDataType">The new data type that the column should become</param>
- <param name="currentRow">The row up to which values should be changed for</param>
- <param name="columnIndex">The column index of the field being changed</param>
- <param name="table"> The Table to apply this strategy to.</param>
- <returns>An integer list showing the index values of the rows where the conversion failed.</returns>
- </member>
- <member name="M:DotSpatial.Data.AttributeTable.OnAttributesFilled">
- <summary>
- Fires the AttributesFilled event
- </summary>
- </member>
- <member name="E:DotSpatial.Data.AttributeTable.AttributesFilled">
- <summary>
- Occurs after content has been loaded into the attribute data.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.AttributeTable.AttributesPopulated">
- <summary>
- gets or sets whether the Attributes have been populated. If data was "opened" from a file,
- and a query is made to the DataTable while _attributesPopulated is false, then
- a Fill method will be called automatically
- </summary>
- </member>
- <member name="P:DotSpatial.Data.AttributeTable.HeaderLength">
- <summary>
- The byte length of the header
- </summary>
- </member>
- <member name="P:DotSpatial.Data.AttributeTable.Columns">
- <summary>
- The columns
- </summary>
- </member>
- <member name="P:DotSpatial.Data.AttributeTable.FileType">
- <summary>
- The file type
- </summary>
- </member>
- <member name="P:DotSpatial.Data.AttributeTable.Filename">
- <summary>
- The fileName of the dbf file
- </summary>
- </member>
- <member name="P:DotSpatial.Data.AttributeTable.NumRecords">
- <summary>
- Number of records
- </summary>
- </member>
- <member name="P:DotSpatial.Data.AttributeTable.ProgressHandler">
- <summary>
- Gets or sets the progress handler for this Attribute Table.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.AttributeTable.ProgressMeter">
- <summary>
- Gets or sets the progress meter that is directly tied to the progress handler
- </summary>
- </member>
- <member name="P:DotSpatial.Data.AttributeTable.RecordLength">
- <summary>
- The byte length of each record
- </summary>
- </member>
- <member name="P:DotSpatial.Data.AttributeTable.LanguageDriverId">
- <summary>
- Gets the language driver ID (LDID) for this file
- </summary>
- </member>
- <member name="P:DotSpatial.Data.AttributeTable.Encoding">
- <summary>
- Gets the encoding used for text-based data and column names (based on LDID)
- </summary>
- </member>
- <member name="P:DotSpatial.Data.AttributeTable.Table">
- <summary>
- DataSet
- </summary>
- </member>
- <member name="P:DotSpatial.Data.AttributeTable.UpdateDate">
- <summary>
- Last date written to
- </summary>
- </member>
- <member name="P:DotSpatial.Data.AttributeTable.DeletedRows">
- <summary>
- Gets the list of raw row numbers that have been marked for deletion
- </summary>
- </member>
- <member name="T:DotSpatial.Data.LineShapefile">
- <summary>
- A shapefile class that handles the special case where the vectors are lines
- </summary>
- </member>
- <member name="T:DotSpatial.Data.Shapefile">
- <summary>
- This is a generic shapefile that is inherited by other specific shapefile types.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Shapefile.#ctor">
- <summary>
- When creating a new shapefile, this simply prevents the basic values from being null.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Shapefile.#ctor(DotSpatial.Topology.FeatureType)">
- <summary>
- Creates a new shapefile that has a specific feature type
- </summary>
- <param name="featureType"></param>
- </member>
- <member name="M:DotSpatial.Data.Shapefile.#ctor(System.String)">
- <summary>
- Creates a new instance of a shapefile based on a fileName
- </summary>
- <param name="fileName"></param>
- </member>
- <member name="M:DotSpatial.Data.Shapefile.GetCounts(System.String[],DotSpatial.Data.ICancelProgressHandler,System.Int32)">
- <summary>
- Gets the count of members that match the expression
- </summary>
- <param name="expressions">The string expression to test</param>
- <param name="progressHandler">THe progress handler that can also cancel the counting</param>
- <param name="maxSampleSize">The integer maximum sample size from which to draw counts. If this is negative, it will not be used.</param>
- <returns>The integer count of the members that match the expression.</returns>
- </member>
- <member name="M:DotSpatial.Data.Shapefile.AttributeTableAttributesFilled(System.Object,System.EventArgs)">
- <summary>
- This makes the assumption that the organization of the feature list has not
- changed since loading the attribute content.
- </summary>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Data.Shapefile.OpenFile(System.String)">
- <summary>
- This will return the correct shapefile type by reading the fileName.
- </summary>
- <param name="fileName">A string specifying the file with the extension .shp to open.</param>
- <returns>A correct shapefile object which is exclusively for reading the .shp data</returns>
- </member>
- <member name="M:DotSpatial.Data.Shapefile.OpenFile(System.String,DotSpatial.Data.IProgressHandler)">
- <summary>
- This will return the correct shapefile type by reading the fileName.
- </summary>
- <param name="fileName">A string specifying the file with the extension .shp to open.</param>
- <param name="progressHandler">receives progress messages and overrides the ProgressHandler on the DataManager.DefaultDataManager</param>
- <returns>A correct shapefile object which is exclusively for reading the .shp data</returns>
- </member>
- <member name="M:DotSpatial.Data.Shapefile.Edit(System.Int32,System.Collections.Generic.Dictionary{System.String,System.Object})">
- <summary>
- saves a single row to the data source.
- </summary>
- <param name="index">the integer row (or FID) index</param>
- <param name="values">The object array holding the new values to store.</param>
- </member>
- <member name="M:DotSpatial.Data.Shapefile.Edit(System.Int32,System.Data.DataRow)">
- <summary>
- saves a single row to the data source.
- </summary>
- <param name="index">the integer row (or FID) index</param>
- <param name="values">The object array holding the new values to store.</param>
- </member>
- <member name="M:DotSpatial.Data.Shapefile.AddRow(System.Collections.Generic.Dictionary{System.String,System.Object})">
- <summary>
- Saves the new row to the data source and updates the file with new content.
- </summary>
- <param name="values">The values organized against the dictionary of field names.</param>
- </member>
- <member name="M:DotSpatial.Data.Shapefile.AddRow(System.Data.DataRow)">
- <summary>
- Saves the new row to the data source and updates the file with new content.
- </summary>
- <param name="values">The values organized against the dictionary of field names.</param>
- </member>
- <member name="M:DotSpatial.Data.Shapefile.GetAttributes(System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Data.Shapefile.SetAttributes(System.Int32,System.Data.DataTable)">
- <summary>
- Converts a page of content from a DataTable format, saving it back to the source.
- </summary>
- <param name="startIndex">The 0 based integer index representing the first row in the file (corresponding to the 0 row of the data table)</param>
- <param name="pageValues">The DataTable representing the rows to set. If the row count is larger than the dataset, this will add the rows instead.</param>
- </member>
- <member name="M:DotSpatial.Data.Shapefile.SelectByAttribute(System.String)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Data.Shapefile.FillAttributes">
- <summary>
- Reads the attributes from the specified attribute Table.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Shapefile.SetupFeatureLookup">
- <summary>
- Sets up the feature lookup, if it has not been already.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Shapefile.WriteFileLength(System.String,System.Int32)">
- <summary>
- This doesn't rewrite the entire header or erase the existing content. This simply replaces the file length
- in the file with the new file length. This is generally because we want to write the header first,
- but don't know the total length of a new file until cycling through the entire file. It is easier, therefore
- to update the length after editing.
- </summary>
- <param name="fileName">A string fileName</param>
- <param name="length">The integer length of the file in 16-bit words</param>
- </member>
- <member name="M:DotSpatial.Data.Shapefile.ToInt(System.Byte[],System.Int32@,System.Boolean)">
- <summary>
- Reads 4 bytes from the specified byte array starting with offset.
- If IsBigEndian = true, then this flips the order of the byte values.
- </summary>
- <param name="value">An array of bytes that is at least 4 bytes in length from the startIndex</param>
- <param name="startIndex">A 0 based integer index where the double value begins</param>
- <param name="isLittleEndian">If this is true, then the order of the bytes is reversed before being converted to a double</param>
- <returns>A double created from reading the byte array</returns>
- </member>
- <member name="M:DotSpatial.Data.Shapefile.ToDouble(System.Byte[],System.Int32@,System.Boolean)">
- <summary>
- Reads 8 bytes from the specified byte array starting with offset.
- If IsBigEndian = true, then this flips the order of the byte values.
- </summary>
- <param name="value">An array of bytes that is at least 8 bytes in length from the startIndex</param>
- <param name="startIndex">A 0 based integer index where the double value begins</param>
- <param name="isLittleEndian">If this is true, then the order of the bytes is reversed before being converted to a double</param>
- <returns>A double created from reading the byte array</returns>
- </member>
- <member name="M:DotSpatial.Data.Shapefile.WriteBytes(System.Byte[],System.Int32,System.Double,System.Boolean)">
- <summary>
- Converts the double value into bytes and inserts them starting at startIndex into the destArray
- </summary>
- <param name="destArray">A byte array where the values should be written</param>
- <param name="startIndex">The starting index where the values should be inserted</param>
- <param name="value">The double value to convert</param>
- <param name="isLittleEndian">Specifies whether the value should be written as big or little endian</param>
- </member>
- <member name="M:DotSpatial.Data.Shapefile.WriteBytes(System.Byte[],System.Int32,System.Int32,System.Boolean)">
- <summary>
- Converts the double value into bytes and inserts them starting at startIndex into the destArray.
- This will correct this system's natural byte order to reflect what is required to match the
- shapefiles specification.
- </summary>
- <param name="destArray">A byte array where the values should be written</param>
- <param name="startIndex">The starting index where the values should be inserted</param>
- <param name="value">The integer value to convert</param>
- <param name="isLittleEndian">Specifies whether the value should be written as big or little endian</param>
- </member>
- <member name="M:DotSpatial.Data.Shapefile.ReadIndexFile(System.String)">
- <summary>
- Reads the entire index file in order to get a breakdown of how shapes are broken up.
- </summary>
- <param name="fileName">A string fileName of the .shx file to read.</param>
- <returns>A List of ShapeHeaders that give offsets and lengths so that reading can be optimized</returns>
- </member>
- <member name="M:DotSpatial.Data.Shapefile.UpdateAttributes">
- <summary>
- Ensures that the attribute Table will have information that matches the current Table of attribute information
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Shapefile.ReadProjection">
- <summary>
- This uses the fileName of this shapefile to read the prj file of the same name
- and stores the result in the Projection class.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Shapefile.SaveProjection">
- <summary>
- Automatically uses the fileName of this shapefile to save the projection
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Shapefile.GetAttributes(System.Int32,System.Int32,System.Collections.Generic.IEnumerable{System.String})">
- <summary>
- Reads just the content requested in order to satisfy the paging ability of VirtualMode for the DataGridView
- </summary>
- <param name="startIndex">The integer lower page boundary</param>
- <param name="numRows">The integer number of attribute rows to return for the page</param>
- <param name="fieldNames">The list or array of fieldnames to return.</param>
- <returns>A DataTable populated with data rows with only the specified values.</returns>
- </member>
- <member name="M:DotSpatial.Data.Shapefile.NumRows">
- <summary>
- The number of rows
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Shapefile.GetColumns">
- <summary>
- This gets a copy of the actual internal list of columns.
- This should never be used to make changes to the column collection.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Shapefile.EnsureValidFileToSave(System.String,System.Boolean)">
- <summary>
- Checks that shape file can be saved to given fileName.
- </summary>
- <param name="fileName">File name to save.</param>
- <param name="overwrite">Overwrite file or not.</param>
- </member>
- <member name="M:DotSpatial.Data.Shapefile.HeaderSaveAs(System.String)">
- <summary>
- Saves header
- </summary>
- <param name="fileName">File to save.</param>
- </member>
- <member name="P:DotSpatial.Data.Shapefile.BufferSize">
- <summary>
- The buffer size is an integer value in bytes specifying how large a piece of memory can be used at any one time.
- Reading and writing from the disk is faster when done all at once. The larger this number the more effective
- the disk management, but the more ram will be required (and the more likely to trip an out of memory error).
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Shapefile.AttributesPopulated">
- <summary>
- Gets whether or not the attributes have all been loaded into the data table.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Shapefile.DataTable">
- <summary>
- This re-directs the DataTable to work with the attribute Table instead.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Shapefile.Header">
- <summary>
- A general header structure that stores some basic information about the shapefile.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Shapefile.Attributes">
- <summary>
- Gets or sets the attribute Table used by this shapefile.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Shapefile.FilePath">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Data.LineShapefile.#ctor">
- <summary>
- Creates a new instance of a LineShapefile for in-ram handling only.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.LineShapefile.#ctor(System.String)">
- <summary>
- Creates a new instance of a LineShapefile that is loaded from the supplied fileName.
- </summary>
- <param name="fileName">The string fileName of the polygon shapefile to load</param>
- </member>
- <member name="M:DotSpatial.Data.LineShapefile.Open(System.String,DotSpatial.Data.IProgressHandler)">
- <summary>
- Opens a shapefile
- </summary>
- <param name="fileName">The string fileName of the line shapefile to load</param>
- <param name="progressHandler">Any valid implementation of the DotSpatial.Data.IProgressHandler</param>
- </member>
- <member name="M:DotSpatial.Data.LineShapefile.GetFeature(System.Int32)">
- <summary>
- Gets the specified feature by constructing it from the vertices, rather
- than requiring that all the features be created. (which takes up a lot of memory).
- </summary>
- <param name="index">The integer index</param>
- </member>
- <member name="M:DotSpatial.Data.LineShapefile.SaveAs(System.String,System.Boolean)">
- <summary>
- Saves the file to a new location
- </summary>
- <param name="fileName">The fileName to save</param>
- <param name="overwrite">Boolean that specifies whether or not to overwrite the existing file</param>
- </member>
- <member name="T:DotSpatial.Data.MultiPointShapefile">
- <summary>
- A shapefile class that handles the special case where each features has multiple points
- </summary>
- </member>
- <member name="M:DotSpatial.Data.MultiPointShapefile.#ctor">
- <summary>
- Creates a new instance of a MultiPointShapefile for in-ram handling only.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.MultiPointShapefile.#ctor(System.String)">
- <summary>
- Creates a new instance of a MultiPointShapefile that is loaded from the supplied fileName.
- </summary>
- <param name="fileName">The string fileName of the polygon shapefile to load</param>
- </member>
- <member name="M:DotSpatial.Data.MultiPointShapefile.GetFeature(System.Int32)">
- <summary>
- Gets the feature at the specified index offset
- </summary>
- <param name="index">the integer index</param>
- <returns>An IFeature created from the shape at the specified offset</returns>
- </member>
- <member name="M:DotSpatial.Data.MultiPointShapefile.Open(System.String,DotSpatial.Data.IProgressHandler)">
- <summary>
- Opens a shapefile
- </summary>
- <param name="fileName">The string fileName of the point shapefile to load</param>
- <param name="progressHandler">Any valid implementation of the DotSpatial.Data.IProgressHandler</param>
- </member>
- <member name="M:DotSpatial.Data.MultiPointShapefile.SaveAs(System.String,System.Boolean)">
- <summary>
- Saves the file to a new location
- </summary>
- <param name="fileName">The fileName to save</param>
- <param name="overwrite">Boolean that specifies whether or not to overwrite the existing file</param>
- </member>
- <member name="T:DotSpatial.Data.NumberConverter">
- <summary>
- Numbers are based on the old school dbf definitions of data formats, and so can only store
- a very limited range of values.
- </summary>
- </member>
- <member name="F:DotSpatial.Data.NumberConverter.MaximumLength">
- <summary>
- Numbers can contain ASCII text up till 18 characters long, but no longer
- </summary>
- </member>
- <member name="F:DotSpatial.Data.NumberConverter.NumberConversionFormatProvider">
- <summary>
- Format provider to use to convert DBF numbers to strings and characters
- </summary>
- </member>
- <member name="M:DotSpatial.Data.NumberConverter.#ctor(System.Int32,System.Int32)">
- <summary>
- Creates a new instance of NumberConverter where the length and decimal count are known.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.NumberConverter.#ctor(System.Collections.Generic.IList{System.Double})">
- <summary>
- Cycles through the numeric values in the specified column and determines a selection of
- length and decimal count can accurately store the data.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.NumberConverter.RandomDouble">
- <summary>
- Creates a new, random double that is constrained by the specified length and decimal count.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.NumberConverter.RandomFloat">
- <summary>
- Creates a new, random float that is constrained by the specified length and decimal count.
- </summary>
- <returns>A new float. Floats can only store about 8 digits of precision, so specifying a high </returns>
- </member>
- <member name="M:DotSpatial.Data.NumberConverter.RandomDecimal">
- <summary>
- Creates a new, random decimal that is constrained by the specified length and decimal count.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.NumberConverter.RandomChars(System.Int32)">
- <summary>
- Creates a new random array of characters that represents a number and is constrained by the specified length and decimal count
- </summary>
- <param name="numDigits">The integer number of significant (non-zero) digits that should be created as part of the number.</param>
- <returns>A character array of that matches the length and decimal count specified by this properties on this number converter</returns>
- </member>
- <member name="M:DotSpatial.Data.NumberConverter.FromString(System.String)">
- <summary>
- Converts from a string, or 0 if the parse failed
- </summary>
- <param name="value">The string value to parse</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.NumberConverter.ToString(System.Double)">
- <summary>
- Converts the specified double value to a string that can be used for the number field
- </summary>
- <param name="number">The double precision floating point value to convert to a string</param>
- <returns>A string version of the specified number</returns>
- </member>
- <member name="M:DotSpatial.Data.NumberConverter.ToString(System.Decimal)">
- <summary>
- Converts the specified decimal value to a string that can be used for the number field
- </summary>
- <param name="number">The decimal value to convert to a string</param>
- <returns>A string version of the specified number</returns>
- </member>
- <member name="M:DotSpatial.Data.NumberConverter.ToString(System.Single)">
- <summary>
- Converts the specified float value to a string that can be used for the number field
- </summary>
- <param name="number">The floating point value to convert to a string</param>
- <returns>A string version of the specified number</returns>
- </member>
- <member name="M:DotSpatial.Data.NumberConverter.ToChar(System.Double)">
- <summary>
- Converts the specified decimal value to a string that can be used for the number field
- </summary>
- <param name="number">The decimal value to convert to a string</param>
- <returns>A string version of the specified number</returns>
- </member>
- <member name="M:DotSpatial.Data.NumberConverter.ToChar(System.Single)">
- <summary>
- Converts the specified decimal value to a string that can be used for the number field
- </summary>
- <param name="number">The decimal value to convert to a string</param>
- <returns>A string version of the specified number</returns>
- </member>
- <member name="M:DotSpatial.Data.NumberConverter.ToChar(System.Decimal)">
- <summary>
- Converts the specified decimal value to a string that can be used for the number field
- </summary>
- <param name="number">The decimal value to convert to a string</param>
- <returns>A string version of the specified number</returns>
- </member>
- <member name="M:DotSpatial.Data.NumberConverter.UpdateDecimalFormatString">
- <summary>
- Compute and update the DecimalFormatString from the precision specifier
- </summary>
- </member>
- <member name="P:DotSpatial.Data.NumberConverter.Length">
- <summary>
- Gets or set the length
- </summary>
- </member>
- <member name="P:DotSpatial.Data.NumberConverter.DecimalCount">
- <summary>
- Gets or sets the decimal count to use for this number converter
- </summary>
- </member>
- <member name="P:DotSpatial.Data.NumberConverter.DecimalFormatString">
- <summary>
- Gets or sets the format string used to convert doubles, floats, and decimals to strings
- </summary>
- </member>
- <member name="T:DotSpatial.Data.NumberException">
- <summary>
- NumberException
- </summary>
- </member>
- <member name="M:DotSpatial.Data.NumberException.#ctor(System.String)">
- <summary>
- An exception that is specifically fo the NumberConverter class
- </summary>
- <param name="message">The message for the exception</param>
- </member>
- <member name="T:DotSpatial.Data.PointShapefile">
- <summary>
- A shapefile class that handles the special case where the data type is point
- </summary>
- </member>
- <member name="M:DotSpatial.Data.PointShapefile.#ctor">
- <summary>
- Creates a new instance of a PointShapefile for in-ram handling only.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.PointShapefile.#ctor(System.String)">
- <summary>
- Creates a new instance of a PointShapefile that is loaded from the supplied fileName.
- </summary>
- <param name="fileName">The string fileName of the polygon shapefile to load</param>
- </member>
- <member name="M:DotSpatial.Data.PointShapefile.Open(System.String,DotSpatial.Data.IProgressHandler)">
- <summary>
- Opens a shapefile
- </summary>
- <param name="fileName">The string fileName of the point shapefile to load</param>
- <param name="progressHandler">Any valid implementation of the DotSpatial.Data.IProgressHandler</param>
- </member>
- <member name="M:DotSpatial.Data.PointShapefile.FillPoints(System.String,DotSpatial.Data.IProgressHandler)">
- <summary>
- Obtains a typed list of ShapefilePoint structures with double values associated with the various coordinates.
- </summary>
- <param name="fileName">A string fileName</param>
- <param name="progressHandler">Progress handler</param>
- </member>
- <member name="M:DotSpatial.Data.PointShapefile.GetFeature(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Data.PointShapefile.SaveAs(System.String,System.Boolean)">
- <summary>
- Saves the shapefile to a different fileName, but still as a shapefile. This method does not support saving to
- any other file format.
- </summary>
- <param name="fileName">The string fileName to save as</param>
- <param name="overwrite">A boolean that is true if the file should be overwritten</param>
- </member>
- <member name="T:DotSpatial.Data.PolygonShapefile">
- <summary>
- A shapefile class that handles the special case where the data is made up of polygons
- </summary>
- </member>
- <member name="M:DotSpatial.Data.PolygonShapefile.#ctor">
- <summary>
- Creates a new instance of a PolygonShapefile for in-ram handling only.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.PolygonShapefile.#ctor(System.String)">
- <summary>
- Creates a new instance of a PolygonShapefile that is loaded from the supplied fileName.
- </summary>
- <param name="fileName">The string fileName of the polygon shapefile to load</param>
- </member>
- <member name="M:DotSpatial.Data.PolygonShapefile.Open(System.String,DotSpatial.Data.IProgressHandler)">
- <summary>
- Opens a shapefile
- </summary>
- <param name="fileName">The string fileName of the polygon shapefile to load</param>
- <param name="progressHandler">Any valid implementation of the DotSpatial.Data.IProgressHandler</param>
- </member>
- <member name="M:DotSpatial.Data.PolygonShapefile.GetFeature(System.Int32)">
- <summary>
- Gets the specified feature by constructing it from the vertices, rather
- than requiring that all the features be created. (which takes up a lot of memory).
- </summary>
- <param name="index">The integer index</param>
- </member>
- <member name="M:DotSpatial.Data.PolygonShapefile.SaveAs(System.String,System.Boolean)">
- <summary>
- Saves the file to a new location
- </summary>
- <param name="fileName">The fileName to save</param>
- <param name="overwrite">Boolean that specifies whether or not to overwrite the existing file</param>
- </member>
- <member name="T:DotSpatial.Data.ShapefileHeader">
- <summary>
- The header for the .shp file and the .shx file that support shapefiles
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ShapefileHeader.#ctor">
- <summary>
- Creates a new, blank ShapeHeader
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ShapefileHeader.#ctor(System.String)">
- <summary>
- Opens the specified fileName directly
- </summary>
- <param name="inFilename">The string fileName to open as a header.</param>
- </member>
- <member name="M:DotSpatial.Data.ShapefileHeader.Clear">
- <summary>
- Resets all the extent values to 0
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ShapefileHeader.Open(System.String)">
- <summary>
- Parses the first 100 bytes of a shapefile into the important values
- </summary>
- <param name="inFilename">The fileName to read</param>
- </member>
- <member name="M:DotSpatial.Data.ShapefileHeader.Save">
- <summary>
- Saves changes to the .shp file will also automatically update the .shx file.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ShapefileHeader.SaveAs(System.String)">
- <summary>
- Saves changes to the .shp file and will also automatically create the header for the .shx file.
- This will no longer automatically delete an existing shapefile.
- </summary>
- <param name="outFilename">The string fileName to create.</param>
- </member>
- <member name="M:DotSpatial.Data.ShapefileHeader.Write(System.String,System.Int32)">
- <summary>
- Writes the current content to the specified file.
- </summary>
- <param name="destFilename">The string fileName to write to</param>
- <param name="destFileLength">The only difference between the shp header and the
- shx header is the file length parameter.</param>
- </member>
- <member name="M:DotSpatial.Data.ShapefileHeader.ToEnvelope">
- <summary>
- Generates a new envelope based on the extents of this shapefile.
- </summary>
- <returns>An Envelope</returns>
- </member>
- <member name="M:DotSpatial.Data.ShapefileHeader.ToExtent">
- <summary>
- Generates a new extent from the shape header. This will infer the whether the ExtentMZ, ExtentM
- or Extent class is the best implementation. Casting is required to access the higher
- values from the Extent return type.
- </summary>
- <returns>Extent, which can be Extent, ExtentM, or ExtentMZ</returns>
- </member>
- <member name="M:DotSpatial.Data.ShapefileHeader.SetExtent(DotSpatial.Data.IExtent)">
- <summary>
- The shape type is assumed to be fixed, and will control how the input extent is treated as far
- as M and Z values, rather than updating the shape type based on the extent.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapefileHeader.FileCode">
- <summary>
- Gets or sets the integer file code that should always be 9994.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapefileHeader.FileLength">
- <summary>
- Gets or sets the integer file length in bytes
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapefileHeader.Filename">
- <summary>
- Gets or sets the string fileName to use for this header
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapefileHeader.ShapeType">
- <summary>
- Gets or sets the DotSpatial.Data.Shapefiles.ShapeType enumeration specifying
- whether the shapes are points, lines, polygons etc.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapefileHeader.ShxFilename">
- <summary>
- Changes the extension of the fileName to .shx instead of .shp
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapefileHeader.Version">
- <summary>
- Gets or sets the version, which should be 1000
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapefileHeader.Xmin">
- <summary>
- The minimum X coordinate for the values in the shapefile
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapefileHeader.Xmax">
- <summary>
- The maximum X coordinate for the shapes in the shapefile
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapefileHeader.Ymin">
- <summary>
- The minimum Y coordinate for the values in the shapefile
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapefileHeader.Ymax">
- <summary>
- The maximum Y coordinate for the shapes in the shapefile
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapefileHeader.Zmin">
- <summary>
- The minimum Z coordinate for the values in the shapefile
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapefileHeader.Zmax">
- <summary>
- The maximum Z coordinate for the shapes in the shapefile
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapefileHeader.Mmin">
- <summary>
- The minimum M coordinate for the values in the shapefile
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapefileHeader.Mmax">
- <summary>
- The maximum M coordinate for the shapes in the shapefile
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapefileHeader.ShxLength">
- <summary>
- Gets or sets the length of the shx file in 16 bit words.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.ShapeHeader">
- <summary>
- A simple structure that contains the elements of a shapefile that must exist
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ShapeHeader.ContentLength">
- <summary>
- The content length
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ShapeHeader.Offset">
- <summary>
- The offset in 16-bit words
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapeHeader.ByteOffset">
- <summary>
- The offset in bytes
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapeHeader.ByteLength">
- <summary>
- The length in bytes
- </summary>
- </member>
- <member name="T:DotSpatial.Data.FeatureSetPack">
- <summary>
- The FeatureSetPack contains a MultiPoint, Line and Polygon FeatureSet which can
- handle the various types of geometries that can arrive from a mixed geometry.
- </summary>
- </member>
- <member name="F:DotSpatial.Data.FeatureSetPack.Lines">
- <summary>
- The featureset with all the lines
- </summary>
- </member>
- <member name="F:DotSpatial.Data.FeatureSetPack.Points">
- <summary>
- The featureset with all the points
- </summary>
- </member>
- <member name="F:DotSpatial.Data.FeatureSetPack.Polygons">
- <summary>
- The featureset with all the polygons
- </summary>
- </member>
- <member name="F:DotSpatial.Data.FeatureSetPack._polygonVertices">
- <summary>
- Stores the raw vertices from the different shapes in a list while being created.
- That way, the final array can be created one time.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.FeatureSetPack.#ctor">
- <summary>
- Creates a new instance of the FeatureSetPack
- </summary>
- </member>
- <member name="M:DotSpatial.Data.FeatureSetPack.GetEnumerator">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Data.FeatureSetPack.Clear">
- <summary>
- Clears the vertices and sets up new featuresets.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.FeatureSetPack.Add(System.Double[],DotSpatial.Data.ShapeRange)">
- <summary>
- Adds the shape. Assumes that the "part" indices are created with a 0 base, and the number of
- vertices is specified. The start range of each part will be updated with the new shape range.
- The vertices array itself iwll be updated during hte stop editing step.
- </summary>
- <param name="shapeVertices"></param>
- <param name="shape"></param>
- </member>
- <member name="M:DotSpatial.Data.FeatureSetPack.StopEditing">
- <summary>
- Finishes the featuresets by converting the lists
- </summary>
- </member>
- <member name="M:DotSpatial.Data.FeatureSetPack.Combine(System.Collections.Generic.IEnumerable{System.Double[]},System.Int32)">
- <summary>
- Combines the vertices, finalizing the creation
- </summary>
- <param name="verts"></param>
- <param name="length"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Data.FeatureSetPack.FeatureSetPackEnumerator">
- <summary>
- Enuemratres the FeatureSetPack in Polygon, Line, Point order. If any member
- is null, it skips that member.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.FeatureSetPack.FeatureSetPackEnumerator.#ctor(DotSpatial.Data.FeatureSetPack)">
- <summary>
- Creates the FeatureSetPackEnumerator based on the specified FeaturSetPack
- </summary>
- <param name="parent">The Pack</param>
- </member>
- <member name="M:DotSpatial.Data.FeatureSetPack.FeatureSetPackEnumerator.Dispose">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Data.FeatureSetPack.FeatureSetPackEnumerator.MoveNext">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Data.FeatureSetPack.FeatureSetPackEnumerator.Reset">
- <inheritdoc />
- </member>
- <member name="P:DotSpatial.Data.FeatureSetPack.FeatureSetPackEnumerator.Current">
- <inheritdoc />
- </member>
- <member name="T:DotSpatial.Data.WkbFeatureReader">
- <summary>
- WKBPointReader
- </summary>
- </member>
- <member name="M:DotSpatial.Data.WkbFeatureReader.CheckEndian(System.Byte[],System.Int32)">
- <summary>
- Given the array of bytes, this reverses the bytes based on size. So if size if 4, the
- reversal will flip uints of 4 bytes at a time.
- </summary>
- <param name="data"></param>
- <param name="size"></param>
- </member>
- <member name="M:DotSpatial.Data.WkbFeatureReader.ReadInt32(System.IO.Stream)">
- <summary>
-
- </summary>
- <param name="data">The raw byte data.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.WkbFeatureReader.ReadInt32(System.IO.Stream,System.Int32)">
- <summary>
-
- </summary>
- <param name="data">The raw byte data.</param>
- <param name="count">The count of integers, not bytes.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.WkbFeatureReader.ReadDouble(System.IO.Stream,System.Int32)">
- <summary>
- Reads the specified number of doubles
- </summary>
- <param name="data"></param>
- <param name="count"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.WkbFeatureReader.GetFeatureSets(System.Byte[])">
- <summary>
- Since WKB can in fact store different kinds of shapes, this will split out
- each type of shape into a different featureset. If all the shapes are
- the same kind of feature, thre will only be one list of feature types.
- </summary>
- <param name="data"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.WkbFeatureReader.GetFeatureSets(System.IO.Stream)">
- <summary>
- Gets a FeatureSetPack from the wkb
- </summary>
- <param name="data"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.WkbFeatureReader.ReadFeature(System.IO.Stream,DotSpatial.Data.FeatureSetPack)">
- <summary>
- Reads only a single geometry into a feature. This may be a multi-part geometry.
- </summary>
- <param name="data"></param>
- <param name="results"></param>
- </member>
- <member name="M:DotSpatial.Data.WkbFeatureReader.ReadShape(System.IO.Stream)">
- <summary>
- Reads only a single geometry into a feature. This may be a multi-part geometry,
- but cannot be a mixed part geometry. Anything that registers as "geometryCollection"
- will trigger an exception.
- </summary>
- <param name="data"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.WkbFeatureReader.ReadShape(System.IO.Stream,DotSpatial.Topology.FeatureType)">
- <summary>
- Attempts to read in an entry to the specified feature type. If the feature type does not match
- the geometry type, this will return null. (A Point geometry will be accepted by MultiPoint
- feature type, but not the other way arround. Either way, this will advance the reader
- through the shape feature. Using the Unspecified will always return the shape it reads,
- or null in the case of mixed feature collections which are not supported.
- </summary>
- <param name="data"></param>
- <param name="featureType"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.WkbFeatureReader.ReadPoint(System.IO.Stream)">
- <summary>
- This assumes that the byte order and shapetype have already been read.
- </summary>
- <param name="data"></param>
- </member>
- <member name="M:DotSpatial.Data.WkbFeatureReader.ReadPoint(System.IO.Stream,DotSpatial.Data.FeatureSetPack)">
- <summary>
- This assumes that the byte order and shapetype have already been read.
- </summary>
- <param name="data"></param>
- <param name="results"></param>
- </member>
- <member name="M:DotSpatial.Data.WkbFeatureReader.ReadMultiPoint(System.IO.Stream)">
- <summary>
- Reads one multipoint shape from a data stream.
- (this assumes that the two bytes (endian and type) have already been read.
- </summary>
- <param name="data"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.WkbFeatureReader.ReverseCoords(System.Double[])">
- <summary>
- Fix introduced by JamesP@esdm.co.uk. 3/11/2010
- Using Array.Reverse does not work because it has the unwanted effect of flipping
- the X and Y values.
- </summary>
- <param name="coords">The double precision XY coordinate array of vertices</param>
- <returns>The double array in reverse order.</returns>
- </member>
- <member name="M:DotSpatial.Data.WkbFeatureReader.IsCounterClockwise(System.Double[])">
- <summary>
- Calculates the area and if the area is negative, this is considered a hole.
- </summary>
- <returns>Boolean, true if this has a negative area and should be thought of as a hole</returns>
- </member>
- <member name="T:DotSpatial.Data.PartRange">
- <summary>
- Vertices require methods to work quickly with data. These are not designed to be inherited,
- overridden or equiped with interfaces and properties.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.VertexRange">
- <summary>
- RangeIndex
- </summary>
- </member>
- <member name="M:DotSpatial.Data.VertexRange.#ctor">
- <summary>
- Creates an empty vertex range that can have the vertices and number of vertices assigned later
- </summary>
- </member>
- <member name="M:DotSpatial.Data.VertexRange.#ctor(System.Double[],System.Int32,System.Int32)">
- <summary>
- Creates a new instance of RangeIndex
- </summary>
- <param name="allVertices">An array of all the vertex locations</param>
- <param name="shapeOffset"></param>
- <param name="partOffset"></param>
- </member>
- <member name="M:DotSpatial.Data.VertexRange.GetEnumerator">
- <summary>
- Gets an enumerator. This exists to make it easier to cycle values,
- but in truth should not be used because it re-adds the property accessor
- which slows down the data access, which is the whole point of putting
- all the vertices into a jagged array of doubles in the first place.
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Data.VertexRange.PartOffset">
- <summary>
- For parts, controlling the part offset is perhaps more useful that controlling the shape offset.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.VertexRange.ShapeOffset">
- <summary>
- The StartIndex is the sum of the shape offset and the part offset. Controlling them separately
- allows the entire shape offset to be adjusted independantly after the part is created.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.VertexRange.StartIndex">
- <summary>
- The integer index of the first vertex included in this range. This is overridden
- in the case of part ranges to also take into account the shape start index.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.VertexRange.EndIndex">
- <summary>
- the integer index of the last vertex included in this range
- </summary>
- </member>
- <member name="P:DotSpatial.Data.VertexRange.NumVertices">
- <summary>
- Gets or sets the number of vertices. This will also set the EndIndex
- relative to the start position.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.VertexRange.Vertices">
- <summary>
- Gets or sets the vertices
- </summary>
- </member>
- <member name="T:DotSpatial.Data.VertexRange.VertexRangeEnumerator">
- <summary>
- The enumerator is here to provide an easy method for cycling vertex values
- in each range. This sort of defeats the point because it adds
- two method calls for advancing each step (one to MoveNext and one to
- access the property. The whole point of loading everything
- into a single array of vertices in the first place is to avoid
- property accessors slowing down the process. However, it's here
- if someone wants it.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.VertexRange.VertexRangeEnumerator.#ctor(System.Double[],System.Int32,System.Int32)">
- <summary>
- Creates a new instance of the VertexRangeEnumerator
- </summary>
- <param name="vertices">The vertices to create</param>
- <param name="start">The integer index of the first included vertex </param>
- <param name="end">The integer index of the last included vertex</param>
- </member>
- <member name="M:DotSpatial.Data.VertexRange.VertexRangeEnumerator.Dispose">
- <summary>
- This does nothing
- </summary>
- </member>
- <member name="M:DotSpatial.Data.VertexRange.VertexRangeEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next position
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.VertexRange.VertexRangeEnumerator.Reset">
- <summary>
- Resets this enumerator to the beginning of the range of vertices
- </summary>
- </member>
- <member name="P:DotSpatial.Data.VertexRange.VertexRangeEnumerator.Current">
- <summary>
- Gets the current value.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.PartRange.#ctor(DotSpatial.Topology.FeatureType)">
- <summary>
- StartRange, count and vertices will be declared later.
- </summary>
- <param name="featureType"></param>
- </member>
- <member name="M:DotSpatial.Data.PartRange.#ctor(System.Double[],System.Int32,System.Int32,DotSpatial.Topology.FeatureType)">
- <summary>
- Creates a new instance of Part
- </summary>
- <param name="allVertices">An array of all the vertex locations</param>
- <param name="shapeOffset">The point index of the shape. </param>
- <param name="partOffset">The ponit index of the part.</param>
- <param name="featureType">The type of features.</param>
- </member>
- <member name="M:DotSpatial.Data.PartRange.Clone">
- <summary>
- This returns a shallow copy, and expects any resetting of the vertex arrays to occur at a
- higher level.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.PartRange.IsHole">
- <summary>
- Calculates the area and if the area is negative, this is considered a hole.
- </summary>
- <returns>Boolean, true if this has a negative area and should be thought of as a hole</returns>
- </member>
- <member name="M:DotSpatial.Data.PartRange.CalculateExtent">
- <summary>
- This creates a new extent and cylces through the coordinates to calculate what it is.
- Since the vertices may change so easilly, this is not cached.
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Data.PartRange.Segments">
- <summary>
- Gets a segment range enumerator.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.Segment">
- <summary>
- Segment
- </summary>
- </member>
- <member name="F:DotSpatial.Data.Segment.P1">
- <summary>
- The start point of the segment
- </summary>
- </member>
- <member name="F:DotSpatial.Data.Segment.P2">
- <summary>
- the end point of the segment
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Segment.#ctor(System.Double,System.Double,System.Double,System.Double)">
- <summary>
- Creates a segment from double valued ordinates.
- </summary>
- <param name="x1"></param>
- <param name="y1"></param>
- <param name="x2"></param>
- <param name="y2"></param>
- </member>
- <member name="M:DotSpatial.Data.Segment.#ctor(DotSpatial.Data.Vertex,DotSpatial.Data.Vertex)">
- <summary>
- Creates a new instance of Segment
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Segment.Intersects(DotSpatial.Data.Segment)">
- <summary>
- Uses the intersection count to detect if there is an intersection
- </summary>
- <param name="other"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Segment.DistanceTo(DotSpatial.Topology.Coordinate)">
- <summary>
- Calculates the shortest distance to this line segment from the specified MapWinGIS.Point
- </summary>
- <param name="point">A MapWinGIS.Point specifing the location to find the distance to the line</param>
- <returns>A double value that is the shortest distance from the given Point to this line segment</returns>
- </member>
- <member name="M:DotSpatial.Data.Segment.ClosestPointTo(DotSpatial.Data.Vertex)">
- <summary>
- Returns a vertex representing the closest point on this line segment from a given vertex
- </summary>
- <param name="point">The point we want to be close to</param>
- <returns>The point on this segment that is closest to the given point</returns>
- </member>
- <member name="M:DotSpatial.Data.Segment.ClosestPointTo(DotSpatial.Data.Vertex,System.Boolean,DotSpatial.Data.EndPointInteraction@)">
- <summary>
- Returns a vertex representing the closest point on this line segment from a given vertex
- </summary>
- <param name="point">The point we want to be close to</param>
- <param name="isInfiniteLine">If true treat the line as infinitly long</param>
- <param name="endPointFlag">Outputs 0 if the vertex is on the line segment, 1 if beyond P0, 2 if beyong P1 and -1 if P1=P2</param>
- <returns>The point on this segment or infinite line that is closest to the given point</returns>
- </member>
- <member name="M:DotSpatial.Data.Segment.ToVector">
- <summary>
- Casts this to a vector
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Segment.DistanceTo(DotSpatial.Data.Segment)">
- <summary>
- Determines the shortest distance between two segments
- </summary>
- <param name="lineSegment">Segment, The line segment to test against this segment</param>
- <returns>Double, the shortest distance between two segments</returns>
- </member>
- <member name="M:DotSpatial.Data.Segment.IntersectionCount(DotSpatial.Data.Segment)">
- <summary>
- Returns 0 if no intersections occur, 1 if an intersection point is found,
- and 2 if the segments are colinear and overlap.
- </summary>
- <param name="other"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Segment.IntersectsVertex(DotSpatial.Data.Vertex)">
- <summary>
- Tests to see if the specified segment contains the point within Epsilon tollerance.
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Data.Segment.Epsilon">
- <summary>
- Gets or sets the precision for calculating equality, but this is just a re-direction to Vertex.Epsilon
- </summary>
- </member>
- <member name="T:DotSpatial.Data.SegmentRange">
- <summary>
- SegmentSet
- </summary>
- </member>
- <member name="M:DotSpatial.Data.SegmentRange.GetEnumerator">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Data.SegmentRange.#ctor(DotSpatial.Data.PartRange,DotSpatial.Topology.FeatureType)">
- <summary>
- Creates a new instance of SegmentSet
- </summary>
- </member>
- <member name="P:DotSpatial.Data.SegmentRange.FeatureType">
- <summary>
- Gets the feature type
- </summary>
- </member>
- <member name="P:DotSpatial.Data.SegmentRange.Part">
- <summary>
- Gets the part
- </summary>
- </member>
- <member name="T:DotSpatial.Data.SegmentRange.SegmentRangeEnumerator">
- <summary>
- Cycles through the points, creating segments. If the feature type is a polygon, then this will
- loop around again at the end of the part to create a segment from the first and last vertex.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.SegmentRange.SegmentRangeEnumerator.#ctor(DotSpatial.Data.SegmentRange)">
- <summary>
- Creates a new enumerator given the SegmentRange
- </summary>
- <param name="parent"></param>
- </member>
- <member name="M:DotSpatial.Data.SegmentRange.SegmentRangeEnumerator.Dispose">
- <summary>
- Does nothing
- </summary>
- </member>
- <member name="M:DotSpatial.Data.SegmentRange.SegmentRangeEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next member
- </summary>
- <returns>True if a member is found, false if there are no more members</returns>
- </member>
- <member name="M:DotSpatial.Data.SegmentRange.SegmentRangeEnumerator.Reset">
- <inheritdoc />
- </member>
- <member name="P:DotSpatial.Data.SegmentRange.SegmentRangeEnumerator.Current">
- <summary>
- Gets the current segment
- </summary>
- </member>
- <member name="T:DotSpatial.Data.Shape">
- <summary>
- The shape caries information about the raw vertices as well as a shapeRange.
- It is effectively away to move around a single shape.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Shape.#ctor">
- <summary>
- Creates a new instance of Shape
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Shape.#ctor(DotSpatial.Topology.FeatureType)">
- <summary>
- Creates a new shape type where the shaperange exists and has a type specified
- </summary>
- <param name="type"></param>
- </member>
- <member name="M:DotSpatial.Data.Shape.#ctor(DotSpatial.Data.IFeature)">
- <summary>
- Creates a shape based on the specified feature. This shape will be standing alone,
- all by itself. The fieldnames and field types will be null.
- </summary>
- <param name="feature"></param>
- </member>
- <member name="M:DotSpatial.Data.Shape.#ctor(DotSpatial.Topology.IBasicGeometry)">
- <summary>
- Creates a shape based on the specified geometry. This shape will be standing alone,
- all by itself. The attributes will be null.
- </summary>
- <param name="geometry">The geometry to create a shape from.</param>
- </member>
- <member name="M:DotSpatial.Data.Shape.#ctor(DotSpatial.Topology.Coordinate)">
- <summary>
- Creates a point shape from a coordinate
- </summary>
- <param name="coord"></param>
- </member>
- <member name="M:DotSpatial.Data.Shape.#ctor(DotSpatial.Data.Vertex)">
- <summary>
- Creates a point shape from a vertex
- </summary>
- <param name="coord"></param>
- </member>
- <member name="M:DotSpatial.Data.Shape.#ctor(DotSpatial.Data.IExtent)">
- <summary>
- Creates a clockwise polygon shape from an extent
- </summary>
- <param name="extent"></param>
- </member>
- <member name="M:DotSpatial.Data.Shape.#ctor(DotSpatial.Topology.IEnvelope)">
- <summary>
- Creates a clockwise polygon shape from an envelope
- </summary>
- <param name="envelope"></param>
- </member>
- <member name="M:DotSpatial.Data.Shape.ToGeometry">
- <summary>
- Converts this shape into a Geometry using the default factory.
- </summary>
- <returns>The geometry version of this shape.</returns>
- </member>
- <member name="M:DotSpatial.Data.Shape.ToGeometry(DotSpatial.Topology.IGeometryFactory)">
- <summary>
- Converts this shape into a Geometry.
- </summary>
- <returns>The geometry version of this shape.</returns>
- </member>
- <member name="M:DotSpatial.Data.Shape.FromPoint(DotSpatial.Topology.IGeometryFactory)">
- <summary>
- Get the point for this shape if this is a point shape.
- </summary>
- <param name="factory"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Shape.FromMultiPoint(DotSpatial.Topology.IGeometryFactory)">
- <summary>
- Creates a new MultiPoint geometry from a MultiPoint shape
- </summary>
- <param name="factory">The IGeometryFactory to use to create the new shape.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Shape.FromLine(DotSpatial.Topology.IGeometryFactory)">
- <summary>
- Gets the line for the specified index
- </summary>
- <returns>A LineString or MultiLineString geometry created from this shape.</returns>
- </member>
- <member name="M:DotSpatial.Data.Shape.FromPolygon(DotSpatial.Topology.IGeometryFactory)">
- <summary>
- Creates a Polygon or MultiPolygon from this Polygon shape.
- </summary>
- <param name="factory">The IGeometryFactory to use to create the new IGeometry.</param>
- <returns>The IPolygon or IMultiPolygon created from this shape.</returns>
- </member>
- <member name="M:DotSpatial.Data.Shape.PointInList(DotSpatial.Topology.Coordinate,System.Collections.Generic.IEnumerable{DotSpatial.Topology.Coordinate})">
- <summary>
- Test if a point is in a list of coordinates.
- </summary>
- <param name="testPoint">TestPoint the point to test for.</param>
- <param name="pointList">PointList the list of points to look through.</param>
- <returns>true if testPoint is a point in the pointList list.</returns>
- </member>
- <member name="M:DotSpatial.Data.Shape.CopyAttributes(DotSpatial.Data.IFeature)">
- <summary>
- Copies the field names and types from the parent feature set if they are currently null.
- Attempts to copy the members of the feature's datarow. This assumes the features have been
- loaded into memory and are available on the feature's DataRow property.
- </summary>
- <param name="feature">An IFeature to copy the attributes from. If the schema is null, this will try to use the parent featureset schema.</param>
- </member>
- <member name="M:DotSpatial.Data.Shape.ShapeRangeFromGeometry(DotSpatial.Topology.IBasicGeometry,System.Double[],System.Int32)">
- <summary>
- Create a ShapeRange from a Geometry to use in constructing a Shape
- </summary>
- <param name="geometry"></param>
- <param name="vertices"></param>
- <param name="offset">offset into vertices array where this feature starts</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Shape.ShapeRangeFromFeature(DotSpatial.Data.IFeature,System.Double[],System.Int32)">
- <summary>
- Create a ShapeRange from a Feature to use in constructing a Shape
- </summary>
- <param name="feature"></param>
- <param name="vertices"></param>
- <param name="offset">offset into vertices array where this feature starts</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Shape.ShapeRangeFromFeature(DotSpatial.Data.IFeature,System.Double[])">
- <summary>
- Create a ShapeRange from a Feature to use in constructing a Shape
- </summary>
- <param name="feature"></param>
- <param name="vertices"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Shape.AddPart(System.Collections.Generic.IEnumerable{DotSpatial.Topology.Coordinate},DotSpatial.Data.CoordinateType)">
- <summary>
- Without changing the feature type or anything else, simply update the local coordinates
- to include the new coordinates. All the new coordinates will be considered one part.
- Since point and multi-point shapes don't have parts, they will just be appended to the
- original part.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Shape.Clone">
- <summary>
- This creates a duplicate shape, also copying the vertex array to
- a new array containing just this shape, as well as duplicating the attribute array.
- The FieldNames and FieldTypes are a shallow copy since this shouldn't change.
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Data.Shape.MinM">
- <summary>
- Gets or sets the minimum M
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Shape.MaxM">
- <summary>
- Gets or sets the maximum M
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Shape.MinZ">
- <summary>
- Gets or sets the minimum Z
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Shape.MaxZ">
- <summary>
- Gets or sets the maximum Z
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Shape.Range">
- <summary>
- Gives a way to cycle through the vertices of this shape.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Shape.Vertices">
- <summary>
- The double vertices in X1, Y1, X2, Y2, ..., Xn, Yn order.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Shape.Z">
- <summary>
- The Z values if any
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Shape.M">
- <summary>
- The M values if any, organized in order.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Shape.Attributes">
- <summary>
- Gets or sets the attributes. Since the most likely use is to copy values from one source to
- another, this should be an independant array in each shape and be deep-copied.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.ShapefileDataProvider">
- <summary>
- ShapefileDataProvider
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IVectorProvider">
- <summary>
- IFeatureProvider
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IVectorProvider.CreateNew(System.String,DotSpatial.Topology.FeatureType,System.Boolean,DotSpatial.Data.IProgressHandler)">
- <summary>
- This create new method implies that this provider has the priority for creating a new file.
- An instance of the dataset should be created and then returned. By this time, the fileName
- will already be checked to see if it exists, and deleted if the user wants to overwrite it.
- </summary>
- <param name="fileName">The string fileName for the new instance</param>
- <param name="featureType">Point, Line, Polygon etc. Sometimes this will be specified, sometimes it will be "Unspecified"</param>
- <param name="inRam">Boolean, true if the dataset should attempt to store data entirely in ram</param>
- <param name="progressHandler">An IProgressHandler for status messages.</param>
- <returns>An IRaster</returns>
- </member>
- <member name="M:DotSpatial.Data.IVectorProvider.GetFeatureType(System.String)">
- <summary>
- This tests the specified file in order to determine what type of vector the file contains.
- This returns unspecified if the file format is not supported by this provider.
- </summary>
- <param name="fileName">The string fileName to test</param>
- <returns>A FeatureType clarifying what sort of features are stored on the data type.</returns>
- </member>
- <member name="M:DotSpatial.Data.ShapefileDataProvider.GetFeatureType(System.String)">
- <summary>
- This tests the specified file in order to determine what type of vector the file contains.
- This returns unspecified if the file format is not supported by this provider.
- </summary>
- <param name="fileName">The string fileName to test</param>
- <returns>A FeatureType clarifying what sort of features are stored on the data type.</returns>
- </member>
- <member name="M:DotSpatial.Data.ShapefileDataProvider.CreateNew(System.String,DotSpatial.Topology.FeatureType,System.Boolean,DotSpatial.Data.IProgressHandler)">
- <summary>
- This create new method implies that this provider has the priority for creating a new file.
- An instance of the dataset should be created and then returned. By this time, the fileName
- will already be checked to see if it exists, and deleted if the user wants to overwrite it.
- </summary>
- <param name="fileName">The string fileName for the new instance</param>
- <param name="featureType">Point, Line, Polygon etc. Sometimes this will be specified, sometimes it will be "Unspecified"</param>
- <param name="inRam">Boolean, true if the dataset should attempt to store data entirely in ram</param>
- <param name="progressHandler">An IProgressHandler for status messages.</param>
- <returns>An IRaster</returns>
- </member>
- <member name="M:DotSpatial.Data.ShapefileDataProvider.Open(System.String)">
- <summary>
- This open method is only called if this plugin has been given priority for one
- of the file extensions supported in the DialogReadFilter property supplied by
- this control. Failing to provide a DialogReadFilter will result in this plugin
- being added to the list of DataProviders being supplied under the Add Other Data
- option in the file menu.
- </summary>
- <param name="fileName">A string specifying the complete path and extension of the file to open.</param>
- <returns>A List of IDataSets to be added to the Map. These can also be groups of datasets.</returns>
- </member>
- <member name="P:DotSpatial.Data.ShapefileDataProvider.DialogReadFilter">
- <summary>
- Gets a dialog read filter that lists each of the file type descriptions and file extensions, delimeted
- by the | symbol. Each will appear in DotSpatial's open file dialog filter, preceded by the name provided
- on this object.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapefileDataProvider.DialogWriteFilter">
- <summary>
- Gets a dialog filter that lists each of the file type descriptions and extensions for a Save File Dialog.
- Each will appear in DotSpatial's open file dialog filter, preceded by the name provided on this object.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapefileDataProvider.Name">
- <summary>
- Gets a preferably short name that identifies this data provider. Example might be GDAL.
- This will be prepended to each of the DialogReadFilter members from this plugin.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapefileDataProvider.Description">
- <summary>
- This is a basic description that will fall next to your plugin in the Add Other Data dialog.
- This will only be shown if your plugin does not supply a DialogReadFilter.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapefileDataProvider.ProgressHandler">
- <summary>
- Gets or sets the progress handler
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ShapeRange.Epsilon">
- <summary>
- Control the epsilon to use for the intersect calculations
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ShapeRange.Clone">
- <summary>
- Creates a shallow copy of everything except the parts list and extent, which are deep copies.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.ShapeRange.UpgradeExtent">
- <summary>
- Considers the ShapeType and upgrades the extent class to accommodate M and Z.
- This is automatically called form the setter of ShapeType.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ShapeRange.#ctor(DotSpatial.Topology.FeatureType,DotSpatial.Data.CoordinateType)">
- <summary>
- Creates a blank instance of a shaperange where vertices can be assigned later.
- <param name="type">the feature type clarifies point, line, or polygon.</param>
- <param name="coordType">The coordinate type clarifies whether M or Z values exist.</param>
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ShapeRange.#ctor(DotSpatial.Data.Vertex)">
- <summary>
- Creates a new "point" shape that has only the one point.
- </summary>
- <param name="v"></param>
- </member>
- <member name="M:DotSpatial.Data.ShapeRange.#ctor(DotSpatial.Topology.IEnvelope)">
- <summary>
- Initializes a new instance of the ShapeRange class.
- </summary>
- <param name="env">The envelope to turn into a shape range.</param>
- </member>
- <member name="M:DotSpatial.Data.ShapeRange.#ctor(DotSpatial.Data.Extent)">
- <summary>
- This creates a polygon shape from an extent.
- </summary>
- <param name="ext">The extent to turn into a polygon shape.</param>
- </member>
- <member name="M:DotSpatial.Data.ShapeRange.CalculateExtents">
- <summary>
- Forces each of the parts to adopt an extent equal to a calculated extents.
- The extents for the shape will expand to include those.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ShapeRange.First">
- <summary>
- Gets the first vertex from the first part.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.ShapeRange.Intersects(DotSpatial.Data.Extent)">
- <summary>
- Tests the intersection with an extents
- </summary>
- <param name="ext"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.ShapeRange.Intersects(DotSpatial.Topology.IEnvelope)">
- <summary>
- Tests the intersection using an envelope
- </summary>
- <param name="envelope"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.ShapeRange.Intersects(DotSpatial.Topology.Coordinate)">
- <summary>
- Tests the intersection with a coordinate
- </summary>
- <param name="coord"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.ShapeRange.Intersects(DotSpatial.Data.Vertex)">
- <summary>
- Tests the intersection with a vertex
- </summary>
- <param name="vert"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.ShapeRange.Intersects(DotSpatial.Data.Shape)">
- <summary>
- Tests the intersection with a shape
- </summary>
- <param name="shape"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.ShapeRange.Intersects(DotSpatial.Data.ShapeRange)">
- <summary>
- This calculations processes the intersections
- </summary>
- <param name="shape">The shape to do intersection calculations with.</param>
- </member>
- <member name="M:DotSpatial.Data.ShapeRange.SetVertices(System.Double[])">
- <summary>
- This sets the vertex array by cycling through each part index and updates.
- </summary>
- <param name="vertices">The double array of vertices that should be referenced by the parts.</param>
- </member>
- <member name="M:DotSpatial.Data.ShapeRange.PartIndex(System.Int32)">
- <summary>
- Given a vertex, this will determine the part that the vertex is within.
- </summary>
- <param name="vertexOffset"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.ShapeRange.EndIndex">
- <summary>
- gets the integer end index as calculated from the number of points and the start index
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Data.ShapeRange.FeatureType">
- <summary>
- The feature type
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapeRange.ContentLength">
- <summary>
- The content length
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapeRange.Parts">
- <summary>
- If this is null, then there is only one part for this ShapeIndex.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapeRange.RecordNumber">
- <summary>
- The record number (for .shp files usually 1-based)
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapeRange.StartIndex">
- <summary>
- The starting index for the entire shape range.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapeRange.Extent">
- <summary>
- Gets or sets the extent of this shape range. Setting this will prevent
- the automatic calculations.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapeRange.ShapeType">
- <summary>
- The shape type for the header of this shape
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapeRange.NumPoints">
- <summary>
- The number of points in the entire shape
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ShapeRange.NumParts">
- <summary>
- If this is set, then it will cache an integer count that is independant from Parts.Count.
- If this is not set, (or set to a negative value) then getting this will return Parts.Count
- </summary>
- </member>
- <member name="T:DotSpatial.Data.ShapeType">
- <summary>
- An enumeration listing the various valid shape types supported by Esri Shapefile formats
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ShapeType.NullShape">
- <summary>
- 0 - No shape type specified, or the shapetype is invalid
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ShapeType.Point">
- <summary>
- 1 - Each shape is a single point
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ShapeType.PolyLine">
- <summary>
- 3 - Each shape is a collection of vertices that should be connected to form a striaght line
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ShapeType.Polygon">
- <summary>
- 5 - Each shape is a closed linestring
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ShapeType.MultiPoint">
- <summary>
- 8 - Each shape consists of severel, unconnected points
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ShapeType.PointZ">
- <summary>
- 11 - Each shape is a point with a Z value
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ShapeType.PolyLineZ">
- <summary>
- 13 - Each shape is a linestring with each vertex having a z value
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ShapeType.PolygonZ">
- <summary>
- 15 - Each shape is a closed linestring with each vertex having a z value
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ShapeType.MultiPointZ">
- <summary>
- 18 - Each shape has several unconnected points, each of which has a z value
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ShapeType.PointM">
- <summary>
- 21 - Each shape has several unconnected points, each of which has an m and z value
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ShapeType.PolyLineM">
- <summary>
- 23 - Each shape is made up of several points connected to form a line, each vertex having an m and z value
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ShapeType.PolygonM">
- <summary>
- 25 - Each shape is a closed linestring with each vertex having a z value and m value
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ShapeType.MultiPointM">
- <summary>
- 28 - Each shape has several unconnected points, each of which has a z value and m value
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ShapeType.MultiPatch">
- <summary>
- 31 - Not sure what this does
- </summary>
- </member>
- <member name="T:DotSpatial.Data.UnspecifiedFeaturetypeException">
- <summary>
- UnspecifiedFeaturetypeException
- </summary>
- </member>
- <member name="M:DotSpatial.Data.UnspecifiedFeaturetypeException.#ctor">
- <summary>
- Creates a new instance of UnspecifiedFeaturetypeException
- </summary>
- </member>
- <member name="T:DotSpatial.Data.Vertex">
- <summary>
- A vertex is a two dimensional structure with an X and a Y value. This is deliberately kept as small as possibl.e
- </summary>
- </member>
- <member name="F:DotSpatial.Data.Vertex.Epsilon">
- <summary>
- The tolerance for testing equality
- </summary>
- </member>
- <member name="F:DotSpatial.Data.Vertex.X">
- <summary>
- An X coordinate
- </summary>
- </member>
- <member name="F:DotSpatial.Data.Vertex.Y">
- <summary>
- The Y coordinate
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Vertex.#ctor(System.Double,System.Double)">
- <summary>
- Creates a new instance of Vertex
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Vertex.ToCoordinate">
- <summary>
- Casts this vertex to a coordinate
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Vertex.Equals(DotSpatial.Data.Vertex)">
- <summary>
-
- </summary>
- <param name="other"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Vertex.op_Equality(DotSpatial.Data.Vertex,DotSpatial.Data.Vertex)">
- <summary>
-
- </summary>
- <param name="v1"></param>
- <param name="v2"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Vertex.op_Inequality(DotSpatial.Data.Vertex,DotSpatial.Data.Vertex)">
- <summary>
-
- </summary>
- <param name="v1"></param>
- <param name="v2"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Vertex.Equals(System.Object)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Data.Vertex.GetHashCode">
- <inheritdoc />
- </member>
- <member name="T:DotSpatial.Data.EnvelopeExt">
- <summary>
- This class handles some extension methods that also require System.Drawing.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.EnvelopeExt.Reproportion(DotSpatial.Topology.IEnvelope,System.Drawing.Rectangle,System.Drawing.Rectangle)">
- <summary>
- This method assumes that there was a direct correlation between this envelope and the original
- rectangle. This reproportions this window to match the specified newRectangle.
- </summary>
- <param name="self">The original envelope</param>
- <param name="original">The original rectangle </param>
- <param name="newRectangle">The new rectangle</param>
- <returns>A new IEnvelope </returns>
- </member>
- <member name="M:DotSpatial.Data.EnvelopeExt.ToExtent(DotSpatial.Topology.IEnvelope)">
- <summary>
- This allows the creation of the correct kind of Extent class from an Envelope, which can contain
- M or Z values.
- </summary>
- <param name="self">The Envelope to convert into an Extent.</param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Data.RectangleExt">
- <summary>
- Contains various extensions for Rectangle
- </summary>
- </member>
- <member name="M:DotSpatial.Data.RectangleExt.IntersectsWith(System.Drawing.Rectangle,System.Drawing.RectangleF)">
- <summary>
- Calculates the intersection by casting the floating point values to integer values.
- </summary>
- <param name="self">This rectangle</param>
- <param name="other">The floating point rectangle to calculate against</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.RectangleExt.ExpandToInclude(System.Drawing.Rectangle,System.Drawing.Point)">
- <summary>
- Tests the location of the point. If the point is outside of the current rectangle, then the bounds
- of the rectangle are adjusted to include the new point.
- </summary>
- <param name="self"></param>
- <param name="newPoint"></param>
- </member>
- <member name="M:DotSpatial.Data.RectangleExt.ExpandBy(System.Drawing.Rectangle,System.Int32)">
- <summary>
- Expands the rectangle by the specified integer distance in all directions.
- </summary>
- <param name="self">The rectangle to expand</param>
- <param name="distance">The distance </param>
- </member>
- <member name="T:DotSpatial.Data.NullException">
- <summary>
- NullExceptioncs
- </summary>
- </member>
- <member name="M:DotSpatial.Data.NullException.#ctor">
- <summary>
- Creates a new instance of the NullLogException, but does not set the message
- or log the exception.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.NullException.#ctor(System.String)">
- <summary>
- Creates a new instance of NullException
- </summary>
- </member>
- <member name="T:DotSpatial.Data.ChangeEventList`1">
- <summary>
- A list that also includes several events during its existing activities.
- List is fussy about inheritance, unfortunately, so this wraps a list
- and then makes this class much more inheritable
- </summary>
- </member>
- <member name="T:DotSpatial.Data.CopyList`1">
- <summary>
- A Copy list is something that is specifically designed to allow internal items
- to be cloned.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.CopyList`1.Clone">
- <summary>
- Returns a duplicate of this entire list, where each item has been cloned
- if it implements ICloneable. Otherwise, the values will be a shallow copy.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.CopyList`1.OnCopy(DotSpatial.Data.CopyList{`0})">
- <summary>
- This copies any individual members of the list. If the item can be
- cloned, then it copies the cloned item. Otherwise it copies the
- regular item. This method can be overridden to handle special behavior
- in sub-classes.
- </summary>
- <param name="copy"></param>
- </member>
- <member name="T:DotSpatial.Data.IChangeEventList`1">
- <summary>
- IChangeEventList
- </summary>
- </member>
- <member name="T:DotSpatial.Data.ISuspendEvents">
- <summary>
- IChangeEvent
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ISuspendEvents.ResumeEvents">
- <summary>
- Resumes event sending and fires a ListChanged event if any changes have taken place.
- This will not track all the individual changes that may have fired in the meantime.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ISuspendEvents.SuspendEvents">
- <summary>
- Temporarilly suspends notice events, allowing a large number of changes.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ISuspendEvents.EventsSuspended">
- <summary>
- Gets whether or not the list is currently suspended
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IChangeItem">
- <summary>
- IChangeItem
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IChangeItem.ItemChanged">
- <summary>
- Occurs when internal properties or characteristics of this member change.
- The member should send itself as the sender of the event.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IChangeItem.RemoveItem">
- <summary>
- An instruction has been sent to remove the specified item from its container.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IChangeEventList`1.AddRange(System.Collections.Generic.IEnumerable{`0})">
- <summary>
- Adds the elements of the specified collection to the end of the System.Collections.Generic.List<T>
- </summary>
- <param name="collection">collection: The collection whose elements should be added to the end of the
- System.Collections.Generic.List<T>. The collection itself cannot be null, but it can contain
- elements that are null,
- if type T is a reference type.</param>
- <exception cref="T:System.ApplicationException">Unable to add while the ReadOnly property is set to
- true.</exception>
- </member>
- <member name="M:DotSpatial.Data.ChangeEventList`1.AddRange(System.Collections.Generic.IEnumerable{`0})">
- <summary>
- Adds the elements of the specified collection to the end of the System.Collections.Generic.List<T>
- </summary>
- <param name="collection">collection: The collection whose elements should be added to the end of the
- System.Collections.Generic.List<T>. The collection itself cannot be null, but it can contain elements that are null,
- if type T is a reference type.</param>
- <exception cref="T:System.ApplicationException">Unable to add while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.ChangeEventList`1.ResumeEvents">
- <summary>
- Resumes event sending and fires a ListChanged event if any changes have taken place.
- This will not track all the individual changes that may have fired in the meantime.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ChangeEventList`1.SuspendEvents">
- <summary>
- Temporarilly suspends notice events, allowing a large number of changes.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ChangeEventList`1.OnInnerListSet">
- <summary>
- An overriding event handler so that we can signfiy the list has changed
- when the inner list has been set to a new list.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ChangeEventList`1.OnClear">
- <summary>
- Overrides the normal clear situation so that we only update after all the members are cleared.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ChangeEventList`1.OnCopy(DotSpatial.Data.CopyList{`0})">
- <summary>
- Occurs during the copy process and overrides the base behavior so that events are suspended.
- </summary>
- <param name="copy"></param>
- </member>
- <member name="M:DotSpatial.Data.ChangeEventList`1.OnResumeEvents">
- <summary>
- Occurs when ResumeEvents has been called enough times so that events are re-enabled.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ChangeEventList`1.Reverse(System.Int32,System.Int32)">
- <summary>
- Reverses the order of the elements in the specified range.
- </summary>
- <param name="index">The zero-based starting index of the range to reverse.</param>
- <param name="count">The number of elements in the range to reverse.</param>
- <exception cref="T:System.ArgumentException">index and count do not denote a valid range of elements in the EventList<T>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-count is less than 0.</exception>
- <exception cref="T:System.ApplicationException">Unable to reverse while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.ChangeEventList`1.Reverse">
- <summary>
- Reverses the order of the elements in the entire EventList<T>.
- </summary>
- <exception cref="T:System.ApplicationException">Unable to reverse while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.ChangeEventList`1.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{`0})">
- <summary>
- Inserts the elements of a collection into the EventList<T> at the specified index.
- </summary>
- <param name="index">The zero-based index at which the new elements should be inserted.</param>
- <param name="collection">The collection whose elements should be inserted into the EventList<T>. The collection itself cannot be null, but it can contain elements that are null, if type T is a reference type.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-index is greater than EventList<T>.Count.</exception>
- <exception cref="T:System.ArgumentNullException">collection is null.</exception>
- <exception cref="T:System.ApplicationException">Unable to insert while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.ChangeEventList`1.RemoveRange(System.Int32,System.Int32)">
- <summary>
- Removes a range of elements from the EventList<T>.
- </summary>
- <param name="index">The zero-based starting index of the range of elements to remove.</param>
- <param name="count">The number of elements to remove.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-count is less than 0.</exception>
- <exception cref="T:System.ArgumentException">index and count do not denote a valid range of elements in the EventList<T>.</exception>
- <exception cref="T:System.ApplicationException">Unable to remove while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.ChangeEventList`1.BinarySearch(`0)">
- <summary>
- Searches the entire sorted System.Collections.Generic.List<T> for an element using the default comparer and returns the zero-based index of the element.
- </summary>
- <param name="item">The object to locate. The value can be null for reference types.</param>
- <returns>The zero-based index of item in the sorted System.Collections.Generic.List<T>, if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than item or, if there is no larger element, the bitwise complement of System.Collections.Generic.List<T>.Count.</returns>
- <exception cref="T:System.InvalidOperationException">The default comparer System.Collections.Generic.Comparer<T>.Default cannot find an implementation of the System.IComparable<T> generic interface or the System.IComparable interface for type T.</exception>
- </member>
- <member name="M:DotSpatial.Data.ChangeEventList`1.ItemItemChanged(System.Object,System.EventArgs)">
- <summary>
- This is a notification that characteristics of one of the members of the list may have changed,
- requiring a refresh, but may not involve a change to the the list itself
- </summary>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Data.ChangeEventList`1.OnItemChanged(System.Object)">
- <summary>
- Occurs when the item is changed. If this list is not suspended, it will forward the change event
- on. Otherwise, it will ensure that when resume events is called that the on change method
- is fired at that time.
- </summary>
- <param name="sender"></param>
- </member>
- <member name="M:DotSpatial.Data.ChangeEventList`1.OnListChanged">
- <summary>
- Fires the ListChanged Event
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ChangeEventList`1.OnRemoveItem">
- <summary>
- This is either a layer collection or a colorbreak collection, and so
- this won't be called by us, but someone might want to override this for their own reasons.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ChangeEventList`1.OnInclude(`0)">
- <summary>
- Occurs when wiring events on a new item
- </summary>
- <param name="item"></param>
- </member>
- <member name="M:DotSpatial.Data.ChangeEventList`1.OnExclude(`0)">
- <summary>
- Occurs when unwiring events on new items
- </summary>
- <param name="item"></param>
- </member>
- <member name="E:DotSpatial.Data.ChangeEventList`1.ItemChanged">
- <summary>
- This event is for when it is necessary to do something if any of the internal
- members changes. It will also forward the original item calling the message.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.ChangeEventList`1.RemoveItem">
- <summary>
- Occurs when this list should be removed from its container
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ChangeEventList`1.EventsSuspended">
- <summary>
- Gets whether or not the list is currently suspended
- </summary>
- </member>
- <member name="T:DotSpatial.Data.Collective`1">
- <summary>
- Carries event arguments for the generic IEventList
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Collective`1.#ctor(System.Collections.Generic.IEnumerable{`0})">
- <summary>
- Creates a new instance of a ListEventArgs class
- </summary>
- <param name="inCollection">The IEnumerable<T> specified during the event"/></param>
- </member>
- <member name="P:DotSpatial.Data.Collective`1.Collection">
- <summary>
- Gets the list item being referenced by this event
- </summary>
- </member>
- <member name="T:DotSpatial.Data.CollectiveCancel`1">
- <summary>
- The same as a ListEventArgs, but provides an option to cancel the event
- </summary>
- </member>
- <member name="M:DotSpatial.Data.CollectiveCancel`1.#ctor(System.Collections.Generic.IEnumerable{`0})">
- <summary>
- Creates a new instance of a ListEventArgs class
- </summary>
- <param name="inCollection">the IEnumerable<T> responsible for the event</param>
- </member>
- <member name="P:DotSpatial.Data.CollectiveCancel`1.Collection">
- <summary>
- Gets the list item being referenced by this event
- </summary>
- </member>
- <member name="T:DotSpatial.Data.CollectiveIndex`1">
- <summary>
- Carries event arguments for the generic IEventList
- </summary>
- </member>
- <member name="M:DotSpatial.Data.CollectiveIndex`1.#ctor(System.Collections.Generic.IEnumerable{`0},System.Int32)">
- <summary>
- Creates a new instance of a ListEventArgs class
- </summary>
- <param name="inCollection">The IEnumerable<T> specified during the event"/></param>
- <param name="inIndex">The integer index associated with this event</param>
- </member>
- <member name="P:DotSpatial.Data.CollectiveIndex`1.Collection">
- <summary>
- Gets the IEnumerable<T> collection of items involved in this event
- </summary>
- </member>
- <member name="P:DotSpatial.Data.CollectiveIndex`1.Index">
- <summary>
- Gets the index in the list where the event is associated
- </summary>
- </member>
- <member name="T:DotSpatial.Data.CollectiveIndexCancelEventArgs`1">
- <summary>
- The same as a ListEventArgs, but provides an option to cancel the event
- </summary>
- </member>
- <member name="M:DotSpatial.Data.CollectiveIndexCancelEventArgs`1.#ctor(System.Collections.Generic.IEnumerable{`0},System.Int32)">
- <summary>
- Creates a new instance of a ListEventArgs class
- </summary>
- <param name="inCollection">the IEnumerable<T> responsible for the event</param>
- <param name="inIndex">the Integer index associated with this event</param>
- </member>
- <member name="P:DotSpatial.Data.CollectiveIndexCancelEventArgs`1.Collection">
- <summary>
- Gets the IEnumerable<T> collection involved in this event
- </summary>
- </member>
- <member name="P:DotSpatial.Data.CollectiveIndexCancelEventArgs`1.Index">
- <summary>
- Gets the integer index in the IEventList where this event occured
- </summary>
- </member>
- <member name="T:DotSpatial.Data.CollectiveIndexCompare`1">
- <summary>
- The same as a ListEventArgs, but provides an option to cancel the event
- </summary>
- </member>
- <member name="M:DotSpatial.Data.CollectiveIndexCompare`1.#ctor(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IComparer{`0},System.Int32)">
- <summary>
- Creates a new instance of a ListEventArgs class.
- </summary>
- <param name="inCollection">the IEnumerable<T> responsible for the event.</param>
- <param name="inComparer">The System.Collections.Generic.IComparer<T> being used by this action.</param>
- <param name="inIndex">the Integer index associated with this event.</param>
- </member>
- <member name="P:DotSpatial.Data.CollectiveIndexCompare`1.Collection">
- <summary>
- Gets the IEnumerable<T> collection involved in this event
- </summary>
- </member>
- <member name="P:DotSpatial.Data.CollectiveIndexCompare`1.Index">
- <summary>
- Gets the integer index in the IEventList where this event occured
- </summary>
- </member>
- <member name="P:DotSpatial.Data.CollectiveIndexCompare`1.Comparer">
- <summary>
- The System.Collections.Generic.IComparer<T> being used by this action
- </summary>
- </member>
- <member name="T:DotSpatial.Data.CollectiveIndexCompareCancel`1">
- <summary>
- The same as a ListEventArgs, but provides an option to cancel the event
- </summary>
- </member>
- <member name="M:DotSpatial.Data.CollectiveIndexCompareCancel`1.#ctor(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IComparer{`0},System.Int32)">
- <summary>
- Creates a new instance of a ListEventArgs class.
- </summary>
- <param name="inCollection">the IEnumerable<T> responsible for the event.</param>
- <param name="inComparer">The System.Collections.Generic.IComparer<T> being used by this action.</param>
- <param name="inIndex">the Integer index associated with this event.</param>
- </member>
- <member name="P:DotSpatial.Data.CollectiveIndexCompareCancel`1.Collection">
- <summary>
- Gets the IEnumerable<T> collection involved in this event
- </summary>
- </member>
- <member name="P:DotSpatial.Data.CollectiveIndexCompareCancel`1.Index">
- <summary>
- Gets the integer index in the IEventList where this event occured
- </summary>
- </member>
- <member name="P:DotSpatial.Data.CollectiveIndexCompareCancel`1.Comparer">
- <summary>
- The System.Collections.Generic.IComparer<T> being used by this action
- </summary>
- </member>
- <member name="T:DotSpatial.Data.Compare`1">
- <summary>
- Carries event arguments for the generic IEventList
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Compare`1.#ctor(System.Collections.Generic.IComparer{`0})">
- <summary>
- Creates a new instance of a ListEventArgs class
- </summary>
- <param name="inComparer">The System.Collections.Generic.IComparer<T> being used by this action </param>
- </member>
- <member name="P:DotSpatial.Data.Compare`1.Comparer">
- <summary>
- Gets the System.Collections.Generic.IComparer<T> being referenced by this event
- </summary>
- </member>
- <member name="T:DotSpatial.Data.CompareCancel`1">
- <summary>
- The same as a ListEventArgs, but provides an option to cancel the event
- </summary>
- </member>
- <member name="M:DotSpatial.Data.CompareCancel`1.#ctor(System.Collections.Generic.IComparer{`0})">
- <summary>
- Creates a new instance of a ListEventArgs class
- </summary>
- <param name="inComparer">The System.Collections.Generic.IComparer<T> being used by this action </param>
- </member>
- <member name="P:DotSpatial.Data.CompareCancel`1.Comparer">
- <summary>
- Gets the comparer being used in this action
- </summary>
- </member>
- <member name="T:DotSpatial.Data.ComparisonArgs`1">
- <summary>
- Carries event arguments for the generic IEventList
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ComparisonArgs`1.#ctor(System.Comparison{`0})">
- <summary>
- Creates a new instance of a ListEventArgs class
- </summary>
- <param name="inComparison">The System.Comparison<T> being used by this action </param>
- </member>
- <member name="P:DotSpatial.Data.ComparisonArgs`1.Comparison">
- <summary>
- Gets System.Comparison being referenced by this event
- </summary>
- </member>
- <member name="T:DotSpatial.Data.ComparisonCancelEventArgs`1">
- <summary>
- The same as a ListEventArgs, but provides an option to cancel the event
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ComparisonCancelEventArgs`1._comparison">
- <summary>
- The protected System.Collections.Generic.IComparer<T> being used by this action
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ComparisonCancelEventArgs`1.#ctor(System.Comparison{`0})">
- <summary>
- Creates a new instance of a ListEventArgs class
- </summary>
- <param name="inComparison">The System.Collections.Generic.IComparer<T> being used by this action </param>
- </member>
- <member name="P:DotSpatial.Data.ComparisonCancelEventArgs`1.Comparison">
- <summary>
- Gets the comparer being used in this action
- </summary>
- </member>
- <member name="T:DotSpatial.Data.EventList`1">
- <summary>
- A list that also includes several events during its existing activities.
- List is fussy about inheritance, unfortunately, so this wraps a list
- and then makes this class much more inheritable
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IEventList`1">
- <summary>
- This describes a generic tool to help with keeping track of strong typed lists.
- The usual list, however, provides no event handling whatsoever.
- This list also provides an event for each of the major actions.
- </summary>
- <typeparam name="T">The type of the members in the list.</typeparam>
- </member>
- <member name="M:DotSpatial.Data.IEventList`1.AddRange(System.Collections.Generic.IEnumerable{`0})">
- <summary>
- Adds the elements of the specified collection to the end of the System.Collections.Generic.List<T>
- </summary>
- <param name="collection">collection: The collection whose elements should be added to the end of the System.Collections.Generic.List<T>. The collection itself cannot be null, but it can contain elements that are null, if type T is a reference type.</param>
- </member>
- <member name="M:DotSpatial.Data.IEventList`1.BinarySearch(`0,System.Collections.Generic.IComparer{`0})">
- <summary>
- Searches the entire sorted System.Collections.Generic.List<T> for an element using the specified comparer and returns the zero-based index of the element.
- </summary>
- <param name="item">The object to locate. The value can be null for reference types.</param>
- <param name="comparer">The System.Collections.Generic.IComparer<T> implementation to use when comparing elements.-or-null to use the default comparer System.Collections.Generic.Comparer<T>.Default.</param>
- <returns>The zero-based index of item in the sorted System.Collections.Generic.List<T>, if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than item or, if there is no larger element, the bitwise complement of System.Collections.Generic.List<T>.Count.</returns>
- <exception cref="T:System.InvalidOperationException">comparer is null, and the default comparer System.Collections.Generic.Comparer<T>.Default cannot find an implementation of the System.IComparable<T>generic interface or the System.IComparable interface for type T.</exception>
- </member>
- <member name="M:DotSpatial.Data.IEventList`1.BinarySearch(`0)">
- <summary>
- Searches the entire sorted System.Collections.Generic.List<T> for an element using the default comparer and returns the zero-based index of the element.
- </summary>
- <param name="item">The object to locate. The value can be null for reference types.</param>
- <returns>The zero-based index of item in the sorted System.Collections.Generic.List<T>, if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than item or, if there is no larger element, the bitwise complement of System.Collections.Generic.List<T>.Count.</returns>
- <exception cref="T:System.InvalidOperationException">The default comparer System.Collections.Generic.Comparer<T>.Default cannot find an implementation of the System.IComparable<T> generic interface or the System.IComparable interface for type T.</exception>
- </member>
- <member name="M:DotSpatial.Data.IEventList`1.BinarySearch(System.Int32,System.Int32,`0,System.Collections.Generic.IComparer{`0})">
- <summary>
- Searches a range of elements in the sorted System.Collections.Generic.List<T> for an element using the specified comparer and returns the zero-based index of the element.
- </summary>
- <param name="index">The zero-based starting index of the range to search.</param>
- <param name="count">The length of the range to search.</param>
- <param name="item">The object to locate. The value can be null for reference types.</param>
- <param name="comparer">The System.Collections.Generic.IComparer<T> implementation to use when comparing elements, or null to use the default comparer System.Collections.Generic.Comparer<T>.Default.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.IEventList`1.ConvertAll``1(System.Converter{`0,``0})">
- <summary>
- Converts the elements in the current DotSpatial.Interfaces.Framework.IEventList<T> to another type, and returns a list containing the converted elements.
- </summary>
- <typeparam name="TOutput">The output type to convert to</typeparam>
- <param name="converter">A System.Converter<TInput, TOutput> delegate that converts each element from one type to another type.</param>
- <returns>A DotSpatial.Interfaces.Framework.IEventList<T> of the target type containing the converted elements from the current DotSpatial.Interfaces.Framework.IEventList<T>.</returns>
- <exception cref="T:System.ArgumentNullException">converter is null.</exception>
- </member>
- <member name="M:DotSpatial.Data.IEventList`1.Exists(System.Predicate{`0})">
- <summary>
- Determines whether the DotSpatial.Interfaces.Framework.IEventList<T> contains elements that match the conditions defined by the specified predicate.
- </summary>
- <param name="match">The System.Predicate<T> delegate that defines the conditions of the elements to search for.</param>
- <returns>true if the DotSpatial.Interfaces.Framework.IEventList<T> contains one or more elements that match the conditions defined by the specified predicate; otherwise, false.</returns>
- <exception cref="T:System.ArgumentNullException">match is null.</exception>
- </member>
- <member name="M:DotSpatial.Data.IEventList`1.ForEach(System.Action{`0})">
- <summary>
- Performs the specified action on each element of the DotSpatial.Interfaces.Framework.IEventList<T>.
- </summary>
- <param name="action"> The System.Action<T> delegate to perform on each element of the DotSpatial.Interfaces.Framework.IEventList<T>.</param>
- <exception cref="T:System.ArgumentNullException"> action is null.</exception>
- </member>
- <member name="M:DotSpatial.Data.IEventList`1.GetRange(System.Int32,System.Int32)">
- <summary>
- Creates a shallow copy of a range of elements in the source DotSpatial.Interfaces.Framework.IEventList<T>.
- </summary>
- <param name="index">The zero-based DotSpatial.Interfaces.Framework.IEventList<T> index at which the range starts.</param>
- <param name="count"> The number of elements in the range.</param>
- <returns>A shallow copy of a range of elements in the source DotSpatial.Interfaces.Framework.IEventList<T>.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-count is less than 0.</exception>
- <exception cref="T:System.ArgumentException">index and count do not denote a valid range of elements in the DotSpatial.Interfaces.Framework.IEventList<T>.</exception>
- </member>
- <member name="M:DotSpatial.Data.IEventList`1.Reverse(System.Int32,System.Int32)">
- <summary>
- Reverses the order of the elements in the specified range.
- </summary>
- <param name="index">The zero-based starting index of the range to reverse.</param>
- <param name="count">The number of elements in the range to reverse.</param>
- <exception cref="T:System.ArgumentException">index and count do not denote a valid range of elements in the DotSpatial.Interfaces.Framework.IEventList<T>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-count is less than 0.</exception>
- </member>
- <member name="M:DotSpatial.Data.IEventList`1.Reverse">
- <summary>
- Reverses the order of the elements in the entire DotSpatial.Interfaces.Framework.IEventList<T>.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IEventList`1.Sort(System.Comparison{`0})">
- <summary>
- Sorts the elements in the entire DotSpatial.Interfaces.Framework.IEventList<T> using the specified System.Comparison<T>.
- </summary>
- <param name="comparison">The System.Comparison<T> to use when comparing elements.</param>
- <exception cref="T:System.ArgumentException">The implementation of comparison caused an error during the sort. For example, comparison might not return 0 when comparing an item with itself.</exception>
- <exception cref="T:System.ArgumentNullException">comparison is null.</exception>
- </member>
- <member name="M:DotSpatial.Data.IEventList`1.Sort(System.Int32,System.Int32,System.Collections.Generic.IComparer{`0})">
- <summary>
- Sorts the elements in a range of elements in DotSpatial.Interfaces.Framework.IEventList<T> using the specified comparer.
- </summary>
- <param name="index"> The zero-based starting index of the range to sort.</param>
- <param name="count">The length of the range to sort.</param>
- <param name="comparer">The System.Collections.Generic.IComparer<T> implementation to use when comparing elements, or null to use the default comparer System.Collections.Generic.Comparer<T>.Default.</param>
- <exception cref="T:System.ArgumentException">index and count do not specify a valid range in the DotSpatial.Interfaces.Framework.IEventList<T>.-or-The implementation of comparer caused an error during the sort. For example, comparer might not return 0 when comparing an item with itself.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-count is less than 0.</exception>
- <exception cref="T:System.InvalidOperationException"> comparer is null, and the default comparer System.Collections.Generic.Comparer<T>.Default cannot find implementation of the System.IComparable<T> generic interface or the System.IComparable interface for type T.</exception>
- </member>
- <member name="M:DotSpatial.Data.IEventList`1.Sort(System.Collections.Generic.IComparer{`0})">
- <summary>
- Sorts the elements in the entire DotSpatial.Interfaces.Framework.IEventList<T> using the specified comparer.
- </summary>
- <param name="comparer"> The System.Collections.Generic.IComparer<T> implementation to use when comparing elements, or null to use the default comparer System.Collections.Generic.Comparer<T>.Default.</param>
- <exception cref="T:System.ArgumentException">The implementation of comparer caused an error during the sort. For example, comparer might not return 0 when comparing an item with itself.</exception>
- <exception cref="T:System.InvalidOperationException">comparer is null, and the default comparer System.Collections.Generic.Comparer<T>.Default cannot find implementation of the System.IComparable<T> generic interface or the System.IComparable interface for type T.</exception>
- </member>
- <member name="M:DotSpatial.Data.IEventList`1.Sort">
- <summary>
- Sorts the elements in the entire DotSpatial.Interfaces.Framework.IEventList<T> using the default comparer.
- </summary>
- <exception cref="T:System.InvalidOperationException">The default comparer System.Collections.Generic.Comparer<T>.Default cannot find an implementation of the System.IComparable<T> generic interface or the System.IComparable interface for type T.</exception>
- </member>
- <member name="M:DotSpatial.Data.IEventList`1.ToArray">
- <summary>
- Copies the elements of the DotSpatial.Interfaces.Framework.IEventList<T> to a new array.
- </summary>
- <returns>An array containing copies of the elements of the DotSpatial.Interfaces.Framework.IEventList<T>.</returns>
- </member>
- <member name="M:DotSpatial.Data.IEventList`1.TrimExcess">
- <summary>
- Sets the capacity to the actual number of elements in the DotSpatial.Interfaces.Framework.IEventList<T>, if that number is less than a threshold value.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IEventList`1.TrueForAll(System.Predicate{`0})">
- <summary>
- Determines whether every element in the DotSpatial.Interfaces.Framework.IEventList<T> matches the conditions defined by the specified predicate.
- </summary>
- <param name="match">The System.Predicate<T> delegate that defines the conditions to check against the elements.</param>
- <returns>true if every element in the DotSpatial.Interfaces.Framework.IEventList<T> matches the conditions defined by the specified predicate; otherwise, false. If the list has no elements, the return value is true.</returns>
- <exception cref="T:System.ArgumentNullException">match is null.</exception>
- </member>
- <member name="M:DotSpatial.Data.IEventList`1.IndexOf(`0,System.Int32,System.Int32)">
- <summary>
- Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the DotSpatial.Interfaces.Framework.IEventList<T> that starts at the specified index and contains the specified number of elements.
- </summary>
- <param name="item">The object to locate in the DotSpatial.Interfaces.Framework.IEventList<T>. The value can be null for reference types.</param>
- <param name="index"> The zero-based starting index of the search.</param>
- <param name="count">The number of elements in the section to search.</param>
- <returns>The zero-based index of the first occurrence of item within the range of elements in the DotSpatial.Interfaces.Framework.IEventList<T> that starts at index and contains count number of elements, if found; otherwise, –1.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException"> index is outside the range of valid indexes for the DotSpatial.Interfaces.Framework.IEventList<T>.-or-count is less than 0.-or-index and count do not specify a valid section in the DotSpatial.Interfaces.Framework.IEventList<T>.</exception>
- </member>
- <member name="M:DotSpatial.Data.IEventList`1.IndexOf(`0,System.Int32)">
- <summary>
- Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the DotSpatial.Interfaces.Framework.IEventList<T> that extends from the specified index to the last element.
- </summary>
- <param name="item">The object to locate in the DotSpatial.Interfaces.Framework.IEventList<T>. The value can be null for reference types.</param>
- <param name="index"> The zero-based starting index of the search.</param>
- <returns>The zero-based index of the first occurrence of item within the range of elements in the DotSpatial.Interfaces.Framework.IEventList<T> that extends from index to the last element, if found; otherwise, –1.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">index is outside the range of valid indexes for the DotSpatial.Interfaces.Framework.IEventList<T>.</exception>
- </member>
- <member name="M:DotSpatial.Data.IEventList`1.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{`0})">
- <summary>
- Inserts the elements of a collection into the DotSpatial.Interfaces.Framework.IEventList<T> at the specified index.
- </summary>
- <param name="index">The zero-based index at which the new elements should be inserted.</param>
- <param name="collection">The collection whose elements should be inserted into the DotSpatial.Interfaces.Framework.IEventList<T>. The collection itself cannot be null, but it can contain elements that are null, if type T is a reference type.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-index is greater than DotSpatial.Interfaces.Framework.IEventList<T>.Count.</exception>
- <exception cref="T:System.ArgumentNullException">collection is null.</exception>
- </member>
- <member name="M:DotSpatial.Data.IEventList`1.LastIndexOf(`0,System.Int32,System.Int32)">
- <summary>
- Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the DotSpatial.Interfaces.Framework.IEventList<T> that contains the specified number of elements and ends at the specified index.
- </summary>
- <param name="item">The object to locate in the DotSpatial.Interfaces.Framework.IEventList<T>. The value can be null for reference types.</param>
- <param name="index">The zero-based starting index of the backward search.</param>
- <param name="count">The number of elements in the section to search.</param>
- <returns>The zero-based index of the last occurrence of item within the range of elements in the DotSpatial.Interfaces.Framework.IEventList<T> that contains count number of elements and ends at index, if found; otherwise, –1.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">index is outside the range of valid indexes for the DotSpatial.Interfaces.Framework.IEventList<T>.-or-count is less than 0.-or-index and count do not specify a valid section in the DotSpatial.Interfaces.Framework.IEventList<T>.</exception>
- </member>
- <member name="M:DotSpatial.Data.IEventList`1.LastIndexOf(`0,System.Int32)">
- <summary>
- Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the DotSpatial.Interfaces.Framework.IEventList<T> that extends from the first element to the specified index.
- </summary>
- <param name="item">The object to locate in the DotSpatial.Interfaces.Framework.IEventList<T>. The value can be null for reference types.</param>
- <param name="index">The zero-based starting index of the backward search.</param>
- <returns>The zero-based index of the last occurrence of item within the range of elements in the DotSpatial.Interfaces.Framework.IEventList<T> that extends from the first element to index, if found; otherwise, –1.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">index is outside the range of valid indexes for the DotSpatial.Interfaces.Framework.IEventList<T>.</exception>
- </member>
- <member name="M:DotSpatial.Data.IEventList`1.LastIndexOf(`0)">
- <summary>
- Searches for the specified object and returns the zero-based index of the last occurrence within the entire DotSpatial.Interfaces.Framework.IEventList<T>.
- </summary>
- <param name="item">The object to locate in the DotSpatial.Interfaces.Framework.IEventList<T>. The value can be null for reference types.</param>
- <returns>The zero-based index of the last occurrence of item within the entire the DotSpatial.Interfaces.Framework.IEventList<T>, if found; otherwise, –1.</returns>
- </member>
- <member name="M:DotSpatial.Data.IEventList`1.RemoveAll(System.Predicate{`0})">
- <summary>
- Removes the all the elements that match the conditions defined by the specified predicate.
- </summary>
- <param name="match">The System.Predicate<T> delegate that defines the conditions of the elements to remove.</param>
- <returns>The number of elements removed from the DotSpatial.Interfaces.Framework.IEventList<T></returns>
- <exception cref="T:System.ArgumentNullException">match is null.</exception>
- </member>
- <member name="M:DotSpatial.Data.IEventList`1.RemoveRange(System.Int32,System.Int32)">
- <summary>
- Removes a range of elements from the DotSpatial.Interfaces.Framework.IEventList<T>.
- </summary>
- <param name="index">The zero-based starting index of the range of elements to remove.</param>
- <param name="count">The number of elements to remove.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-count is less than 0.</exception>
- <exception cref="T:System.ArgumentException">index and count do not denote a valid range of elements in the DotSpatial.Interfaces.Framework.IEventList<T>.</exception>
- </member>
- <member name="M:DotSpatial.Data.IEventList`1.FindIndex(System.Int32,System.Int32,System.Predicate{`0})">
- <summary>
- Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the DotSpatial.Interfaces.Framework.IEventList<T> that starts at the specified index and contains the specified number of elements.
- </summary>
- <param name="startIndex">The zero-based starting index of the search.</param>
- <param name="count">The number of elements in the section to search.</param>
- <param name="match"> The System.Predicate<T> delegate that defines the conditions of the element to search for.</param>
- <returns>The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">startIndex is outside the range of valid indexes for the DotSpatial.Interfaces.Framework.IEventList<T>.-or-count is less than 0.-or-startIndex and count do not specify a valid section in the DotSpatial.Interfaces.Framework.IEventList<T>.</exception>
- <exception cref="T:System.ArgumentNullException">match is null</exception>
- </member>
- <member name="M:DotSpatial.Data.IEventList`1.FindIndex(System.Int32,System.Predicate{`0})">
- <summary>
- Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the DotSpatial.Interfaces.Framework.IEventList<T> that extends from the specified index to the last element.
- </summary>
- <param name="startIndex">The zero-based starting index of the search.</param>
- <param name="match">The System.Predicate<T> delegate that defines the conditions of the element to search for.</param>
- <returns>The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">startIndex is outside the range of valid indexes for the DotSpatial.Interfaces.Framework.IEventList<T>.</exception>
- <exception cref="T:System.ArgumentNullException">match is null.</exception>
- </member>
- <member name="M:DotSpatial.Data.IEventList`1.FindIndex(System.Predicate{`0})">
- <summary>
- Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the entire DotSpatial.Interfaces.Framework.IEventList<T>.
- </summary>
- <param name="match">The System.Predicate<T> delegate that defines the conditions of the element to search for.</param>
- <returns>The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1.</returns>
- <exception cref="T:System.ArgumentNullException">match is null.</exception>
- </member>
- <member name="M:DotSpatial.Data.IEventList`1.FindLast(System.Predicate{`0})">
- <summary>
- Searches for an element that matches the conditions defined by the specified predicate, and returns the last occurrence within the entire DotSpatial.Interfaces.Framework.IEventList<T>.
- </summary>
- <param name="match">The System.Predicate<T> delegate that defines the conditions of the element to search for.</param>
- <returns>The last element that matches the conditions defined by the specified predicate, if found; otherwise, the default value for type T.</returns>
- <exception cref="T:System.ArgumentNullException">match is null."</exception>
- </member>
- <member name="M:DotSpatial.Data.IEventList`1.FindLastIndex(System.Int32,System.Int32,System.Predicate{`0})">
- <summary>
- Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the range of elements in the DotSpatial.Interfaces.Framework.IEventList<T> that contains the specified number of elements and ends at the specified index.
- </summary>
- <param name="startIndex">The zero-based starting index of the backward search.</param>
- <param name="count">The number of elements in the section to search.</param>
- <param name="match"></param>
- <returns>The System.Predicate<T> delegate that defines the conditions of the element to search for.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">startIndex is outside the range of valid indexes for the DotSpatial.Interfaces.Framework.IEventList<T>.-or-count is less than 0.-or-startIndex and count do not specify a valid section in the DotSpatial.Interfaces.Framework.IEventList<T>.</exception>
- <exception cref="T:System.ArgumentNullException">match is null.</exception>
- </member>
- <member name="M:DotSpatial.Data.IEventList`1.FindLastIndex(System.Int32,System.Predicate{`0})">
- <summary>
- Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the range of elements in the DotSpatial.Interfaces.Framework.IEventList<T> that extends from the first element to the specified index.
- </summary>
- <param name="startIndex"> The zero-based starting index of the backward search.</param>
- <param name="match">The System.Predicate<T> delegate that defines the conditions of the element to search for.</param>
- <returns>The zero-based index of the last occurrence of an element that matches the conditions defined by match, if found; otherwise, –1.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">: startIndex is outside the range of valid indexes for the DotSpatial.Interfaces.Framework.IEventList<T>.</exception>
- </member>
- <member name="M:DotSpatial.Data.IEventList`1.FindLastIndex(System.Predicate{`0})">
- <summary>
- Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the entire DotSpatial.Interfaces.Framework.IEventList<T>.
- </summary>
- <param name="match">The System.Predicate<T> delegate that defines the conditions of the element to search for.</param>
- <returns>The zero-based index of the last occurrence of an element that matches the conditions defined by match, if found; otherwise, –1.</returns>
- <exception cref="T:System.ArgumentNullException">match is null.</exception>
- </member>
- <member name="M:DotSpatial.Data.IEventList`1.CopyTo(System.Int32,`0[],System.Int32,System.Int32)">
- <summary>
- Copies a range of elements from the DotSpatial.Interfaces.Framework.IEventList<T> to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="index">The zero-based index in the source DotSpatial.Interfaces.Framework.IEventList<T> at which copying begins</param>
- <param name="array">The one-dimensional System.Array that is the destination of the elements copied from DotSpatial.Interfaces.Framework.IEventList<T>. The System.Array must have zero-based indexing.</param>
- <param name="arrayIndex">The zero-based index in array at which copying begins.</param>
- <param name="count">The number of elements to copy.</param>
- <exception cref="T:System.ArgumentNullException">array is null.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException"> index is less than 0.-or-arrayIndex is less than 0.-or-count is less than 0.</exception>
- <exception cref="T:System.ArgumentException">index is equal to or greater than the DotSpatial.Interfaces.Framework.IEventList<T>.Count of the source DotSpatial.Interfaces.Framework.IEventList<T>.-or-arrayIndex is equal to or greater than the length of array.-or-The number of elements from index to the end of the source DotSpatial.Interfaces.Framework.IEventList<T> is greater than the available space from arrayIndex to the end of the destination array.</exception>
- </member>
- <member name="M:DotSpatial.Data.IEventList`1.CopyTo(`0[])">
- <summary>
- Copies the entire DotSpatial.Interfaces.Framework.IEventList<T> to a compatible one-dimensional array, starting at the beginning of the target array.
- </summary>
- <param name="array">The one-dimensional System.Array that is the destination of the elements copied from DotSpatial.Interfaces.Framework.IEventList<T>. The System.Array must have zero-based indexing.</param>
- <exception cref="T:System.ArgumentException">The number of elements in the source DotSpatial.Interfaces.Framework.IEventList<T> is greater than the number of elements that the destination array can contain.</exception>
- <exception cref="T:System.ArgumentNullException">array is null.</exception>
- </member>
- <member name="P:DotSpatial.Data.IEventList`1.Capacity">
- <summary>
- Gets or sets the total number of elements the internal data structure can hold without resizing.
- </summary>
- <returns>
- The number of elements that the DotSpatial.Interfaces.Framework.IEventList<T> can contain before resizing is required.
- </returns>
- <exception cref="T:System.ArgumentOutOfRangeException">DotSpatial.Interfaces.Framework.IEventList<T>.Capacity is set to a value that is less than DotSpatial.Interfaces.Framework.IEventList<T>.Count.</exception>
- </member>
- <member name="E:DotSpatial.Data.IEventList`1.BeforeItemAdded">
- <summary>
- Occurs before an item is added to the List.
- There is no index yet specified because it will be added to the
- end of the list.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventList`1.BeforeRangeAdded">
- <summary>
- Occurs before a range of items is added to the list.
- There is no index yet, but this event can be cancelled.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventList`1.AfterItemAdded">
- <summary>
- Occurs after an item has already been added to the list.
- The index where the item was added is specified.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventList`1.AfterRangeAdded">
- <summary>
- Occurs after a range has already been added to the list.
- This reveals the index where the beginning of the range
- was added, but cannot be canceled.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventList`1.BeforeItemInserted">
- <summary>
- Occurs before an item is inserted. The index of the requested
- insertion as well as the item being inserted and an option to
- cancel the event are specified
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventList`1.BeforeRangeInserted">
- <summary>
- Occurs before a range is inserted. The index of the requested
- insertion location as well as the item being inserted and an option to
- cancel the event are provided in the event arguments
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventList`1.AfterItemInserted">
- <summary>
- Occurs after an item is inserted.
- Shows the true index of the item after it was actually added.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventList`1.AfterRangeInserted">
- <summary>
- Occurs after an item is inserted.
- Shows the true index of the item after it was actually added.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventList`1.BeforeItemRemoved">
- <summary>
- Occurs before an item is removed from the List.
- Specifies the item, the current index and an option to cancel.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventList`1.BeforeRangeRemoved">
- <summary>
- Occurs before a range is removed from the List.
- Specifies the range, the current index and an option to cancel.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventList`1.AfterItemRemoved">
- <summary>
- Occurs after an item is removed from the List.
- Gives a handle to the item that was removed, but it no longer
- has a meaningful index value or an option to cancel.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventList`1.AfterRangeRemoved">
- <summary>
- Occurs after an item is removed from the List.
- Gives a handle to the range that was removed, but it no longer
- has a meaningful index value or an option to cancel.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventList`1.BeforeAllMatchingRemoved">
- <summary>
- Occurs before all the elements that match a predicate are removed.
- Supplies an IEnumerable list in the event args of all the items
- that will match the expression. This action can be cancelled.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventList`1.AfterAllMatchingRemoved">
- <summary>
- Occurs after all the elements that matched a predicate were
- removed. The values are the items that were successfully removed.
- The action has already happened, and so cannot be cancelled here.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventList`1.BeforeListCleared">
- <summary>
- Occurs before the list is cleared and can cancel the event.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventList`1.AfterListCleared">
- <summary>
- Occurs after the list is cleared and this cannot be canceled.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventList`1.ListChanged">
- <summary>
- Occurs after a method that sorts or reorganizes the list
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventList`1.BeforeRangeReversed">
- <summary>
- Occurs before a specific range is reversed
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventList`1.AfterRangeReversed">
- <summary>
- Occurs after a specific range is reversed
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventList`1.BeforeListReversed">
- <summary>
- Occurs before the entire list is reversed
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventList`1.AfterListReversed">
- <summary>
- Occurs after the entire list is reversed
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventList`1.AfterReversed">
- <summary>
- Occurs just after the list or any sub portion
- of the list is sorted. This event occurs in
- addition to the specific reversal case.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventList`1.BeforeReversed">
- <summary>
- Occurs just before the list or any sub portion
- of the list is sorted. This event occurs in
- addition to the specific reversal case.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventList`1.BeforeSort">
- <summary>
- Occurs just before any of the specific sorting methodsin addition
- to the event associated with the specific method.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventList`1.AfterSort">
- <summary>
- Occurs after any of the specific sorting methods in addition
- to the event associated with the specific method.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventList`1.BeforeListSorted">
- <summary>
- Occurs just before the entire list is sorted
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventList`1.AfterListSorted">
- <summary>
- Occurs after the entire list has been sorted
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventList`1.BeforeSortByComparison">
- <summary>
- Occurs just before the Sort method that uses a System.Comparison<T>
- This event can cancel the action.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventList`1.AfterSortByComparison">
- <summary>
- Occurs just after the Sort method that uses a System.Comparison<T>
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventList`1.BeforeRangeSorted">
- <summary>
- Occurs just before the Sort method that only sorts a specified range.
- This event can cancel the action.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventList`1.AfterRangeSorted">
- <summary>
- Occurs just after the Sort method that only sorts a specified range.
- </summary>
- </member>
- <member name="F:DotSpatial.Data.EventList`1._isReadOnly">
- <summary>
- Decides whether or not this list can be changed. This characteristic
- can be set, so that once it becomes readonly, methods that would normally
- change the sequence or number of members will be prevented and throw an
- Application error.
- </summary>
- </member>
- <member name="F:DotSpatial.Data.EventList`1._list">
- <summary>
- The internal list of items
- </summary>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.#ctor">
- <summary>
- Initializes a new instance of the EventList<T> class that is empty and has the default initial capacity.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.#ctor(System.Int32)">
- <summary>
- Initializes a new instance of the EventList<T> class that is empty and has the specified initial capacity.
- </summary>
- <param name="capactiy"> The number of elements that the new list can initially store.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">capacity is less than 0.</exception>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.#ctor(System.Collections.Generic.IEnumerable{`0})">
- <summary>
- Initializes a new instance of the EventList<T> class that contains elements copied from the specified collection and has sufficient capacity to accommodate the number of elements copied.
- </summary>
- <param name="collection">The collection whose elements are copied to the new list.</param>
- <exception cref="T:System.ArgumentNullException">collection is null.</exception>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.Add(`0)">
- <summary>
- Adds an object to the end of the System.Collections.Generic.List<T>.
- </summary>
- <param name="item">The object to be added to the end of the System.Collections.Generic.List<T>.
- The value can be null for reference types.</param>
- <exception cref="T:System.ApplicationException">Unable to add while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.AddRange(System.Collections.Generic.IEnumerable{`0})">
- <summary>
- Adds the elements of the specified collection to the end of the System.Collections.Generic.List<T>
- </summary>
- <param name="collection">collection: The collection whose elements should be added to the end of the
- System.Collections.Generic.List<T>. The collection itself cannot be null, but it can contain elements that are null,
- if type T is a reference type.</param>
- <exception cref="T:System.ApplicationException">Unable to add while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.BinarySearch(`0,System.Collections.Generic.IComparer{`0})">
- <summary>
- Searches the entire sorted System.Collections.Generic.List<T> for an element using the specified comparer and returns the zero-based index of the element.
- </summary>
- <param name="item">The object to locate. The value can be null for reference types.</param>
- <param name="comparer">The System.Collections.Generic.IComparer<T> implementation to use when comparing elements.-or-null to use the default comparer System.Collections.Generic.Comparer<T>.Default.</param>
- <returns>The zero-based index of item in the sorted System.Collections.Generic.List<T>, if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than item or, if there is no larger element, the bitwise complement of System.Collections.Generic.List<T>.Count.</returns>
- <exception cref="T:System.InvalidOperationException">comparer is null, and the default comparer
- System.Collections.Generic.Comparer<T>.Default cannot find an implementation of the System.IComparable<T>generic
- interface or the System.IComparable interface for type T.</exception>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.BinarySearch(`0)">
- <summary>
- Searches the entire sorted System.Collections.Generic.List<T> for an element using the default comparer and returns the zero-based index of the element.
- </summary>
- <param name="item">The object to locate. The value can be null for reference types.</param>
- <returns>The zero-based index of item in the sorted System.Collections.Generic.List<T>, if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than item or, if there is no larger element, the bitwise complement of System.Collections.Generic.List<T>.Count.</returns>
- <exception cref="T:System.InvalidOperationException">The default comparer System.Collections.Generic.Comparer<T>.Default cannot find an implementation of the System.IComparable<T> generic interface or the System.IComparable interface for type T.</exception>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.BinarySearch(System.Int32,System.Int32,`0,System.Collections.Generic.IComparer{`0})">
- <summary>
- Searches a range of elements in the sorted System.Collections.Generic.List<T> for an element using the specified comparer and returns the zero-based index of the element.
- </summary>
- <param name="index">The zero-based starting index of the range to search.</param>
- <param name="count">The length of the range to search.</param>
- <param name="item">The object to locate. The value can be null for reference types.</param>
- <param name="comparer">The System.Collections.Generic.IComparer<T> implementation to use when comparing elements, or null to use the default comparer System.Collections.Generic.Comparer<T>.Default.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.Clear">
- <summary>
- Removes all elements from the EventList<T>.
- </summary>
- <exception cref="T:System.ApplicationException">Unable to clear while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.Contains(`0)">
- <summary>
- Determines whether an element is in the System.Collections.Generic.List<T>.
- </summary>
- <param name="item"> The object to locate in the System.Collections.Generic.List<T>. The value can be null for reference types.</param>
- <returns>true if item is found in the System.Collections.Generic.List<T> otherwise, false.</returns>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.Exists(System.Predicate{`0})">
- <summary>
- Determines whether the EventList<T> contains elements that match the conditions defined by the specified predicate.
- </summary>
- <param name="match">The System.Predicate<T> delegate that defines the conditions of the elements to search for.</param>
- <returns>true if the EventList<T> contains one or more elements that match the conditions defined by the specified predicate; otherwise, false.</returns>
- <exception cref="T:System.ArgumentNullException">match is null.</exception>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.ForEach(System.Action{`0})">
- <summary>
- Performs the specified action on each element of the EventList<T>.
- </summary>
- <param name="action"> The System.Action<T> delegate to perform on each element of the EventList<T>.</param>
- <exception cref="T:System.ArgumentNullException"> action is null.</exception>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.GetEnumerator">
- <summary>
- Returns an enumerator that iterates through this list
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.GetRange(System.Int32,System.Int32)">
- <summary>
- Creates a shallow copy of a range of elements in the source EventList<T>.
- </summary>
- <param name="index">The zero-based EventList<T> index at which the range starts.</param>
- <param name="count"> The number of elements in the range.</param>
- <returns>A shallow copy of a range of elements in the source EventList<T>.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-count is less than 0.</exception>
- <exception cref="T:System.ArgumentException">index and count do not denote a valid range of elements in the EventList<T>.</exception>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.IndexOf(`0,System.Int32,System.Int32)">
- <summary>
- Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the EventList<T> that starts at the specified index and contains the specified number of elements.
- </summary>
- <param name="item">The object to locate in the EventList<T>. The value can be null for reference types.</param>
- <param name="index"> The zero-based starting index of the search.</param>
- <param name="count">The number of elements in the section to search.</param>
- <returns>The zero-based index of the first occurrence of item within the range of elements in the EventList<T> that starts at index and contains count number of elements, if found; otherwise, –1.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException"> index is outside the range of valid indexes for the EventList<T>.-or-count is less than 0.-or-index and count do not specify a valid section in the EventList<T>.</exception>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.IndexOf(`0,System.Int32)">
- <summary>
- Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the EventList<T> that extends from the specified index to the last element.
- </summary>
- <param name="item">The object to locate in the EventList<T>. The value can be null for reference types.</param>
- <param name="index"> The zero-based starting index of the search.</param>
- <returns>The zero-based index of the first occurrence of item within the range of elements in the EventList<T> that extends from index to the last element, if found; otherwise, –1.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">index is outside the range of valid indexes for the EventList<T>.</exception>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.IndexOf(`0)">
- <summary>
- Searches for the specified object and returns the zero-based index of the first occurrence within the entire System.Collections.Generic.List<T>.
- </summary>
- <param name="item">The object to locate in the System.Collections.Generic.List<T>. The value can be null for reference types.</param>
- <returns>The zero-based index of the first occurrence of item within the entire System.Collections.Generic.List<T>, if found; otherwise, –1.</returns>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{`0})">
- <summary>
- Inserts the elements of a collection into the EventList<T> at the specified index.
- </summary>
- <param name="index">The zero-based index at which the new elements should be inserted.</param>
- <param name="collection">The collection whose elements should be inserted into the EventList<T>. The collection itself cannot be null, but it can contain elements that are null, if type T is a reference type.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-index is greater than EventList<T>.Count.</exception>
- <exception cref="T:System.ArgumentNullException">collection is null.</exception>
- <exception cref="T:System.ApplicationException">Unable to insert while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.Insert(System.Int32,`0)">
- <summary>
- Inserts an element into the System.Collections.Generic.List<T> at the specified index.
- </summary>
- <param name="index">The zero-based index at which item should be inserted.</param>
- <param name="item">The object to insert. The value can be null for reference types.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-index is greater than System.Collections.Generic.List<T>.Count.</exception>
- <exception cref="T:System.ApplicationException">Unable to insert while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.LastIndexOf(`0,System.Int32,System.Int32)">
- <summary>
- Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the EventList<T> that contains the specified number of elements and ends at the specified index.
- </summary>
- <param name="item">The object to locate in the EventList<T>. The value can be null for reference types.</param>
- <param name="index">The zero-based starting index of the backward search.</param>
- <param name="count">The number of elements in the section to search.</param>
- <returns>The zero-based index of the last occurrence of item within the range of elements in the EventList<T> that contains count number of elements and ends at index, if found; otherwise, –1.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">index is outside the range of valid indexes for the EventList<T>.-or-count is less than 0.-or-index and count do not specify a valid section in the EventList<T>.</exception>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.LastIndexOf(`0,System.Int32)">
- <summary>
- Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the EventList<T> that extends from the first element to the specified index.
- </summary>
- <param name="item">The object to locate in the EventList<T>. The value can be null for reference types.</param>
- <param name="index">The zero-based starting index of the backward search.</param>
- <returns>The zero-based index of the last occurrence of item within the range of elements in the EventList<T> that extends from the first element to index, if found; otherwise, –1.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">index is outside the range of valid indexes for the EventList<T>.</exception>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.LastIndexOf(`0)">
- <summary>
- Searches for the specified object and returns the zero-based index of the last occurrence within the entire EventList<T>.
- </summary>
- <param name="item">The object to locate in the EventList<T>. The value can be null for reference types.</param>
- <returns>The zero-based index of the last occurrence of item within the entire the EventList<T>, if found; otherwise, –1.</returns>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.Remove(`0)">
- <summary>
- Removes the first occurrence of a specific object from the System.Collections.Generic.List<T>.
- </summary>
- <param name="item">The object to remove from the System.Collections.Generic.List<T>. The value can be null for reference types.</param>
- <returns>true if item is successfully removed; otherwise, false. This method also returns false if item was not
- found in the System.Collections.Generic.List<T>.</returns>
- <exception cref="T:System.ApplicationException">Unable to remove while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.RemoveAll(System.Predicate{`0})">
- <summary>
- Removes the all the elements that match the conditions defined by the specified predicate.
- </summary>
- <param name="match">The System.Predicate<T> delegate that defines the conditions of the elements to remove.</param>
- <returns>The number of elements removed from the EventList<T></returns>
- <exception cref="T:System.ArgumentNullException">match is null.</exception>
- <exception cref="T:System.ApplicationException">Unable to remove while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.RemoveAt(System.Int32)">
- <summary>
- Removes the element at the specified index of the System.Collections.Generic.List<T>.
- </summary>
- <param name="index">The zero-based index of the element to remove.</param>
- <exception cref="T:System.ApplicationException">Unable to remove while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.RemoveRange(System.Int32,System.Int32)">
- <summary>
- Removes a range of elements from the EventList<T>.
- </summary>
- <param name="index">The zero-based starting index of the range of elements to remove.</param>
- <param name="count">The number of elements to remove.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-count is less than 0.</exception>
- <exception cref="T:System.ArgumentException">index and count do not denote a valid range of elements in the EventList<T>.</exception>
- <exception cref="T:System.ApplicationException">Unable to remove while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.Reverse(System.Int32,System.Int32)">
- <summary>
- Reverses the order of the elements in the specified range.
- </summary>
- <param name="index">The zero-based starting index of the range to reverse.</param>
- <param name="count">The number of elements in the range to reverse.</param>
- <exception cref="T:System.ArgumentException">index and count do not denote a valid range of elements in the EventList<T>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-count is less than 0.</exception>
- <exception cref="T:System.ApplicationException">Unable to reverse while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.Reverse">
- <summary>
- Reverses the order of the elements in the entire EventList<T>.
- </summary>
- <exception cref="T:System.ApplicationException">Unable to reverse while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.Sort(System.Comparison{`0})">
- <summary>
- Sorts the elements in the entire EventList<T> using the specified System.Comparison<T>.
- </summary>
- <param name="comparison">The System.Comparison<T> to use when comparing elements.</param>
- <exception cref="T:System.ArgumentException">The implementation of comparison caused an error during the sort. For example, comparison might not return 0 when comparing an item with itself.</exception>
- <exception cref="T:System.ArgumentNullException">comparison is null.</exception>
- <exception cref="T:System.ApplicationException">Unable to sort while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.Sort(System.Int32,System.Int32,System.Collections.Generic.IComparer{`0})">
- <summary>
- Sorts the elements in a range of elements in EventList<T> using the specified comparer.
- </summary>
- <param name="index"> The zero-based starting index of the range to sort.</param>
- <param name="count">The length of the range to sort.</param>
- <param name="comparer">The System.Collections.Generic.IComparer<T> implementation to use when comparing elements, or null to use the default comparer System.Collections.Generic.Comparer<T>.Default.</param>
- <exception cref="T:System.ArgumentException">index and count do not specify a valid range in the EventList<T>.-or-The implementation of comparer caused an error during the sort. For example, comparer might not return 0 when comparing an item with itself.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-count is less than 0.</exception>
- <exception cref="T:System.InvalidOperationException"> comparer is null, and the default comparer
- System.Collections.Generic.Comparer<T>.Default cannot find implementation of the System.IComparable<T>
- generic interface or the System.IComparable interface for type T.</exception>
- <exception cref="T:System.ApplicationException">Unable to sort while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.Sort(System.Collections.Generic.IComparer{`0})">
- <summary>
- Sorts the elements in the entire DotSpatial.Interfaces.Framework.IEventList<T> using the specified comparer.
- </summary>
- <param name="comparer"> The System.Collections.Generic.IComparer<T> implementation to use when comparing elements, or null to use the default comparer System.Collections.Generic.Comparer<T>.Default.</param>
- <exception cref="T:System.ArgumentException">The implementation of comparer caused an error during the sort. For example, comparer might not return 0 when comparing an item with itself.</exception>
- <exception cref="T:System.InvalidOperationException">comparer is null, and the default comparer System.Collections.Generic.Comparer<T>.Default cannot find implementation of the System.IComparable<T> generic interface or the System.IComparable interface for type T.</exception>
- <exception cref="T:System.ApplicationException">Unable to sort while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.Sort">
- <summary>
- Sorts the elements in the entire DotSpatial.Interfaces.Framework.IEventList<T> using the default comparer.
- </summary>
- <exception cref="T:System.InvalidOperationException">The default comparer System.Collections.Generic.Comparer<T>.Default cannot find an implementation of the System.IComparable<T> generic interface or the System.IComparable interface for type T.</exception>
- <exception cref="T:System.ApplicationException">Unable to sort while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.ToArray">
- <summary>
- Copies the elements of the DotSpatial.Interfaces.Framework.IEventList<T> to a new array.
- </summary>
- <returns>An array containing copies of the elements of the DotSpatial.Interfaces.Framework.IEventList<T>.</returns>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.TrimExcess">
- <summary>
- Sets the capacity to the actual number of elements in the DotSpatial.Interfaces.Framework.IEventList<T>, if that number is less than a threshold value.
- </summary>
- <exception cref="T:System.ApplicationException">Unable to trim while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.TrueForAll(System.Predicate{`0})">
- <summary>
- Determines whether every element in the DotSpatial.Interfaces.Framework.IEventList<T> matches the conditions defined by the specified predicate.
- </summary>
- <param name="match">The System.Predicate<T> delegate that defines the conditions to check against the elements.</param>
- <returns>true if every element in the DotSpatial.Interfaces.Framework.IEventList<T> matches the conditions defined by the specified predicate; otherwise, false. If the list has no elements, the return value is true.</returns>
- <exception cref="T:System.ArgumentNullException">match is null.</exception>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.FindIndex(System.Int32,System.Int32,System.Predicate{`0})">
- <summary>
- Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the EventList<T> that starts at the specified index and contains the specified number of elements.
- </summary>
- <param name="startIndex">The zero-based starting index of the search.</param>
- <param name="count">The number of elements in the section to search.</param>
- <param name="match"> The System.Predicate<T> delegate that defines the conditions of the element to search for.</param>
- <returns>The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">startIndex is outside the range of valid indexes for the EventList<T>.-or-count is less than 0.-or-startIndex and count do not specify a valid section in the EventList<T>.</exception>
- <exception cref="T:System.ArgumentNullException">match is null</exception>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.FindIndex(System.Int32,System.Predicate{`0})">
- <summary>
- Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the EventList<T> that extends from the specified index to the last element.
- </summary>
- <param name="startIndex">The zero-based starting index of the search.</param>
- <param name="match">The System.Predicate<T> delegate that defines the conditions of the element to search for.</param>
- <returns>The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">startIndex is outside the range of valid indexes for the EventList<T>.</exception>
- <exception cref="T:System.ArgumentNullException">match is null.</exception>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.FindIndex(System.Predicate{`0})">
- <summary>
- Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the entire EventList<T>.
- </summary>
- <param name="match">The System.Predicate<T> delegate that defines the conditions of the element to search for.</param>
- <returns>The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1.</returns>
- <exception cref="T:System.ArgumentNullException">match is null.</exception>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.FindLast(System.Predicate{`0})">
- <summary>
- Searches for an element that matches the conditions defined by the specified predicate, and returns the last occurrence within the entire EventList<T>.
- </summary>
- <param name="match">The System.Predicate<T> delegate that defines the conditions of the element to search for.</param>
- <returns>The last element that matches the conditions defined by the specified predicate, if found; otherwise, the default value for type T.</returns>
- <exception cref="T:System.ArgumentNullException">match is null."</exception>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.FindLastIndex(System.Int32,System.Int32,System.Predicate{`0})">
- <summary>
- Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the range of elements in the EventList<T> that contains the specified number of elements and ends at the specified index.
- </summary>
- <param name="startIndex">The zero-based starting index of the backward search.</param>
- <param name="count">The number of elements in the section to search.</param>
- <param name="match"></param>
- <returns>The System.Predicate<T> delegate that defines the conditions of the element to search for.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">startIndex is outside the range of valid indexes for the EventList<T>.-or-count is less than 0.-or-startIndex and count do not specify a valid section in the EventList<T>.</exception>
- <exception cref="T:System.ArgumentNullException">match is null.</exception>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.FindLastIndex(System.Int32,System.Predicate{`0})">
- <summary>
- Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the range of elements in the EventList<T> that extends from the first element to the specified index.
- </summary>
- <param name="startIndex"> The zero-based starting index of the backward search.</param>
- <param name="match">The System.Predicate<T> delegate that defines the conditions of the element to search for.</param>
- <returns>The zero-based index of the last occurrence of an element that matches the conditions defined by match, if found; otherwise, –1.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">: startIndex is outside the range of valid indexes for the EventList<T>.</exception>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.FindLastIndex(System.Predicate{`0})">
- <summary>
- Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the entire EventList<T>.
- </summary>
- <param name="match">The System.Predicate<T> delegate that defines the conditions of the element to search for.</param>
- <returns>The zero-based index of the last occurrence of an element that matches the conditions defined by match, if found; otherwise, –1.</returns>
- <exception cref="T:System.ArgumentNullException">match is null.</exception>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.CopyTo(System.Int32,`0[],System.Int32,System.Int32)">
- <summary>
- Copies a range of elements from the EventList<T> to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="index">The zero-based index in the source EventList<T> at which copying begins</param>
- <param name="array">The one-dimensional System.Array that is the destination of the elements copied from EventList<T>. The System.Array must have zero-based indexing.</param>
- <param name="arrayIndex">The zero-based index in array at which copying begins.</param>
- <param name="count">The number of elements to copy.</param>
- <exception cref="T:System.ArgumentNullException">array is null.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException"> index is less than 0.-or-arrayIndex is less than 0.-or-count is less than 0.</exception>
- <exception cref="T:System.ArgumentException">index is equal to or greater than the EventList<T>.Count of the source EventList<T>.-or-arrayIndex is equal to or greater than the length of array.-or-The number of elements from index to the end of the source EventList<T> is greater than the available space from arrayIndex to the end of the destination array.</exception>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.CopyTo(`0[],System.Int32)">
- <summary>
- Copies the entire System.Collections.Generic.List<T> to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional System.Array that is the destination of the elements copied from System.Collections.Generic.List<T>. The System.Array must have zero-based indexing.</param>
- <param name="arrayIndex"> The zero-based index in array at which copying begins.</param>
- <exception cref="T:System.ArgumentException">System.ArgumentException: arrayIndex is equal to or greater than the length of array.-or-The number of elements in the source System.Collections.Generic.List<T> is greater than the available space from arrayIndex to the end of the destination array. </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">arrayIndex is less than 0</exception>
- <exception cref="T:System.ArgumentNullException">array is null</exception>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.CopyTo(`0[])">
- <summary>
- Copies the entire EventList<T> to a compatible one-dimensional array, starting at the beginning of the target array.
- </summary>
- <param name="array">The one-dimensional System.Array that is the destination of the elements copied from EventList<T>. The System.Array must have zero-based indexing.</param>
- <exception cref="T:System.ArgumentException">The number of elements in the source EventList<T> is greater than the number of elements that the destination array can contain.</exception>
- <exception cref="T:System.ArgumentNullException">array is null.</exception>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.ConvertAll``1(System.Converter{`0,``0})">
- <summary>
- Converts the elements in the current EventList<T> to another type, and returns a list containing the converted elements.
- </summary>
- <typeparam name="TOutput">The output type to convert to</typeparam>
- <param name="converter">A System.Converter<TInput, TOutput> delegate that converts each element from one type to another type.</param>
- <returns>A EventList<T> of the target type containing the converted elements from the current EventList<T>.</returns>
- <exception cref="T:System.ArgumentNullException">converter is null.</exception>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.OnAfterItemAdded(`0,System.Int32)">
- <summary>
- Fires the AfterItemAdded Event
- </summary>
- <param name="item"></param>
- <param name="index"></param>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.OnAfterRangeAdded(System.Collections.Generic.IEnumerable{`0},System.Int32)">
- <summary>
- Fires the AfterRangeAdded method
- </summary>
- <param name="collection"></param>
- <param name="index"></param>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.OnBeforeItemAdded(`0)">
- <summary>
- Fires the BeforeItemAdded Event
- </summary>
- <param name="item"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.OnBeforeRangeAdded(System.Collections.Generic.IEnumerable{`0})">
- <summary>
- Fires the BeforeRangeAdded Event
- </summary>
- <param name="collection"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.OnAfterListCleared">
- <summary>
- Fires the AfterListCleared event
- </summary>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.OnBeforeListCleared">
- <summary>
- Fires the BeforeListCleared event
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.OnAfterItemInserted(`0,System.Int32)">
- <summary>
- Fires the AfterItemInserted event
- </summary>
- <param name="item"></param>
- <param name="index"></param>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.OnAfterRangeInserted(System.Collections.Generic.IEnumerable{`0},System.Int32)">
- <summary>
- Fires the AfterRangeInserted event
- </summary>
- <param name="collection"></param>
- <param name="index"></param>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.OnBeforeItemInserted(`0,System.Int32)">
- <summary>
- Fires the BeforeItemInserted event
- </summary>
- <param name="item"></param>
- <param name="index"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.OnBeforeRangeInserted(System.Collections.Generic.IEnumerable{`0},System.Int32)">
- <summary>
- Fires the BeforeRangeInserted event
- </summary>
- <param name="collection"></param>
- <param name="index"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.OnListChanged">
- <summary>
- Fires the ListChanged Event
- </summary>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.OnAfterReversed">
- <summary>
- fires the AfterReversed event
- </summary>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.OnBeforeReversed">
- <summary>
- Fires the BeforeReversed event
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.OnBeforeRangeReversed(System.Int32,System.Collections.Generic.IEnumerable{`0})">
- <summary>
- Fires the BeforeRangeReversed event
- </summary>
- <param name="index"></param>
- <param name="range"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.OnAfterRangeReversed(System.Int32,System.Collections.Generic.IEnumerable{`0})">
- <summary>
- Fires the AfterRangeReversed event
- </summary>
- <param name="index"></param>
- <param name="collection"></param>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.OnBeforeListReversed">
- <summary>
- Fires the BeforeLiestReversed event
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.OnAfterListReversed">
- <summary>
- fires the AfterListReversed Event
- </summary>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.OnBeforeItemRemoved(`0,System.Int32)">
- <summary>
- Fires the BeforeItemRemoved event
- </summary>
- <param name="item"></param>
- <param name="index"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.OnBeforeRangeRemoved(System.Collections.Generic.IEnumerable{`0},System.Int32)">
- <summary>
- Fires the BeforeRangeRemoved event
- </summary>
- <param name="collection"></param>
- <param name="index"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.OnBeforeAllMatchingRemoved(System.Collections.Generic.IEnumerable{`0})">
- <summary>
- Fires the BeforeAllMatchingRemoved event
- </summary>
- <param name="collection"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.OnAfterAllMatchingRemoved(System.Collections.Generic.IEnumerable{`0})">
- <summary>
- Fires the AfterAllMatchingRemoved event
- </summary>
- <param name="collection"></param>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.OnAfterItemRemoved(`0)">
- <summary>
- Fires the AfterItemRemoved event
- </summary>
- <param name="item"></param>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.OnAfterRangeRemoved(System.Collections.Generic.IEnumerable{`0})">
- <summary>
- Fires the AfterRangeRemoved Event
- </summary>
- <param name="collection"></param>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.OnBeforeSort">
- <summary>
- Fires the BeforeSort event
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.OnAfterSort">
- <summary>
- Fires the AfterSort event
- </summary>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.OnBeforeListSorted(System.Collections.Generic.IComparer{`0})">
- <summary>
- Fires the BeforeListSorted event
- </summary>
- <param name="comparer"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.OnAfterListSorted(System.Collections.Generic.IComparer{`0})">
- <summary>
- Fires the AfterListSorted event
- </summary>
- <param name="comparer"></param>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.OnBeforeSortByComparison(System.Comparison{`0})">
- <summary>
- Fires the BeforeSortByComparison
- </summary>
- <param name="comparison"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.OnAfterSortByComparison(System.Comparison{`0})">
- <summary>
- Fires the AfterSortByComparison event
- </summary>
- <param name="comparison"></param>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.OnBeforeRangeSorted(System.Int32,System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IComparer{`0})">
- <summary>
- Fires the BeforeRangeSorted event
- </summary>
- <param name="index"></param>
- <param name="collection"></param>
- <param name="comparer"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.OnAfterRangeSorted(System.Int32,System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IComparer{`0})">
- <summary>
- Fires the AfterRangeSorted event
- </summary>
- <param name="index"></param>
- <param name="collection"></param>
- <param name="comparer"></param>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.DotSpatial#Data#IEventList{T}#ConvertAll``1(System.Converter{`0,``0})">
- <summary>
- Converts between one output an another
- </summary>
- <typeparam name="TOutput"></typeparam>
- <param name="converter"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.EventList`1.System#Collections#IEnumerable#GetEnumerator">
- <summary>
- Gets an Enumerator
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Data.EventList`1.Capacity">
- <summary>
- Gets or sets the total number of elements the internal data structure can hold without resizing.
- </summary>
- <returns>
- The number of elements that the DotSpatial.Interfaces.Framework.IEventList<T> can contain before resizing is required.
- </returns>
- <exception cref="T:System.ArgumentOutOfRangeException">DotSpatial.Interfaces.Framework.IEventList<T>.Capacity is set to a value that is less than DotSpatial.Interfaces.Framework.IEventList<T>.Count.</exception>
- </member>
- <member name="P:DotSpatial.Data.EventList`1.Item(System.Int32)">
- <summary>
- The default, indexed value of type T
- </summary>
- <param name="index">The numeric index</param>
- <returns>An object of type T corresponding to the index value specified</returns>
- </member>
- <member name="P:DotSpatial.Data.EventList`1.Count">
- <summary>
- Integer, the total number of items currently stored in the list
- </summary>
- </member>
- <member name="P:DotSpatial.Data.EventList`1.IsReadOnly">
- <summary>
- Gets a boolean property indicating whether this list can be written to.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.EventList`1.AfterItemAdded">
- <summary>
- Occurs after an item has already been added to the list.
- The index where the item was added is specified.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.EventList`1.AfterRangeAdded">
- <summary>
- Occurs after a range has already been added to the list.
- This reveals the index where the beginning of the range
- was added, but cannot be canceled.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.EventList`1.BeforeItemAdded">
- <summary>
- Occurs before an item is added to the List.
- There is no index yet specified because it will be added to the
- end of the list.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.EventList`1.BeforeRangeAdded">
- <summary>
- Occurs before a range of items is added to the list.
- There is no index yet, but this event can be cancelled.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.EventList`1.AfterListCleared">
- <summary>
- Occurs after the the list is cleared.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.EventList`1.BeforeListCleared">
- <summary>
- Occurs before the list is cleared and can cancel the event.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.EventList`1.AfterItemInserted">
- <summary>
- Occurs after an item is inserted.
- Shows the true index of the item after it was actually added.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.EventList`1.AfterRangeInserted">
- <summary>
- Occurs after an item is inserted.
- Shows the true index of the item after it was actually added.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.EventList`1.BeforeItemInserted">
- <summary>
- Occurs before an item is inserted. The index of the requested
- insertion as well as the item being inserted and an option to
- cancel the event are specified
- </summary>
- </member>
- <member name="E:DotSpatial.Data.EventList`1.BeforeRangeInserted">
- <summary>
- Occurs before a range is inserted. The index of the requested
- insertion location as well as the item being inserted and an option to
- cancel the event are provided in the event arguments
- </summary>
- </member>
- <member name="E:DotSpatial.Data.EventList`1.ListChanged">
- <summary>
- Occurs after a method that sorts or reorganizes the list
- </summary>
- </member>
- <member name="E:DotSpatial.Data.EventList`1.AfterReversed">
- <summary>
- Occurs just after the list or any sub portion
- of the list is sorted. This event occurs in
- addition to the specific reversal case.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.EventList`1.BeforeReversed">
- <summary>
- Occurs just before the list or any sub portion
- of the list is sorted. This event occurs in
- addition to the specific reversal case.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.EventList`1.BeforeRangeReversed">
- <summary>
- Occurs before a specific range is reversed
- </summary>
- </member>
- <member name="E:DotSpatial.Data.EventList`1.AfterRangeReversed">
- <summary>
- Occurs after a specific range is reversed
- </summary>
- </member>
- <member name="E:DotSpatial.Data.EventList`1.BeforeListReversed">
- <summary>
- Occurs before the entire list is reversed
- </summary>
- </member>
- <member name="E:DotSpatial.Data.EventList`1.AfterListReversed">
- <summary>
- Occurs after the entire list is reversed
- </summary>
- </member>
- <member name="E:DotSpatial.Data.EventList`1.BeforeItemRemoved">
- <summary>
- Occurs before an item is removed from the List.
- Specifies the item, the current index and an option to cancel.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.EventList`1.BeforeRangeRemoved">
- <summary>
- Occurs before a range is removed from the List.
- Specifies the range, the current index and an option to cancel.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.EventList`1.BeforeAllMatchingRemoved">
- <summary>
- Occurs before all the elements that match a predicate are removed.
- Supplies an IEnumerable list in the event args of all the items
- that will match the expression. This action can be cancelled.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.EventList`1.AfterAllMatchingRemoved">
- <summary>
- Occurs after all the elements that matched a predicate were
- removed. The values are the items that were successfully removed.
- The action has already happened, and so cannot be cancelled here.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.EventList`1.AfterItemRemoved">
- <summary>
- Occurs after an item is removed from the List.
- Gives a handle to the item that was removed, but it no longer
- has a meaningful index value or an option to cancel.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.EventList`1.AfterRangeRemoved">
- <summary>
- Occurs after an item is removed from the List.
- Gives a handle to the range that was removed, but it no longer
- has a meaningful index value or an option to cancel.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.EventList`1.BeforeSort">
- <summary>
- Occurs just before any of the specific sorting methodsin addition
- to the event associated with the specific method.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.EventList`1.AfterSort">
- <summary>
- Occurs after any of the specific sorting methods in addition
- to the event associated with the specific method.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.EventList`1.BeforeListSorted">
- <summary>
- Occurs just before the entire list is sorted
- </summary>
- </member>
- <member name="E:DotSpatial.Data.EventList`1.AfterListSorted">
- <summary>
- Occurs after the entire list has been sorted
- </summary>
- </member>
- <member name="E:DotSpatial.Data.EventList`1.BeforeSortByComparison">
- <summary>
- Occurs just before the Sort method that uses a System.Comparison<T>
- This event can cancel the action.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.EventList`1.AfterSortByComparison">
- <summary>
- Occurs just after the Sort method that uses a System.Comparison<T>
- </summary>
- </member>
- <member name="E:DotSpatial.Data.EventList`1.BeforeRangeSorted">
- <summary>
- Occurs just before the Sort method that only sorts a specified range.
- This event can cancel the action.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.EventList`1.AfterRangeSorted">
- <summary>
- Occurs just after the Sort method that only sorts a specified range.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.Global">
- <summary>
- Global has some basic methods that may be useful in lots of places.
- TODO: This class needs to be removed and these methods relocated to easier to find places.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Global.Convert``1(System.Double)">
- <summary>
- Converts a double numeric value into the appropriate T data type using a ChangeType process.
- </summary>
- <typeparam name="T">The numeric output type created from the double value.</typeparam>
- <param name="value">The double value to retrieve the equivalent numeric value for.</param>
- <returns>A variable of type T with the value of the value parameter.</returns>
- </member>
- <member name="M:DotSpatial.Data.Global.ToDouble``1(``0)">
- <summary>
- This involves boxing and unboxing as well as a convert to double, but IConvertible was
- not CLS Compliant, so we were always getting warnings about it. Ted was trying to make
- all the code CLS Compliant to remove warnings.
- </summary>
- <param name="value"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.Global.MaximumValue``1">
- <summary>
- For numeric types, this will return the maximum value.
- </summary>
- <typeparam name="T">The type of the numeric range to find the maximum for.</typeparam>
- <returns>The maximum value for the numeric type specified by T.</returns>
- </member>
- <member name="M:DotSpatial.Data.Global.MinimumValue``1">
- <summary>
- For Numeric types, this will return the minimum value.
- </summary>
- <typeparam name="T">The type of the numeric range to return the minimum for.</typeparam>
- <returns>The the minimum value possible for a numeric value of type T.</returns>
- </member>
- <member name="M:DotSpatial.Data.Global.SafeCastTo``1(System.Object)">
- <summary>
- A Generic Safe Casting method that should simply exist as part of the core framework
- </summary>
- <typeparam name="T">The type of the member to attempt to cast to.</typeparam>
- <param name="obj">The original object to attempt to System.Convert.</param>
- <returns>An output variable of type T.</returns>
- </member>
- <member name="M:DotSpatial.Data.Global.ParseEnum``1(System.String)">
- <summary>
- Uses the standard enum parsing, but returns it cast as the specified T parameter
- </summary>
- <typeparam name="T">The type of the enum to use</typeparam>
- <param name="text">The string to parse into a copy of the enumeration</param>
- <returns>an enumeration of the specified type</returns>
- </member>
- <member name="M:DotSpatial.Data.Global.GetByte(System.Object)">
- <summary>
- This attempts to convert a value into a byte. If it fails, the byte will be 0.
- </summary>
- <param name="expression">The expression (like a string) to System.Convert.</param>
- <returns>A byte that is 0 if the test fails.</returns>
- </member>
- <member name="M:DotSpatial.Data.Global.GetDouble(System.Object)">
- <summary>
- This attempts to convert a value into a double. If it fails, the double will be double.NaN.
- </summary>
- <param name="expression">The expression (like a string) to System.Convert.</param>
- <returns>A double that is double.NAN if the test fails.</returns>
- </member>
- <member name="M:DotSpatial.Data.Global.GetFloat(System.Object)">
- <summary>
- This attempts to convert a value into a float. If it fails, the float will be 0.
- </summary>
- <param name="expression">The expression (like a string) to System.Convert.</param>
- <returns>A float that is 0 if the test fails.</returns>
- </member>
- <member name="M:DotSpatial.Data.Global.GetInteger(System.Object)">
- <summary>
- This attempts to convert a value into an integer. If it fails, it returns 0.
- </summary>
- <param name="expression">The expression to test</param>
- <returns>true if the value could be cast as a double, false otherwise</returns>
- </member>
- <member name="M:DotSpatial.Data.Global.GetShort(System.Object)">
- <summary>
- This attempts to convert a value into a short. If it fails, it returns 0.
- </summary>
- <param name="expression">The expression (like a string) to System.Convert.</param>
- <returns>A short that is 0 if the test fails.</returns>
- </member>
- <member name="M:DotSpatial.Data.Global.GetString(System.Object)">
- <summary>
- Gets the string form of the number using culture settings
- </summary>
- <param name="expression">The expression to obtain the string for</param>
- <returns>A string</returns>
- </member>
- <member name="M:DotSpatial.Data.Global.IsByte(System.Object)">
- <summary>
- Tests an expression to see if it can be converted into a byte.
- </summary>
- <param name="expression">The expression to test</param>
- <returns>true if the value could be cast as a double, false otherwise</returns>
- </member>
- <member name="M:DotSpatial.Data.Global.IsDouble(System.Object)">
- <summary>
- Tests an expression to see if it can be converted into a double.
- </summary>
- <param name="expression">The expression to test</param>
- <returns>true if the value could be cast as a double, false otherwise</returns>
- </member>
- <member name="M:DotSpatial.Data.Global.IsFloat(System.Object)">
- <summary>
- Tests an expression to see if it can be converted into a float.
- </summary>
- <param name="expression">The expression to test</param>
- <returns>true if the value could be cast as a double, false otherwise</returns>
- </member>
- <member name="M:DotSpatial.Data.Global.IsInteger(System.Object)">
- <summary>
- Tests an expression to see if it can be converted into an integer.
- </summary>
- <param name="expression">The expression to test</param>
- <returns>true if the value could be cast as an integer, false otherwise</returns>
- </member>
- <member name="M:DotSpatial.Data.Global.IsShort(System.Object)">
- <summary>
- Tests an expression to see if it can be converted into a short.
- </summary>
- <param name="expression">The expression to test</param>
- <returns>true if the value could be cast as a double, false otherwise</returns>
- </member>
- <member name="T:DotSpatial.Data.ICancelProgressHandler">
- <summary>
- a IProgressHandler that carries a boolean property allowing the process using the handler to know if you should cancelled
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IProgressHandler">
- <summary>
- An interface for sending progress messages. Percent is an integer from 0 to 100.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IProgressHandler.Progress(System.String,System.Int32,System.String)">
- <summary>
- Progress is the method that should receive a progress message.
- </summary>
- <param name="key">The message string without any information about the status of completion.</param>
- <param name="percent">An integer from 0 to 100 that indicates the condition for a status bar etc.</param>
- <param name="message">A string containing both information on what the process is, as well as its completion status.</param>
- </member>
- <member name="P:DotSpatial.Data.ICancelProgressHandler.Cancel">
- <summary>
- Returns true if the progress handler has been notified that the running process should be cancelled
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IEventDictionary`2">
- <summary>
- Represents a nongeneric collection of key/value pairs.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IEventDictionary`2.ContainsValue(`1)">
- <summary>
- Determines whether the IEventDictionary<TKey, TValue> contains a specific value.
- </summary>
- <param name="value">The value to locate in the IEventDictionary<TKey, TValue>. The value can be null for reference types.</param>
- <returns>true if the IEventDictionary<TKey, TValue> contains an element with the specified value; otherwise, false.</returns>
- </member>
- <member name="P:DotSpatial.Data.IEventDictionary`2.Count">
- <summary>
- Two separate forms of count exist and are ambiguous so this provides a single new count
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IEventDictionary`2.Item(System.Int32)">
- <summary>
- Gets or sets the specific KeyValuePair for the specified index
- </summary>
- <param name="index">The integer index representing the order in the list</param>
- <returns>A KeyValuePair that is currently stored at the specified index </returns>
- </member>
- <member name="E:DotSpatial.Data.IEventDictionary`2.BeforeItemAdded">
- <summary>
- Occurs before an item is added to the List.
- There is no index yet specified because it will be added to the
- end of the list.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventDictionary`2.BeforeRangeAdded">
- <summary>
- Occurs before a range of items is added to the list.
- There is no index yet, but this event can be cancelled.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventDictionary`2.AfterItemAdded">
- <summary>
- Occurs after an item has already been added to the list.
- The index where the item was added is specified.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventDictionary`2.AfterRangeAdded">
- <summary>
- Occurs after a range has already been added to the list.
- This reveals the index where the beginning of the range
- was added, but cannot be canceled.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventDictionary`2.BeforeClearing">
- <summary>
- Occurs before a clear action, allowing the event to be canceled.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventDictionary`2.AfterClearing">
- <summary>
- Occurs after a clear action, allowing the event to be cancled
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventDictionary`2.ListChanged">
- <summary>
- Occurs after a method that changes either the order or the members of this EventDictionary
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventDictionary`2.BeforeItemInserted">
- <summary>
- Occurs before an item is inserted. The index of the requested
- insertion as well as the item being inserted and an option to
- cancel the event are specified
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventDictionary`2.BeforeRangeInserted">
- <summary>
- Occurs before a range is inserted. The index of the requested
- insertion location as well as the item being inserted and an option to
- cancel the event are provided in the event arguments
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventDictionary`2.AfterItemInserted">
- <summary>
- Occurs after an item is inserted.
- Shows the true index of the item after it was actually added.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventDictionary`2.AfterRangeInserted">
- <summary>
- Occurs after an item is inserted.
- Shows the true index of the item after it was actually added.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventDictionary`2.BeforeItemRemoved">
- <summary>
- Occurs before an item is removed from the List.
- Specifies the item, the current index and an option to cancel.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventDictionary`2.BeforeRangeRemoved">
- <summary>
- Occurs before a range is removed from the List.
- Specifies the range, the current index and an option to cancel.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventDictionary`2.AfterItemRemoved">
- <summary>
- Occurs after an item is removed from the List.
- Gives a handle to the item that was removed, but it no longer
- has a meaningful index value or an option to cancel.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventDictionary`2.AfterRangeRemoved">
- <summary>
- Occurs after an item is removed from the List.
- Gives a handle to the range that was removed, but it no longer
- has a meaningful index value or an option to cancel.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventDictionary`2.BeforeAllMatchingRemoved">
- <summary>
- Occurs before all the elements that match a predicate are removed.
- Supplies an IEnumerable list in the event args of all the items
- that will match the expression. This action can be cancelled.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventDictionary`2.AfterAllMatchingRemoved">
- <summary>
- Occurs after all the elements that matched a predicate were
- removed. The values are the items that were successfully removed.
- The action has already happened, and so cannot be cancelled here.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventDictionary`2.BeforeItemSet">
- <summary>
- Occurs before an item is set. This event can cancel the set opperation.
- </summary>
- </member>
- <member name="E:DotSpatial.Data.IEventDictionary`2.AfterItemSet">
- <summary>
- Occurs after an item is successfully set
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IListEM">
- <summary>
- IListEM
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IListEM.IncreaseIndex``1(System.Collections.Generic.IList{``0},``0)">
- <summary>
- This extension method helps by simply increasing the index value of the specified item
- by one.
- </summary>
- <typeparam name="T">The generic type of this list</typeparam>
- <param name="self">This list</param>
- <param name="item">The item to increase the index of</param>
- </member>
- <member name="M:DotSpatial.Data.IListEM.DecreaseIndex``1(System.Collections.Generic.IList{``0},``0)">
- <summary>
- Decreases the index of the specified item by one.
- </summary>
- <typeparam name="T">The type of the list</typeparam>
- <param name="self">This list</param>
- <param name="item">the item of type T to decrease the index of.</param>
- </member>
- <member name="T:DotSpatial.Data.INamedList">
- <summary>
- INamedList
- </summary>
- </member>
- <member name="M:DotSpatial.Data.INamedList.Demote(System.String)">
- <summary>
- Re-orders the list so that the index of the specifeid item is lower,
- and threfore will be drawn earlier, and therefore should appear
- in a lower position on the list.
- </summary>
- <param name="name">The name of the item to demote</param>
- </member>
- <member name="M:DotSpatial.Data.INamedList.GetItem(System.String)">
- <summary>
- Gets the item with the specified name as an object.
- This enables the INamedList to work with items even
- if it doesn't know the strong type.
- </summary>
- <param name="name">The string name of the item to retrieve</param>
- <returns>The actual item cast as an object.</returns>
- </member>
- <member name="M:DotSpatial.Data.INamedList.GetNameOfObject(System.Object)">
- <summary>
- Gets the name of the specified item, even if the strong type of the
- item is not known.
- </summary>
- <param name="item">The item to get the name of cast as an object</param>
- <returns>The string name of the specified object.</returns>
- </member>
- <member name="M:DotSpatial.Data.INamedList.GetNames">
- <summary>
- Gets the list of names for the items currently stored in the list,
- in the sequence defined by the list of items.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.INamedList.Promote(System.String)">
- <summary>
- Re-orders the list so that the index of the specified item is higher,
- and therefore will be drawn later, and therefore should appear
- in a higher position on the list.
- </summary>
- <param name="name"></param>
- </member>
- <member name="M:DotSpatial.Data.INamedList.RefreshNames">
- <summary>
- Updates the names to match the current set of actual items.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.INamedList.Remove(System.String)">
- <summary>
- Removes the item with the specified name from the list.
- </summary>
- <param name="name">The string name of the item to remove</param>
- </member>
- <member name="P:DotSpatial.Data.INamedList.BaseName">
- <summary>
- Gets or sets the base name to use for naming items
- </summary>
- </member>
- <member name="P:DotSpatial.Data.INamedList.Count">
- <summary>
- Gets the count of the items in the list.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IndividualEventArgs`1">
- <summary>
- Carries event arguments for the generic IEventList
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IndividualEventArgs`1.#ctor(`0)">
- <summary>
- Creates a new instance of a ListEventArgs class
- </summary>
- <param name="inListItem">an object that is being interacted with in the list</param>
- </member>
- <member name="P:DotSpatial.Data.IndividualEventArgs`1.ListItem">
- <summary>
- Gets the list item being referenced by this event
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IndividualCancelEventArgs`1">
- <summary>
- The same as a ListEventArgs, but provides an option to cancel the event
- </summary>
- </member>
- <member name="F:DotSpatial.Data.IndividualCancelEventArgs`1._listItem">
- <summary>
- The protected object internal to this list event args class
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IndividualCancelEventArgs`1.#ctor(`0)">
- <summary>
- Creates a new instance of a ListEventArgs class
- </summary>
- <param name="inListItem">an object that is being interacted with in the list</param>
- </member>
- <member name="P:DotSpatial.Data.IndividualCancelEventArgs`1.ListItem">
- <summary>
- Gets the list item being referenced by this event
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IndividualDictionaryEventArgs`2">
- <summary>
- Carries event arguments for the generic IEventList
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IndividualDictionaryEventArgs`2.#ctor(`0,`1)">
- <summary>
- Creates a new instance of a ListEventArgs class
- </summary>
- <param name="inKey">The key of type <TKey> being referenced</param>
- <param name="inValue">an object of type <TValue> that is being referenced</param>
- </member>
- <member name="P:DotSpatial.Data.IndividualDictionaryEventArgs`2.Key">
- <summary>
- Gets the key of the item being referenced by this event
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IndividualDictionaryEventArgs`2.Value">
- <summary>
- Gets the actual item being referenced by this event
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IndividualDictionaryCancelEventArgs`2">
- <summary>
- Contains properties for both a specified item and an integer index
- as well as the option to cancel.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IndividualDictionaryCancelEventArgs`2.#ctor(`0,`1)">
- <summary>
- Creates a new instance of a ListEventArgs class
- </summary>
- <param name="inKey">The key that provides direct access to the value member being interacted with</param>
- <param name="inValue">an object that is being interacted with in the list</param>
- </member>
- <member name="P:DotSpatial.Data.IndividualDictionaryCancelEventArgs`2.Key">
- <summary>
- Gets the key for the member referenced by this event
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IndividualDictionaryCancelEventArgs`2.Value">
- <summary>
- Gets the specific item being accessed
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IndividualIndex`1">
- <summary>
- Carries event arguments for the generic IEventList
- </summary>
- </member>
- <member name="F:DotSpatial.Data.IndividualIndex`1._listItem">
- <summary>
- The protected object internal to this list event args class
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IndividualIndex`1.#ctor(`0)">
- <summary>
- Creates a new instance of a ListEventArgs class
- </summary>
- <param name="inListItem">an object that is being interacted with in the list</param>
- </member>
- <member name="M:DotSpatial.Data.IndividualIndex`1.#ctor(`0,System.Int32)">
- <summary>
- Creates a new instance of a ListEventArgs class
- </summary>
- <param name="inListItem">The list item that the event belongs to</param>
- <param name="inIndex">The list index, if any, that is specified.</param>
- </member>
- <member name="P:DotSpatial.Data.IndividualIndex`1.ListItem">
- <summary>
- Gets the list item being referenced by this event
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IndividualIndex`1.Index">
- <summary>
- Gets the index for the ListItem
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IndividualIndexCancel`1">
- <summary>
- Contains properties for both a specified item and an integer index
- as well as the option to cancel.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IndividualIndexCancel`1.#ctor(`0)">
- <summary>
- Creates a new instance of a ListEventArgs class
- </summary>
- <param name="inListItem">an object that is being interacted with in the list</param>
- </member>
- <member name="M:DotSpatial.Data.IndividualIndexCancel`1.#ctor(`0,System.Int32)">
- <summary>
- Creates a new instance of a ListEventArgs class
- </summary>
- <param name="inListItem">The list item that the event belongs to</param>
- <param name="inIndex">The list index, if any, that is specified.</param>
- </member>
- <member name="P:DotSpatial.Data.IndividualIndexCancel`1.ListItem">
- <summary>
- Gets the list item being referenced by this event
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IndividualIndexCancel`1.Index">
- <summary>
- Gets the index for the ListItem
- </summary>
- </member>
- <member name="T:DotSpatial.Data.IOrderedDictionary`2">
- <summary>
- This has the indexing and ordering capabilities, but without all the events of an EventDictionary
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IOrderedDictionary`2.ContainsValue(`1)">
- <summary>
- Determines whether the IEventDictionary<TKey, TValue> contains a specific value.
- </summary>
- <param name="value">The value to locate in the IEventDictionary<TKey, TValue>. The value can be null for reference types.</param>
- <returns>true if the IEventDictionary<TKey, TValue> contains an element with the specified value; otherwise, false.</returns>
- </member>
- <member name="M:DotSpatial.Data.IOrderedDictionary`2.GetValue(`0)">
- <summary>
- Obtains a value in the dictionary based on a key. This happens without consulting the
- index at all.
- </summary>
- <param name="key">The Tkey key to search for.</param>
- <returns>The TValue to obtain a value for. </returns>
- </member>
- <member name="M:DotSpatial.Data.IOrderedDictionary`2.SetValue(`0,`1)">
- <summary>
- Sets the value associated with a key that is already in the dictionary.
- </summary>
- <param name="key">The key currently found in the index</param>
- <param name="value">the value to be changed</param>
- </member>
- <member name="M:DotSpatial.Data.IOrderedDictionary`2.GetIndex(System.Int32)">
- <summary>
- Gets a pair based on the index value
- </summary>
- <param name="index"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.IOrderedDictionary`2.SetIndex(System.Int32,System.Collections.Generic.KeyValuePair{`0,`1})">
- <summary>
- Sets a pair based on the index value
- </summary>
- <param name="index"></param>
- <param name="item"></param>
- </member>
- <member name="P:DotSpatial.Data.IOrderedDictionary`2.Count">
- <summary>
- Two separate forms of count exist and are ambiguous so this provides a single new count
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IOrderedDictionary`2.Item(System.Int32)">
- <summary>
- For ordered dictionaries, the default accessor returns the Key Value Pair associated with the
- index.
- </summary>
- <param name="index"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Data.IParentItem`1">
- <summary>
- Any item which can be contained by a parent item
- </summary>
- <typeparam name="T">The type class of the potential parent</typeparam>
- </member>
- <member name="M:DotSpatial.Data.IParentItem`1.GetParentItem">
- <summary>
- Gets the parent item relative to this item.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IParentItem`1.SetParentItem(`0)">
- <summary>
- Sets teh parent legend item for this item
- </summary>
- <param name="value"></param>
- </member>
- <member name="T:DotSpatial.Data.IReadOnlyList`1">
- <summary>
- IReadOnlyList
- </summary>
- </member>
- <member name="M:DotSpatial.Data.IReadOnlyList`1.Contains(`0)">
- <summary>
- Tests to see if the specified item is contained in the list. This returns true if the item is contained in the list.
- </summary>
- <param name="item">The item to test for.</param>
- <returns>Boolean, true if the item is found in the list</returns>
- </member>
- <member name="M:DotSpatial.Data.IReadOnlyList`1.CopyTo(`0[],System.Int32)">
- <summary>
- Copies the specified memebers into the array, starting at the specified index.
- </summary>
- <param name="array">The array to copy values to.</param>
- <param name="arrayIndex">The array index where the 0 member of this list should be copied to.</param>
- </member>
- <member name="M:DotSpatial.Data.IReadOnlyList`1.IndexOf(`0)">
- <summary>
- Obtains the index of the specified item
- </summary>
- <param name="item">The item to find the index of</param>
- <returns>An integer representing the index of the specified item</returns>
- </member>
- <member name="P:DotSpatial.Data.IReadOnlyList`1.Count">
- <summary>
- Gets the integer count of items in this list.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IReadOnlyList`1.IsReadOnly">
- <summary>
- Return true because this is a read-only list.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.IReadOnlyList`1.Item(System.Int32)">
- <summary>
- Gets the item at the specified index. Ideally, this ReadOnlyList is used with
- value types, or else this gives the user considerable power over the core content.
- </summary>
- <param name="index">The item to obtain from this list</param>
- <returns>The item at the specified index.</returns>
- </member>
- <member name="T:DotSpatial.Data.ITreeList`1">
- <summary>
- An all purpose item
- </summary>
- </member>
- <member name="T:DotSpatial.Data.MessageCancelEventArgs">
- <summary>
- A set of PaintEventArgs that can be used before a drawing function in order to cancel an event.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.MessageCancelEventArgs.#ctor(System.String)">
- <summary>
- Creates a new instance of the MessageCancel Event Arguments
- </summary>
- <param name="message">A string message to convey with this event.</param>
- </member>
- <member name="P:DotSpatial.Data.MessageCancelEventArgs.Cancel">
- <summary>
- Returns a boolean specifying whether the action that caused this event should be canceled.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.MessageCancelEventArgs.Message">
- <summary>
- The message allowing someone to decide whether or not the process should be cancelled. For instance,
- when writing a new file, a message might show "The file C:\bob.txt already exists, overwrite it?"
- </summary>
- </member>
- <member name="T:DotSpatial.Data.NamedList`1">
- <summary>
- A named list preserves a 1:1 mapping between names and items. It can be used to
- reference information in either direction. It essentially provides a string
- handle for working with generic typed ILists. This cannot instantiate new
- items. (Creating a default T would not work, for instance, for an interface).
- </summary>
- </member>
- <member name="M:DotSpatial.Data.NamedList`1.#ctor">
- <summary>
- Creates a new instance of NamedList
- </summary>
- </member>
- <member name="M:DotSpatial.Data.NamedList`1.#ctor(System.Collections.Generic.IList{`0})">
- <summary>
- Creates a new instance of a named list.
- </summary>
- <param name="values">The values to use for the content.</param>
- </member>
- <member name="M:DotSpatial.Data.NamedList`1.#ctor(System.Collections.Generic.IList{`0},System.String)">
- <summary>
- Creates a new instance of a named list.
- </summary>
- <param name="values">The values to use for the content.</param>
- <param name="baseName">The string that should preceed the numbering to describe the individual items.</param>
- </member>
- <member name="M:DotSpatial.Data.NamedList`1.Demote(System.String)">
- <summary>
- Re-orders the list so that the index of the specifeid item is lower,
- and threfore will be drawn earlier, and therefore should appear
- in a lower position on the list.
- </summary>
- <param name="name"></param>
- </member>
- <member name="M:DotSpatial.Data.NamedList`1.GetNameOfObject(System.Object)">
- <summary>
- Gets the name of the item corresponding
- </summary>
- <param name="value">The item cast as an object.</param>
- <returns>The string name of the specified object, or null if the cast fails.</returns>
- </member>
- <member name="M:DotSpatial.Data.NamedList`1.GetItem(System.String)">
- <summary>
- Gets the item with the specified name as an object.
- This enables the INamedList to work with items even
- if it doesn't know the strong type.
- </summary>
- <param name="name">The string name of the item to retrieve</param>
- <returns>The actual item cast as an object.</returns>
- </member>
- <member name="M:DotSpatial.Data.NamedList`1.GetNames">
- <summary>
- Gets the list of names for the items currently stored in the list,
- in the sequence defined by the list of items.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.NamedList`1.Promote(System.String)">
- <summary>
- Re-orders the list so that the index of the specified item is higher,
- and therefore will be drawn later, and therefore should appear
- in a higher position on the list.
- </summary>
- <param name="name"></param>
- </member>
- <member name="M:DotSpatial.Data.NamedList`1.RefreshNames">
- <summary>
- Updates the names to match the current set of actual items.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.NamedList`1.Remove(System.String)">
- <summary>
- Removes the item with the specified name from the list.
- </summary>
- <param name="name">The string name of the item to remove</param>
- </member>
- <member name="M:DotSpatial.Data.NamedList`1.Demote(`0)">
- <summary>
- Re-orders the list so that this item appears closer to the 0 index.
- </summary>
- <param name="item"></param>
- </member>
- <member name="M:DotSpatial.Data.NamedList`1.GetName(`0)">
- <summary>
- Gets the string name for the specified item
- </summary>
- <param name="item">The item of type T to find the name for</param>
- <returns>The string name corresponding to the specified item.</returns>
- </member>
- <member name="M:DotSpatial.Data.NamedList`1.Promote(`0)">
- <summary>
- Re-orders the list so that the index of the specified item is higher,
- and therefore will be drawn later, and therefore should appear
- in a higher position on the list.
- </summary>
- <param name="item"></param>
- </member>
- <member name="M:DotSpatial.Data.NamedList`1.Remove(`0)">
- <summary>
- Removes the specified item
- </summary>
- <param name="item">The item to remove.</param>
- </member>
- <member name="P:DotSpatial.Data.NamedList`1.Item(System.String)">
- <summary>
- Gets or sets the item corresponding to the specified name. Setting this
- will re-use the same name and position in the list, but set a new object.
- </summary>
- <param name="name">The string name of the item to obtain</param>
- <returns>The item of type T corresponding to the specified name</returns>
- </member>
- <member name="P:DotSpatial.Data.NamedList`1.Items">
- <summary>
- Gets the list of actual items. This is basically a reference copy of
- the actual collection of items to be contained in this named list.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.NamedList`1.BaseName">
- <summary>
- Gets or sets the base name to use for naming items
- </summary>
- </member>
- <member name="P:DotSpatial.Data.NamedList`1.Count">
- <summary>
- Gets the count of the items in the list.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.NonNumericException">
- <summary>
- NonNumericException
- </summary>
- </member>
- <member name="M:DotSpatial.Data.NonNumericException.#ctor(System.String)">
- <summary>
- Creates a new instance of NonNumericException
- </summary>
- <param name="invalidVariable">The string name of the variable, or value that cannot be parsed as a number.</param>
- </member>
- <member name="T:DotSpatial.Data.Number">
- <summary>
- NumberFormat
- </summary>
- </member>
- <member name="M:DotSpatial.Data.Number.#ctor(System.Object)">
- <summary>
- Creates a value from an object
- </summary>
- <param name="value">A numeric value that is, or can be parsed to a numeric value.</param>
- <exception cref="T:DotSpatial.Data.NonNumericException">Not Numeric</exception>
- </member>
- <member name="M:DotSpatial.Data.Number.#ctor(System.Double)">
- <summary>
- Creates a number to fit the specified double value.
- </summary>
- <param name="value">A double</param>
- </member>
- <member name="M:DotSpatial.Data.Number.#ctor(System.Int32)">
- <summary>
- Creates a number to fit the specified int value
- </summary>
- <param name="value">An integer</param>
- </member>
- <member name="M:DotSpatial.Data.Number.#ctor(System.Single)">
- <summary>
- Creates a number to fit the specified float value
- </summary>
- <param name="value">The value to work with</param>
- </member>
- <member name="M:DotSpatial.Data.Number.#ctor(System.Int16)">
- <summary>
- Creates a number from a short
- </summary>
- <param name="value">A short</param>
- </member>
- <member name="M:DotSpatial.Data.Number.CompareTo(System.Object)">
- <summary>
- Compares this with the specified value. Returns 1 if the other
- item is greater than this value, 0 if they are equal and -1 if
- the other value is less than this value.
- </summary>
- <param name="other">The value to be tested.</param>
- <returns>An integer: 1 if the other
- item is greater than this value, 0 if they are equal and -1 if
- the other value is less than this value. </returns>
- </member>
- <member name="M:DotSpatial.Data.Number.CompareTo(System.Double)">
- <summary>
- Compares this with the specified value. Returns 1 if the other
- item is greater than this value, 0 if they are equal and -1 if
- the other value is less than this value.
- </summary>
- <param name="other">The value to be tested.</param>
- <returns>An integer: 1 if the other
- item is greater than this value, 0 if they are equal and -1 if
- the other value is less than this value. </returns>
- </member>
- <member name="M:DotSpatial.Data.Number.CompareTo(DotSpatial.Data.Number)">
- <summary>
- Compares this with the specified value. Returns 1 if the other
- item is greater than this value, 0 if they are equal and -1 if
- the other value is less than this value.
- </summary>
- <param name="other">The value to be tested.</param>
- <returns>An integer: 1 if the other
- item is greater than this value, 0 if they are equal and -1 if
- the other value is less than this value. </returns>
- </member>
- <member name="M:DotSpatial.Data.Number.ToString">
- <summary>
- Returns this Number as a string.
- </summary>
- <returns>The string created using the specified number format and precision.</returns>
- </member>
- <member name="M:DotSpatial.Data.Number.ToString(System.IFormatProvider)">
- <summary>
- Returns this Number as a string.
- </summary>
- <param name="provider">An IFormatProvider that provides culture specific formatting information.</param>
- <returns>A string with the formatted number.</returns>
- </member>
- <member name="M:DotSpatial.Data.Number.ToString(System.String)">
- <summary>
- Returns this Number as a string.
- </summary>
- <param name="format">A string that controls how this value should be formatted.</param>
- <returns>A string with the formatted number.</returns>
- </member>
- <member name="M:DotSpatial.Data.Number.ToString(System.String,System.IFormatProvider)">
- <summary>
- Returns this Number as a string.
- </summary>
- <param name="format">A string that controls how this value should be formatted.</param>
- <param name="provider">An IFormatProvider that provides culture specific formatting information.</param>
- <returns>A string with the formatted number.</returns>
- </member>
- <member name="M:DotSpatial.Data.Number.ToInt32">
- <summary>
- Gets this number as an int 32
- </summary>
- <returns>An integer</returns>
- </member>
- <member name="M:DotSpatial.Data.Number.ToInt16">
- <summary>
- Gets this number as a short, or a short.MaxValue/short.MinValue
- </summary>
- <returns>A short</returns>
- </member>
- <member name="M:DotSpatial.Data.Number.ToFloat">
- <summary>
- Gets this number as a float
- </summary>
- <returns>A float </returns>
- </member>
- <member name="P:DotSpatial.Data.Number.Code">
- <summary>
- Gets the alphabetical letter code for ToString(-Code-)
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Number.Format">
- <summary>
- A NumberFormats enumeration giving the various formatting options
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Number.IsEmpty">
- <summary>
- Tests to see if a value has been assigned to this Number
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Number.DecimalsCount">
- <summary>
- Gets or sets the number of digits that folow the decimal
- when converting this value to string notation.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Number.SignificantFigures">
- <summary>
- Gets the precision (determined by the data type) which
- effectively describes how many significant figures there are.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.Number.Value">
- <summary>
- Gets this number as a double
- </summary>
- <returns>a double</returns>
- </member>
- <member name="T:DotSpatial.Data.NumberFormat">
- <summary>
- NumberFormats
- </summary>
- </member>
- <member name="F:DotSpatial.Data.NumberFormat.Currency">
- <summary>
- Currency - C
- </summary>
- </member>
- <member name="F:DotSpatial.Data.NumberFormat.Exponential">
- <summary>
- Scientific Notation Exponential - E
- </summary>
- </member>
- <member name="F:DotSpatial.Data.NumberFormat.FixedPoint">
- <summary>
- Fixed point - F
- The number is converted to a string of the form "-ddd.ddd…" where each 'd'
- indicates a digit (0-9). The string starts with a minus sign if the number
- is negative.
- </summary>
- </member>
- <member name="F:DotSpatial.Data.NumberFormat.General">
- <summary>
- Shortest text - G
- </summary>
- </member>
- <member name="F:DotSpatial.Data.NumberFormat.Number">
- <summary>
- Number - N, The number is converted to a string of the form "-d, ddd, ddd.ddd…",
- where '-' indicates a negative number symbol if required, 'd' indicates a digit
- (0-9), ',' indicates a thousand separator between number groups, and '.' indicates
- a decimal point symbol
- </summary>
- </member>
- <member name="F:DotSpatial.Data.NumberFormat.Percent">
- <summary>
- Percent, value is multiplied by 100 and shown with a % symbol (cultural specific)
- </summary>
- </member>
- <member name="F:DotSpatial.Data.NumberFormat.Unspecified">
- <summary>
- No format specified.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.ReadOnlyList`1">
- <summary>
- In cases where we want to allow some basic cycling or checking of values, but we don't want the user to change
- the values directly, we can wrap the values in this read-only list, which restricts what the user can do.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ReadOnlyList`1.#ctor(System.Collections.Generic.IList{`0})">
- <summary>
- Creates a new instance of ReadOnlyList
- </summary>
- </member>
- <member name="M:DotSpatial.Data.ReadOnlyList`1.Contains(`0)">
- <summary>
- Tests to see if the specified item is contained in the list. This returns true if the item is contained in the list.
- </summary>
- <param name="item">The item to test for.</param>
- <returns>Boolean, true if the item is found in the list</returns>
- </member>
- <member name="M:DotSpatial.Data.ReadOnlyList`1.CopyTo(`0[],System.Int32)">
- <summary>
- Copies the specified memebers into the array, starting at the specified index.
- </summary>
- <param name="array">The array to copy values to.</param>
- <param name="arrayIndex">The array index where the 0 member of this list should be copied to.</param>
- </member>
- <member name="M:DotSpatial.Data.ReadOnlyList`1.GetEnumerator">
- <summary>
- Obtains an enumerator for cycling through the values in this list.
- </summary>
- <returns>An enumerator for the items in this list.</returns>
- </member>
- <member name="M:DotSpatial.Data.ReadOnlyList`1.IndexOf(`0)">
- <summary>
- Obtains the index of the specified item
- </summary>
- <param name="item">The item to find the index of</param>
- <returns>An integer representing the index of the specified item</returns>
- </member>
- <member name="P:DotSpatial.Data.ReadOnlyList`1.Count">
- <summary>
- Gets the integer count of items in this list.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ReadOnlyList`1.IsReadOnly">
- <summary>
- Return true because this is a read-only list.
- </summary>
- </member>
- <member name="P:DotSpatial.Data.ReadOnlyList`1.Item(System.Int32)">
- <summary>
- Gets the item at the specified index. Ideally, this ReadOnlyList is used with
- value types, or else this gives the user considerable power over the core content.
- </summary>
- <param name="index">The item to obtain from this list</param>
- <returns>The item at the specified index.</returns>
- </member>
- <member name="T:DotSpatial.Data.SubclassList`2">
- <summary>
- SubclassList is brilliant if I do say so myself. Let's say you have a list of IPointCategory, which is a subclass of IFeatureCategory.
- You can't have a strong typed List that is both without creating a special class that can deal with the specific implementations of
- each. So I was writing all of the stupid type specific collection classes, when in reality, I just needed a class like this
- that could handle the business logic. Then specific instances can just inherit from this class, but specify the two types.
- </summary>
- <typeparam name="TBase">The base type that is inherited</typeparam>
- <typeparam name="TSub">The sub type that inherits from the base type</typeparam>
- </member>
- <member name="M:DotSpatial.Data.SubclassList`2.Add(`1)">
- <summary>
- Allows adding of the sub type
- </summary>
- <param name="item"></param>
- </member>
- <member name="M:DotSpatial.Data.SubclassList`2.AddRange(System.Collections.Generic.IEnumerable{`1})">
- <summary>
- Adds the entire range of enumerable elements.
- </summary>
- <param name="items">The items to add</param>
- </member>
- <member name="M:DotSpatial.Data.SubclassList`2.Contains(`1)">
- <summary>
- Tests to see if the list contains the specified item.
- </summary>
- <param name="item">The item to check the list for.</param>
- <returns>Boolean, true if the item is contained in the list.</returns>
- </member>
- <member name="M:DotSpatial.Data.SubclassList`2.CopyTo(`1[],System.Int32)">
- <summary>
- Copies each of the members to the specified array.
- </summary>
- <param name="array">The array to copy items to.</param>
- <param name="arrayIndex">The zero based integer index in the destination array where the first item should be saved.</param>
- </member>
- <member name="M:DotSpatial.Data.SubclassList`2.GetEnumerator">
- <summary>
- Gets an enumerator of type TSub for cycling through the list.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.SubclassList`2.IndexOf(`1)">
- <summary>
- Gets the zero based integer index of the specified item of type TSub
- </summary>
- <param name="item">The item to obtain the index of</param>
- <returns>The zero based integer index of the specified item</returns>
- </member>
- <member name="M:DotSpatial.Data.SubclassList`2.Insert(System.Int32,`1)">
- <summary>
- inserts the specified item into the specified index
- </summary>
- <param name="index">The zero based integer index where insertion can take place</param>
- <param name="item">The item to insert of type TSub</param>
- </member>
- <member name="M:DotSpatial.Data.SubclassList`2.Remove(`1)">
- <summary>
- Removes the specified item from the list.
- </summary>
- <param name="item">The item to remove</param>
- <returns>Boolean, true if the item was found in the list and removed</returns>
- </member>
- <member name="P:DotSpatial.Data.SubclassList`2.Item(System.Int32)">
- <summary>
- Gets or sets the specific item in the list
- </summary>
- <param name="index"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Data.SubclassList`2.SubclassListEnumerator`2">
- <summary>
- I can't simply return the enumerator of the internal list because it would be the wrong type.
- Furthermore, I need to know both types so that I can cast them appropriately.
- </summary>
- <typeparam name="TB">The base type that is inherited</typeparam>
- <typeparam name="TS">The sub type that inherits from the base type</typeparam>
- </member>
- <member name="M:DotSpatial.Data.SubclassList`2.SubclassListEnumerator`2.#ctor(System.Collections.Generic.IEnumerator{`2})">
- <summary>
- Creates a new instance of the enumerator of the sub-type given an enumerator
- of the base type.
- </summary>
- <param name="internalEnumerator">The internal enumerator.</param>
- </member>
- <member name="M:DotSpatial.Data.SubclassList`2.SubclassListEnumerator`2.Dispose">
- <summary>
- Disposes any unmanaged memory objects
- </summary>
- </member>
- <member name="M:DotSpatial.Data.SubclassList`2.SubclassListEnumerator`2.MoveNext">
- <summary>
- Advances the enumerator to the next position
- </summary>
- <returns>Boolean, false at the end of the list.</returns>
- </member>
- <member name="M:DotSpatial.Data.SubclassList`2.SubclassListEnumerator`2.Reset">
- <summary>
- Resets the enumerator to the beginning of the list
- </summary>
- </member>
- <member name="P:DotSpatial.Data.SubclassList`2.SubclassListEnumerator`2.Current">
- <summary>
- Gets the current member returned as type TSub.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.TreeList`1">
- <summary>
- A list that keeps track of a "parent" body that is also of type T.
- Whenever a member is added to the list, it sets the parent property.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.#ctor">
- <summary>
- Initializes a new instance of list with no parent
- </summary>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.#ctor(`0)">
- <summary>
- Instantiates a new instance of a TreeList of type T, where the specified parent
- will be used as the parent for each of the items of type T in the list.
- </summary>
- <param name="parent">The ParentItem of the specified item</param>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.Add(`0)">
- <summary>
- Adds the item to the list, setting the parent to be the list's parent
- </summary>
- <param name="item"></param>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.AddRange(System.Collections.Generic.IEnumerable{`0})">
- <summary>
- Adds the elements of the specified collection to the end of the System.Collections.Generic.List<T>
- </summary>
- <param name="collection">collection: The collection whose elements should be added to the end of the
- System.Collections.Generic.List<T>. The collection itself cannot be null, but it can contain elements that are null,
- if type T is a reference type.</param>
- <exception cref="T:System.ApplicationException">Unable to add while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.BinarySearch(`0)">
- <summary>
- Searches the entire sorted System.Collections.Generic.List<T> for an element using the default comparer and returns the zero-based index of the element.
- </summary>
- <param name="item">The object to locate. The value can be null for reference types.</param>
- <returns>The zero-based index of item in the sorted System.Collections.Generic.List<T>, if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than item or, if there is no larger element, the bitwise complement of System.Collections.Generic.List<T>.Count.</returns>
- <exception cref="T:System.InvalidOperationException">The default comparer System.Collections.Generic.Comparer<T>.Default cannot find an implementation of the System.IComparable<T> generic interface or the System.IComparable interface for type T.</exception>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.Clear">
- <summary>
- Removes all elements from the EventList<T>.
- </summary>
- <exception cref="T:System.ApplicationException">Unable to clear while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.Contains(`0)">
- <summary>
- Determines whether an element is in the System.Collections.Generic.List<T>.
- </summary>
- <param name="item"> The object to locate in the System.Collections.Generic.List<T>. The value can be null for reference types.</param>
- <returns>true if item is found in the System.Collections.Generic.List<T>; otherwise, false.</returns>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.GetEnumerator">
- <summary>
- Returns an enumerator that iterates through this list
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.CopyTo(`0[],System.Int32)">
- <summary>
- Copies the entire System.Collections.Generic.List<T> to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional System.Array that is the destination of the elements copied from System.Collections.Generic.List<T>. The System.Array must have zero-based indexing.</param>
- <param name="arrayIndex"> The zero-based index in array at which copying begins.</param>
- <exception cref="T:System.ArgumentException">System.ArgumentException: arrayIndex is equal to or greater than the length of array.-or-The number of elements in the source System.Collections.Generic.List<T> is greater than the available space from arrayIndex to the end of the destination array. </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">arrayIndex is less than 0</exception>
- <exception cref="T:System.ArgumentNullException">array is null</exception>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.CopyTo(System.Int32,`0[],System.Int32,System.Int32)">
- <summary>
- Copies a range of elements from the EventList<T> to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="index">The zero-based index in the source EventList<T> at which copying begins</param>
- <param name="array">The one-dimensional System.Array that is the destination of the elements copied from EventList<T>. The System.Array must have zero-based indexing.</param>
- <param name="arrayIndex">The zero-based index in array at which copying begins.</param>
- <param name="count">The number of elements to copy.</param>
- <exception cref="T:System.ArgumentNullException">array is null.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException"> index is less than 0.-or-arrayIndex is less than 0.-or-count is less than 0.</exception>
- <exception cref="T:System.ArgumentException">index is equal to or greater than the EventList<T>.Count of the source EventList<T>.-or-arrayIndex is equal to or greater than the length of array.-or-The number of elements from index to the end of the source EventList<T> is greater than the available space from arrayIndex to the end of the destination array.</exception>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.CopyTo(`0[])">
- <summary>
- Copies the entire EventList<T> to a compatible one-dimensional array, starting at the beginning of the target array.
- </summary>
- <param name="array">The one-dimensional System.Array that is the destination of the elements copied from EventList<T>. The System.Array must have zero-based indexing.</param>
- <exception cref="T:System.ArgumentException">The number of elements in the source EventList<T> is greater than the number of elements that the destination array can contain.</exception>
- <exception cref="T:System.ArgumentNullException">array is null.</exception>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.ConvertAll``1(System.Converter{`0,``0})">
- <summary>
- Converts the elements in the current EventList<T> to another type, and returns a list containing the converted elements.
- </summary>
- <typeparam name="TOutput">The output type to convert to</typeparam>
- <param name="converter">A System.Converter<TInput, TOutput> delegate that converts each element from one type to another type.</param>
- <returns>A List<T> of the target type containing the converted elements from the current EventList<T>.</returns>
- <exception cref="T:System.ArgumentNullException">converter is null.</exception>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.Exists(System.Predicate{`0})">
- <summary>
- Determines whether the EventList<T> contains elements that match the conditions defined by the specified predicate.
- </summary>
- <param name="match">The System.Predicate<T> delegate that defines the conditions of the elements to search for.</param>
- <returns>true if the EventList<T> contains one or more elements that match the conditions defined by the specified predicate; otherwise, false.</returns>
- <exception cref="T:System.ArgumentNullException">match is null.</exception>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.GetRange(System.Int32,System.Int32)">
- <summary>
- Creates a shallow copy of a range of elements in the source EventList<T>.
- </summary>
- <param name="index">The zero-based EventList<T> index at which the range starts.</param>
- <param name="count"> The number of elements in the range.</param>
- <returns>A shallow copy of a range of elements in the source EventList<T>.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-count is less than 0.</exception>
- <exception cref="T:System.ArgumentException">index and count do not denote a valid range of elements in the EventList<T>.</exception>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.ToArray">
- <summary>
- Copies the elements of the DotSpatial.Interfaces.Framework.IEventList<T> to a new array.
- </summary>
- <returns>An array containing copies of the elements of the DotSpatial.Interfaces.Framework.IEventList<T>.</returns>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.TrimExcess">
- <summary>
- Sets the capacity to the actual number of elements in the DotSpatial.Interfaces.Framework.IEventList<T>, if that number is less than a threshold value.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.TrueForAll(System.Predicate{`0})">
- <summary>
- Determines whether every element in the DotSpatial.Interfaces.Framework.IEventList<T> matches the conditions defined by the specified predicate.
- </summary>
- <param name="match">The System.Predicate<T> delegate that defines the conditions to check against the elements.</param>
- <returns>true if every element in the DotSpatial.Interfaces.Framework.IEventList<T> matches the conditions defined by the specified predicate; otherwise, false. If the list has no elements, the return value is true.</returns>
- <exception cref="T:System.ArgumentNullException">match is null.</exception>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.IndexOf(`0)">
- <summary>
- Searches for the specified object and returns the zero-based index of the first occurrence within the entire System.Collections.Generic.List<T>.
- </summary>
- <param name="item">The object to locate in the System.Collections.Generic.List<T>. The value can be null for reference types.</param>
- <returns>The zero-based index of the first occurrence of item within the entire System.Collections.Generic.List<T>, if found; otherwise, –1.</returns>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.IndexOf(`0,System.Int32,System.Int32)">
- <summary>
- Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the EventList<T> that starts at the specified index and contains the specified number of elements.
- </summary>
- <param name="item">The object to locate in the EventList<T>. The value can be null for reference types.</param>
- <param name="index"> The zero-based starting index of the search.</param>
- <param name="count">The number of elements in the section to search.</param>
- <returns>The zero-based index of the first occurrence of item within the range of elements in the EventList<T> that starts at index and contains count number of elements, if found; otherwise, –1.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException"> index is outside the range of valid indexes for the EventList<T>.-or-count is less than 0.-or-index and count do not specify a valid section in the EventList<T>.</exception>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.IndexOf(`0,System.Int32)">
- <summary>
- Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the EventList<T> that extends from the specified index to the last element.
- </summary>
- <param name="item">The object to locate in the EventList<T>. The value can be null for reference types.</param>
- <param name="index"> The zero-based starting index of the search.</param>
- <returns>The zero-based index of the first occurrence of item within the range of elements in the EventList<T> that extends from index to the last element, if found; otherwise, –1.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">index is outside the range of valid indexes for the EventList<T>.</exception>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.Insert(System.Int32,`0)">
- <summary>
- Inserts an element into the System.Collections.Generic.List<T> at the specified index.
- </summary>
- <param name="index">The zero-based index at which item should be inserted.</param>
- <param name="item">The object to insert. The value can be null for reference types.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-index is greater than System.Collections.Generic.List<T>.Count.</exception>
- <exception cref="T:System.ApplicationException">Unable to insert while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{`0})">
- <summary>
- Inserts the elements of a collection into the EventList<T> at the specified index.
- </summary>
- <param name="index">The zero-based index at which the new elements should be inserted.</param>
- <param name="collection">The collection whose elements should be inserted into the EventList<T>. The collection itself cannot be null, but it can contain elements that are null, if type T is a reference type.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-index is greater than EventList<T>.Count.</exception>
- <exception cref="T:System.ArgumentNullException">collection is null.</exception>
- <exception cref="T:System.ApplicationException">Unable to insert while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.LastIndexOf(`0,System.Int32,System.Int32)">
- <summary>
- Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the EventList<T> that contains the specified number of elements and ends at the specified index.
- </summary>
- <param name="item">The object to locate in the EventList<T>. The value can be null for reference types.</param>
- <param name="index">The zero-based starting index of the backward search.</param>
- <param name="count">The number of elements in the section to search.</param>
- <returns>The zero-based index of the last occurrence of item within the range of elements in the EventList<T> that contains count number of elements and ends at index, if found; otherwise, –1.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">index is outside the range of valid indexes for the EventList<T>.-or-count is less than 0.-or-index and count do not specify a valid section in the EventList<T>.</exception>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.LastIndexOf(`0,System.Int32)">
- <summary>
- Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the EventList<T> that extends from the first element to the specified index.
- </summary>
- <param name="item">The object to locate in the EventList<T>. The value can be null for reference types.</param>
- <param name="index">The zero-based starting index of the backward search.</param>
- <returns>The zero-based index of the last occurrence of item within the range of elements in the EventList<T> that extends from the first element to index, if found; otherwise, –1.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">index is outside the range of valid indexes for the EventList<T>.</exception>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.LastIndexOf(`0)">
- <summary>
- Searches for the specified object and returns the zero-based index of the last occurrence within the entire EventList<T>.
- </summary>
- <param name="item">The object to locate in the EventList<T>. The value can be null for reference types.</param>
- <returns>The zero-based index of the last occurrence of item within the entire the EventList<T>, if found; otherwise, –1.</returns>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.Remove(`0)">
- <summary>
- Removes the first occurrence of a specific object from the System.Collections.Generic.List<T>.
- </summary>
- <param name="item">The object to remove from the System.Collections.Generic.List<T>. The value can be null for reference types.</param>
- <returns>true if item is successfully removed; otherwise, false. This method also returns false if item was not
- found in the System.Collections.Generic.List<T>.</returns>
- <exception cref="T:System.ApplicationException">Unable to remove while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.RemoveAt(System.Int32)">
- <summary>
- Removes the element at the specified index of the System.Collections.Generic.List<T>.
- </summary>
- <param name="index">The zero-based index of the element to remove.</param>
- <exception cref="T:System.ApplicationException">Unable to remove while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.RemoveAll(System.Predicate{`0})">
- <summary>
- Removes the all the elements that match the conditions defined by the specified predicate.
- </summary>
- <param name="match">The System.Predicate<T> delegate that defines the conditions of the elements to remove.</param>
- <returns>The number of elements removed from the EventList<T></returns>
- <exception cref="T:System.ArgumentNullException">match is null.</exception>
- <exception cref="T:System.ApplicationException">Unable to remove while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.RemoveRange(System.Int32,System.Int32)">
- <summary>
- Removes a range of elements from the EventList<T>.
- </summary>
- <param name="index">The zero-based starting index of the range of elements to remove.</param>
- <param name="count">The number of elements to remove.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-count is less than 0.</exception>
- <exception cref="T:System.ArgumentException">index and count do not denote a valid range of elements in the EventList<T>.</exception>
- <exception cref="T:System.ApplicationException">Unable to remove while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.Reverse(System.Int32,System.Int32)">
- <summary>
- Reverses the order of the elements in the specified range.
- </summary>
- <param name="index">The zero-based starting index of the range to reverse.</param>
- <param name="count">The number of elements in the range to reverse.</param>
- <exception cref="T:System.ArgumentException">index and count do not denote a valid range of elements in the EventList<T>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-count is less than 0.</exception>
- <exception cref="T:System.ApplicationException">Unable to reverse while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.Reverse">
- <summary>
- Reverses the order of the elements in the entire EventList<T>.
- </summary>
- <exception cref="T:System.ApplicationException">Unable to reverse while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.Sort(System.Comparison{`0})">
- <summary>
- Sorts the elements in the entire EventList<T> using the specified System.Comparison<T>.
- </summary>
- <param name="comparison">The System.Comparison<T> to use when comparing elements.</param>
- <exception cref="T:System.ArgumentException">The implementation of comparison caused an error during the sort. For example, comparison might not return 0 when comparing an item with itself.</exception>
- <exception cref="T:System.ArgumentNullException">comparison is null.</exception>
- <exception cref="T:System.ApplicationException">Unable to sort while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.Sort(System.Int32,System.Int32,System.Collections.Generic.IComparer{`0})">
- <summary>
- Sorts the elements in a range of elements in EventList<T> using the specified comparer.
- </summary>
- <param name="index"> The zero-based starting index of the range to sort.</param>
- <param name="count">The length of the range to sort.</param>
- <param name="comparer">The System.Collections.Generic.IComparer<T> implementation to use when comparing elements, or null to use the default comparer System.Collections.Generic.Comparer<T>.Default.</param>
- <exception cref="T:System.ArgumentException">index and count do not specify a valid range in the EventList<T>.-or-The implementation of comparer caused an error during the sort. For example, comparer might not return 0 when comparing an item with itself.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-count is less than 0.</exception>
- <exception cref="T:System.InvalidOperationException"> comparer is null, and the default comparer
- System.Collections.Generic.Comparer<T>.Default cannot find implementation of the System.IComparable<T>
- generic interface or the System.IComparable interface for type T.</exception>
- <exception cref="T:System.ApplicationException">Unable to sort while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.Sort(System.Collections.Generic.IComparer{`0})">
- <summary>
- Sorts the elements in the entire DotSpatial.Interfaces.Framework.IEventList<T> using the specified comparer.
- </summary>
- <param name="comparer"> The System.Collections.Generic.IComparer<T> implementation to use when comparing elements, or null to use the default comparer System.Collections.Generic.Comparer<T>.Default.</param>
- <exception cref="T:System.ArgumentException">The implementation of comparer caused an error during the sort. For example, comparer might not return 0 when comparing an item with itself.</exception>
- <exception cref="T:System.InvalidOperationException">comparer is null, and the default comparer System.Collections.Generic.Comparer<T>.Default cannot find implementation of the System.IComparable<T> generic interface or the System.IComparable interface for type T.</exception>
- <exception cref="T:System.ApplicationException">Unable to sort while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.Sort">
- <summary>
- Sorts the elements in the entire DotSpatial.Interfaces.Framework.IEventList<T> using the default comparer.
- </summary>
- <exception cref="T:System.InvalidOperationException">The default comparer System.Collections.Generic.Comparer<T>.Default cannot find an implementation of the System.IComparable<T> generic interface or the System.IComparable interface for type T.</exception>
- <exception cref="T:System.ApplicationException">Unable to sort while the ReadOnly property is set to true.</exception>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.FindAll(System.Predicate{`0})">
- <summary>
- Retrieves all the elements that match the conditions described by the specified predicate
- </summary>
- <param name="match">The System.Predicate that defines the conditions to search for</param>
- <returns>A List of matches</returns>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.FindIndex(System.Int32,System.Int32,System.Predicate{`0})">
- <summary>
- Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the EventList<T> that starts at the specified index and contains the specified number of elements.
- </summary>
- <param name="startIndex">The zero-based starting index of the search.</param>
- <param name="count">The number of elements in the section to search.</param>
- <param name="match"> The System.Predicate<T> delegate that defines the conditions of the element to search for.</param>
- <returns>The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">startIndex is outside the range of valid indexes for the EventList<T>.-or-count is less than 0.-or-startIndex and count do not specify a valid section in the EventList<T>.</exception>
- <exception cref="T:System.ArgumentNullException">match is null</exception>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.FindIndex(System.Int32,System.Predicate{`0})">
- <summary>
- Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the EventList<T> that extends from the specified index to the last element.
- </summary>
- <param name="startIndex">The zero-based starting index of the search.</param>
- <param name="match">The System.Predicate<T> delegate that defines the conditions of the element to search for.</param>
- <returns>The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">startIndex is outside the range of valid indexes for the EventList<T>.</exception>
- <exception cref="T:System.ArgumentNullException">match is null.</exception>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.FindIndex(System.Predicate{`0})">
- <summary>
- Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the entire EventList<T>.
- </summary>
- <param name="match">The System.Predicate<T> delegate that defines the conditions of the element to search for.</param>
- <returns>The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1.</returns>
- <exception cref="T:System.ArgumentNullException">match is null.</exception>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.FindLast(System.Predicate{`0})">
- <summary>
- Searches for an element that matches the conditions defined by the specified predicate, and returns the last occurrence within the entire EventList<T>.
- </summary>
- <param name="match">The System.Predicate<T> delegate that defines the conditions of the element to search for.</param>
- <returns>The last element that matches the conditions defined by the specified predicate, if found; otherwise, the default value for type T.</returns>
- <exception cref="T:System.ArgumentNullException">match is null."</exception>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.FindLastIndex(System.Int32,System.Int32,System.Predicate{`0})">
- <summary>
- Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the range of elements in the EventList<T> that contains the specified number of elements and ends at the specified index.
- </summary>
- <param name="startIndex">The zero-based starting index of the backward search.</param>
- <param name="count">The number of elements in the section to search.</param>
- <param name="match"></param>
- <returns>The System.Predicate<T> delegate that defines the conditions of the element to search for.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">startIndex is outside the range of valid indexes for the EventList<T>.-or-count is less than 0.-or-startIndex and count do not specify a valid section in the EventList<T>.</exception>
- <exception cref="T:System.ArgumentNullException">match is null.</exception>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.FindLastIndex(System.Int32,System.Predicate{`0})">
- <summary>
- Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the range of elements in the EventList<T> that extends from the first element to the specified index.
- </summary>
- <param name="startIndex"> The zero-based starting index of the backward search.</param>
- <param name="match">The System.Predicate<T> delegate that defines the conditions of the element to search for.</param>
- <returns>The zero-based index of the last occurrence of an element that matches the conditions defined by match, if found; otherwise, –1.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">: startIndex is outside the range of valid indexes for the EventList<T>.</exception>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.FindLastIndex(System.Predicate{`0})">
- <summary>
- Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the entire EventList<T>.
- </summary>
- <param name="match">The System.Predicate<T> delegate that defines the conditions of the element to search for.</param>
- <returns>The zero-based index of the last occurrence of an element that matches the conditions defined by match, if found; otherwise, –1.</returns>
- <exception cref="T:System.ArgumentNullException">match is null.</exception>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.OnInclude(`0)">
- <summary>
- This sets the parent item of the item being added to this treelist.
- </summary>
- <param name="item">The item being included</param>
- </member>
- <member name="M:DotSpatial.Data.TreeList`1.OnExclude(`0)">
- <summary>
- This reverts the parent item of an item when it is removed from this treelist
- </summary>
- <param name="item">The item being removed from the list</param>
- </member>
- <member name="P:DotSpatial.Data.TreeList`1.Capacity">
- <summary>
- Gets or sets the total number of elements the internal data structure can hold without resizing.
- </summary>
- <returns>
- The number of elements that the DotSpatial.Interfaces.Framework.IEventList<T> can contain before resizing is required.
- </returns>
- <exception cref="T:System.ArgumentOutOfRangeException">DotSpatial.Interfaces.Framework.IEventList<T>.Capacity is set to a value that is less than DotSpatial.Interfaces.Framework.IEventList<T>.Count.</exception>
- </member>
- <member name="P:DotSpatial.Data.TreeList`1.Count">
- <summary>
- Gets the count of the members in the list
- </summary>
- </member>
- <member name="P:DotSpatial.Data.TreeList`1.Item(System.Int32)">
- <summary>
- The default, indexed value of type T
- </summary>
- <param name="index">The numeric index</param>
- <returns>An object of type T corresponding to the index value specified</returns>
- </member>
- <member name="P:DotSpatial.Data.TreeList`1.IsReadOnly">
- <summary>
- Gets a boolean property indicating whether this list can be written to.
- </summary>
- </member>
- <member name="T:DotSpatial.Data.ValidationType">
- <summary>
- ValidationType
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ValidationType.None">
- <summary>
- No validation will be performed
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ValidationType.String">
- <summary>
- Any string value, including null will be accepted
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ValidationType.Byte">
- <summary>
- Only values that can be parsed to byte values will be accepted
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ValidationType.Short">
- <summary>
- Only values that can be parsed to short values will be accepted
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ValidationType.Integer">
- <summary>
- Only values that can be parsed to integer values will be accepted
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ValidationType.Float">
- <summary>
- Only values that can be parsed to float values will be accepted
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ValidationType.Double">
- <summary>
- Only values that can be parsed to double values will be accepted
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ValidationType.PositiveShort">
- <summary>
- Only values that can be parsed to positive short values will be accepted
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ValidationType.PositiveInteger">
- <summary>
- Only values that can be parsed to positive integer values will be accepted
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ValidationType.PositiveFloat">
- <summary>
- Only values that can be parsed to positive float values will be accepted
- </summary>
- </member>
- <member name="F:DotSpatial.Data.ValidationType.PositiveDouble">
- <summary>
- Only values that can be parsed to positive double values will be accepted
- </summary>
- </member>
- <member name="T:DotSpatial.Data.MockICancelProgressHandler">
- <summary>
- This class converts an IProgressHandler to an ICancelProgressHandler. It wraps the IProgressHandler so that
- it can be used by a class that requires an ICancelProgressHandler. Cancel will always return false.
- </summary>
- </member>
- <member name="M:DotSpatial.Data.MockICancelProgressHandler.#ctor(DotSpatial.Data.IProgressHandler)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Data.MockICancelProgressHandler"/> class.
- </summary>
- <param name="progressHandler">The progress handler.</param>
- </member>
- <member name="M:DotSpatial.Data.MockICancelProgressHandler.Progress(System.String,System.Int32,System.String)">
- <summary>
- Progress is the method that should receive a progress message.
- </summary>
- <param name="key">The message string without any information about the status of completion.</param>
- <param name="percent">An integer from 0 to 100 that indicates the condition for a status bar etc.</param>
- <param name="message">A string containing both information on what the process is, as well as its completion status.</param>
- </member>
- <member name="P:DotSpatial.Data.MockICancelProgressHandler.Cancel">
- <summary>
- Returns true if the running process should be cancelled
- </summary>
- </member>
- </members>
-</doc>
diff --git a/MES_Wind/bin/Debug/DotSpatial.Extensions.pdb b/MES_Wind/bin/Debug/DotSpatial.Extensions.pdb
deleted file mode 100644
index 94d43b5c542c800d5165a1a6b3cd0fa8ad693bfe..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/DotSpatial.Extensions.pdb and /dev/null differ
diff --git a/MES_Wind/bin/Debug/DotSpatial.Extensions.xml b/MES_Wind/bin/Debug/DotSpatial.Extensions.xml
deleted file mode 100644
index 23287b90310b75aa2eb33dfe61cdfc2758ae5443..0000000000000000000000000000000000000000
--- a/MES_Wind/bin/Debug/DotSpatial.Extensions.xml
+++ /dev/null
@@ -1,236 +0,0 @@
-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>DotSpatial.Extensions</name>
- </assembly>
- <members>
- <member name="T:DotSpatial.Extensions.AssemblyInformation">
- <summary>
- Information about the assembly containing the extension
- </summary>
- </member>
- <member name="P:DotSpatial.Extensions.AssemblyInformation.ReferenceType">
- <summary>
- The type of the referenced class
- </summary>
- </member>
- <member name="P:DotSpatial.Extensions.AssemblyInformation.ReferenceAssembly">
- <summary>
- Gets the reference assembly.
- </summary>
- </member>
- <member name="P:DotSpatial.Extensions.AssemblyInformation.ReferenceFile">
- <summary>
- Gets the reference file.
- </summary>
- </member>
- <member name="P:DotSpatial.Extensions.AssemblyInformation.Author">
- <summary>
- Author of the plugin.
- </summary>
- <remarks>This setter should be overriden by a derived class (if needed).</remarks>
- </member>
- <member name="P:DotSpatial.Extensions.AssemblyInformation.BuildDate">
- <summary>
- Build date.
- </summary>
- </member>
- <member name="P:DotSpatial.Extensions.AssemblyInformation.Description">
- <summary>
- Short description of the plugin.
- </summary>
- <remarks>This setter should be overriden by a derived class (if needed).</remarks>
- </member>
- <member name="P:DotSpatial.Extensions.AssemblyInformation.Name">
- <summary>
- Name of the plugin.
- </summary>
- <remarks>This setter should be overriden by a derived class (if needed).</remarks>
- </member>
- <member name="P:DotSpatial.Extensions.AssemblyInformation.Version">
- <summary>
- Plugin version.
- </summary>
- <remarks>This setter should be overriden by a derived class (if needed).</remarks>
- </member>
- <member name="P:DotSpatial.Extensions.AssemblyInformation.AssemblyQualifiedName">
- <summary>
- Gets the name of the assembly and class.
- </summary>
- </member>
- <member name="T:DotSpatial.Extensions.IExtension">
- <summary>
- The IExtension interface represents the shared content between all providers and plugins. This simply acts like
- an on-off switch for enabling or disabling the extension.
- </summary>
- </member>
- <member name="M:DotSpatial.Extensions.IExtension.Activate">
- <summary>
- Activates this extension
- </summary>
- </member>
- <member name="M:DotSpatial.Extensions.IExtension.Deactivate">
- <summary>
- Deactivates this extension
- </summary>
- </member>
- <member name="P:DotSpatial.Extensions.IExtension.IsActive">
- <summary>
- Gets or sets a boolean that is true if the extension is active and running.
- </summary>
- </member>
- <member name="P:DotSpatial.Extensions.IExtension.DeactivationAllowed">
- <summary>
- Gets a value indicating whether [deactivation is allowed].
- </summary>
- <value>
- <c>true</c> if [deactivation is allowed]; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:DotSpatial.Extensions.IExtension.Author">
- <summary>
- Gets the author.
- </summary>
- </member>
- <member name="P:DotSpatial.Extensions.IExtension.BuildDate">
- <summary>
- Gets the build date.
- </summary>
- </member>
- <member name="P:DotSpatial.Extensions.IExtension.Description">
- <summary>
- Gets the description.
- </summary>
- </member>
- <member name="P:DotSpatial.Extensions.IExtension.Name">
- <summary>
- Gets the name.
- </summary>
- </member>
- <member name="P:DotSpatial.Extensions.IExtension.Version">
- <summary>
- Gets the version.
- </summary>
- </member>
- <member name="P:DotSpatial.Extensions.IExtension.AssemblyQualifiedName">
- <summary>
- Gets the Assembly Qualified FullName.
- </summary>
- </member>
- <member name="P:DotSpatial.Extensions.IExtension.Priority">
- <summary>
- Specifies the activation priority order
- </summary>
- </member>
- <member name="T:DotSpatial.Extensions.IExtensionExtensionMethods">
- <summary>
- Extension methods for IExtension
- </summary>
- </member>
- <member name="M:DotSpatial.Extensions.IExtensionExtensionMethods.TryActivate(DotSpatial.Extensions.IExtension)">
- <summary>
- Tries to activate the extension.
- </summary>
- <param name="extension">The extension.</param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Extensions.IProjectFileProvider.FileTypeDescription">
- <summary>
- Gets the file type description.
- </summary>
- </member>
- <member name="P:DotSpatial.Extensions.IProjectFileProvider.Extension">
- <summary>
- Gets the extension, which by convention will be lower case.
- </summary>
- </member>
- <member name="M:DotSpatial.Extensions.IOpenProjectFileProvider.Open(System.String)">
- <summary>
- Opens the specified file name.
- </summary>
- <param name="fileName">Name of the file.</param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Extensions.ISampleProject">
- <summary>
- Used to specify a sample .dspx project that the user can download as a package and open.
- </summary>
- </member>
- <member name="P:DotSpatial.Extensions.ISampleProject.AbsolutePathToProjectFile">
- <summary>
- Gets the absolute path to project file. This includes the directory, filename, and extension
- </summary>
- </member>
- <member name="P:DotSpatial.Extensions.ISampleProject.Name">
- <summary>
- Gets the name to display to the user when they are selecting a project.
- </summary>
- </member>
- <member name="P:DotSpatial.Extensions.ISampleProject.Description">
- <summary>
- Gets the description of the project
- </summary>
- </member>
- <member name="M:DotSpatial.Extensions.ISaveProjectFileProvider.Save(System.String,System.String)">
- <summary>
- Saves the specified file.
- </summary>
- <param name="fileName">Name of the file.</param>
- <param name="graph">The control graph.</param>
- </member>
- <member name="T:DotSpatial.Extensions.ISatisfyImportsExtension">
- <summary>
- Extensions of this type are activiated before other extensions and may be used to help satisfy required imports.
- </summary>
- </member>
- <member name="M:DotSpatial.Extensions.ISatisfyImportsExtension.Activate">
- <summary>
- Activates this extension
- </summary>
- </member>
- <member name="P:DotSpatial.Extensions.ISatisfyImportsExtension.Priority">
- <summary>
- Specifies the activation priority order
- </summary>
- </member>
- <member name="T:DotSpatial.Extensions.SplashScreens.ISplashScreenManager">
- <summary>
- An interface that allows the creation of a splash screen extension, which will be loaded before other extensions.
- </summary>
- </member>
- <member name="M:DotSpatial.Extensions.SplashScreens.ISplashScreenManager.Activate">
- <summary>
- Show the Splash Screen.
- </summary>
- </member>
- <member name="M:DotSpatial.Extensions.SplashScreens.ISplashScreenManager.ProcessCommand(System.Enum,System.Object)">
- <summary>
-
- </summary>
- <param name="cmd">A SplashScreenCommand enum value.</param>
- <param name="arg">The argument to pass to the command. See SplashScreenCommand for details reguarding each individual command.</param>
- </member>
- <member name="M:DotSpatial.Extensions.SplashScreens.ISplashScreenManager.Deactivate">
- <summary>
- Deactivates this instance.
- </summary>
- </member>
- <member name="T:DotSpatial.Extensions.SplashScreens.SplashScreenCommand">
- <summary>
- The type of splash screen command
- Supported operation is to change the display text.
- </summary>
- </member>
- <member name="F:DotSpatial.Extensions.SplashScreens.SplashScreenCommand.SetDisplayText">
- <summary>
- Displays a string on the splash screen.
- </summary>
- </member>
- <member name="M:DotSpatial.Extensions.SplashScreens.SplashScreenHelper.GetSplashScreenManager">
- <summary>
- Searches "Application Extensions" for and activates "*SplashScreen*.dll"
- </summary>
- <returns></returns>
- </member>
- </members>
-</doc>
diff --git a/MES_Wind/bin/Debug/DotSpatial.Modeling.Forms.pdb b/MES_Wind/bin/Debug/DotSpatial.Modeling.Forms.pdb
deleted file mode 100644
index 0458027f0fe2f20d249c3982126238081e182e92..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/DotSpatial.Modeling.Forms.pdb and /dev/null differ
diff --git a/MES_Wind/bin/Debug/DotSpatial.Modeling.Forms.xml b/MES_Wind/bin/Debug/DotSpatial.Modeling.Forms.xml
deleted file mode 100644
index fdb084476a7c8420aa64dd4903301e04f15ed7cc..0000000000000000000000000000000000000000
--- a/MES_Wind/bin/Debug/DotSpatial.Modeling.Forms.xml
+++ /dev/null
@@ -1,2212 +0,0 @@
-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>DotSpatial.Modeling.Forms</name>
- </assembly>
- <members>
- <member name="T:DotSpatial.Modeling.Forms.ExtentElement">
- <summary>
- ProjectionElement
- </summary>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.DialogElement">
- <summary>
- A modular component that can be inherited to retrieve parameters for functions.
- </summary>
- </member>
- <member name="F:DotSpatial.Modeling.Forms.DialogElement.GroupBox1">
- <summary>
- The group box for this element
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.DialogElement.#ctor">
- <summary>
- Creates a blank dialog element
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.DialogElement.ParamValueChanged(DotSpatial.Modeling.Forms.Parameter)">
- <summary>
- Fires whenever the
- </summary>
- <param name="sender"></param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.DialogElement.OnClick(System.EventArgs)">
- <summary>
- Called to fire the click event for this element
- </summary>
- <param name="e">A mouse event args thingy</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.DialogElement.DialogElement_Click(System.Object,System.EventArgs)">
- <summary>
- Occurs when the dialong element is clicked
- </summary>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.DialogElement.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="F:DotSpatial.Modeling.Forms.DialogElement.components">
- <summary>
- Required designer variable
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.DialogElement.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="E:DotSpatial.Modeling.Forms.DialogElement.Clicked">
- <summary>
- Fires when the inactive areas around the controls are clicked on the element.
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.DialogElement.GroupBox">
- <summary>
- Gets or sets the group box that surrounds the element contents
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.DialogElement.StatusLabel">
- <summary>
- Gets or sets the status label
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.DialogElement.LightTipText">
- <summary>
- Gets or sets the tool tip text to display when the mouse hovers over the light status
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.DialogElement.Status">
- <summary>
- Gets the current status the input
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.DialogElement.Param">
- <summary>
- Gets or sets the Parameter that the element represents
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ExtentElement.#ctor(DotSpatial.Modeling.Forms.ExtentParam)">
- <summary>
- Creates a new instance of ProjectionElement
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ExtentElement.Param">
- <summary>
- Gets or sets the Parameter that the element represents
- </summary>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.DataSetArray">
- <summary>
- Used to create arrays of data sets with an associated name to be passed into Tools to populate their dialog boxes
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.DataSetArray.#ctor(System.String,DotSpatial.Data.IDataSet)">
- <summary>
- Creates an instance of a simple object that holds a name and a dataset
- </summary>
- <param name="name"> The name of the DataSet in this object</param>
- <param name="dataSet">The IDataSet in this object</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.DataSetArray.ToString">
- <summary>
- Returns the Name
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.DataSetArray.Name">
- <summary>
- The name of the DataSet in this object
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.DataSetArray.DataSet">
- <summary>
- The IDataSet in this object
- </summary>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.Images">
- <summary>
- A strongly-typed resource class, for looking up localized strings, etc.
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.Images.ResourceManager">
- <summary>
- Returns the cached ResourceManager instance used by this class.
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.Images.Culture">
- <summary>
- Overrides the current thread's CurrentUICulture property for all
- resource lookups using this strongly typed resource class.
- </summary>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.ITool">
- <summary>
- Defines the way a tool interfaces with the toolbox
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ITool.Initialize">
- <summary>
- The parameters array should be populated with default values here
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ITool.ParameterChanged(DotSpatial.Modeling.Forms.Parameter)">
- <summary>
- Fires when one of the paramters value has beend changed, usually when a user changes a input or output parameters value, this can be used to populate other parameters default values.
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ITool.Execute(DotSpatial.Data.ICancelProgressHandler)">
- <summary>
- Once the parameters have been configured the Execute command can be called, it returns true if succesful
- </summary>
- <param name="cancelProgressHandler">A cancel progress handler that used to indicate how much of the tool is done</param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ITool.Name">
- <summary>
- Returns the name of the tool
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ITool.AssemblyQualifiedName">
- <summary>
- A UniqueName Identifying this Tool, if another tool with the same UniqueName exists this tool will not be loaded. The is persisted by the model builder in saved files.
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ITool.Category">
- <summary>
- Returns the category of tool that the ITool should be added to
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ITool.Version">
- <summary>
- Returns the Version of the tool
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ITool.Author">
- <summary>
- Returns the Author of the tool's name
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ITool.ToolTip">
- <summary>
- Returns a brief description displayed when the user hovers over the tool in the toolbox
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ITool.InputParameters">
- <summary>
- Gets or Sets the input paramater array
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ITool.OutputParameters">
- <summary>
- Gets or Sets the output paramater array
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ITool.Icon">
- <summary>
- 32x32 Bitmap - The Large icon that will appears in the Tool Dialog Next to the tools name
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ITool.HelpImage">
- <summary>
- Image displayed in the help area when no input field is selected
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ITool.Description">
- <summary>
- Help text to be displayed when no input field is selected
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ITool.HelpUrl">
- <summary>
- Returns the address of the tools help web page in HTTP://... format. Return a empty string to hide the help hyperlink.
- </summary>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.ModelingMessageStrings">
- <summary>
- A strongly-typed resource class, for looking up localized strings, etc.
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ModelingMessageStrings.ResourceManager">
- <summary>
- Returns the cached ResourceManager instance used by this class.
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ModelingMessageStrings.Culture">
- <summary>
- Overrides the current thread's CurrentUICulture property for all
- resource lookups using this strongly typed resource class.
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ModelingMessageStrings.DefaultToolProvider_SettingsDialogText">
- <summary>
- Looks up a localized string similar to There are no setting for the default Tool Provider. It scans the same folders the ToolManager scans for Tool Providers.
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ModelingMessageStrings.DefaultToolProvider_SettingsDialogTitle">
- <summary>
- Looks up a localized string similar to Default Tool Provider Settings.
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ModelingMessageStrings.ExtentElement_Press_button">
- <summary>
- Looks up a localized string similar to Press the button to specify an Extent.
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ModelingMessageStrings.FeaturesetMissing">
- <summary>
- Looks up a localized string similar to No feature set is specified..
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ModelingMessageStrings.FeaturesetValid">
- <summary>
- Looks up a localized string similar to The feature set is valid..
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ModelingMessageStrings.FeaturesSelected">
- <summary>
- Looks up a localized string similar to Selected features.
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ModelingMessageStrings.FeatureTypeException">
- <summary>
- Looks up a localized string similar to The feature set selected was the incorrect type..
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ModelingMessageStrings.Input">
- <summary>
- Looks up a localized string similar to Input.
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ModelingMessageStrings.InvalidDouble">
- <summary>
- Looks up a localized string similar to The value is invalid, it must be a decimal between %min and %max.
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ModelingMessageStrings.InvalidInteger">
- <summary>
- Looks up a localized string similar to The value is invalid, it must be an integer between %min and %max.
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ModelingMessageStrings.Output">
- <summary>
- Looks up a localized string similar to Output.
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ModelingMessageStrings.ParameterInvalid">
- <summary>
- Looks up a localized string similar to The parameter is invalid.
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ModelingMessageStrings.ParameterValid">
- <summary>
- Looks up a localized string similar to The parameter is valid.
- </summary>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.BooleanParam">
- <summary>
- Boolean Parameters returned by an ITool allows the tool to specify default value
- </summary>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.Parameter">
- <summary>
- This is the base class for the parameter array to be passed into a ITool
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.Parameter.OnValueChanged">
- <summary>
- Call this when the parameter's value is changed
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.Parameter.GenerateDefaultOutput(System.String)">
- <summary>
- Populates the parameter with default values
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.Parameter.InputDialogElement(System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- This method returns the dialog component that should be used to visualise INPUT to this parameter
- </summary>
- <param name="dataSets"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.Parameter.OutputDialogElement(System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- This method returns the dialog component that should be used to visualise OUTPUT to this parameter
- </summary>
- <param name="dataSets"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.Parameter.Clone">
- <summary>
- This returns a duplicate of this object.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.Parameter.Copy">
- <summary>
- Returns a shallow copy of the Parameter class
- </summary>
- <returns>A new Parameters class that is a shallow copy of the original parameters class</returns>
- </member>
- <member name="E:DotSpatial.Modeling.Forms.Parameter.ValueChanged">
- <summary>
- Fires when the parameter's value is changed
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.Parameter.ParamVisible">
- <summary>
- Specify if a graphic should be added to the model to represent the parameter
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.Parameter.ModelName">
- <summary>
- Used to identify this parameter in the modeler, it will be set automatically by the modeler
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.Parameter.DefaultSpecified">
- <summary>
- Gets true if the parameter contains a value and false if none has been specified
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.Parameter.Value">
- <summary>
- Gets or sets the value of the parameter
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.Parameter.Name">
- <summary>
- The name of that parameter that shows up in auto generated forms
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.Parameter.ParamType">
- <summary>
- Gets the type of data used in this parameter
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.Parameter.HelpImage">
- <summary>
- Gets or Sets the help image that will appear beside the parameter element when it is clicked
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.Parameter.HelpText">
- <summary>
- Gets or Sets the help text that will appear beside the parameter element when it is clicked
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.BooleanParam.#ctor(System.String,System.String)">
- <summary>
- Creates a new Boolean parameter
- </summary>
- <param name="name">The name of the parameter</param>
- <param name="checkBoxText">The text to appear adjacent to the checkBox</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.BooleanParam.#ctor(System.String,System.String,System.Boolean)">
- <summary>
- Creates a new Boolean parameter
- </summary>
- <param name="name">The name of the parameter</param>
- <param name="checkBoxText">The text to appear adjacent to the checkBox</param>
- <param name="value">The default value</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.BooleanParam.InputDialogElement(System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- This method returns the dialog component that should be used to visualise INPUT to this parameter
- </summary>
- <param name="dataSets"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.BooleanParam.OutputDialogElement(System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- This method returns the dialog component that should be used to visualise OUTPUT to this parameter
- </summary>
- <param name="dataSets"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.BooleanParam.Value">
- <summary>
- Specifies the value of the parameter (This is also the default value for input)
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.BooleanParam.CheckBoxText">
- <summary>
- Gets or sets the text that appears beside the check box in a Tool Dialog
- </summary>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.DateTimeParam">
- <summary>
- DateTime Parameters returned by an ITool allows the tool to specify default value
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.DateTimeParam.#ctor(System.String)">
- <summary>
- Creates a new string parameter
- </summary>
- <param name="name">The name of the parameter</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.DateTimeParam.#ctor(System.String,System.DateTime)">
- <summary>
- Creates a new string parameter
- </summary>
- <param name="name">The name of the parameter</param>
- <param name="value">The default value</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.DateTimeParam.InputDialogElement(System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- This method returns the dialog component that should be used to visualise INPUT to this parameter
- </summary>
- <param name="dataSets"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.DateTimeParam.OutputDialogElement(System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- This method returns the dialog component that should be used to visualise OUTPUT to this parameter
- </summary>
- <param name="dataSets"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.DateTimeParam.Value">
- <summary>
- Specifies the value of the parameter (This is also the default value for input)
- </summary>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.DoubleParam">
- <summary>
- Double Parameter returned by an ITool allows the tool to specify a range and default value
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.DoubleParam.#ctor(System.String)">
- <summary>
- Creates a new double parameter
- </summary>
- <param name="name">The name of the parameter</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.DoubleParam.#ctor(System.String,System.Double)">
- <summary>
- Creates a new double parameter
- </summary>
- <param name="name">The name of the parameter</param>
- <param name="value">The default value</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.DoubleParam.#ctor(System.String,System.Double,System.Double,System.Double)">
- <summary>
- Creates a new double parameter
- </summary>
- <param name="name">The name of the parameter</param>
- <param name="value">The default value</param>
- <param name="min">The minimum value</param>
- <param name="max">The maximum value</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.DoubleParam.InputDialogElement(System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- This method returns the dialog component that should be used to visualise INPUT to this parameter
- </summary>
- <param name="dataSets"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.DoubleParam.OutputDialogElement(System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- This method returns the dialog component that should be used to visualise OUTPUT to this parameter
- </summary>
- <param name="dataSets"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.DoubleParam.Value">
- <summary>
- Specifies the value of the parameter (This is also the default value for input)
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.DoubleParam.Min">
- <summary>
- The minimum range for the parameter Default: -1.79769313486232e308
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.DoubleParam.Max">
- <summary>
- The maximum range for the paramater Default: 1.79769313486232e308
- </summary>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.ExtentParam">
- <summary>
- ProjectionParam
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ExtentParam.#ctor(System.String)">
- <summary>
- Creates a new instance of ProjectionParam with the specified name
- and a default projection of WGS1984
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ExtentParam.#ctor(System.String,DotSpatial.Data.Extent)">
- <summary>
- Creates a new instance of an Extent Param with the specified name
- and the specified projection as the default projection that will
- appear if no changes are made.
- </summary>
- <param name="name"></param>
- <param name="defaultExtent"></param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ExtentParam.InputDialogElement(System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- This method returns the dialog component that should be used to visualize INPUT to this parameter
- </summary>
- <param name="dataSets"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ExtentParam.OutputDialogElement(System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- This method returns the dialog component that should be used to visualize OUTPUT to this parameter
- </summary>
- <param name="dataSets"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ExtentParam.DefaultToMapExtent">
- <summary>
- Gets or sets a value indicating whether the extent should be modified to show the MapExtent
- before being shown in the tool dialog.
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ExtentParam.Value">
- <summary>
- Specifies the value of the parameter (This is also the default value for input)
- </summary>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.FeatureSetParam">
- <summary>
- Raster parameter allows ITools to specify that they require a Raster data set as input
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.FeatureSetParam.#ctor(System.String)">
- <summary>
- Creates a new Feature Set Parameter
- </summary>
- <param name="name">The name of the parameter</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.FeatureSetParam.GenerateDefaultOutput(System.String)">
- <summary>
- Generates a default instance of the data type so that tools have something to write too
- </summary>
- <param name="path"></param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.FeatureSetParam.InputDialogElement(System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- This method returns the dialog component that should be used to visualise INPUT to this parameter
- </summary>
- <param name="dataSets"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.FeatureSetParam.OutputDialogElement(System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- This method returns the dialog component that should be used to visualise OUTPUT to this parameter
- </summary>
- <param name="dataSets"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.FeatureSetParam.Value">
- <summary>
- Specifies the value of the parameter (This is also the default value for input)
- </summary>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.FileParam">
- <summary>
- A File access parameter
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.FileParam.#ctor(System.String,System.String)">
- <summary>
- Creates a new Feature Set Parameter
- </summary>
- <param name="name">The name of the parameter</param>
- <param name="filter">The string dialog filter to use.</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.FileParam.#ctor(System.String)">
- <summary>
- Creates a new Feature Set Parameter
- </summary>
- <param name="name">The name of the parameter</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.FileParam.#ctor(System.String,DotSpatial.Modeling.Forms.TextFile)">
- <summary>
- Creates a new Feature Set Parameter
- </summary>
- <param name="name">The name of the parameter</param>
- <param name="value">A TextFile</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.FileParam.GenerateDefaultOutput(System.String)">
- <summary>
- Generates a default instance of the data type so that tools have something to write too
- </summary>
- <param name="path"></param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.FileParam.InputDialogElement(System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- This method returns the dialog component that should be used to visualize INPUT to this parameter
- </summary>
- <param name="dataSets"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.FileParam.OutputDialogElement(System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- This method returns the dialog component that should be used to visualize OUTPUT to this parameter
- </summary>
- <param name="dataSets"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.FileParam.DialogFilter">
- <summary>
- Gets or sets the filter expression to limit extensions that can be used for this FileParam.
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.FileParam.Value">
- <summary>
- Specifies the value of the parameter (This is also the default value for input)
- </summary>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.IndexParam">
- <summary>
- Index Parameters returned by an ITool allows the tool to select the index for given Featureset indexs.
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.IndexParam.#ctor(System.String)">
- <summary>
- Creates a new Index parameter
- </summary>
- <param name="name">The name of the parameter</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.IndexParam.InputDialogElement(System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- This method returns the dialog component that should be used to visualise INPUT to this parameter
- </summary>
- <param name="dataSets"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.IndexParam.Fs">
- <summary>
- The featureset used to populate the query generator
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.IndexParam.Value">
- <summary>
- Specifies the value of the parameter (This will give the result featureset that user want handle.)
- </summary>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.IntParam">
- <summary>
- Int Parameters returned by an ITool allows the tool to specify a range and default value
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.IntParam.#ctor(System.String)">
- <summary>
- Creates a new integer parameter
- </summary>
- <param name="name">The name of the parameter</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.IntParam.#ctor(System.String,System.Int32)">
- <summary>
- Creates a new integer parameter
- </summary>
- <param name="name">The name of the parameter</param>
- <param name="value">The default value</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.IntParam.#ctor(System.String,System.Int32,System.Int32,System.Int32)">
- <summary>
- Creates a new integer parameter
- </summary>
- <param name="name">The name of the parameter</param>
- <param name="value">The default value</param>
- <param name="min">The minimum value</param>
- <param name="max">The maximum value</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.IntParam.InputDialogElement(System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- This method returns the dialog component that should be used to visualise INPUT to this parameter
- </summary>
- <param name="dataSets"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.IntParam.OutputDialogElement(System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- This method returns the dialog component that should be used to visualise OUTPUT to this parameter
- </summary>
- <param name="dataSets"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.IntParam.Min">
- <summary>
- The minimum range for the parameter Default: -2, 147, 483, 648
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.IntParam.Max">
- <summary>
- The maximum range for the paramater Default: 2, 147, 483, 648
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.IntParam.Value">
- <summary>
- Specifies the value to use by default must be between the min and max
- </summary>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.LineFeatureSetParam">
- <summary>
- Line Feature Parameter past back from a ITool to the toolbox manager
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.LineFeatureSetParam.#ctor(System.String)">
- <summary>
- Creates a new Line Feature Set parameter
- </summary>
- <param name="name">The name of the parameter</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.LineFeatureSetParam.GenerateDefaultOutput(System.String)">
- <summary>
- Generates a default instance of the data type so that tools have something to write too
- </summary>
- <param name="path"></param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.LineFeatureSetParam.InputDialogElement(System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- This method returns the dialog component that should be used to visualise INPUT to this parameter
- </summary>
- <param name="dataSets"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.LineFeatureSetParam.OutputDialogElement(System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- This method returns the dialog component that should be used to visualise OUTPUT to this parameter
- </summary>
- <param name="dataSets"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.LineFeatureSetParam.Value">
- <summary>
- Specifies the value of the parameter (This is also the default value for input)
- </summary>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.ListParam">
- <summary>
- List of strings parameter returned by an ITool allows the tool to specify a list of values and a default
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ListParam.#ctor(System.String)">
- <summary>
- Creates a new list parameter
- </summary>
- <param name="name">The name of the parameter</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ListParam.#ctor(System.String,System.Collections.Generic.List{System.String})">
- <summary>
- Creates a new list parameter
- </summary>
- <param name="name">The name of the parameter</param>
- <param name="valueList">The list of string values to poluate the combo box</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ListParam.#ctor(System.String,System.Collections.Generic.List{System.String},System.Int32)">
- <summary>
- Creates a new list parameter
- </summary>
- <param name="name">The name of the parameter</param>
- <param name="valueList">The list of string values to poluate the combo box</param>
- <param name="value">The default item in the list</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ListParam.InputDialogElement(System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- This method returns the dialog component that should be used to visualise INPUT to this parameter
- </summary>
- <param name="dataSets"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ListParam.OutputDialogElement(System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- This method returns the dialog component that should be used to visualise OUTPUT to this parameter
- </summary>
- <param name="dataSets"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ListParam.Value">
- <summary>
- Gets or sets the index of the list
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ListParam.ValueList">
- <summary>
- Gets or sets the list of items in the valuelist
- </summary>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.EventHandlerValueChanged">
- <summary>
- EventHandler delegate for the tool parameter when a value is changed.
- </summary>
- <param name="sender"></param>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.PointFeatureSetParam">
- <summary>
- Point Feature Set Parameters past back from a ITool to the toolbox manager
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.PointFeatureSetParam.#ctor(System.String)">
- <summary>
- Creates a new Line Feature Set parameter
- </summary>
- <param name="name">The name of the parameter</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.PointFeatureSetParam.GenerateDefaultOutput(System.String)">
- <summary>
- Generates a default instance of the data type so that tools have something to write too
- </summary>
- <param name="path"></param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.PointFeatureSetParam.InputDialogElement(System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- This method returns the dialog component that should be used to visualise INPUT to this parameter
- </summary>
- <param name="dataSets"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.PointFeatureSetParam.OutputDialogElement(System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- This method returns the dialog component that should be used to visualise OUTPUT to this parameter
- </summary>
- <param name="dataSets"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.PointFeatureSetParam.Value">
- <summary>
- Specifies the value of the parameter (This is also the default value for input)
- </summary>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.PolygonFeatureSetParam">
- <summary>
- Polygon Feature Set Parameters past back from a ITool to the toolbox manager
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.PolygonFeatureSetParam.#ctor(System.String)">
- <summary>
- Creates a new Polygon Feature Set parameter
- </summary>
- <param name="name">The name of the parameter</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.PolygonFeatureSetParam.GenerateDefaultOutput(System.String)">
- <summary>
- Generates a default instance of the data type so that tools have something to write too
- </summary>
- <param name="path"></param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.PolygonFeatureSetParam.InputDialogElement(System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- This method returns the dialog component that should be used to visualise INPUT to this parameter
- </summary>
- <param name="dataSets"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.PolygonFeatureSetParam.OutputDialogElement(System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- This method returns the dialog component that should be used to visualise OUTPUT to this parameter
- </summary>
- <param name="dataSets"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.PolygonFeatureSetParam.Value">
- <summary>
- Specifies the value of the parameter (This is also the default value for input)
- </summary>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.ProjectionParam">
- <summary>
- ProjectionParam
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ProjectionParam.#ctor(System.String)">
- <summary>
- Creates a new instance of ProjectionParam with the specified name
- and a default projection of WGS1984
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ProjectionParam.#ctor(System.String,DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Creates a new instance of a Projection Param with the specified name
- and the specified projection as the default projection that will
- appear if no changes are made.
- </summary>
- <param name="name"></param>
- <param name="defaultProjection"></param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ProjectionParam.InputDialogElement(System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- This method returns the dialog component that should be used to visualise INPUT to this parameter
- </summary>
- <param name="dataSets"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ProjectionParam.OutputDialogElement(System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- This method returns the dialog component that should be used to visualise OUTPUT to this parameter
- </summary>
- <param name="dataSets"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ProjectionParam.Value">
- <summary>
- Specifies the value of the parameter (This is also the default value for input)
- </summary>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.RasterParam">
- <summary>
- Raster parameter allows ITools to specify that they require a Raster data set as input
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.RasterParam.#ctor(System.String)">
- <summary>
- Creates a new Raster parameter
- </summary>
- <param name="name">The name of the parameter</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.RasterParam.InputDialogElement(System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- This method returns the dialog component that should be used to visualise INPUT to this parameter
- </summary>
- <param name="dataSets"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.RasterParam.OutputDialogElement(System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- This method returns the dialog component that should be used to visualise OUTPUT to this parameter
- </summary>
- <param name="dataSets"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.RasterParam.GenerateDefaultOutput(System.String)">
- <summary>
- Creates a new blank raster
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.RasterParam.Value">
- <summary>
- Specifies the value of the parameter (This is also the default value for input)
- </summary>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.ShowParamInModel">
- <summary>
- Defines whether or not to add the parameter to the model
- </summary>
- </member>
- <member name="F:DotSpatial.Modeling.Forms.ShowParamInModel.Always">
- <summary>
- Always add the parameter to the model
- </summary>
- </member>
- <member name="F:DotSpatial.Modeling.Forms.ShowParamInModel.Yes">
- <summary>
- Show the parameter in the model
- </summary>
- </member>
- <member name="F:DotSpatial.Modeling.Forms.ShowParamInModel.No">
- <summary>
- Don't show the parameter in the model
- </summary>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.StringParam">
- <summary>
- String Parameters returned by an ITool allows the tool to specify a default value
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.StringParam.#ctor(System.String)">
- <summary>
- Creates a new string parameter
- </summary>
- <param name="name">The name of the parameter</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.StringParam.#ctor(System.String,System.String)">
- <summary>
- Creates a new string parameter
- </summary>
- <param name="name">The name of the parameter</param>
- <param name="value">The default value</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.StringParam.InputDialogElement(System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- This method returns the dialog component that should be used to visualise INPUT to this parameter
- </summary>
- <param name="dataSets"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.StringParam.OutputDialogElement(System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- This method returns the dialog component that should be used to visualise OUTPUT to this parameter
- </summary>
- <param name="dataSets"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.StringParam.Value">
- <summary>
- Specifies the value of the parameter (This is also the default value for input)
- </summary>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.ParameterType">
- <summary>
- Defines the data types which can be parameters for a ITool
- </summary>
- </member>
- <member name="F:DotSpatial.Modeling.Forms.ParameterType.IntParam">
- <summary>
- Defines a parameter of type Int which takes a max/min and default value
- </summary>
- </member>
- <member name="F:DotSpatial.Modeling.Forms.ParameterType.DoubleParam">
- <summary>
- Defines a parameter of type Double which takes a max/min and default value
- </summary>
- </member>
- <member name="F:DotSpatial.Modeling.Forms.ParameterType.RasterParam">
- <summary>
- Defines a parameter which specifies a raster
- </summary>
- </member>
- <member name="F:DotSpatial.Modeling.Forms.ParameterType.FeatureSetParam">
- <summary>
- Defines a parameter which specifies a Feature Set
- </summary>
- </member>
- <member name="F:DotSpatial.Modeling.Forms.ParameterType.PointFeatureSetParam">
- <summary>
- Defines a parameter which specifies a Point Feature Set
- </summary>
- </member>
- <member name="F:DotSpatial.Modeling.Forms.ParameterType.LineFeatureSetParam">
- <summary>
- Defines a parameter which specifies a Line Feature Set
- </summary>
- </member>
- <member name="F:DotSpatial.Modeling.Forms.ParameterType.PolygonFeatureSetParam">
- <summary>
- Defines a parameter which specifies a Polygon Feature Set
- </summary>
- </member>
- <member name="F:DotSpatial.Modeling.Forms.ParameterType.StringParam">
- <summary>
- Defines a parameter which specifies a string
- </summary>
- </member>
- <member name="F:DotSpatial.Modeling.Forms.ParameterType.BooleanParam">
- <summary>
- Defines a parameter which specifies a boolean value
- </summary>
- </member>
- <member name="F:DotSpatial.Modeling.Forms.ParameterType.ListParam">
- <summary>
- Defines a parameter that is presented by a comboBox in the form
- </summary>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.BooleanElement">
- <summary>
- An element for true/false values
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.BooleanElement.#ctor(DotSpatial.Modeling.Forms.BooleanParam)">
- <summary>
- Creates an instance of the dialog
- </summary>
- <param name="param">The parameter this element represents</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.BooleanElement.Refresh">
- <summary>
- Updates the status lights
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.BooleanElement.CheckBox1CheckStateChanged(System.Object,System.EventArgs)">
- <summary>
- This changes the color of the light and the tooltip of the light based on the status of the checkbox
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.BooleanElement.CheckBox1Click(System.Object,System.EventArgs)">
- <summary>
- When the check box it clicked this event fires
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.BooleanElement.Param">
- <summary>
- Gets or sets the Parameter that the element represents
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.DateTimeElement.#ctor(DotSpatial.Modeling.Forms.DateTimeParam)">
- <summary>
- Creates an instance of the dialog
- </summary>
- <param name="param">The parameter this element represents</param>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.DateTimeElement.Param">
- <summary>
- Gets or sets the Parameter that the element represents
- </summary>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.DialogSpacerElement">
- <summary>
- An element for DialogSpacing
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.DialogSpacerElement.#ctor">
- <summary>
- Creates an instance of a dialogspacerelement
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.DialogSpacerElement.Text">
- <summary>
- Gets or sets the text of the spacer
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.DialogSpacerElement.Status">
- <summary>
- Gets the current status the input
- </summary>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.DoubleElement">
- <summary>
- An element for doubles
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.DoubleElement.#ctor(DotSpatial.Modeling.Forms.DoubleParam)">
- <summary>
- Creates an instance of the dialog
- </summary>
- <param name="param">The parameter this element represents</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.DoubleElement.Refresh">
- <summary>
- Refreshes status lights or other content
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.DoubleElement.textBox1_TextChanged(System.Object,System.EventArgs)">
- <summary>
- This changes the color of the light and the tooltip of the light based on the status of the text in the box
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.DoubleElement.IsDecimal(System.String)">
- <summary>
- Checks if text contains a value double
- </summary>
- <param name="theValue">The text to text</param>
- <returns>Returns true if it is a valid double</returns>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.DoubleElement.textBox1_Click(System.Object,System.EventArgs)">
- <summary>
- When the text box is clicked this event fires
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.DoubleElement.Param">
- <summary>
- Gets or sets the Parameter that the element represents
- </summary>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.ToolStatus">
- <summary>
- Indicates the allowed values for the status of the element, illustrated by the light
- </summary>
- </member>
- <member name="F:DotSpatial.Modeling.Forms.ToolStatus.Empty">
- <summary>
- Indicates that no value has been set for this yet.
- </summary>
- </member>
- <member name="F:DotSpatial.Modeling.Forms.ToolStatus.Ok">
- <summary>
- Indicates that the element parameter is ok and won't halt.
- </summary>
- </member>
- <member name="F:DotSpatial.Modeling.Forms.ToolStatus.Error">
- <summary>
- Indicates that the element value will cause an error.
- </summary>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.FeatureSetElement">
- <summary>
- Feature Set element
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.FeatureSetElement.#ctor(DotSpatial.Modeling.Forms.FeatureSetParam,System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- Creates an instance of the dialog
- </summary>
- <param name="inputParam">The parameter this element represents</param>
- <param name="dataSets">An array of available data</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.FeatureSetElement.Refresh">
- <summary>
- updates the param if something's been changed
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.FeatureSetElement.comboFeature_SelectedValueChanged(System.Object,System.EventArgs)">
- <summary>
- This fires when the selected value in the combo box is changed
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.FeatureSetElement.btnAddData_Click(System.Object,System.EventArgs)">
- <summary>
- Adds a new entry to the drop down list from data provider
- </summary>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.FeatureSetElementOut">
- <summary>
- Feature Set element out
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.FeatureSetElementOut.#ctor(DotSpatial.Modeling.Forms.FeatureSetParam,System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- Creates an instance of the dialog
- </summary>
- <param name="outputParam">The parameter this element represents</param>
- <param name="dataSets">An array of available data</param>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.IndexElement">
- <summary>
- /// A modular component that can be inherited to retrieve parameters for functions.
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.IndexElement.#ctor(DotSpatial.Modeling.Forms.IndexParam)">
- <summary>
- Create a new instant.
- </summary>
- <param name="param"></param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.IndexElement.TextBox1Click(System.Object,System.EventArgs)">
- <summary>
- When the text box is clicked this event fires
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.IndexElement.Param">
- <summary>
- Gets or sets the Parameter that the element represents
- </summary>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.IntElement">
- <summary>
- an element for integers
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.IntElement.#ctor(DotSpatial.Modeling.Forms.IntParam)">
- <summary>
- Creates an instance of the dialog
- </summary>
- <param name="param">The parameter this element represents</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.IntElement.Refresh">
- <summary>
- Updates the status lights
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.IntElement.textBox1_TextChanged(System.Object,System.EventArgs)">
- <summary>
- This changes the color of the light and the tooltip of the light based on the status of the text in the box
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.IntElement.IsInteger(System.String)">
- <summary>
- Checks if text contains a value integer
- </summary>
- <param name="theValue">The text to text</param>
- <returns>Returns true if it is a valid integer</returns>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.IntElement.textBox1_Click(System.Object,System.EventArgs)">
- <summary>
- When the text box is clicked this event fires
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.IntElement.Param">
- <summary>
- Gets or sets the Parameter that the element represents
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.LineElement.#ctor(DotSpatial.Modeling.Forms.LineFeatureSetParam,System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- Creates an instance of the dialog
- </summary>
- <param name="inputParam">The parameter this element represents</param>
- <param name="dataSets">An array of available data</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.LineElement.Refresh">
- <summary>
- updates the param if something's been changed
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.LineElement.ComboFeatureSelectedValueChanged(System.Object,System.EventArgs)">
- <summary>
- This fires when the selected value in the combo box is changed
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.LineElement.BtnAddDataClick(System.Object,System.EventArgs)">
- <summary>
- Adds a new entry to the drop down list from data provider
- </summary>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.LineElementOut.#ctor(DotSpatial.Modeling.Forms.LineFeatureSetParam,System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- Creates an instance of the dialog
- </summary>
- <param name="outputParam">The parameter this element represents</param>
- <param name="dataSets">An array of available data</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ListElement.#ctor(DotSpatial.Modeling.Forms.ListParam)">
- <summary>
- Creates an instance of the dialog
- </summary>
- <param name="param">The parameter this element represents</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ListElement.Refresh">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ListElement.ComboBox1SelectedValueChanged(System.Object,System.EventArgs)">
- <summary>
- This changes the color of the light and the tooltip of the light based on the status of the text in the box
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ListElement.ComboBox1Click(System.Object,System.EventArgs)">
- <summary>
- When the control is clicked this event fires
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ListElement.Param">
- <summary>
- Gets or sets the Parameter that the element represents
- </summary>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.OpenFileElement">
- <summary>
- Open File Element
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.OpenFileElement.#ctor(DotSpatial.Modeling.Forms.FileParam,System.String)">
- <summary>
- Create an instance of the dialog
- </summary>
- <param name="param"></param>
- <param name="text"></param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.OpenFileElement.#ctor(DotSpatial.Modeling.Forms.FileParam,System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- Creates an instance of the dialog
- </summary>
- <param name="inputParam">The parameter this element represents</param>
- <param name="dataSets">An array of available data</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.OpenFileElement.Refresh">
- <summary>
- updates the param if something's been changed
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.OpenFileElement.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.PointElement.#ctor(DotSpatial.Modeling.Forms.PointFeatureSetParam,System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- Creates an instance of the dialog
- </summary>
- <param name="inputParam">The parameter this element represents</param>
- <param name="dataSets">An array of available data</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.PointElement.Refresh">
- <summary>
- updates the param if something's been changed
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.PointElement.ComboFeatureSelectedValueChanged(System.Object,System.EventArgs)">
- <summary>
- This fires when the selected value in the combo box is changed
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.PointElement.BtnAddDataClick(System.Object,System.EventArgs)">
- <summary>
- Adds a new entry to the drop down list from data provider
- </summary>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.PointElementOut.#ctor(DotSpatial.Modeling.Forms.PointFeatureSetParam,System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- Creates an instance of the dialog
- </summary>
- <param name="outputParam">The parameter this element represents</param>
- <param name="dataSets">An array of available data</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.PolygonElement.#ctor(DotSpatial.Modeling.Forms.PolygonFeatureSetParam,System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- Creates an instance of the dialog
- </summary>
- <param name="inputParam">The parameter this element represents</param>
- <param name="dataSets">An array of available data</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.PolygonElement.Refresh">
- <summary>
- updates the param if something's been changed
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.PolygonElement.ComboFeatureSelectedValueChanged(System.Object,System.EventArgs)">
- <summary>
- This fires when the selected value in the combo box is changed
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.PolygonElement.BtnAddDataClick(System.Object,System.EventArgs)">
- <summary>
- Adds a new entry to the drop down list from data provider
- </summary>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.PolygonElementOut.#ctor(DotSpatial.Modeling.Forms.PolygonFeatureSetParam,System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- Creates an instance of the dialog
- </summary>
- <param name="outputParam">The parameter this element represents</param>
- <param name="dataSets">An array of available data</param>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.ProjectionElement">
- <summary>
- ProjectionElement
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ProjectionElement.#ctor(DotSpatial.Modeling.Forms.ProjectionParam)">
- <summary>
- Creates a new instance of ProjectionElement
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ProjectionElement.ParamValueChanged(DotSpatial.Modeling.Forms.Parameter)">
- <inheritdoc/>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ProjectionElement.Param">
- <summary>
- Gets or sets the Parameter that the element represents
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.RasterElement.#ctor(DotSpatial.Modeling.Forms.RasterParam,System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- Creates an instance of the dialog
- </summary>
- <param name="inputParam">The parameter this element represents</param>
- <param name="dataSets">An array of available data</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.RasterElement.Refresh">
- <summary>
- updates the param if something's been changed
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.RasterElement.ComboRasterSelectedValueChanged(System.Object,System.EventArgs)">
- <summary>
- This changes the color of the light and the tooltip of the light based on the status of the text in the box
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.RasterElement.BtnAddDataClick(System.Object,System.EventArgs)">
- <summary>
- Adds a new entry to the drop down list from data provider
- </summary>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.RasterElementOut.#ctor(DotSpatial.Modeling.Forms.RasterParam,System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- Creates an instance of the dialog
- </summary>
- <param name="outputParam">The parameter this element represents</param>
- <param name="dataSets">An array of available data</param>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.SaveFileElement">
- <summary>
- Save File Element
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.SaveFileElement.#ctor(DotSpatial.Modeling.Forms.FileParam,System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray})">
- <summary>
- Creates an instance of the dialog
- </summary>
- <param name="outputParam">The parameter this element represents</param>
- <param name="dataSets">An array of available data</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.SaveFileElement.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.StringElement.#ctor(DotSpatial.Modeling.Forms.StringParam)">
- <summary>
- Creates an instance of the dialog
- </summary>
- <param name="param">The parameter this element represents</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.StringElement.TextBox1TextChanged(System.Object,System.EventArgs)">
- <summary>
- This changes the color of the light and the tooltip of the light based on the status of the text in the box
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.StringElement.TextBox1Click(System.Object,System.EventArgs)">
- <summary>
- When the text box is clicked this event fires
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.StringElement.Param">
- <summary>
- Gets or sets the Parameter that the element represents
- </summary>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.Tool">
- <summary>
- A class from which Tools may be derived. Implments mundane parts of ITool for Assembly based tools.
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.Tool.Execute(DotSpatial.Data.ICancelProgressHandler)">
- <summary>
- Once the parameters have been configured the Execute command can be called, it returns true if succesful
- </summary>
- <param name="cancelProgressHandler">A cancel progress handler that used to indicate how much of the tool is done</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.Tool.Initialize">
- <summary>
- The parameters array should be populated with default values here
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.Tool.ParameterChanged(DotSpatial.Modeling.Forms.Parameter)">
- <summary>
- Fires when one of the paramters value has beend changed, usually when a user changes a input or output parameters value, this can be used to populate other parameters default values.
- </summary>
- <param name="sender"></param>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.Tool.Author">
- <summary>
- Author of the plugin.
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.Tool.Category">
- <summary>
- Returns the category of tool that the ITool should be added to
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.Tool.Description">
- <summary>
- Short description of the plugin.
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.Tool.HelpImage">
- <summary>
- Image displayed in the help area when no input field is selected
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.Tool.HelpUrl">
- <summary>
- Returns the address of the tools help web page in HTTP://... format. Returns null if no URL has been specified.
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.Tool.Icon">
- <summary>
- 32x32 Bitmap - The Large icon that will appears in the Tool Dialog Next to the tools name
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.Tool.InputParameters">
- <summary>
- Gets or Sets the input paramater array
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.Tool.Name">
- <summary>
- Name of the plugin.
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.Tool.OutputParameters">
- <summary>
- Gets or Sets the output paramater array
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.Tool.ToolTip">
- <summary>
- Returns a brief description displayed when the user hovers over the tool in the toolbox
- </summary>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.ToolDialog">
- <summary>
- A generic form that works with the various dialog elements in order to create a fully working process.
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ToolDialog.#ctor(DotSpatial.Modeling.Forms.ITool,System.Collections.Generic.List{DotSpatial.Modeling.Forms.DataSetArray},DotSpatial.Data.Extent)">
- <summary>
- The constructor for the ToolDialog
- </summary>
- <param name="tool">The ITool to create the dialog box for</param>
- <param name="dataSets">The list of available DataSets available</param>
- <param name="mapExtent">Creates a new instance of the tool dialog with map extent.</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ToolDialog.#ctor(DotSpatial.Modeling.Forms.ITool,System.Collections.Generic.IEnumerable{DotSpatial.Modeling.Forms.ModelElement})">
- <summary>
- The constructor for the ToolDialog
- </summary>
- <param name="tool">The ITool to create the dialog box for</param>
- <param name="modelElements">A list of all model elements</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ToolDialog.AddElement(DotSpatial.Modeling.Forms.DialogElement)">
- <summary>
- This adds the Elements to the form incrementally lower down
- </summary>
- <param name="element">The element to add</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ToolDialog.ElementClicked(System.Object,System.EventArgs)">
- <summary>
- When one of the DialogElements is clicked this event fires to populate the help
- </summary>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ToolDialog.Initialize(DotSpatial.Modeling.Forms.ITool)">
- <summary>
- The constructor for the ToolDialog
- </summary>
- <param name="tool">The ITool to create the dialog box for</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ToolDialog.ParamValueChanged(DotSpatial.Modeling.Forms.Parameter)">
- <summary>
- Fires when a parameter is changed
- </summary>
- <param name="sender"></param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ToolDialog.PopulateHelp(System.String,System.String,System.Drawing.Image)">
- <summary>
- This adds a Bitmap to the help section.
- </summary>
- <param name="title">The text to appear in the help box.</param>
- <param name="body">The title to appear in the help box.</param>
- <param name="image">The bitmap to appear at the bottom of the help box.</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ToolDialog.PopulateInputElements">
- <summary>
- Adds Elements to the dialog based on what input Parameter the ITool contains
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ToolDialog.PopulateOutputElements">
- <summary>
- Adds Elements to the dialog based on what output Parameter the ITool contains
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ToolDialog.btnCancel_Click(System.Object,System.EventArgs)">
- <summary>
- When the user clicks Cancel
- </summary>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ToolDialog.btnOK_Click(System.Object,System.EventArgs)">
- <summary>
- When the user clicks OK
- </summary>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ToolDialog.helpHyperlink_LinkClicked(System.Object,System.Windows.Forms.LinkLabelLinkClickedEventArgs)">
- <summary>
- When the hyperlink is clicked this event fires.
- </summary>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ToolDialog.otherElement_Click(System.Object,System.EventArgs)">
- <summary>
- If the user clicks out side of one of the tool elements
- </summary>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ToolDialog.panelHelp_SizeChanged(System.Object,System.EventArgs)">
- <summary>
- When the size of the help panel changes this event fires to move stuff around.
- </summary>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ToolDialog.Dispose(System.Boolean)">
- <summary>
- Disposes of the resources (other than memory) used by the <see cref="T:System.Windows.Forms.Form"/>.
- </summary>
- <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ToolDialog.DataSets">
- <summary>
- Returns a list of IDataSet that are available in the ToolDialog excluding any of its own outputs.
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ToolDialog.ToolStatus">
- <summary>
- Gets the status of the tool
- </summary>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.ArrowElement">
- <summary>
- An arrow
- </summary>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.ModelElement">
- <summary>
- Defines the base class for all model components
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ModelElement.#ctor(System.Collections.Generic.List{DotSpatial.Modeling.Forms.ModelElement})">
- <summary>
- Creates an instance of the model Element
- <param name="modelElements">A list of all the elements in the model</param>
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ModelElement.Clone">
- <summary>
- This returns a duplicate of this object.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ModelElement.Copy">
- <summary>
- Returns a shallow copy of the Parameter class
- </summary>
- <returns>A new Parameters class that is a shallow copy of the original parameters class</returns>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ModelElement.Highlighted(System.Boolean)">
- <summary>
- Darkens the component slightly
- </summary>
- <param name="highlighted">Darkens if true returns to normal if false</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ModelElement.Paint(System.Drawing.Graphics)">
- <summary>
- Repaints the form with cool background and stuff
- </summary>
- <param name="graph">The graphics object to paint to, the element will be drawn to 0, 0</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ModelElement.DrawStatusLight(System.Drawing.Graphics)">
- <summary>
- This does nothing in the base class but child classes may override it
- </summary>
- <param name="graph"></param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ModelElement.PointInExtents(System.Drawing.Point)">
- <summary>
- Returns true if the point is in the extents rectangle of the element
- </summary>
- <param name="pt">A point to test, assuming 0, 0 is the top left corner of the shapes drawing rectangle</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ModelElement.PointInElement(System.Drawing.Point)">
- <summary>
- Calculates if a point is within the shape that defines the element
- </summary>
- <param name="point">A point to test in the virtual modeling plane</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ModelElement.ElementInRectangle(System.Drawing.Rectangle)">
- <summary>
- Returns true if the element intersect the rectangle from the parent class
- </summary>
- <param name="rect">The rectangle to test must be in the virtual modeling coordinant plane</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ModelElement.PointInRectangle(System.Drawing.Point,System.Drawing.Rectangle)">
- <summary>
- Returns true if a point is in a rectangle
- </summary>
- <param name="pt"></param>
- <param name="rect"></param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ModelElement.DoubleClick">
- <summary>
- When a double click is caught by the parent class call this method
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ModelElement.GetRoundedRect(System.Drawing.RectangleF,System.Single)">
- <summary>
- Creates a rounded corner rectangle from a regular rectangel
- </summary>
- <param name="baseRect"></param>
- <param name="radius"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ModelElement.IsDownstreamOf(DotSpatial.Modeling.Forms.ModelElement)">
- <summary>
- Returns true if this model element is downstram of the potentialUpstream element
- </summary>
- <param name="potentialUpstream"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ModelElement.GetParents">
- <summary>
- Returns a list of all model elements that are direct parents of this element
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ModelElement.IsUpstreamOf(DotSpatial.Modeling.Forms.ModelElement)">
- <summary>
- Returns true if this model element is downstream of the potentialUpstream element
- </summary>
- <param name="potentialDownstream"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ModelElement.GetChildren">
- <summary>
- Returns a list of all model elements that are direct children of this element
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ModelElement.ModelElements">
- <summary>
- Gets a list of all elements in the model
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ModelElement.Highlight">
- <summary>
- Returns 1 if the object is not highlighted less than 1 if it is highlighted
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ModelElement.Name">
- <summary>
- Gets or sets the text that is drawn on the element
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ModelElement.Font">
- <summary>
- Gets or sets the font used to draw the text on the element
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ModelElement.Shape">
- <summary>
- Gets or Sets the shape of the model component
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ModelElement.Color">
- <summary>
- Gets or set the base color of the shapes gradient
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ModelElement.Rectangle">
- <summary>
- Gets a rectangle representing the element, top left corner being the location of the parent form of the element
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ModelElement.Width">
- <summary>
- Gets or sets the width of the element
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ModelElement.Height">
- <summary>
- Gets or sets the shape of the element
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ModelElement.Location">
- <summary>
- Gets or sets the location of the element in the parent form
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ArrowElement.#ctor(DotSpatial.Modeling.Forms.ModelElement,DotSpatial.Modeling.Forms.ModelElement,System.Collections.Generic.List{DotSpatial.Modeling.Forms.ModelElement})">
- <summary>
- Creates an instance of an ArrowElement
- </summary>
- <param name="sourceElement">The element the arrow starts at</param>
- <param name="destElement">the element the arrow ends at</param>
- <param name="modelElements">A list of all the elements in the model</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ArrowElement.UpdateDimentions">
- <summary>
- Updates the dimentions
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ArrowElement.Paint(System.Drawing.Graphics)">
- <summary>
- Repaints the form with cool background and stuff
- </summary>
- <param name="graph">The graphics object to paint to, the element will be drawn to 0, 0</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ArrowElement.PointInElement(System.Drawing.Point)">
- <summary>
- Calculates if a point is within the shape that defines the element
- </summary>
- <param name="point">A point to test in the virtual modeling plane</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ArrowElement.ElementInRectangle(System.Drawing.Rectangle)">
- <summary>
- Returns true if the element intersect the rectangle from the parent class
- </summary>
- <param name="rect">The rectangle to test must be in the virtual modeling coordinant plane</param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ArrowElement.StopElement">
- <summary>
- Gets or sets the destination Element
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ArrowElement.StartElement">
- <summary>
- Gets or sets the source element
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ArrowElement.StartPoint">
- <summary>
- the point in the arrows coordinants we draw from
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ArrowElement.StopPoint">
- <summary>
- the point in the arrows coordinants we stop drawing from
- </summary>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.BlankElement">
- <summary>
- A default element
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.BlankElement.#ctor(System.Collections.Generic.List{DotSpatial.Modeling.Forms.ModelElement})">
- <summary>
- Creates an instance of the Data Element
- <param name="modelElements">A list of all the elements in the model</param>
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.BlankElement.Paint(System.Drawing.Graphics)">
- <summary>
- Does nothing
- </summary>
- <param name="graph"></param>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.DataElement">
- <summary>
- Element for Data
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.DataElement.#ctor(DotSpatial.Modeling.Forms.Parameter,System.Collections.Generic.List{DotSpatial.Modeling.Forms.ModelElement})">
- <summary>
- Creates an instance of the Data Element
- <param name="parameter">One of Brian's Parameter classes</param>
- <param name="modelElements">A list of all the elements in the model</param>
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.DataElement.DoubleClick">
- <summary>
- When the user doulbe clicks on a tool call this method
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.DataElement.DataType">
- <summary>
- Gets the dataType of the DataElement
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.DataElement.Parameter">
- <summary>
- Gets or sets the Data set that this element represents
- </summary>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.ModelShape">
- <summary>
- Definitions for the shapes that components can have in the modeler
- </summary>
- </member>
- <member name="F:DotSpatial.Modeling.Forms.ModelShape.Rectangle">
- <summary>
- Defines the Model Component as a Rectangle
- </summary>
- </member>
- <member name="F:DotSpatial.Modeling.Forms.ModelShape.Triangle">
- <summary>
- Defines the Model Component as a Triangle
- </summary>
- </member>
- <member name="F:DotSpatial.Modeling.Forms.ModelShape.Ellipse">
- <summary>
- Defines the Model Component as a Ellipse
- </summary>
- </member>
- <member name="F:DotSpatial.Modeling.Forms.ModelShape.Arrow">
- <summary>
- Defines an Arrow
- </summary>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.ToolExecuteStatus">
- <summary>
- Used internally to decided if a tool has executed, is done, or finished in error
- </summary>
- </member>
- <member name="F:DotSpatial.Modeling.Forms.ToolExecuteStatus.NotRun">
- <summary>
- The tool has not been run yet
- </summary>
- </member>
- <member name="F:DotSpatial.Modeling.Forms.ToolExecuteStatus.Running">
- <summary>
- The tool is currently executing
- </summary>
- </member>
- <member name="F:DotSpatial.Modeling.Forms.ToolExecuteStatus.Done">
- <summary>
- The tool finished running succesfully
- </summary>
- </member>
- <member name="F:DotSpatial.Modeling.Forms.ToolExecuteStatus.Error">
- <summary>
- The tool returned an error when executing
- </summary>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.ModelerMenuStrip">
- <summary>
- A Menu strip that is part of Brian's toolbox
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ModelerMenuStrip.#ctor">
- <summary>
- Creates a new instance of hte ModelerMenuStrip
- </summary>
- </member>
- <member name="F:DotSpatial.Modeling.Forms.ModelerMenuStrip.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ModelerMenuStrip.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ModelerMenuStrip.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.ToolElement">
- <summary>
- the basic element for tools
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ToolElement.#ctor(DotSpatial.Modeling.Forms.ITool,System.Collections.Generic.List{DotSpatial.Modeling.Forms.ModelElement})">
- <summary>
- Creates an instance of the tool element
- </summary>
- <param name="tool">The tool that the tool element represents</param>
- <param name="modelElements">A list of all the elements in the model</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ToolElement.UpdateStatus">
- <summary>
- Updates the status indicator
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ToolElement.DrawStatusLight(System.Drawing.Graphics)">
- <summary>
- Draws the status light on the background of the DataElement
- </summary>
- <param name="graph"></param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ToolElement.DoubleClick">
- <summary>
- When the user doulbe clicks on a tool call this method
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ToolElement.ExecutionStatus">
- <summary>
- Gets or sets the status of the tools execution, used when the modeler runs the model.
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ToolElement.Tool">
- <summary>
- Gets the ITool this element represents
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ToolElement.ElementsInModel">
- <summary>
- Gets or sets the list of Elements presently available in the Modeler
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ToolElement.ToolStatus">
- <summary>
- Gets the current status of the tool
- </summary>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.TextFile">
- <summary>
- This class is used to enable linking of tools
- that work with File parameters
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.TextFile.#ctor">
- <summary>
- Text File constructor
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.TextFile.#ctor(System.String)">
- <summary>
- Creates a new instance of the TextFile class
- </summary>
- <param name="fileName">the associated file name</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.TextFile.ToString">
- <summary>
- To string
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.TextFile.FileName">
- <summary>
- The file name associated with this text file
- </summary>
- </member>
- <member name="T:DotSpatial.Modeling.Forms.ToolProgress">
- <summary>
- A form which shows the progress of a tool
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ToolProgress.#ctor(System.Int32)">
- <summary>
- Creates an instance of the Tool Progress forms and hands over an array of tools which will then be executed
- </summary>
- <param name="numTools">The number of tools that are going to be executed</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ToolProgress.Progress(System.String,System.Int32,System.String)">
- <summary>
- Handles the progress method necessary to implement IProgress
- </summary>
- <param name="key">This a message with no percentage information..this is ignored</param>
- <param name="percent">The integer percentage from 0 to 100 that is used to control the progress bar</param>
- <param name="message">The actual complete message to show..this is also ignored</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ToolProgress.ExecutionComplete">
- <summary>
- This method should be called when the process has been completed
- </summary>
- </member>
- <member name="F:DotSpatial.Modeling.Forms.ToolProgress.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ToolProgress.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Modeling.Forms.ToolProgress.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ToolProgress.ToolProgressCount">
- <summary>
- Gets or sets the number of tools that have been succesfully executed
- </summary>
- </member>
- <member name="P:DotSpatial.Modeling.Forms.ToolProgress.Cancel">
- <summary>
- Returns true if the cancel button was pressed
- </summary>
- </member>
- </members>
-</doc>
diff --git a/MES_Wind/bin/Debug/DotSpatial.Mono.pdb b/MES_Wind/bin/Debug/DotSpatial.Mono.pdb
deleted file mode 100644
index b37a69cb17774582573e9ca742bccb270956489b..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/DotSpatial.Mono.pdb and /dev/null differ
diff --git a/MES_Wind/bin/Debug/DotSpatial.Mono.xml b/MES_Wind/bin/Debug/DotSpatial.Mono.xml
deleted file mode 100644
index 855e1593ffd0e38b362572a4d3db87f4e261a332..0000000000000000000000000000000000000000
--- a/MES_Wind/bin/Debug/DotSpatial.Mono.xml
+++ /dev/null
@@ -1,8 +0,0 @@
-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>DotSpatial.Mono</name>
- </assembly>
- <members>
- </members>
-</doc>
diff --git a/MES_Wind/bin/Debug/DotSpatial.Positioning.Design.pdb b/MES_Wind/bin/Debug/DotSpatial.Positioning.Design.pdb
deleted file mode 100644
index e242f1679831722654fca89a026173c2170614a1..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/DotSpatial.Positioning.Design.pdb and /dev/null differ
diff --git a/MES_Wind/bin/Debug/DotSpatial.Positioning.Design.xml b/MES_Wind/bin/Debug/DotSpatial.Positioning.Design.xml
deleted file mode 100644
index ca95277e5836a65916ff1574a5f901ddaad68b58..0000000000000000000000000000000000000000
--- a/MES_Wind/bin/Debug/DotSpatial.Positioning.Design.xml
+++ /dev/null
@@ -1,623 +0,0 @@
-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>DotSpatial.Positioning.Design</name>
- </assembly>
- <members>
- <member name="T:DotSpatial.Positioning.Design.AngleConverter">
- <summary>
- Provides functionality to converting values to and from <strong>Angle</strong>
- objects.
- </summary>
- <remarks>
- <para>This class allows any <strong>Angle</strong> object to be converted between
- other data types, such as <strong>Double</strong>, <strong>Integer</strong> and
- <strong>String</strong>. This class is used primarily during the Windows Forms
- designer to give detailed information about properties of type
- <strong>Angle</strong>, and also allows developers to type in string values such as
- "1.50" and have them converted to <strong>Angle</strong> objects automatically.
- Finally, this class controls design-time serialization of <strong>Angle</strong>
- object properties.</para>
- <para>In most situations this class is used by the Visual Studio.NET IDE and is
- rarely created at run-time.</para>
- </remarks>
- </member>
- <member name="T:DotSpatial.Positioning.Design.PositioningNumericObjectConverter">
- <summary>
- An abstract class that is inherited by several other classes to handle type conversions.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.Design.PositioningObjectConverter">
- <summary>
- A base Expandable object converter
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Design.PositioningObjectConverter.CanConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Type)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.PositioningObjectConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.PositioningObjectConverter.CanConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Type)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.PositioningObjectConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Positioning.Design.PositioningObjectConverter.HandledTypeName">
- <summary>
- Indicates the name of the type handled by this type converter.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Design.PositioningObjectConverter.HandledAssemblyName">
- <summary>
- Indicates the full nume of the assembly housing objects handled by this type converter.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Design.PositioningObjectConverter.HandledAssemblyVersion">
- <summary>
- Gets the hard coded assembly version of the library that this designer handles.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Design.PositioningNumericObjectConverter.CanConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Type)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.PositioningNumericObjectConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.PositioningNumericObjectConverter.CanConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Type)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.AngleConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.AngleConverter.GetStandardValuesSupported(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.AngleConverter.GetStandardValues(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.AngleConverter.GetStandardValuesExclusive(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Positioning.Design.AngleConverter.HandledTypeName">
- <inheritdocs/>
- </member>
- <member name="T:DotSpatial.Positioning.Design.AreaConverter">
- <summary>
- Provides functionality to convert string values to and from Area objects at design time.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Design.AreaConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.AreaConverter.GetStandardValuesSupported(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.AreaConverter.GetStandardValues(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.AreaConverter.GetStandardValuesExclusive(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Positioning.Design.AreaConverter.HandledTypeName">
- <inheritdocs/>
- </member>
- <member name="T:DotSpatial.Positioning.Design.AzimuthConverter">
- <summary>
- Provides functionality to converting values to and from <strong>Azimuth</strong>
- objects.
- </summary>
- <remarks>
- <para>This class allows any <strong>Azimuth</strong> object to be converted between
- other data types, such as <strong>Double</strong>, <strong>Integer</strong> and
- <strong>String</strong>. This class is used primarily during the Windows Forms
- designer to give detailed information about properties of type
- <strong>Azimuth</strong>, and also allows developers to type in string values such
- as "NNW" and have them converted to <strong>Azimuth</strong> objects automatically.
- Finally, this class controls design-time serialization of <strong>Azimuth</strong>
- object properties.</para>
- <para>In most situations this class is used by the Visual Studio.NET IDE and is
- rarely created at run-time.</para>
- </remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Design.AzimuthConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.AzimuthConverter.GetStandardValuesSupported(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.AzimuthConverter.GetStandardValues(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.AzimuthConverter.GetStandardValuesExclusive(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Positioning.Design.AzimuthConverter.HandledTypeName">
- <inheritdocs/>
- </member>
- <member name="T:DotSpatial.Positioning.Design.CartesianPointConverter">
- <summary>
- Provides functionality to converting values to and from <strong>CartesianPoint</strong>
- objects.
- </summary>
- <remarks>
- <para>This class allows any <strong>CartesianPoint</strong> object to be converted between
- other data types, such as <strong>String</strong>. This class is used primarily
- during the Windows Forms designer to give detailed information about properties of
- type <strong>CartesianPoint</strong>, and also allows developers to type in string values
- such as "10m, 20m, 100m" and have them converted to <strong>CartesianPoint</strong> objects
- automatically. Finally, this class controls design-time serialization of
- <strong>CartesianPoint</strong> object properties.</para>
- <para>In most situations this class is used by the Visual Studio.NET IDE and is
- rarely created at run-time.</para>
- </remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Design.CartesianPointConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.CartesianPointConverter.GetStandardValuesSupported(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.CartesianPointConverter.GetStandardValues(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.CartesianPointConverter.GetStandardValuesExclusive(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Positioning.Design.CartesianPointConverter.HandledTypeName">
- <inheritdocs/>
- </member>
- <member name="T:DotSpatial.Positioning.Design.DilutionOfPrecisionConverter">
- <summary>
- Provides functionality to convert string values to and from DilutionOfPrecision objects at design time.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.Design.PositioningFormsNumericObjectConverter">
- <summary>
- The PositioningFormsNumericObjectConverter handles the object conversion but is tailored to work with the DotSpatial.Positioning.Forms class.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Design.PositioningFormsNumericObjectConverter.HandledAssemblyVersion">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Positioning.Design.PositioningFormsNumericObjectConverter.HandledAssemblyName">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.DilutionOfPrecisionConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.DilutionOfPrecisionConverter.GetStandardValuesSupported(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.DilutionOfPrecisionConverter.GetStandardValues(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.DilutionOfPrecisionConverter.GetStandardValuesExclusive(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Positioning.Design.DilutionOfPrecisionConverter.HandledTypeName">
- <inheritdocs/>
- </member>
- <member name="T:DotSpatial.Positioning.Design.DistanceConverter">
- <summary>
- Provides functionality to converting values to and from <strong>Distance</strong>
- objects.
- </summary>
- <remarks>
- <para>This class allows any <strong>Distance</strong> object to be converted
- between other data types, such as <strong>String</strong>. This class is used
- primarily during the Windows Forms designer to give detailed information about
- properties of type <strong>Distance</strong>, and also allows developers to type in
- string values such as "2 miles" and have them converted to
- <strong>Distance</strong> objects automatically. Finally, this class controls
- design-time serialization of <strong>Distance</strong> object properties.</para>
- <para>In most situations this class is used by the Visual Studio.NET IDE and is
- rarely created at run-time.</para>
- </remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Design.DistanceConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.DistanceConverter.GetStandardValuesSupported(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.DistanceConverter.GetStandardValues(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.DistanceConverter.GetStandardValuesExclusive(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Positioning.Design.DistanceConverter.HandledTypeName">
- <inheritdocs/>
- </member>
- <member name="T:DotSpatial.Positioning.Design.ElevationConverter">
- <summary>
- Provides functionality to converting values to and from
- <strong>Elevation</strong> objects.
- </summary>
- <remarks>
- <para>This class allows any <strong>Elevation</strong> object to be converted
- between other data types, such as <strong>Double</strong>, <strong>Integer</strong>
- and <strong>String</strong>. This class is used primarily during the Windows Forms
- designer to give detailed information about properties of type
- <strong>Elevation</strong>, and also allows developers to type in string values
- such as "45" and have them converted to <strong>Elevation</strong> objects
- automatically. Finally, this class controls design-time serialization of
- <strong>Elevation</strong> object properties.</para>
- <para>In most situations this class is used by the Visual Studio.NET IDE and is
- rarely created at run-time.</para>
- </remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Design.ElevationConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.ElevationConverter.GetStandardValuesSupported(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.ElevationConverter.GetStandardValues(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.ElevationConverter.GetStandardValuesExclusive(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Positioning.Design.ElevationConverter.HandledTypeName">
- <inheritdocs/>
- </member>
- <member name="T:DotSpatial.Positioning.Design.GeographicRectangleConverter">
- <summary>
- Provides functionality to converting values to and from
- <strong>GeographicRectangle</strong> objects.
- </summary>
- <remarks>
- <para>This class allows any <strong>GeographicRectangle</strong> object to be
- converted between other data types, such as <strong>String</strong>. This class is
- used primarily during the Windows Forms designer to give detailed information about
- properties of type <strong>GeographicRectangle</strong>, and also allows developers
- to type in string values such as "1, 2, 10, 10" and have them converted to
- <strong>GeographicRectangle</strong> objects automatically. Finally, this class
- controls design-time serialization of <strong>GeographicRectangle</strong> object
- properties.</para>
- <para>In most situations this class is used by the Visual Studio.NET IDE and is
- rarely created at run-time.</para>
- </remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Design.GeographicRectangleConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.GeographicRectangleConverter.GetStandardValuesSupported(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.GeographicRectangleConverter.GetStandardValues(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.GeographicRectangleConverter.GetStandardValuesExclusive(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Positioning.Design.GeographicRectangleConverter.HandledTypeName">
- <inheritdocs/>
- </member>
- <member name="T:DotSpatial.Positioning.Design.GeographicSizeConverter">
- <summary>
- Provides functionality to converting values to and from
- <strong>GeographicSize</strong> objects.
- </summary>
- <remarks>
- <para>This class allows any <strong>GeographicSize</strong> object to be converted
- between other data types, such as <strong>String</strong>. This class is used
- primarily during the Windows Forms designer to give detailed information about
- properties of type <strong>GeographicSize</strong>, and also allows developers to
- type in string values such as "1, 2" and have them converted to
- <strong>GeographicSize</strong> objects automatically. Finally, this class controls
- design-time serialization of <strong>GeographicSize</strong> object
- properties.</para>
- <para>In most situations this class is used by the Visual Studio.NET IDE and is
- rarely created at run-time.</para>
- </remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Design.GeographicSizeConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.GeographicSizeConverter.GetStandardValuesSupported(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.GeographicSizeConverter.GetStandardValues(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.GeographicSizeConverter.GetStandardValuesExclusive(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Positioning.Design.GeographicSizeConverter.HandledTypeName">
- <inheritdocs/>
- </member>
- <member name="T:DotSpatial.Positioning.Design.LatitudeConverter">
- <summary>
- Provides functionality to convert string values to and from Latitude objects at design time.
- </summary>
- <remarks>
- <para>This class allows any <strong>Latitude</strong> object to be converted
- between other data types, such as <strong>Double</strong>, <strong>Integer</strong>
- and <strong>String</strong>. This class is used primarily during the Windows Forms
- designer to give detailed information about properties of type
- <strong>Latitude</strong>, and also allows developers to type in string values such
- as "12N" (for 12° North) and have them converted to <strong>Latitude</strong>
- objects automatically. Finally, this class controls design-time serialization of
- <strong>Latitude</strong> object properties.</para>
- <para>In most situations this class is used by the Visual Studio.NET IDE and is
- rarely created at run-time.</para>
- </remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Design.LatitudeConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.LatitudeConverter.GetStandardValuesSupported(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.LatitudeConverter.GetStandardValues(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.LatitudeConverter.GetStandardValuesExclusive(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Positioning.Design.LatitudeConverter.HandledTypeName">
- <inheritdocs/>
- </member>
- <member name="T:DotSpatial.Positioning.Design.LongitudeConverter">
- <summary>
- Provides functionality to convert string values to and from Longitude objects at design time.
- </summary>
- <remarks>
- <para>This class allows any <strong>Longitude</strong> object to be converted
- between other data types, such as <strong>Double</strong>, <strong>Integer</strong>
- and <strong>String</strong>. This class is used primarily during the Windows Forms
- designer to give detailed information about properties of type
- <strong>Longitude</strong>, and also allows developers to type in string values
- such as "54E" (for 54° East) and have them converted to <strong>Longitude</strong>
- objects automatically. Finally, this class controls design-time serialization of
- <strong>Longitude</strong> object properties.</para>
- <para>In most situations this class is used by the Visual Studio.NET IDE and is
- rarely created at run-time.</para>
- </remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Design.LongitudeConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.LongitudeConverter.GetStandardValuesSupported(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.LongitudeConverter.GetStandardValues(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.LongitudeConverter.GetStandardValuesExclusive(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Positioning.Design.LongitudeConverter.HandledTypeName">
- <inheritdocs/>
- </member>
- <member name="T:DotSpatial.Positioning.Design.PercentConverter">
- <summary>
- Provides functionality to converting values to and from <strong>Percent</strong>
- objects.
- </summary>
- <remarks>
- <para>This class allows any <strong>Percent</strong> object to be converted between
- other data types, such as <strong>Double</strong>, <strong>Integer</strong> and
- <strong>String</strong>. This class is used primarily during the Windows Forms
- designer to give detailed information about properties of type
- <strong>Percent</strong>, and also allows developers to type in string values such as
- "1.50" and have them converted to <strong>Percent</strong> objects automatically.
- Finally, this class controls design-time serialization of <strong>Percent</strong>
- object properties.</para>
- <para>In most situations this class is used by the Visual Studio.NET IDE and is
- rarely created at run-time.</para>
- </remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Design.PercentConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.PercentConverter.GetStandardValuesSupported(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.PercentConverter.GetStandardValues(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.PercentConverter.GetStandardValuesExclusive(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Positioning.Design.PercentConverter.HandledTypeName">
- <inheritdocs/>
- </member>
- <member name="T:DotSpatial.Positioning.Design.PointDConverter">
- <summary>
- Provides functionality to converting values to and from <strong>PointD</strong>
- objects.
- </summary>
- <remarks>
- <para>This class allows any <strong>PointD</strong> object to be converted between
- other data types, such as <strong>String</strong>. This class is used primarily
- during the Windows Forms designer to give detailed information about properties of
- type <strong>PointD</strong>, and also allows developers to type in string values
- such as "10.123, 20.123" and have them converted to <strong>PointD</strong> objects
- automatically. Finally, this class controls design-time serialization of
- <strong>PointD</strong> object properties.</para>
- <para>In most situations this class is used by the Visual Studio.NET IDE and is
- rarely created at run-time.</para>
- </remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Design.PointDConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.PointDConverter.GetStandardValuesSupported(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.PointDConverter.GetStandardValues(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.PointDConverter.GetStandardValuesExclusive(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Positioning.Design.PointDConverter.HandledTypeName">
- <inheritdocs/>
- </member>
- <member name="T:DotSpatial.Positioning.Design.PositionConverter">
- <summary>
- Provides functionality to converting values to and from <strong>Position</strong>
- objects.
- </summary>
- <remarks>
- <para>This class allows any <strong>Position</strong> object to be converted
- between other data types, such as <strong>String</strong>. This class is used
- primarily during the Windows Forms designer to give detailed information about
- properties of type <strong>Position</strong>, and also allows developers to type in
- string values such as "29N, 42W" (for 29°North by 42°West) and have them converted
- to <strong>Position</strong> objects automatically. Finally, this class controls
- design-time serialization of <strong>Position</strong> object properties. UTM
- coordinates such as "13S 12345E 12345N" are also accepted.</para>
- <para>In most situations this class is used by the Visual Studio.NET IDE and is
- rarely created at run-time.</para>
- </remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Design.PositionConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.PositionConverter.GetStandardValuesSupported(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.PositionConverter.GetStandardValues(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.PositionConverter.GetStandardValuesExclusive(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Positioning.Design.PositionConverter.HandledTypeName">
- <inheritdocs/>
- </member>
- <member name="T:DotSpatial.Positioning.Design.RadianConverter">
- <summary>
- Type converter for angles in radians
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Design.RadianConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.RadianConverter.GetStandardValuesSupported(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.RadianConverter.GetStandardValues(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.RadianConverter.GetStandardValuesExclusive(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdoc/>
- </member>
- <member name="P:DotSpatial.Positioning.Design.RadianConverter.HandledTypeName">
- <inheritdoc/>
- </member>
- <member name="T:DotSpatial.Positioning.Design.RectangleDConverter">
- <summary>
- Provides functionality to converting values to and from
- <strong>RectangleD</strong> objects.
- </summary>
- <remarks>
- <para>This class allows any <strong>RectangleD</strong> object to be converted
- between other data types, such as <strong>String</strong>. This class is used
- primarily during the Windows Forms designer to give detailed information about
- properties of type <strong>RectangleD</strong>, and also allows developers to type
- in string values such as "1.5, 2.5, 4.5, 7.8" and have them converted to
- <strong>RectangleD</strong> objects automatically. Finally, this class controls
- design-time serialization of <strong>RectangleD</strong> object properties.</para>
- <para>In most situations this class is used by the Visual Studio.NET IDE and is
- rarely created at run-time.</para>
- </remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Design.RectangleDConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.RectangleDConverter.GetStandardValuesSupported(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.RectangleDConverter.GetStandardValues(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.RectangleDConverter.GetStandardValuesExclusive(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Positioning.Design.RectangleDConverter.HandledTypeName">
- <inheritdocs/>
- </member>
- <member name="T:DotSpatial.Positioning.Design.SignalToNoiseRatioConverter">
- <summary>
- Provides functionality to convert string values to and from SignalToNoiseRatio objects at design time.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Design.SignalToNoiseRatioConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.SignalToNoiseRatioConverter.GetStandardValuesSupported(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.SignalToNoiseRatioConverter.GetStandardValues(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.SignalToNoiseRatioConverter.GetStandardValuesExclusive(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Positioning.Design.SignalToNoiseRatioConverter.HandledTypeName">
- <inheritdocs/>
- </member>
- <member name="T:DotSpatial.Positioning.Design.SizeDConverter">
- <summary>
- Provides functionality to converting values to and from <strong>SizeD</strong>
- objects.
- </summary>
- <remarks>
- <para>This class allows any <strong>Position</strong> object to be converted
- between other data types, such as <strong>String</strong>. This class is used
- primarily during the Windows Forms designer to give detailed information about
- properties of type <strong>Position</strong>, and also allows developers to type in
- string values such as "29.23, 15.65" and have them converted to
- <strong>Position</strong> objects automatically. Finally, this class controls
- design-time serialization of <strong>Position</strong> object properties.</para>
- <para>In most situations this class is used by the Visual Studio.NET IDE and is
- rarely created at run-time.</para>
- </remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Design.SizeDConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.SizeDConverter.GetStandardValuesSupported(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.SizeDConverter.GetStandardValues(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Design.SizeDConverter.GetStandardValuesExclusive(System.ComponentModel.ITypeDescriptorContext)">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Positioning.Design.SizeDConverter.HandledTypeName">
- <inheritdocs/>
- </member>
- <member name="T:DotSpatial.Positioning.Design.SpeedConverter">
- <summary>
- Provides functionality to converting values to and from <strong>Speed</strong>
- objects.
- </summary>
- <remarks>
- <para>This class allows any <strong>Speed</strong> object to be converted between
- other data types, such as <strong>String</strong>. This class is used primarily
- during the Windows Forms designer to give detailed information about properties of
- type <strong>Speed</strong>, and also allows developers to type in string values
- such as "120 km/h" and have them converted to <strong>Speed</strong> objects
- automatically. Finally, this class controls design-time serialization of
- <strong>Speed</strong> object properties.</para>
- <para>In most situations this class is used by the Visual Studio.NET IDE and is
- rarely created at run-time.</para>
- </remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Design.SpeedConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Positioning.Design.SpeedConverter.HandledTypeName">
- <inheritdocs/>
- </member>
- </members>
-</doc>
diff --git a/MES_Wind/bin/Debug/DotSpatial.Positioning.Forms.pdb b/MES_Wind/bin/Debug/DotSpatial.Positioning.Forms.pdb
deleted file mode 100644
index 5c9e8524499b6b9810344688d0d182f95fc69e82..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/DotSpatial.Positioning.Forms.pdb and /dev/null differ
diff --git a/MES_Wind/bin/Debug/DotSpatial.Positioning.Forms.xml b/MES_Wind/bin/Debug/DotSpatial.Positioning.Forms.xml
deleted file mode 100644
index 92186b452c24c99ce688be6d91022789c059ec9a..0000000000000000000000000000000000000000
--- a/MES_Wind/bin/Debug/DotSpatial.Positioning.Forms.xml
+++ /dev/null
@@ -1,2577 +0,0 @@
-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>DotSpatial.Positioning.Forms</name>
- </assembly>
- <members>
- <member name="T:DotSpatial.Positioning.Forms.Altimeter">
- <summary>Represents a user control used to display altitude.</summary>
- <remarks>
- Altimeters are used to visually represent some form of altitude, typically the
- user's current altitude above sea level. Altitude is measured using three needles which
- represent (from longest to shortest) hundreds, thousands and tens-of-thousands. The
- display of the Altimeter is controlled via the <strong>Value</strong> property.
- </remarks>
- </member>
- <member name="T:DotSpatial.Positioning.Forms.PolarControl">
- <summary>
- Represents a base class for round controls painted using polar
- coordinates.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.Forms.DoubleBufferedControl">
- <summary>
- Represents a base class for designing flicker-free, multithreaded user
- controls.
- </summary>
- <remarks>
- <para>This powerful and versatile class provides a framework upon which to create
- high-performance owner-drawn controls. Common rendering challenges such as
- multithreading, thread synchronization, double-buffering, performance tuning,
- platform tuning and animation are all handled by this class.</para>
- <para>Controls which inherit from this class perform all paint operations by
- overriding the <strong>OnPaintOffScreen</strong> method, and optionally the
- <strong>OnPaintOffScreenBackground</strong> and
- <strong>OnPaintOffScreenAdornments</strong> methods. Controls which demand higher
- performance should perform all rendering on a separate thread. This is done by
- setting the <strong>IsPaintingOnSeparateThread</strong> property to
- <strong>True</strong>. Since the actual painting of the control is handled by this
- class, the <strong>OnPaint</strong> method should not be overridden.</para>
- <para>When all off-screen paint operations have completed, this class will copy the
- contents of the off-screen bitmap to the on-screen bitmap which is visibly
- displayed on the control. By deferring all rendering operations to another thread,
- the user interface remains very responsive even during time-consuming paint
- operations.</para>
- <para>Performance tuning is another major feature of this class. The
- <strong>OptimizationMode</strong> property gives developers the ability to tune
- rendering performance for animation speed, rendering quality, low CPU usage, or a
- balance between all three.</para>
- <para>While thread synchronization has been implemented wherever possible in this
- class, and the class is almost entirely thread-safe, some care should be taken when
- accessing base <strong>Control</strong> properties from a separate thread. Even
- basic properties like <strong>Visible</strong> can fail, especially on the Compact
- Framework. For minimal threading issues, avoid reading control properties during
- paint events.</para>
- <para>This class has been tuned to deliver the best performance on all versions of
- the .NET Framework (1.0, 1.1 and 2.0) as well as the .NET Compact Framework (1.0
- and 2.0). Compatibility is also managed internally, which simplifies the process of
- porting controls to the Compact Framework.</para>
- </remarks>
- <example>
- This example demonstrates how little code is required to use features like
- double-buffering and multithreading. <strong>IsPaintingOnSeparateThread</strong>
- enables multithreading, and all paint operations take place in the
- <strong>OnPaintOffScreen</strong> method instead of <strong>OnPaint</strong>. To
- prevent memory leaks, all GDI objects are disposed of during the
- <strong>Dispose</strong> method.
- <code lang="VB" title="[New Example]">
- Public Class MyControl
- Inherits DoubleBufferedControl
- Dim MyBrush As New SolidBrush(Color.Blue)
-
- Sub New()
- IsPaintingOnSeparateThread = True
- End Sub
-
- Protected Overrides Sub OnPaintOffScreen(ByVal e As CancelablePaintEventArgs)
- e.Graphics.FillRectangle(MyBrush, New Rectangle(50, 50, 50, 50))
- End Sub
-
- Public Overrides Sub Dispose(ByVal disposing As Boolean)
- MyBrush.Dispose()
- End Sub
- End Class
- </code>
- <code lang="CS" title="[New Example]">
- public class MyControl : DoubleBufferedControl
- {
- SolidBrush MyBrush = new SolidBrush(Color.Blue);
-
- MyControl()
- {
- IsPaintingOnSeparateThread = true;
- }
-
- protected override void OnPaintOffScreen(PaintEventArgs e)
- {
- e.Graphics.FillRectangle(MyBrush, New Rectangle(50, 50, 50, 50));
- }
-
- public override void Dispose(bool disposing)
- {
- MyBrush.Dispose();
- }
- }
- </code>
- </example>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.DoubleBufferedControl.#ctor">
- <summary>Creates a new instance.</summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.DoubleBufferedControl.#ctor(System.String)">
- <summary>Creates a new instance using the specified thread name.</summary>
- <param name="threadName">
- The name associated with the rendering thread when rendering is multithreaded.
- This name appears in the Output window when the thread exits and can be useful during
- debugging. The name should also contain a company or support URL.
- </param>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.DoubleBufferedControl.ResumePainting">
- <summary>
- Allows the control to be repainted after a call to SuspendPainting.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.DoubleBufferedControl.SuspendPainting">
- <summary>
- Temporarily pauses all painting operations.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.DoubleBufferedControl.InvokeRepaint">
- <summary>
- Repaints the control either directly or via the painting thread.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.DoubleBufferedControl.Repaint">
- <summary>
- Redraws the control off-screen.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.DoubleBufferedControl.OnPaintException(System.Exception)">
- <summary>Occurs when an exception occurs during a multithreaded paint operation.</summary>
- <remarks>
- <para>Exceptions caught during rendering iterations are channeled through this
- method instead of being re-thrown. This allows developers the ability to silently
- handle rendering problems without letting them interrupt the user interface. This
- method invokes the <strong>ExceptionOccurred</strong> event.</para>
- </remarks>
- <example>
- This example demonstrates how to be notified of rendering failures using the
- <strong>OnPaintException</strong> method.
- <code lang="VB" title="[New Example]">
- Public Class MyControl
- Inherits DoubleBufferedControl
-
- Protected Overrides Sub OnPaintOffScreen(ByVal e As CancelablePaintEventArgs)
- ' Cause an error by using a null pen
- e.Graphics.DrawRectangle(Nothing, Rectangle.Empty)
- End Sub
-
- Protected Overrides Sub OnPaintException(ByVal e As ExceptionEventArgs)
- Throw e.Exception
- End Sub
- End Class
- </code>
- <code lang="CS" title="[New Example]">
- public class MyControl : DoubleBufferedControl
- {
- protected override void OnPaintOffScreen(PaintEventArgs e)
- {
- // Cause an error by using a null pen
- e.Graphics.DrawRectangle(null, Rectangle.Empty);
- }
-
- protected override void OnPaintException(ExceptionEventArgs e)
- {
- throw e.Exception;
- }
- }
- </code>
- </example>
- <param name="exception">An <strong>Exception</strong> object describing the rendering error.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.DoubleBufferedControl.OnHandleCreated(System.EventArgs)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.DoubleBufferedControl.OnHandleDestroyed(System.EventArgs)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.DoubleBufferedControl.OnTargetFrameRateChanged(System.Int32)">
- <summary>Occurs when the desired frame rate has changed.</summary>
- <remarks>
- This virtual method is called whenever the <strong>TargetFrameRate</strong>
- property has changed. This method gives controls the opportunity to adjust animation
- effects to achieve the frame rate as closely as possible.
- </remarks>
- <param name="framesPerSecond">
- An <strong>Integer</strong> specifying the ideal or desired frame rate for the
- control.
- </param>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.DoubleBufferedControl.OnPaintOffScreen(System.Windows.Forms.PaintEventArgs)">
- <summary>Performs all major painting operations for the control.</summary>
- <remarks>
- <para>This method must be overridden. All painting operations for the control take
- place during this method. After this method completes, the
- <strong>OnPaintOffScreenAdornments</strong> method is called. When all painting
- operations have completed, the task of repainting the control visually takes place
- automatically.</para>
- <para>Developers seeking to upgrade their existing controls to use this control
- must move all code from <strong>OnPaint</strong> into
- <strong>OnPaintOffScreen</strong>. For best performance, the
- <strong>OnPaint</strong> method would not be overridden at all.</para>
- </remarks>
- <param name="e">
- A <strong>CancelablePaintEventArgs</strong> object used for all painting
- operations, as well as to signal when a rendering iteration has been aborted.
- </param>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.DoubleBufferedControl.OnPaintOffScreenBackground(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Optional. Performs painting operations which draw the control's
- background.
- </summary>
- <remarks>
- <para>This method provides the ability to prepare the background of the control
- before major painting operations take place. By default, this method calls the
- <strong>Graphics.Clear</strong> method to erase the control to the background
- color.</para>
- <para>This method can be overridden to perform certain visual effects. For example,
- the <strong>PolarControl</strong> class, which inherits from this class, uses this
- method to apply a fading circular gradient to create a 3D illusion. Then, the
- <strong>OnPaintOffScreenAdornments</strong> method is also overridden to apply a
- second effect which gives the appearance of glass over the control. For more
- information on glass effects, see the <strong>Effect</strong> property of the
- <strong>PolarControl</strong> class.</para>
- </remarks>
- <param name="e">
- A <strong>CancelablePaintEventArgs</strong> object used for all painting
- operations, as well as to signal when a rendering iteration has been aborted.
- </param>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.DoubleBufferedControl.OnPaintOffScreenAdornments(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Optional. Performs any additional painting operations after the main portions of
- the control are painted.
- </summary>
- <remarks>
- By default, this method does nothing. This method can be overridden to apply
- certain details, however, such as a watermark, company logo, or glass. For example, the
- <strong>PolarControl</strong> class overrides this method to apply a glass effect on
- top of anything that has already been painted. For more information on glass effects,
- see the <strong>Effect</strong> property of the <strong>PolarControl</strong>
- class.
- </remarks>
- <param name="e">
- A <strong>CancelablePaintEventArgs</strong> object used for all painting
- operations, as well as to signal when a rendering iteration has been aborted.
- </param>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.DoubleBufferedControl.OnResize(System.EventArgs)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.DoubleBufferedControl.OnVisibleChanged(System.EventArgs)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.DoubleBufferedControl.OnInitialize">
- <summary>
- Occurs when the control is about to be rendered for the first time.
- </summary>
- <remarks>
- <para>This virtual method provides the ability to prepare any local variables
- before the control is painted for the first time. This method is typically used to
- create GDI objects such as <strong>Pen</strong>, <strong>Brush</strong>, and
- <strong>Font</strong> immediately before they are needed. It is recommended that
- this event be used to create any such GDI objects. Additionally, it is also
- recommended that GDI objects get created outside of the
- <strong>OnPaintOffScreen</strong> method if they are used repeatedly.</para>
- <para>For desktop framework applications, this method is called when the control's
- handle is created. For Compact Framework 1.0 applications, there is no handle
- creation event, so this method is called when the first call to
- <strong>OnPaint</strong> occurs.</para>
- </remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.DoubleBufferedControl.OnPaint(System.Windows.Forms.PaintEventArgs)">
- <summary>Occurs when the control is to be redrawn on-screen.</summary>
- <remarks>
- <para>In the <strong>DoubleBufferedControl</strong> class, the process of painting
- the control on-screen is handled automatically. As a result, this method does not
- have to be overloaded to paint the control. In fact, this method should not be
- overridden to perform any painting operations because it would defeat the purpose
- of the control and re-introduce flickering problems.</para>
- <para>Ideally, well-written controls will move any and all painting operations from
- the <strong>OnPaint</strong> method into the <strong>OnPaintOffScreen</strong>
- method, and avoid overriding <strong>OnPaint</strong> entirely. By keeping the
- <strong>OnPaint</strong> method as lightweight as possible, user interfaces remain
- responsive and free from flickering problems.</para>
- </remarks>
- <example>
- <para>This example demonstrates how a user control is upgraded from Control to the
- <strong>DoubleBufferedControl</strong> class. Upgrading is straightforward: All
- painting operations are moved from <strong>OnPaint</strong> to
- <strong>OnPaintOffScreen</strong> and <strong>OnPaint</strong> is no longer
- overridden.</para>
- <code lang="VB" title="[New Example]" description="Before: A control's paint operations before being upgraded to use the DoubleBufferedControl class.">
- Public Class MyControl
- Inherits Control
- Protected Overrides Sub OnPaint(ByVal e As PaintEventArgs)
- Dim MyBrush As New SolidBrush(Color.Blue)
- e.Graphics.FillRectangle(MyBrush, New Rectangle(50, 50, 50, 50))
- MyBrush.Dispose();
- End Sub
- End Class
- </code>
- <code lang="CS" title="[New Example]" description="Before: A control's paint operations before being upgraded to use the DoubleBufferedControl class.">
- public class MyControl : Control
- {
- protected override void OnPaint(PaintEventArgs e)
- {
- SolidBrush MyBrush = new SolidBrush(Color.Blue);
- e.Graphics.FillRectangle(MyBrush, new Rectangle(50, 50, 50, 50));
- MyBrush.Dispose();
- }
- }
- </code>
- <code lang="VB" title="[New Example]" description="After: A control's paint operations after upgrading to DoubleBufferedControl.">
- Public Class MyControl
- Inherits DoubleBufferedControl
- Protected Overrides Sub OnPaintOffScreen(ByVal e As CancelablePaintEventArgs)
- Dim MyBrush As New SolidBrush(Color.Blue)
- e.Graphics.FillRectangle(MyBrush, New Rectangle(50, 50, 50, 50))
- MyBrush.Dispose();
- End Sub
- End Class
- </code>
- <code lang="CS" title="[New Example]">
- public class MyControl : DoubleBufferedControl
- {
- protected override void OnPaintOffScreen(PaintEventArgs e)
- {
- SolidBrush MyBrush = new SolidBrush(Color.Blue);
- e.Graphics.FillRectangle(MyBrush, new Rectangle(50, 50, 50, 50));
- MyBrush.Dispose();
- }
- }
- </code>
- </example>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.DoubleBufferedControl.Finalize">
- <summary>
- Finalizes an instance of the DoubleBufferedControl class.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.DoubleBufferedControl.Dispose(System.Boolean)">
- <summary>Releases memory and GDI resources created by the control.</summary>
- <remarks>
- <para>This method is very important to implement properly when working with
- controls. Any <strong>Brush</strong>, <strong>Pen</strong>, <strong>Font</strong>,
- <strong>Matrix</strong>, <strong>GraphicsPath</strong>, <strong>Region</strong> or
- other GDI+ object containing a <strong>Dispose</strong> method must be disposed of
- before they are destructed by the garbage collector.</para>
- <para>Well-written controls will create unmanaged GDI+ objects outside of the
- <strong>OnPaintOffScreen</strong> method, then dispose of them during the
- <strong>Dispose</strong> method. This practice improves performance by creating as
- new new objects and resources as possible while minimizing problems which may occur
- due to resources which are not properly released.</para>
- <para>Failure to call the <strong>Dispose</strong> method on GDI+ objects will
- cause memory leaks which will slowly eat up available memory until the application
- can no longer function. Use the "GDI Objects" column of the Windows Task Manager to
- monitor the number of GDI objects allocated. Memory leaks will cause the GDI Object
- count to increase continuously, whereas well-written controls will experience a GDI
- Object count that remains fairly constant over a longer period of time.</para>
- <para>To view the GDI Objects column in the Windows Task Manager:</para>
- <para class="xmldocnumberedlist"></para>
- <list type="bullet">
- <item>Open the Windows Task Manager</item>
- <item>Select the "Processes" tab.</item>
- <item>Select "Choose Columns..." from the View menu.</item>
- <item>Check the "GDI Objects" box and click OK.</item>
- </list>
- </remarks>
- <example>
- This example demonstrates how a control might create subtle problems when the
- <strong>Dispose</strong> method is not used on every GDI+ object.
- <code lang="VB" title="[New Example]" description="An example of a poorly written control: A new SolidBrush is created on every paint iteration when it only needs to be created once. The brush is never disposed of, creating a memory leak.">
- Public Class MyControl
- Inherits DoubleBufferedControl
- Protected Overrides Sub OnPaintOffScreen(ByVal e As CancelablePaintEventArgs)
- Dim MyBrush As New SolidBrush(Color.Blue)
- e.Graphics.FillRectangle(MyBrush, New Rectangle(50, 50, 50, 50))
- End Sub
-
- ' Notice: MyBrush is never disposed. A memory leak
- ' will occur!
- End Class
- </code>
- <code lang="CS" title="[New Example]" description="An example of a poorly written control: A new SolidBrush is created on every paint iteration when it only needs to be created once. The brush is never disposed of, creating a memory leak.">
- public class MyControl : DoubleBufferedControl
- {
- protected override void OnPaintOffScreen(PaintEventArgs e)
- {
- SolidBrush MyBrush = new SolidBrush(Color.Blue);
- e.Graphics.FillRectangle(MyBrush, New Rectangle(50, 50, 50, 50));
- }
-
- // Notice: MyBrush is never disposed. A memory leak
- // will occur!
- }
- </code>
- <code lang="VB" title="[New Example]" description="Problems are solved by properly implementing the Dispose method. Performance is improved by moving the SolidBrush declaration out of OnPaintOffScreen.">
- Public Class MyControl
- Inherits DoubleBufferedControl
- ' 1. GDI objects are created outside of the OnPaintOffScreen
- ' methods whenever possible.
- Dim MyBrush As New SolidBrush(Color.Blue)
-
- Protected Overrides Sub OnPaintOffScreen(ByVal e As CancelablePaintEventArgs)
- ' 2. The paint method is as lightweight as possible,
- ' improving rendering performance
- e.Graphics.FillRectangle(MyBrush, New Rectangle(50, 50, 50, 50))
- End Sub
-
- Public Overrides Sub Dispose(ByVal disposing As Boolean)
- ' 3. Any GDI+ objects are disposed of properly
- MyBrush.Dispose()
- End Sub
- End Class
- </code>
- <code lang="CS" title="[New Example]" description="Problems are solved by properly implementing the Dispose method. Performance is improved by moving the SolidBrush declaration out of OnPaintOffScreen.">
- public class MyControl : DoubleBufferedControl
- {
- // 1. GDI objects are created outside of the OnPaintOffScreen
- // methods whenever possible.
- SolidBrush MyBrush = new SolidBrush(Color.Blue);
-
- protected override void OnPaintOffScreen(PaintEventArgs e)
- {
- // 2. The paint method is as lightweight as possible,
- // improving rendering performance
- e.Graphics.FillRectangle(MyBrush, New Rectangle(50, 50, 50, 50));
- }
-
- public override void Dispose(bool disposing)
- {
- // 3. Any GDI+ objects are disposed of properly
- MyBrush.Dispose();
- }
- }
- </code>
- </example>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.DoubleBufferedControl.ColorFromAhsb(System.Int32,System.Single,System.Single,System.Single)">
- <summary>
- Converts a color from HSB (hue, saturation, brightness) to RGB.
- </summary>
- <param name="a"></param>
- <param name="h"></param>
- <param name="s"></param>
- <param name="b"></param>
- <returns></returns>
- </member>
- <member name="E:DotSpatial.Positioning.Forms.DoubleBufferedControl.ExceptionOccurred">
- <summary>Occurs when an exception is thrown during off-screen painting operations.</summary>
- <remarks>
- <para>When the control is rendering on a separate thread, exceptions cannot be
- caught by a regular <strong>Try..Catch</strong> statement. Exceptions are instead
- channeled through this event. The control will also attempt to display exception
- information on-screen to inform developers of the code which failed.</para>
- <para>It is important to capture this event or override the
- <strong>OnPaintException</strong> method in order to be properly notified of
- problems. Without doing this, the control could fail to paint properly yet give no
- indication that there is a problem.</para>
- </remarks>
- <example>
- This example hooks into the <strong>ExceptionOccurred</strong> event of a control
- in order to handle painting exceptions.
- <code lang="VB" title="[New Example]">
- Public Class MyControl
- Inherits DoubleBufferedControl
-
- Sub New()
- ' Receive notifications of paint problems
- AddHandler ExceptionOccurred, AddressOf HandleExceptions
- End Sub
-
- Protected Overrides Sub OnPaintOffScreen(ByVal e As CancelablePaintEventArgs)
- ' Try to paint with a null Pen
- e.Graphics.DrawRectangle(Nothing, Rectangle.Empty)
- End Sub
-
- Private Sub HandleExceptions(ByVal sender As Object, ByVal e As ExceptionEventArgs)
- ' Write the error to the Debug window
- Debug.WriteLine(e.Exception.ToString())
- End Sub
- End Class
- </code>
- <code lang="CS" title="[New Example]">
- public class MyControl : DoubleBufferedControl
- {
- MyControl()
- {
- // Receive notifications of paint problems
- ExceptionOccurred += new ExceptionEventHandler(HandleExceptions);
- }
-
- protected override void OnPaintOffScreen(PaintEventArgs e)
- {
- // Try to paint with a null Pen.
- e.Graphics.DrawRectangle(null, Rectangle.Empty);
- }
-
- private sub HandleExceptions(object sender, ExceptionEventArgs e)
- {
- // Write the error to the Console
- Console.WriteLine(e.Exception.ToString());
- }
- }
- </code>
- </example>
- </member>
- <member name="E:DotSpatial.Positioning.Forms.DoubleBufferedControl.PaintOffScreen">
- <summary>
- Occurs when the control is to be redrawn in the background.
- </summary>
- <remarks>In the DoubleBufferedControl class, all painting occurs off-screen. Then, the off-screen bitmap is quickly
- drawn on-screen when painting completes. This event is called immediately after the PaintOffScreenBackground event.</remarks>
- </member>
- <member name="E:DotSpatial.Positioning.Forms.DoubleBufferedControl.PaintOffScreenBackground">
- <summary>
- Occurs when the control's background is to be redrawn before the main graphics of the control.
- </summary>
- <remarks>In the DoubleBufferedControl class, all painting occurs off-screen. Then, the off-screen bitmap is quickly
- drawn on-screen when painting completes. This event is called to paint any background graphics before the main elements of the
- control are drawn. Some painting effects, such as glass or plastic, use this event along with PaintOffScreenAdornments
- to add annotations to the control. This event is called immediately before the PaintOffScreen event.</remarks>
- </member>
- <member name="E:DotSpatial.Positioning.Forms.DoubleBufferedControl.PaintOffScreenAdornments">
- <summary>
- Occurs when additional graphics or annotations must be added to the control.
- </summary>
- <remarks>In the DoubleBufferedControl class, all painting occurs off-screen. Then, the off-screen bitmap is quickly
- drawn on-screen when painting completes. This event is called to paint any additional graphics after the main elements of the
- control are drawn. Some painting effects, such as glass, adding text or logos, use this event to draw on the control. This event is called immediately after the PaintOffScreen event.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.DoubleBufferedControl.IsDesignMode">
- <summary>
- Indicates whether the control is currently running inside of a Windows Forms designer.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.DoubleBufferedControl.IsDisposed">
- <summary>Indicates if the control and its resources have been disposed.</summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.DoubleBufferedControl.IsPaintingOnSeparateThread">
- <summary>
- Indicates if all off-screen rendering takes place on a separate thread.
- </summary>
- <remarks>
- <para>This powerful property controls whether or not rendering operations are
- multithreaded. When set to <strong>True</strong>, a new thread is launched and all
- subsequent calls to <strong>OnPaintOffScreen</strong>,
- <strong>OnPaintOffScreenBackground</strong> and
- <strong>OnPaintOffScreenAdornments</strong> occur on that thread. Thread
- synchronization features are enabled so that painting operations never interfere
- with rendering operations. The priority of the rendering thread is controlled via
- the <strong>ThreadPriority</strong> property.</para>
- <para>When this property is <strong>False</strong>, the rendering thread is torn
- down and all rendering occurs on the owner's thread. Controls which perform
- significant painting operations should enable this property to allow the user
- interface to be more responsive. As a general rule, any intense processing should
- be moved away from the user interface thread.</para>
- </remarks>
- <example>
- This example instructs the control to perform all rendering on a separate thread.
- Notice that all thread management is handled automatically -- the only operation
- required is enabling the property.
- <code lang="VB" title="[New Example]">
- Public Class MyControl
- Inherits DoubleBufferedControl
-
- Sub New()
- ' Enable multithreading
- IsPaintingOnSeparateThread = True
- End Sub
-
- ' This method is now called from another thread
- Protected Overrides Sub OnPaintOffScreen(ByVal e As CancelablePaintEventArgs)
- Dim MyBrush As New SolidBrush(Color.Blue)
- e.Graphics.FillRectangle(MyBrush, New Rectangle(50, 50, 50, 50))
- MyBrush.Dispose()
- End Sub
- End Class
- </code>
- <code lang="CS" title="[New Example]">
- public class MyControl : DoubleBufferedControl
- {
- MyControl()
- {
- // Enable multithreading
- IsPaintingOnSeparateThread = true;
- }
-
- // This method is now called from another thread
- protected overrides void OnPaintOffScreen(PaintEventArgs e)
- {
- SolidBrush MyBrush = new SolidBrush(Color.Blue);
- e.Graphics.FillRectangle(MyBrush, new Rectangle(50, 50, 50, 50));
- MyBrush.Dispose();
- }
- }
- </code>
- </example>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.DoubleBufferedControl.OffScreenBitmapOffset">
- <summary>
- Controls the upper-left portion of the off-screen bitmap to paint
- on-screen.
- </summary>
- <value>
- A <strong>Point</strong> structure indicating the corner of the off-screen bitmap
- to draw on-screen. Default is <strong>Empty</strong>.
- </value>
- <remarks>
- <para>If the size of the off-screen bitmap is different than the on-screen bitmap,
- a control may need to draw different portions of the off-screen bitmap. For
- example, if an off-screen bitmap is 200x200 pixels but the visible portion of the
- control is only 50x50 pixels, an offset of (10, 10) instructs the control to paint
- the off-screen bitmap from (10, 10)-(60, 60).</para>
- <para>for most controls, this property does not need to be overridden. Controls
- which override this property also override the <strong>OffScreenBitmapSize</strong>
- property to specify a size defferent than the visible portion of the
- control.</para>
- </remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.DoubleBufferedControl.OffScreenBitmap">
- <summary>Returns the bitmap used for off-screen painting operations.</summary>
- <value>A <strong>Bitmap</strong> containing off-screen painted data.</value>
- <remarks>
- <para>This control maintains two separate bitmaps: an "off-screen" bitmap, where
- all painting operations take place, and an "on-screen" bitmap which is displayed
- visually to the user. When an off-screen painting operation completes successfully,
- the off-screen bitmap is copies to the on-screen bitmap, then painted on the
- display. This property returns the off-screen bitmap created during the most recent
- paint iteration.</para>
- </remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.DoubleBufferedControl.ThreadPriority">
- <summary>Controls the relative priority of multithreaded painting operations.</summary>
- <value>
- A <strong>ThreadPriority</strong> value. Default is
- <strong>Normal</strong>.
- </value>
- <remarks>
- Painting operations may require more CPU time if they represent the majority of
- a user interface, or if painting operations are more complicated. Performance can be
- improved by increasing the priority of the rendering thread. Likewise, if a control is
- of minor importance to an application, a lower thread priority can improve performance
- in more important areas of the application.
- </remarks>
- <example>
- This example enables multithreaded painting then changes the priority of the
- rendering thread to <strong>Lowest</strong> to give the rest of the application
- more CPU time.
- <code lang="VB" title="[New Example]">
- Public Class MyControl
- Inherits DoubleBufferedControl
-
- Sub New()
- ' Enable multithreading
- IsPaintingOnSeparateThread = True
- ' Set a low thread priority
- ThreadPriority = ThreadPriority.Lowest
- End Sub
-
- ' This method is now called from another thread
- Protected Overrides Sub OnPaintOffScreen(ByVal e As CancelablePaintEventArgs)
- ' ...etc.
- End Sub
- End Class
- </code>
- <code lang="CS" title="[New Example]">
- public class MyControl : DoubleBufferedControl
- {
- MyControl()
- {
- // Enable multithreading
- IsPaintingOnSeparateThread = true;
- // Set a low thread priority
- ThreadPriority = ThreadPriority.Lowest;
- }
-
- // This method is now called from another thread
- protected override void OnPaintOffScreen(PaintEventArgs e)
- {
- // ...etc.
- }
- }
- </code>
- </example>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.DoubleBufferedControl.BackColor">
- <summary>Controls the background color of the control.</summary>
- <value>A <strong>Color</strong> structure representing the background color.</value>
- <remarks>
- The default <strong>BackColor</strong> property of the <strong>Control</strong>
- class cannot be accessed from a thread other than the UI thread. As a result, this
- property was shadowed in order to make it thread-safe.
- </remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.DoubleBufferedControl.IsExceptionTextAllowed">
- <summary>
- Controls whether exception messages are displayed on the control.
- </summary>
- <remarks>In some situations, an exception can occur during a paint operation. To notify
- developers of the problem, the error text is written directly to the control. This behavior
- may not be suitable for some developers, however, who want to trap errors more gracefully.
- Setting this property to False causes error messages to never be drawn on the control. The
- ExceptionOccurred event should instead be used to gracefully handle errors when they occur.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.DoubleBufferedControl.Width">
- <summary>Returns the width of the control in pixels.</summary>
- <value>An <strong>Integer</strong> indicating the width of the control in pixels.</value>
- <remarks>
- The default <strong>Width</strong> property of the <strong>Control</strong> class
- cannot be accessed from a thread other than the UI thread. As a result, this property
- was shadowed in order to make it thread-safe.
- </remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.DoubleBufferedControl.Size">
- <summary>
- Returns the horizontal and vertical length of the control in pixels.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.DoubleBufferedControl.Height">
- <remarks>
- The default <strong>Height</strong> property of the <strong>Control</strong>
- class cannot be accessed from a thread other than the UI thread. As a result, this
- property was shadowed in order to make it thread-safe.
- </remarks>
- <summary>Returns the height of the control in pixels.</summary>
- <value>An <strong>Integer</strong> indicating the width of the control in pixels.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.DoubleBufferedControl.OnScreenBitmap">
- <summary>Returns the bitmap used to paint the visible portion of the control.</summary>
- <value>A <strong>Bitmap</strong> containing data to be painted on the display.</value>
- <remarks>
- <para>This control maintains two separate bitmaps: an "off-screen" bitmap, where
- all painting operations take place, and an "on-screen" bitmap which is displayed
- visually to the user. When an off-screen painting operation completes successfully,
- the off-screen bitmap is copies to the on-screen bitmap, then painted on the
- display. This property returns the on-screen bitmap matching what is actually seen
- in the control.</para>
- </remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.DoubleBufferedControl.TargetFramesPerSecond">
- <summary>Controls the desired frame rate for rendering operations.</summary>
- <value>
- An <strong>Integer</strong> indicating the desired frame rate. Default is
- <strong>30</strong>.
- </value>
- <remarks>
- <para>This property is used by controls which make use of animation effects.
- Typically, this property tells a control how long to delay between repaint
- operations, or how many frames to allocate for a certain time period. Controls
- which do not do any custom animation effects ignore this property and it has no
- effect. When this property changes, the <strong>OnTargetFrameRateChanged</strong>
- virtual method is called.</para>
- <para>If a control is able to repaint itself very quickly, smooth animation effects
- can be achieved. A refresh rate of 30 frames per second or above is necessary to
- give the human eye the illusion of motion. Refresh rates of 60 or even 120 are
- possible for extremely fast controls and can result in very nice, smooth animation
- effects.</para>
- <para>This property can be a bit confusing for developers because it does not
- control the rate at which the control is actually repainted. (The control is only
- repainted when necessary, whenever that occurs.) This property is used only to tune
- custom effects implemented by controls inheriting from this class.</para>
- </remarks>
- <example>
- This example animates a green rectangle. The default target frame rate is set to 60
- frames per second, which causes the interval of a timer to change. The timer
- changes the position of the rectangle.
- <code lang="VB" title="[New Example]">
- Public Class MyControl
- Inherits DoubleBufferedControl
- Dim AnimatedRectangle As Rectangle
-
- Sub New()
- ' Set a 60 frames per second target
- TargetFramesPerSecond = 60
- End Sub
-
- Protected Overrides Sub OnTargetFrameRateChanged()
- ' Change the timer to fire 60 times per second
- MyTimer.Interval = 1000 / TargetFramesPerSecond
- End Sub
-
- Private Sub MyTimer_Tick(ByVal sender As Object, ByVal e As EventArgs)
- ' Change the location of an animated thing
- AnimatedRectangle = New Rectangle((AnimatedRectangle.X + 1) Mod Width,
- (AnimatedRectangle.Y + 1) Mod Height,
- 50, 50)
- ' And cause the control to repaint
- InvokeRepaint()
- End Sub
-
- Protected Overrides Sub OnPaintOffScreen(ByVal e As CancelablePaintEventArgs)
- Dim MyBrush As New SolidBrush(Color.Green)
- e.Graphics.FillRectangle(MyBrush, AnimatedRectangle)
- MyBrush.Dispose()
- End Sub
- End Class
- </code>
- <code lang="CS" title="[New Example]">
- public class MyControl : DoubleBufferedControl
- Rectangle AnimatedRectangle;
-
- MyControl()
- {
- // Set a 60 frames per second target
- TargetFramesPerSecond = 60;
- }
-
- protected override void OnTargetFrameRateChanged()
- {
- // Change the timer to fire 60 times per second
- MyTimer.Interval = 1000 / TargetFramesPerSecond
- }
-
- private void MyTimer_Tick(object sender, EventArgs e)
- {
- // Change the location of an animated thing
- AnimatedRectangle = New Rectangle((AnimatedRectangle.X + 1) ^ Width,
- (AnimatedRectangle.Y + 1) ^ Height,
- 50, 50);
- // And cause the control to repaint
- InvokeRepaint();
- }
-
- protected override void OnPaintOffScreen(PaintEventArgs e)
- {
- SolidBrush MyBrush = new SolidBrush(Color.Green);
- e.Graphics.FillRectangle(MyBrush, AnimatedRectangle);
- MyBrush.Dispose();
- }
- }
- </code>
- </example>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.DoubleBufferedControl.GraphicsSettings">
- <summary>
- Controls the graphics quality settings for the control.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.DoubleBufferedControl.Center">
- <summary>
- Indicates the point at the center of the control.
- </summary>
- <remarks>This property is typically used for centering items in the control. This property
- is updated automatically as the control is resized.</remarks>
- <value>
- A <strong>Point</strong> structure representing the pixel at the center of the
- control.
- </value>
- <example>
- This example uses the <strong>Center</strong> property to center a rectangle in the
- middle of the control.
- <code lang="VB" title="[New Example]">
- Public Class MyControl
- Inherits DoubleBufferedControl
-
- Protected Overrides Sub OnPaintOffScreen(ByVal e As CancelablePaintEventArgs)
- ' Center a rectangle in the middle of the control
- Dim MyShape As New Rectangle(Center.X - 25, Center.Y - 25, 50, 50)
- ' Now paint it
- Dim MyBrush As New SolidBrush(Color.Green)
- e.Graphics.FillRectangle(MyBrush, MyShape)
- MyBrush.Dispose()
- End Sub
- End Class
- </code>
- <code lang="CS" title="[New Example]">
- public class MyControl : DoubleBufferedControl
- {
- protected override void OnPaintOffScreen(PaintEventArgs e)
- {
- // Center a rectangle in the middle of the control
- Rectangle MyShape = new Rectangle(Center.X - 25, Center.Y - 25, 50, 50);
- // Now paint it
- SolidBrush MyBrush = new SolidBrush(Color.Green);
- e.Graphics.FillRectangle(MyBrush, MyShape);
- MyBrush.Dispose();
- }
- }
- </code>
- </example>
- </member>
- <member name="F:DotSpatial.Positioning.Forms.PolarControl.GlassReflectionBrush">
- <summary>
- Glass reflection
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Forms.PolarControl.GlassReflectionRectangle">
- <summary>
- Glass reflection rectangle
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarControl.#ctor">
- <summary>
- Creates a new instance.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarControl.#ctor(System.String)">
- <summary>
- Creates a new instance using the specified thread name.
- </summary>
- <param name="threadName">A <strong>String</strong> representing the friendly name of the control.</param>
- <remarks>The thread name is dusplayed in the Visual Studio "Threads" debugging window. Multithreaded debugging
- can be simplified when threads are clearly and uniquely named.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarControl.Dispose(System.Boolean)">
- <summary>Cleans up any unmanaged GDI+ resources used during painting.</summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarControl.OnBackColorChanged(System.EventArgs)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarControl.MakeBrushes">
- <summary>
- Make Brushes
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarControl.OnEffectChanged(DotSpatial.Positioning.Forms.PolarControlEffect)">
- <summary>Occurs when the control's effect has changed.</summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarControl.OnResize(System.EventArgs)">
- <summary>Occurs when the control's size has changed.</summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarControl.OnRotationChanged(DotSpatial.Positioning.Angle)">
- <summary>Occurs when the control's rotation has changed.</summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarControl.OnOriginChanged(DotSpatial.Positioning.Azimuth)">
- <summary>Occurs when the compass direction associated with 0° has changed.</summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarControl.OnOrientationChanged(DotSpatial.Positioning.Forms.PolarCoordinateOrientation)">
- <summary>Occurs when the control's orientation has changed.</summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarControl.CreatePolarGraphics">
- <summary>
- Create Graphics
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarControl.CreatePolarGraphics(System.Drawing.Graphics)">
- <summary>
- Create Polar Graphics
- </summary>
- <param name="graphics"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarControl.OnPaintOffScreenBackground(System.Windows.Forms.PaintEventArgs)">
- <summary>Occurs when the control's background is painted.</summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarControl.OnPaintOffScreenAdornments(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Occurs when additional painting is performed on top of the control's main
- content.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarControl.Rotate(DotSpatial.Positioning.Angle)">
- <summary>Rotates the entire control to the specified value.</summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarControl.OnTargetFrameRateChanged(System.Int32)">
- <summary>Occurs when the desired animation frame rate has changed.</summary>
- </member>
- <member name="E:DotSpatial.Positioning.Forms.PolarControl.RotationChanged">
- <summary>Occurs when the rotation amount has changed.</summary>
- </member>
- <member name="E:DotSpatial.Positioning.Forms.PolarControl.OriginChanged">
- <summary>Occurs when the compass direction associated with 0° has changed.</summary>
- </member>
- <member name="E:DotSpatial.Positioning.Forms.PolarControl.OrientationChanged">
- <summary>Occurs when the control's coordinate orientation has changed.</summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.PolarControl.Effect">
- <summary>Controls the special painting effect applied to the control.</summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.PolarControl.Rotation">
- <summary>Controls the amount of rotation applied to the entire control.</summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.PolarControl.RotationInterpolated">
- <summary>Returns the current amount of rotation during an animation.</summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.PolarControl.RotationInterpolationMethod">
- <summary>Controls the acceleration and deceleration technique used during rotation.</summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.PolarControl.Origin">
- <summary>
- Returns the compass direction which matches zero degrees.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.PolarControl.MaximumR">
- <summary>Returns the radius corresponding to the edge of the control.</summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.PolarControl.BackColor">
- <summary>Controls the background color of the control.</summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.PolarControl.CenterR">
- <summary>Returns the radius corresponding to the center of the control.</summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.PolarControl.Orientation">
- <summary>
- Returns whether positive values are applied in a clockwise or counter-clockwise direction.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.Altimeter.#ctor">
- <summary>Creates a new instance.</summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.Altimeter.Dispose(System.Boolean)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.Altimeter.OnPaintOffScreen(System.Windows.Forms.PaintEventArgs)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.Altimeter.OnTargetFrameRateChanged(System.Int32)">
- <inheritdocs/>
- </member>
- <member name="E:DotSpatial.Positioning.Forms.Altimeter.ValueChanged">
- <summary>
- Occurs when the Value property has changed.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Altimeter.IsUsingRealTimeData">
- <summary>
- Indicates if the control should automatically display the current
- altitude.
- </summary>
- <value>
- A <strong>Boolean</strong>, <strong>True</strong> if the control automatically
- displays the current altitude.
- </value>
- <remarks>
- When this property is enabled, the control will examine the
- <strong>CurrentAltitude</strong> property of the
- <strong>DotSpatial.Positioning.Gps.Devices</strong> class and update itself when the property
- changes. When disabled, the <strong>Value</strong> property must be set manually to
- change the control.
- </remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Altimeter.ValueFont">
- <summary>Controls the font used for displaying altitude text.</summary>
- <remarks>
- This property controls the font used to display altitude text on the control. To
- control the font of numbers drawn around the edge of the control, see the
- <strong>AltitudeLabelFont</strong> property.
- </remarks>
- <seealso cref="P:DotSpatial.Positioning.Forms.Altimeter.AltitudeLabelFont">AltitudeLabelFont Property</seealso>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Altimeter.ValueColor">
- <summary>Controls the color of altitude text.</summary>
- <remarks>
- This property controls the color of the altitude text on the control. To change
- the color of numbers drawn around the edge of the control, see the
- <strong>AltitudeLabelColor</strong> property.
- </remarks>
- <seealso cref="P:DotSpatial.Positioning.Forms.Altimeter.AltitudeLabelColor">AltitudeLabelColor Property</seealso>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Altimeter.ValueInterpolationMethod">
- <summary>
- Controls how the control smoothly transitions from one value to another.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Altimeter.ValueFormat">
- <summary>Controls the format of altitude values.</summary>
- <value>
- A <strong>String</strong> which is compatible with the <strong>ToString</strong>
- method of the <strong>Distance</strong> class.
- </value>
- <remarks>
- This property controls how text is output on the control. By default, the format
- is "<strong>v uu</strong>" where <strong>v</strong> represents the numeric portion of
- the altitude, and <strong>uu</strong> represents units.
- </remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Altimeter.Value">
- <summary>Controls the altitude to display on the control.</summary>
- <value>A <strong>Distance</strong> structure measuring the altitude to display.</value>
- <remarks>
- Changing this property causes the needles on the control to move so that they
- represent the value.
- </remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Altimeter.AltitudeLabelColor">
- <summary>Controls the color of numbers around the edge of the control.</summary>
- <remarks>
- This property controls the color of numbers around the edge of the control. To
- control the color of altitude text, see the <strong>ValueColor</strong>
- property.
- </remarks>
- <seealso cref="P:DotSpatial.Positioning.Forms.Altimeter.ValueColor">ValueColor Property</seealso>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Altimeter.AltitudeLabelFont">
- <summary>Controls the font of numbers drawn around the edge of the control.</summary>
- <remarks>
- This property controls the font used to draw numbers around the edge of the
- control. To control the font used to draw altitude text, see the
- <strong>ValueFont</strong> property.
- </remarks>
- <seealso cref="P:DotSpatial.Positioning.Forms.Altimeter.ValueFont">ValueFont Property</seealso>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Altimeter.MinorTickColor">
- <summary>
- Controls the color of smaller tick marks drawn around the edge of the
- control.
- </summary>
- <remarks>
- Minor tick marks are drawn between major tick marks around the control. These
- tick marks can be made invisible by changing the color to
- <strong>Transparent</strong>.
- </remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Altimeter.MajorTickColor">
- <remarks>
- There are ten major tick marks in an altimeter, drawn next to numbers on the
- control. These tick marks can be made invisible by changing the color to
- <strong>Transparent</strong>.
- </remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Altimeter.TensOfThousandsNeedleFillColor">
- <summary>Controls the interior color of the tens-of-thousands needle.</summary>
- <remarks>
- The tens-of-thousands needle is the smallest needle of the control. The interior
- can be made invisible by setting this property to <strong>Transparent</strong>.
- </remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Altimeter.ThousandsNeedleFillColor">
- <summary>
- Controls the color of the interior of the thousands needle.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Altimeter.HundredsNeedleFillColor">
- <summary>
- Controls the color of the interior of the hundreds needle.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Altimeter.TensOfThousandsNeedleOutlineColor">
- <summary>
- Controls the color of the edge of the tens-of-thousands needle.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Altimeter.ThousandsNeedleOutlineColor">
- <summary>
- Controls the color of the edge of the thousands needle.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Altimeter.HundredsNeedleOutlineColor">
- <summary>
- Controls the color of the edge of the hundreds needle.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Altimeter.NeedleShadowColor">
- <summary>
- Controls the color of the shadow cast by the altitude needles.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Altimeter.NeedleShadowSize">
- <summary>
- Controls the size of the shadow cast by the altitude needles.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.Forms.ClockDisplayMode">
- <summary>
- Indicates which time is displayed by the clock control.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Forms.ClockDisplayMode.SatelliteDerivedTime">
- <summary>
- GPS satellite signals are used to display the current time.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Forms.ClockDisplayMode.LocalMachineTime">
- <summary>
- The computer's system clock is used to display the current time.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Forms.ClockDisplayMode.Manual">
- <summary>
- A custom time will be displayed by setting the Value property manually.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.Forms.Clock">
- <summary>
- Represents a user control which displays the local or satellite-derived time.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.Clock.#ctor">
- <summary>
- The constructor provides a name for the control. This name is used as the name of the thread if multithreading is enabled.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.Clock.Dispose(System.Boolean)">
- <summary>
- Dispose
- </summary>
- <param name="disposing"></param>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.Clock.OnPaintOffScreen(System.Windows.Forms.PaintEventArgs)">
- <summary>
- This method is called whenever the control must be rendered. All rendering takes
- place off-screen, which prevents flickering. The "PolarControl" base class automatically
- handles tasks such as resizing and smoothing. All you have to be concerned with is
- calculating the polar coordinates to draw.
- </summary>
- <param name="e"></param>
- </member>
- <member name="E:DotSpatial.Positioning.Forms.Clock.ValueChanged">
- <summary>
- Occurs when the value changes
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Clock.MinorTickColor">
- <summary>
- Controls the color of smaller tick marks drawn around the edge of the
- control.
- </summary>
- <remarks>
- Minor tick marks are drawn between major tick marks around the control. These
- tick marks can be made invisible by changing the color to
- <strong>Transparent</strong>.
- </remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Clock.MajorTickColor">
- <remarks>
- There are ten major tick marks in an altimeter, drawn next to numbers on the
- control. These tick marks can be made invisible by changing the color to
- <strong>Transparent</strong>.
- </remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Clock.HoursFont">
- <summary>
- Controls the font used to draw the hour labels around the edge of the clock.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Clock.HoursColor">
- <summary>
- Controls the color of the shortest hand on the clock, representing hours.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Clock.MinutesColor">
- <summary>
- Controls the color of the minutes hand on the clock.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Clock.SecondsColor">
- <summary>
- Controls the color of the seconds hand on the clock.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Clock.DisplayMode">
- <summary>
- Controls the technique used to display the current time.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Clock.UpdateInterval">
- <summary>
- Controls the amount of time allowed to elapse before the clock is refreshed with the latest time report. This property works only when the control is set to display the local machine's time.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Clock.Value">
- <summary>
- Controls the time being displayed by the device.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Clock.ValueColor">
- <summary>
- Controls the color used to paint numeric labels for hours.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.Forms.ColorInterpolator">
- <summary>Calculates intermediate colors between two other colors.</summary>
- <remarks>
- <para>This class is used to create a smooth transition from one color to another.
- After specifying a start color, end color, and number of intervals, the indexer
- will return a calculated <strong>Color</strong>. Specifying a greater number of
- intervals creates a smoother color gradient.</para>
- <para>Instances of this class are guaranteed to be thread-safe because the class
- uses thread synchronization.</para>
- <para>On the .NET Compact Framework, the alpha channel is not supported.</para>
- </remarks>
- <example>
- This example uses a <strong>ColorInterpolator</strong> to calculate ten colors
- between (and including) <strong>Blue</strong> and <strong>Red</strong> .
- <code lang="VB" title="[New Example]">
- ' Create a New color interpolator
- Dim Interpolator As New ColorInterpolator(Color.Blue, Color.Red, 10)
- ' Output Each calculated color
- Dim i As Integer
- For i = 0 To 9
- ' Get the Next color In the sequence
- Dim NewColor As Color = Interpolator(i)
- ' Output RGB values of this color
- Debug.Write(NewColor.R.ToString() + ",")
- Debug.Write(NewColor.G.ToString() + ",")
- Debug.WriteLine(NewColor.B.ToString())
- Next i
- </code>
- <code lang="CS" title="[New Example]">
- // Create a new color interpolator
- ColorInterpolator Interpolator = new ColorInterpolator(Color.Blue, Color.Red, 10);
- // Output each calculated color
- for (int i = 0; i < 10; i++)
- {
- // Get the next color in the sequence
- Color NewColor = Interpolator[i];
- // Output RGB values of this color
- Console.Write(NewColor.R.ToString() + ",");
- Console.Write(NewColor.G.ToString() + ",");
- Console.WriteLine(NewColor.B.ToString());
- }
- </code>
- </example>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.ColorInterpolator.#ctor(System.Drawing.Color,System.Drawing.Color,System.Int32)">
- <summary>Creates a new instance.</summary>
- <param name="startColor">A <strong>Color</strong> at the start of the sequence.</param>
- <param name="endColor">A <strong>Color</strong> at the end of the sequence.</param>
- <param name="count">
- The total number of colors in the sequence, including the start and end
- colors.
- </param>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.ColorInterpolator.Item(System.Int32)">
- <summary>Returns a calculated color in the sequence.</summary>
- <value>A <strong>Color</strong> value representing a calculated color.</value>
- <example>
- This example creates a new color interpolator between blue and red, then accesses
- the sixth item in the sequence.
- <code lang="VB" title="[New Example]">
- ' Create a New color interpolator
- Dim Interpolator As New ColorInterpolator(Color.Blue, Color.Red, 10)
- ' Access the sixth item
- Color CalculatedColor = Interpolator(5);
- </code>
- <code lang="CS" title="[New Example]">
- // Create a New color interpolator
- ColorInterpolator Interpolator = new ColorInterpolator(Color.Blue, Color.Red, 10);
- // Access the sixth item
- Color CalculatedColor = Interpolator[5];
- </code>
- </example>
- <param name="index">
- An <strong>Integer</strong> between 0 and <strong>Count</strong> minus
- one.
- </param>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.ColorInterpolator.InterpolationMethod">
- <summary>
- Controls the interpolation technique used to calculate intermediate
- colors.
- </summary>
- <value>
- An <strong>InterpolationMethod</strong> value indicating the interpolation
- technique. Default is <strong>Linear</strong>.
- </value>
- <remarks>
- This property controls the rate at which the start color transitions to the end
- color. Values other than Linear can "accelerate" and/or "decelerate" towards the end
- color.
- </remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.ColorInterpolator.StartColor">
- <summary>Controls the first color in the sequence.</summary>
- <value>
- A <strong>Color</strong> object representing the first color in the
- sequence.
- </value>
- <remarks>Changing this property causes the entire sequence to be recalculated.</remarks>
- <example>
- This example changes the start color from Green to Orange.
- </example>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.ColorInterpolator.EndColor">
- <value>
- A <strong>Color</strong> object representing the last color in the
- sequence.
- </value>
- <summary>Controls the last color in the sequence.</summary>
- <remarks>Changing this property causes the entire sequence to be recalculated.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.ColorInterpolator.Count">
- <summary>Controls the number of colors in the sequence.</summary>
- <remarks>Changing this property causes the entire sequence to be recalculated.</remarks>
- <value>
- An <strong>Integer</strong> indicating the total number of colors, including the
- start and end colors.
- </value>
- </member>
- <member name="T:DotSpatial.Positioning.Forms.Compass">
- <summary>
- Represents a user control used to display the current direction of travel.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.Compass.#ctor">
- <summary>
- A compass control
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.Compass.Dispose(System.Boolean)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.Compass.OnPaintOffScreen(System.Windows.Forms.PaintEventArgs)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.Compass.OnTargetFrameRateChanged(System.Int32)">
- <inheritdocs/>
- </member>
- <member name="E:DotSpatial.Positioning.Forms.Compass.ValueChanged">
- <summary>
- Occurs when the value changes
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Compass.Value">
- <summary>
- Controls the direction that the needle points to.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Compass.ValueInterpolationMethod">
- <summary>
- Controls how the control smoothly transitions from one value to another.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Compass.AngleLabelInterval">
- <summary>
- Controls the number of degrees in between each label around the control.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Compass.AngleLabelColor">
- <summary>
- Controls the color of degree labels drawn around the control.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Compass.AngleLabelFont">
- <summary>
- Controls the font of degree labels drawn around the control.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Compass.DirectionLabelInterval">
- <summary>
- Controls the number of degrees in between each compass direction (i.e. \"N\", \"NW\") around the control.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Compass.DirectionLabelColor">
- <summary>
- Controls the color of compass labels on the control.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Compass.DirectionTickColor">
- <summary>
- Controls the color of tick marks next to each direction label on the control.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Compass.IsUsingRealTimeData">
- <summary>
- Controls whether the Value property is set manually, or automatically read from any available GPS device.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Compass.DirectionLabelFont">
- <summary>
- Controls the font used to draw direction labels on the control.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Compass.AngleLabelFormat">
- <summary>
- Controls the output format of labels drawn around the control. (i.e. h°m's\")"
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Compass.MinorTickInterval">
- <summary>
- Controls the number of degrees in between each small tick mark around the control.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Compass.MinorTickColor">
- <summary>
- Controls the color of smaller tick marks drawn around the control.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Compass.MajorTickInterval">
- <summary>
- Controls the number of degrees in between each larger tick mark around the control.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Compass.MajorTickColor">
- <summary>
- Controls the color of larger tick marks drawn around the control.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Compass.NorthNeedleFillColor">
- <summary>
- Controls the color of the interior of the needle which points North.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Compass.NorthNeedleOutlineColor">
- <summary>
- Controls the color of the edge of the needle which points North.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Compass.SouthNeedleFillColor">
- <summary>
- Controls the color of the interior of the needle which points South.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Compass.SouthNeedleOutlineColor">
- <summary>
- Controls the color of the edge of the needle which points South.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Compass.NeedleShadowColor">
- <summary>
- Controls the color of the shadow cast by the compass needle.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Compass.NeedleShadowSize">
- <summary>
- Controls the size of the shadow cast by the compass needle.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.Forms.CancelablePaintEventArgs">
- <summary>Represents information about a cancelable paint iteration.</summary>
- <remarks>
- This class is used primarily by the <strong>OnPaintOffScreen</strong> method of
- the <strong>DoubleBufferedControl</strong> class when paint operations need to be
- performed. This class behaves the same as <strong>PaintEventArgs</strong>, but includes
- an extra <strong>IsCanceled</strong> property to indicate when a rendering iteration
- should be aborted.
- </remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.CancelablePaintEventArgs.#ctor(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Creates a new instance using the specified <strong>Graphics</strong> object and
- clipping rectangle.
- </summary>
- <param name="graphics">
- A <strong>Graphics</strong> object used for all painting within the
- control.
- </param>
- <param name="clipRectangle">
- A <strong>Rectangle</strong> that defines the area that should be painted.
- Typically the size of the entire control.
- </param>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.CancelablePaintEventArgs.Canceled">
- <summary>Indicates if the painting operation should be completely aborted.</summary>
- <value>
- A <strong>Boolean</strong>, <strong>True</strong> if painting was aborted.
- Default is <strong>False</strong>.
- </value>
- <remarks>
- <para>This property is used by controls which allow their paint operations to be
- cancelled. When set to True, the entire painting iteration is stopped and
- restarted. This property is useful if a control always needs to display the very
- latest information.</para>
- <para>Setting this property to <strong>True</strong> can have some undesirable
- affects. For example, if a paint iteration is cancelled repeatedly, the control
- will never get far enough in a paint operation to paint on-screen. Some care should
- be taken when using this property.</para>
- </remarks>
- <example>
- This example demonstrates how to write a cancelable paint operation. It's typically
- a good idea to check for conditions which should cause a paint to cancel before
- beginning a time-consuming painting task. In this case, the
- <strong>IsPaintingAborted</strong> property is examined before entering a large
- loop. <strong>IsPaintingAborted</strong> becomes <strong>True</strong> when a new
- request to paint the control is made after starting the current paint iteration.
- <code lang="VB" title="[New Example]">
- Public Class MyControl
- Inherits DoubleBufferedControl
-
- Sub New()
- IsPaintingOnSeparateThread = True
- End Sub
-
- Protected Overrides Sub OnPaintOffScreen(ByVal e As CancelablePaintEventArgs)
- ' Should painting be cancelled?
- If IsPaintingAborted
- ' Yes. Abort all painting
- e.IsCanceled = True
- Exit Sub
- End If
-
- ' Otherwise, A big paint operation begins
- Dim Count As Integer
- For Count = 1 To 20000
- Dim MyBrush As New SolidBrush(Color.Green)
- e.Graphics.DrawRectangle(MyBrush, New Rectangle(Count, Count, 5, 5))
- MyBrush.Dispose()
- Next Count
- End Sub
- End Class
- </code>
- <code lang="CS" title="[New Example]">
- public class MyControl : DoubleBufferedControl
- {
- MyControl()
- {
- IsPaintingOnSeparateThread = true;
- }
-
- protected override void OnPaintOffScreen(PaintEventArgs e)
- {
- // Should painting be cancelled?
- if (IsPaintingAborted)
- {
- // Yes. Abort all painting
- e.IsCanceled = true;
- return;
- }
-
- // Otherwise, A big paint operation begins
- for (int Count = 1; Count <= 20000; Count++)
- {
- SolidBrush MyBrush = new SolidBrush(Color.Green);
- e.Graphics.DrawRectangle(MyBrush, new Rectangle(Count, Count, 5, 5));
- MyBrush.Dispose();
- }
- }
- }
- </code>
- </example>
- </member>
- <member name="T:DotSpatial.Positioning.Forms.GraphicsSettings">
- <summary>
- Represents a collection of rendering performance and quality settings.
- </summary>
- <remarks>
- <para>This class is used to control the quality of all painting operations in
- GIS.NET. Settings are biased either towards rendering performance, quality, or a
- compromise between the two. The <strong>HighPerformance</strong> static member is
- used to paint quickly at the cost of quality; the <strong>HighQuality</strong>
- member paints better-looking results but painting operations require more time. The
- <strong>Balanced</strong> member provides minimal quality improvements while
- preserving moderate rendering speed.</para>
- </remarks>
- </member>
- <member name="F:DotSpatial.Positioning.Forms.GraphicsSettings.Balanced">
- <summary>
- Represents graphics settings balanced between quality and rendering performance.
- </summary>
- <value>A <strong>GraphicsSettings</strong> object.</value>
- <remarks>
- <para>When this setting is used, painting operations will enable a few
- quality-improving features while still allowing for faster rendering performance.
- This quality setting is recommended for "draft" quality, where a more responsive
- map is preferable to quality.</para>
- </remarks>
- </member>
- <member name="F:DotSpatial.Positioning.Forms.GraphicsSettings.HighQuality">
- <summary>
- Represents graphics settings which maximize quality.
- </summary>
- <value>A <strong>GraphicsSettings</strong> object.</value>
- <remarks>
- This is the default setting used by the GIS.NET rendering engine. All possible
- smoothing features are enabled, including anti-aliasing, bicubic image interpolation,
- and ClearText. With this setting, the smallest geographic features and even most text
- are readable. This setting is recommended for production use, as well as
- printing.
- </remarks>
- </member>
- <member name="F:DotSpatial.Positioning.Forms.GraphicsSettings.HighPerformance">
- <summary>
- Represents graphics settings which maximize rendering performance.
- </summary>
- <value>A <strong>GraphicsSettings</strong> object.</value>
- <remarks>
- When this setting is used, all quality enhancement features are disabled. The
- resulting map will render more quickly, but the resulting quality will be hardly
- suitable for production use. This setting is best suited for situations where panning
- and zooming performance must have all possible speed.
- </remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.GraphicsSettings.#ctor">
- <summary>
- Creates a new instance.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.GraphicsSettings.#ctor(System.Drawing.Drawing2D.CompositingQuality,System.Drawing.Drawing2D.InterpolationMode,System.Drawing.Drawing2D.PixelOffsetMode,System.Drawing.Drawing2D.SmoothingMode,System.Drawing.Text.TextRenderingHint,System.Int32)">
- <summary>
- Creates a new instance using the specified settings.
- </summary>
- <param name="compositingQuality"></param>
- <param name="interpolationMode"></param>
- <param name="pixelOffsetMode"></param>
- <param name="smoothingMode"></param>
- <param name="textRenderingHint"></param>
- <param name="textContrast"></param>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.GraphicsSettings.Apply(System.Drawing.Graphics)">
- <summary>
- Applies the graphics settings to the specified grahpics container.
- </summary>
- <param name="graphics">A <strong>Graphics</strong> object.</param>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.GraphicsSettings.CompositingQuality">
- <summary>
- Controls the technique used to merge bitmap images.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.GraphicsSettings.InterpolationMode">
- <summary>
- Controls the method used to calculate color values between pixels.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.GraphicsSettings.PixelOffsetMode">
- <summary>
- Controls the amount of shift for each pixel to improve anti-aliasing.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.GraphicsSettings.SmoothingMode">
- <summary>
- Controls the technique used to blend edges.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.GraphicsSettings.TextRenderingHint">
- <summary>
- Controls the technique used to smoothen the edges of text.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.GraphicsSettings.TextContrast">
- <summary>
- Controls the amount of gamma correction applied to text.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.Forms.PolarControlEffect">
- <summary>Indicates the special effect applied to polar controls during painting.</summary>
- </member>
- <member name="F:DotSpatial.Positioning.Forms.PolarControlEffect.None">
- <summary>No effect is applied.</summary>
- </member>
- <member name="F:DotSpatial.Positioning.Forms.PolarControlEffect.Glass">
- <summary>
- Additional painting is performed during
- <strong>OnPaintOffScreenBackground</strong> and
- <strong>OnPaintOffScreenAdornments</strong> to give the appearance of lighting and
- glass.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.Forms.PolarCoordinate">
- <summary>Represents a coordinate measured relative to the center of a circle.</summary>
- <remarks>
- <para>Instances of this class are guaranteed to be thread-safe because the class is
- immutable (its properties can only be changed via constructors).</para>
- </remarks>
- </member>
- <member name="F:DotSpatial.Positioning.Forms.PolarCoordinate.Empty">
- <summary>Represents a polar coordinate with no value.</summary>
- </member>
- <member name="F:DotSpatial.Positioning.Forms.PolarCoordinate.Center">
- <summary>Represents a polar coordinate at the center of a circle.</summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarCoordinate.#ctor(System.Single,DotSpatial.Positioning.Angle)">
- <summary>
- Creates a new instance using the specified radius and angle.
- </summary>
- <param name="r">A <strong>Double</strong> indicating a radius. Increasing values represent a distance further away from the center of a circle.</param>
- <param name="theta">An <strong>Angle</strong> representing a direction from the center of a circle.</param>
- <remarks>The radius "r," when combined with an angle "theta" will create a coordinate relative to
- the center of a circle. By default, an angle of zero represents the top of the circle ("North") and
- increasing angles wind clockwise around the circle.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarCoordinate.#ctor(System.Single,System.Double)">
- <summary>
- Creates a new instance using the specified radius and angle.
- </summary>
- <param name="r">A <strong>Double</strong> indicating a radius. Increasing values represent a distance further away from the center of a circle.</param>
- <param name="theta">An <strong>Angle</strong> representing a direction from the center of a circle.</param>
- <remarks>The radius "r," when combined with an angle "theta" will create a coordinate relative to
- the center of a circle. By default, an angle of zero represents the top of the circle ("North") and
- increasing angles wind clockwise around the circle.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarCoordinate.#ctor(System.Single,DotSpatial.Positioning.Angle,DotSpatial.Positioning.Azimuth,DotSpatial.Positioning.Forms.PolarCoordinateOrientation)">
- <summary>
- Creates a new instance using the specified radius, angle, origin and winding direction.
- </summary>
- <param name="r">A <strong>Double</strong> indicating a radius. Increasing values represent a distance further away from the center of a circle.</param>
- <param name="theta">An <strong>Angle</strong> representing a direction from the center of a circle.</param>
- <param name="origin">An <strong>Azimuth</strong> indicating which compass direction is associated with zero degrees. (Typically North.)</param>
- <param name="orientation">A <strong>PolarCoordinateOrientation</strong> value indicating whether increasing Theta values wind clockwise or counter-clockwise.</param>
- <remarks>The radius "r," when combined with an angle "theta" will create a coordinate relative to
- the center of a circle. The BearingOrigin will associate a compass direction with zero degrees (0°), but this value is typically "North".</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarCoordinate.#ctor(System.Single,System.Double,DotSpatial.Positioning.Azimuth,DotSpatial.Positioning.Forms.PolarCoordinateOrientation)">
- <summary>
- Creates a new Polar Coordinate
- </summary>
- <param name="r"></param>
- <param name="theta"></param>
- <param name="origin"></param>
- <param name="orientation"></param>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarCoordinate.#ctor(System.String)">
- <summary>
- Creates a new instance by converting the specified string.
- </summary>
- <param name="value">A <strong>String</strong> describing a polar coordinate in the current culture.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarCoordinate.#ctor(System.String,System.Globalization.CultureInfo)">
- <summary>
- Creates a new instance by converting the specified string.
- </summary>
- <param name="value">A <strong>String</strong> describing a polar coordinate in any culture.</param>
- <param name="culture">A <strong>CultureInfo</strong> object describing how to parse the specified string.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarCoordinate.ToPoint">
- <summary>Converts the current instance to a pixel coordinate.</summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarCoordinate.ToPointF">
- <summary>Converts the current instance to a precise pixel coordinate.</summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarCoordinate.ToPointD">
- <summary>Converts the current instance to a highly-precise pixel coordinate.</summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarCoordinate.ToCartesianPointD">
- <summary>Converts the current instance to a highly-precise Cartesian coordinate.</summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarCoordinate.Rotate(System.Double)">
- <summary>
- Applies rotation to the existing coordinate.
- </summary>
- <param name="angle">The amount of rotation to apply (above zero for clockwise).</param>
- <returns>A <strong>PolarCoordinate</strong> adjusted by the specified rotation amount.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarCoordinate.SetRotation(System.Double)">
- <summary>
- Sets the rotation of the angle
- </summary>
- <param name="angle">The angle to set</param>
- <returns>the PolarCoordinate</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarCoordinate.ToOrientation(DotSpatial.Positioning.Azimuth,DotSpatial.Positioning.Forms.PolarCoordinateOrientation)">
- <summary>
- Returns the current instance adjusted to the specified orientation and
- origin.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarCoordinate.Parse(System.String)">
- <summary>
- Parses the value as a PolarCoordinate
- </summary>
- <param name="value"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarCoordinate.Parse(System.String,System.Globalization.CultureInfo)">
- <summary>
- Parses the value in the specified culter as a polar coordinate
- </summary>
- <param name="value"></param>
- <param name="culture"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarCoordinate.ToString">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarCoordinate.ToString(System.String,System.IFormatProvider)">
- <summary>
- Customizes the string with a format provider
- </summary>
- <param name="format"></param>
- <param name="formatProvider"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarCoordinate.op_Explicit(System.String)~DotSpatial.Positioning.Forms.PolarCoordinate">
- <summary>
- Polar Coordinate
- </summary>
- <param name="value"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarCoordinate.op_Explicit(DotSpatial.Positioning.Forms.PolarCoordinate)~System.String">
- <summary>
- string
- </summary>
- <param name="value"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarCoordinate.op_Explicit(DotSpatial.Positioning.Forms.PolarCoordinate)~System.Drawing.Point">
- <summary>
- Point
- </summary>
- <param name="value"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarCoordinate.op_Explicit(DotSpatial.Positioning.Forms.PolarCoordinate)~System.Drawing.PointF">
- <summary>
- PointF
- </summary>
- <param name="value"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarCoordinate.op_Explicit(DotSpatial.Positioning.Forms.PolarCoordinate)~DotSpatial.Positioning.PointD">
- <summary>
- PointD
- </summary>
- <param name="value"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.PolarCoordinate.Theta">
- <summary>
- Returns <em>Theta</em>, the amount of clockwise rotation of the
- coordinate.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.PolarCoordinate.R">
- <summary>
- Returns <em>R</em>, the distance away from the center of an imaginary
- circle.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.PolarCoordinate.Origin">
- <summary>
- Returns the compass direction which matches zero degrees.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.PolarCoordinate.Orientation">
- <summary>
- Returns whether positive values are applied in a clockwise or counter-clockwise direction.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.Forms.PolarCoordinateOrientation">
- <summary>
- Controls the winding direction of increasing angular values.
- </summary>
- <remarks>This enumeration is used by the <strong>PolarCoordinate</strong> class
- to determine where a coordinate is on a circle.</remarks>
- </member>
- <member name="F:DotSpatial.Positioning.Forms.PolarCoordinateOrientation.Clockwise">
- <summary>
- Increasing angles are further clockwise around the circle.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Forms.PolarCoordinateOrientation.Counterclockwise">
- <summary>
- Increasing angles are further counter-clockwise around the circle.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.Forms.PolarCoordinateOrientationEventArgs">
- <summary>
- Polar Coordinate Orientation Event Args
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarCoordinateOrientationEventArgs.#ctor(DotSpatial.Positioning.Forms.PolarCoordinateOrientation)">
- <summary>
- Creates a new instance of the Polar coordinate orientation event arguments
- </summary>
- <param name="orientation"></param>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.PolarCoordinateOrientationEventArgs.Orientation">
- <summary>
- The orientation
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.Forms.PolarGraphics">
- <summary>
- Encapsulates a GDI+ drawing surface using polar coordinates instead of pixel coordinates.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarGraphics.ToPoint(DotSpatial.Positioning.Forms.PolarCoordinate)">
- <summary>Converts a polar coordinate to a pixel coordinate.</summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarGraphics.ToPointD(DotSpatial.Positioning.Forms.PolarCoordinate)">
- <summary>Converts a polar coordinate to a highly-precise pixel coordinate.</summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarGraphics.ToPolarCoordinate(System.Drawing.Point)">
- <summary>
- To Polar Coordinate
- </summary>
- <param name="point"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarGraphics.ToPolarCoordinate(System.Drawing.PointF)">
- <summary>
- To Polar Coordinate
- </summary>
- <param name="point"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarGraphics.ToPolarCoordinate(DotSpatial.Positioning.PointD)">
- <summary>
- To Polar coordinate
- </summary>
- <param name="point"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarGraphics.PointDToPolarCoordinate(DotSpatial.Positioning.PointD)">
- <summary>Converts the current instance into a polar coordinate.</summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarGraphics.ToPointF(DotSpatial.Positioning.Forms.PolarCoordinate)">
- <summary>Converts a polar coordinate to a precise pixel coordinate.</summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarGraphics.ToPointF(DotSpatial.Positioning.PointD)">
- <summary>
- To PointF
- </summary>
- <param name="pointD"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarGraphics.Clear(System.Drawing.Color)">
- <summary>Erases the control's background to the specified color.</summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarGraphics.DrawLine(System.Drawing.Pen,DotSpatial.Positioning.Forms.PolarCoordinate,DotSpatial.Positioning.Forms.PolarCoordinate)">
- <summary>Draws a single straight line.</summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarGraphics.DrawString(System.String,System.Drawing.Font,System.Drawing.Brush,DotSpatial.Positioning.Forms.PolarCoordinate,System.Drawing.StringFormat)">
- <summary>
- DrawString
- </summary>
- <param name="s"></param>
- <param name="font"></param>
- <param name="brush"></param>
- <param name="point"></param>
- <param name="format"></param>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarGraphics.DrawString(System.String,System.Drawing.Font,System.Drawing.SolidBrush,DotSpatial.Positioning.Forms.PolarCoordinate)">
- <summary>
- Draw String
- </summary>
- <param name="s"></param>
- <param name="font"></param>
- <param name="brush"></param>
- <param name="point"></param>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarGraphics.DrawCenteredString(System.String,System.Drawing.Font,System.Drawing.Brush,DotSpatial.Positioning.Forms.PolarCoordinate,System.Drawing.StringFormat)">
- <summary>
- Draw Centered String
- </summary>
- <param name="s"></param>
- <param name="font"></param>
- <param name="brush"></param>
- <param name="point"></param>
- <param name="format"></param>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarGraphics.DrawCenteredString(System.String,System.Drawing.Font,System.Drawing.SolidBrush,DotSpatial.Positioning.Forms.PolarCoordinate)">
- <summary>
- Draw Centered String
- </summary>
- <param name="s"></param>
- <param name="font"></param>
- <param name="brush"></param>
- <param name="point"></param>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarGraphics.DrawRectangle(System.Drawing.Pen,DotSpatial.Positioning.Forms.PolarCoordinate,DotSpatial.Positioning.Forms.PolarCoordinate)">
- <summary>Draws a square or rectangular shape.</summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarGraphics.FillEllipse(System.Drawing.Brush,DotSpatial.Positioning.Forms.PolarCoordinate,System.Single)">
- <summary>Fills the interior of a circular shape.</summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarGraphics.DrawEllipse(System.Drawing.Pen,DotSpatial.Positioning.Forms.PolarCoordinate,System.Single)">
- <summary>Draws a circular shape.</summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarGraphics.FillPolygon(System.Drawing.Brush,DotSpatial.Positioning.Forms.PolarCoordinate[])">
- <summary>Fills the interior of a closed shape.</summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarGraphics.ToGraphicsPath(DotSpatial.Positioning.Forms.PolarCoordinate[])">
- <summary>
- Converts an array of polar coordinates into a <strong>GraphicsPath</strong>
- object.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarGraphics.DrawAndFillPolygon(System.Drawing.Pen,System.Drawing.Brush,DotSpatial.Positioning.Forms.PolarCoordinate[])">
- <summary>Fills and outlines a polygon using the specified style.</summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarGraphics.DrawPolygon(System.Drawing.Pen,DotSpatial.Positioning.Forms.PolarCoordinate[])">
- <summary>Draws a closed shape.</summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarGraphics.DrawRotatedString(System.String,System.Drawing.Font,System.Drawing.Brush,DotSpatial.Positioning.Forms.PolarCoordinate)">
- <summary>Draws text rotated by the specified amount.</summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarGraphics.ToPointArray(DotSpatial.Positioning.Forms.PolarCoordinate[])">
- <summary>Converts an array of polar coordinates to an array of pixel coordinates.</summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarGraphics.ToPointFArray(DotSpatial.Positioning.Forms.PolarCoordinate[])">
- <summary>
- Converts an array of polar coordinates to an array of precise pixel
- coordinates.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarGraphics.ToPointDArray(DotSpatial.Positioning.Forms.PolarCoordinate[])">
- <summary>
- Converts an array of polar coordinates to an array of highly-precise pixel
- coordinates.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarGraphics.DrawArc(System.Drawing.Pen,DotSpatial.Positioning.Forms.PolarCoordinate,DotSpatial.Positioning.Forms.PolarCoordinate)">
- <summary>Draws a rounded line.</summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarGraphics.DrawBezier(System.Drawing.Pen,DotSpatial.Positioning.Forms.PolarCoordinate,DotSpatial.Positioning.Forms.PolarCoordinate,DotSpatial.Positioning.Forms.PolarCoordinate,DotSpatial.Positioning.Forms.PolarCoordinate)">
- <summary>Draws a rounded line that travels through several points.</summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarGraphics.DrawBeziers(System.Drawing.Pen,DotSpatial.Positioning.Forms.PolarCoordinate[])">
- <summary>Draws multiple rounded lines that travels through several points.</summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarGraphics.DrawClosedCurve(System.Drawing.Pen,DotSpatial.Positioning.Forms.PolarCoordinate[])">
- <summary>
- Draw Closed Curve
- </summary>
- <param name="pen"></param>
- <param name="points"></param>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarGraphics.DrawClosedCurve(System.Drawing.Pen,DotSpatial.Positioning.Forms.PolarCoordinate[],System.Single,System.Drawing.Drawing2D.FillMode)">
- <summary>
- Draw Closed Curve
- </summary>
- <param name="pen"></param>
- <param name="points"></param>
- <param name="tension"></param>
- <param name="fillMode"></param>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarGraphics.DrawCurve(System.Drawing.Pen,DotSpatial.Positioning.Forms.PolarCoordinate[])">
- <summary>
- Draw Curve
- </summary>
- <param name="pen"></param>
- <param name="points"></param>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.PolarGraphics.DrawCurve(System.Drawing.Pen,DotSpatial.Positioning.Forms.PolarCoordinate[],System.Int32,System.Int32,System.Single)">
- <summary>
- Draw Curve
- </summary>
- <param name="pen"></param>
- <param name="points"></param>
- <param name="offset"></param>
- <param name="numberOfSegments"></param>
- <param name="tension"></param>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.PolarGraphics.Origin">
- <summary>
- Returns the compass direction which matches zero degrees.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.PolarGraphics.Orientation">
- <summary>
- Returns whether positive values are applied in a clockwise or counter-clockwise direction.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.PolarGraphics.CenterR">
- <summary>Returns the value of <em>R</em> associated with the center of the control.</summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.PolarGraphics.MaximumR">
- <summary>Returns the value of <em>R</em> associated with the edge of the control.</summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.PolarGraphics.Graphics">
- <summary>Returns the GDI+ drawing surface used for painting.</summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.PolarGraphics.Rotation">
- <summary>Returns the amount of rotation applied to the entire control.</summary>
- </member>
- <member name="T:DotSpatial.Positioning.Forms.SatelliteSignalBar">
- <summary>
- Represents a control used to display satellite signal strengths.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.SatelliteSignalBar.#ctor">
- <summary>
- Satellite Signal Bar
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.SatelliteSignalBar.OnHandleCreated(System.EventArgs)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.SatelliteSignalBar.OnHandleDestroyed(System.EventArgs)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.SatelliteSignalBar.Dispose(System.Boolean)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.SatelliteSignalBar.OnInitialize">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.SatelliteSignalBar.OnPaintOffScreen(System.Windows.Forms.PaintEventArgs)">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteSignalBar.DefaultSize">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteSignalBar.Satellites">
- <summary>
- Controls the satellites which are currently being viewed in the control.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteSignalBar.GapWidth">
- <summary>
- Controls the number of pixels in between vertical satellite signal bars.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteSignalBar.NoSignalFillColor">
- <summary>
- Controls the color inside of satellite icons with no signal.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteSignalBar.PoorSignalFillColor">
- <summary>
- Controls the color inside of satellite icons with a weak signal.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteSignalBar.ModerateSignalFillColor">
- <summary>
- Controls the color inside of satellite icons with a moderate signal.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteSignalBar.GoodSignalFillColor">
- <summary>
- Controls the color inside of satellite icons with a strong signal.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteSignalBar.ExcellentSignalFillColor">
- <summary>
- Controls the color inside of satellite icons with a very strong signal.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteSignalBar.NoSignalOutlineColor">
- <summary>
- Controls the color around satellite icons with no signal.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteSignalBar.PoorSignalOutlineColor">
- <summary>
- Controls the color around satellite icons with a weak signal.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteSignalBar.ModerateSignalOutlineColor">
- <summary>
- Controls the color around satellite icons with a moderate signal.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteSignalBar.GoodSignalOutlineColor">
- <summary>
- Controls the color around satellite icons with a strong signal.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteSignalBar.ExcellentSignalOutlineColor">
- <summary>
- Controls the color around satellite icons with a very strong signal.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteSignalBar.FixColor">
- <summary>
- Controls the color of the ellipse drawn around fixed satellites.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteSignalBar.IsUsingRealTimeData">
- <summary>
- Controls whether the Satellites property is set manually, or automatically read from any available GPS device.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteSignalBar.SignalStrengthLabelFont">
- <summary>
- Controls the font used to draw the strength of each satellite.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteSignalBar.SignalStrengthLabelColor">
- <summary>
- Controls the color used to draw the strength of each satellite.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteSignalBar.PseudorandomNumberFont">
- <summary>
- Controls the font used to draw the ID of each satellite.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteSignalBar.PseudorandomNumberColor">
- <summary>
- Controls the color used to draw the ID of each satellite.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.Forms.RotationOrientation">
- <summary>
- Controls whether controls are rotated to show the current bearing straight up.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Forms.RotationOrientation.NorthUp">
- <summary>
- The control will be rotated so that North always points to the top of the screen.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Forms.RotationOrientation.TrackUp">
- <summary>
- The control will be rotated so the the current bearing points to the top of the screen.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.Forms.SatelliteViewer">
- <summary>
- Represents a user control used to display the location and signal strength of GPS satellites.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.SatelliteViewer.#ctor">
- <summary>
- Creates a new instance.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.SatelliteViewer.OnHandleCreated(System.EventArgs)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.SatelliteViewer.OnHandleDestroyed(System.EventArgs)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.SatelliteViewer.OnInitialize">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.SatelliteViewer.Dispose(System.Boolean)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.SatelliteViewer.OnPaintOffScreen(System.Windows.Forms.PaintEventArgs)">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteViewer.Bearing">
- <summary>
- Controls the amount of rotation applied to the entire control to indicate the current direction of travel.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteViewer.IsUsingRealTimeData">
- <summary>
- Controls whether the Satellites property is set manually, or automatically read from any available GPS device.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteViewer.MinorTickInterval">
- <summary>
- Controls the number of degrees in between each smaller tick mark around the control.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteViewer.DirectionLabelFormat">
- <summary>
- Controls the format of compass directions drawn around the control.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteViewer.MajorTickInterval">
- <summary>
- Controls the number of degrees in between each larger tick mark around the control.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteViewer.MinorTickColor">
- <summary>
- Controls the color used to draw smaller tick marks around the control.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteViewer.MajorTickColor">
- <summary>
- Controls the color used to draw larger tick marks around the control.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteViewer.DirectionLabelInterval">
- <summary>
- Controls the number of degrees in between each compass label around the control.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteViewer.DirectionLabelColor">
- <summary>
- Controls the color used to display compass direction letters around the control.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteViewer.DirectionLabelFont">
- <summary>
- Controls the font used to draw compass labels around the control.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteViewer.NoSignalFillColor">
- <summary>
- Controls the color inside of satellite icons with no signal.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteViewer.PoorSignalFillColor">
- <summary>
- Controls the color inside of satellite icons with a weak signal.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteViewer.ModerateSignalFillColor">
- <summary>
- Controls the color inside of satellite icons with a moderate signal.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteViewer.GoodSignalFillColor">
- <summary>
- Controls the color inside of satellite icons with a strong signal.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteViewer.ExcellentSignalFillColor">
- <summary>
- Controls the color inside of satellite icons with a very strong signal.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteViewer.NoSignalOutlineColor">
- <summary>
- Controls the color around satellite icons with no signal.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteViewer.PoorSignalOutlineColor">
- <summary>
- Controls the color around satellite icons with a weak signal.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteViewer.ModerateSignalOutlineColor">
- <summary>
- Controls the color around satellite icons with a moderate signal.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteViewer.GoodSignalOutlineColor">
- <summary>
- Controls the color around satellite icons with a strong signal.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteViewer.ExcellentSignalOutlineColor">
- <summary>
- Controls the color around satellite icons with a very strong signal.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteViewer.FixColor">
- <summary>
- Controls the color of the ellipse drawn around fixed satellites.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteViewer.RotationOrientation">
- <summary>
- Controls which bearing points straight up on the screen.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteViewer.Satellites">
- <summary>
- Contains the list of satellites drawn inside of the control.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteViewer.Origin">
- <summary>
- The Origin Azimuth angle
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteViewer.Rotation">
- <summary>
- The rotation angle
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteViewer.ShadowColor">
- <summary>
- Controls the color of the shadow cast by satellite icons.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteViewer.PseudorandomNumberFont">
- <summary>
- Controls the font used to display the ID of each satellite.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.SatelliteViewer.PseudorandomNumberColor">
- <summary>
- Controls the color used to display the ID of each satellite.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.Forms.Speedometer">
- <summary>
- Represents a user control used to measure speed graphically.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.Speedometer.#ctor">
- <summary>
- Speedometer
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.Speedometer.Dispose(System.Boolean)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.Speedometer.OnPaintOffScreen(System.Windows.Forms.PaintEventArgs)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Forms.Speedometer.OnTargetFrameRateChanged(System.Int32)">
- <inheritdocs/>
- </member>
- <member name="E:DotSpatial.Positioning.Forms.Speedometer.ValueChanged">
- <summary>
- Occurs when the value changed
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Speedometer.Origin">
- <summary>
- The azimuth angle of hte origin
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Speedometer.Rotation">
- <summary>
- The rotation angle
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Speedometer.NeedleOutlineColor">
- <summary>
- Gets or sets the spedometer needle color of the edge
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Speedometer.NeedleFillColor">
- <summary>
- Gets or sets the needle fill color.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Speedometer.NeedleShadowColor">
- <summary>
- The Needle Shadow Brush color intially semitransparent black.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Speedometer.NeedleShadowSize">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Speedometer.Value">
- <summary>
- Controls the amount of speed being displayed in the control
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Speedometer.ValueInterpolationMethod">
- <summary>
- Controls how the control smoothly transitions from one value to another.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Speedometer.MaximumSpeed">
- <summary>
- Controls the fastest speed allowed by the control.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Speedometer.SpeedLabelInterval">
- <summary>
- Controls the amount of speed in between each label around the control.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Speedometer.MinorTickInterval">
- <summary>
- Controls the number of degrees in between each smaller tick mark around the control.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Speedometer.MajorTickInterval">
- <summary>
- Controls the number of degrees in between each larger tick mark around the control.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Speedometer.MinorTickColor">
- <summary>
- the color of the minor ticks.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Speedometer.IsUnitLabelVisible">
- <summary>
- Controls whether the speed label is drawn in the center of the control.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Speedometer.IsUsingRealTimeData">
- <summary>
- Controls whether the Value property is set manually, or automatically read from any available GPS device.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Speedometer.MajorTickColor">
- <summary>
- Gets or sets the Major Tick Color
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Speedometer.SpeedLabelFormat">
- <summary>
- Controls the display format used for speed labels drawn around the control.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Speedometer.Font">
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Speedometer.SpeedLabelColor">
- <summary>
- Gets or sets the Speed Label font color
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Speedometer.MinimumAngle">
- <summary>
- Controls the angle associated with the smallest possible speed.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Forms.Speedometer.MaximumAngle">
- <summary>
- Controls the angle associated with the largest possible speed.
- </summary>
- </member>
- </members>
-</doc>
diff --git a/MES_Wind/bin/Debug/DotSpatial.Positioning.pdb b/MES_Wind/bin/Debug/DotSpatial.Positioning.pdb
deleted file mode 100644
index fc7545a95c3c2b6b63582bf80970097102135b44..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/DotSpatial.Positioning.pdb and /dev/null differ
diff --git a/MES_Wind/bin/Debug/DotSpatial.Positioning.xml b/MES_Wind/bin/Debug/DotSpatial.Positioning.xml
deleted file mode 100644
index 23ddcb9e22620ee14b4980069625ee18e1252098..0000000000000000000000000000000000000000
--- a/MES_Wind/bin/Debug/DotSpatial.Positioning.xml
+++ /dev/null
@@ -1,29522 +0,0 @@
-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>DotSpatial.Positioning</name>
- </assembly>
- <members>
- <member name="T:DotSpatial.Positioning.Angle">
- <summary>
- Represents an angular measurement around a circle.
- </summary>
- <seealso cref="T:DotSpatial.Positioning.Azimuth">Azimuth Class</seealso>
-
- <seealso cref="T:DotSpatial.Positioning.Elevation">Elevation Class</seealso>
-
- <seealso cref="T:DotSpatial.Positioning.Latitude">Latitude Class</seealso>
-
- <seealso cref="T:DotSpatial.Positioning.Longitude">Longitude Class</seealso>
-
- <example>
- These examples create new instances of Angle objects.
- <code lang="VB" description="Create an angle of 90°">
- Dim MyAngle As New Angle(90)
- </code>
- <code lang="CS" description="Create an angle of 90°">
- Angle MyAngle = new Angle(90);
- </code>
- <code lang="C++" description="Create an angle of 90°">
- Angle MyAngle = new Angle(90);
- </code>
- <code lang="VB" description="Create an angle of 105°30'21.4">
- Dim MyAngle1 As New Angle(105, 30, 21.4)
- </code>
- <code lang="CS" description="Create an angle of 105°30'21.4">
- Angle MyAngle = new Angle(105, 30, 21.4);
- </code>
- <code lang="C++" description="Create an angle of 105°30'21.4">
- Angle MyAngle = new Angle(105, 30, 21.4);
- </code>
- </example>
- <remarks><para>This class serves as the base class for angular measurement classes within
- the framework, such as the <strong>Azimuth</strong>, <strong>Elevation</strong>,
- <strong>Latitude</strong> and <strong>Longitude</strong> classes. An "angular
- measurement" is a measurement around a circle. Typically, angular measurements are
- between 0° and 360°.</para>
- <para>Angles can be represented in two forms: decimal and sexagesimal. In decimal
- form, angles are represented as a single number. In sexagesimal form, angles are
- represented in three components: hours, minutes, and seconds, very much like a
- clock.</para>
- <para>Upon creating an <strong>Angle</strong> object, other properties such as
- <strong>DecimalDegrees</strong>, <strong>DecimalMinutes</strong>,
- <strong>Hours</strong>, <strong>Minutes</strong> and <strong>Seconds</strong> are
- calculated automatically.</para>
- <para>Instances of this class are guaranteed to be thread-safe because they are
- immutable (properties can only be modified via constructors).</para></remarks>
- </member>
- <member name="T:DotSpatial.Positioning.ICloneable`1">
- <summary>
- Facilitates the creation of a deep copy of an object.
- </summary>
- <typeparam name="T">The destination type for the ICloneable interface.</typeparam>
- </member>
- <member name="M:DotSpatial.Positioning.ICloneable`1.Clone">
- <summary>
- Creates a deep copy of the object.
- </summary>
- <returns></returns>
- </member>
- <member name="F:DotSpatial.Positioning.Angle.MAXIMUM_PRECISION_DIGITS">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Angle._decimalDegrees">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Angle.Minimum">
- <summary>
- Represents the minimum value of an angle in one turn of a circle.
- </summary>
- <example>
- This example creates an angle representing the minimum allowed value.
- <code lang="VB">
- Dim MyAngle As Angle = Angle.Minimum
- </code>
- <code lang="CS">
- Angle MyAngle = Angle.Minimum;
- </code>
- <code lang="C++">
- Angle MyAngle = Angle.Minimum;
- </code>
- </example>
-
- <value>An Angle with a value of -359.999999°.</value>
- </member>
- <member name="F:DotSpatial.Positioning.Angle.Empty">
- <summary>
- Represents an angle with no value.
- </summary>
- <value>An Angle containing a value of zero (0°).</value>
-
- <seealso cref="P:DotSpatial.Positioning.Angle.IsEmpty">IsEmpty Property</seealso>
- </member>
- <member name="F:DotSpatial.Positioning.Angle.Infinity">
- <summary>
- Represents an angle with infinite value.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Angle.Maximum">
- <summary>
- Represents the maximum value of an angle in one turn of a circle.
- </summary>
- <example>
- This example creates an angle representing the maximum allowed value of 359.9999°.
- <code lang="VB">
- Dim MyAngle As Angle = Angle.Maximum
- </code>
- <code lang="CS">
- Angle MyAngle = Angle.Maximum;
- </code>
- </example>
- </member>
- <member name="F:DotSpatial.Positioning.Angle.Invalid">
- <summary>
- Represents an invalid or unspecified value.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.#ctor(System.Double)">
- <summary>
- Creates a new instance with the specified decimal degrees.
- </summary>
- <param name="decimalDegrees">The decimal degrees.</param>
- <example>
- This example demonstrates how to create an angle with a measurement of 90°.
- <code lang="VB">
- Dim MyAngle As New Angle(90)
- </code>
- <code lang="CS">
- Angle MyAngle = new Angle(90);
- </code>
- </example>
-
- <returns>An <strong>Angle</strong> containing the specified value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.#ctor(System.Int32)">
- <summary>
- Creates a new instance with the specified degrees.
- </summary>
- <param name="hours">The hours.</param>
- <returns>An <strong>Angle</strong> containing the specified value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.#ctor(System.Int32,System.Int32,System.Double)">
- <summary>
- Creates a new instance with the specified hours, minutes and
- seconds.
- </summary>
- <param name="hours">The hours.</param>
- <param name="minutes">The minutes.</param>
- <param name="seconds">The seconds.</param>
- <example>
- This example demonstrates how to create an angular measurement of 34°12'29.2 in
- hours, minutes and seconds.
- <code lang="VB">
- Dim MyAngle As New Angle(34, 12, 29.2)
- </code>
- <code lang="CS">
- Angle MyAngle = new Angle(34, 12, 29.2);
- </code>
- </example>
-
- <returns>An <strong>Angle</strong> containing the specified value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.#ctor(System.Int32,System.Double)">
- <summary>
- Creates a new instance with the specified hours and decimal minutes.
- </summary>
- <param name="hours">The hours.</param>
- <param name="decimalMinutes">The decimal minutes.</param>
- <example>
- This example demonstrates how an angle can be created when only the hours and
- minutes (in decimal form) are known. This creates a value of 12°42.345'.
- <code lang="VB">
- Dim MyAngle As New Angle(12, 42.345)
- </code>
- <code lang="VB">
- Angle MyAngle = new Angle(12, 42.345);
- </code>
- </example>
- <remarks>An <strong>Angle</strong> containing the specified value.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.#ctor(System.String)">
- <summary>
- Creates a new instance by converting the specified string.
- </summary>
- <param name="value">The value.</param>
- <seealso cref="M:DotSpatial.Positioning.Angle.Parse(System.String)">Parse Method</seealso>
-
- <example>
- This example creates a new instance by parsing a string. (Notice The double-quote is
- doubled up to represent a single double-quote in the string.)
- <code lang="VB">
- Dim MyAngle As New Angle("123°45'67.8""")
- </code>
- <code lang="CS">
- Angle MyAngle = new Angle("123°45'67.8\"");
- </code>
- </example>
-
- <returns>An <strong>Angle</strong> containing the specified value.</returns>
-
- <exception cref="T:System.ArgumentNullException" caption="ArgumentNullException">The Parse method requires a decimal or sexagesimal measurement.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">Only the right-most portion of a sexagesimal measurement can be a fractional value.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">Extra characters were encountered while parsing an angular measurement. Only hours, minutes, and seconds are allowed.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">The specified text was not fully understood as an angular measurement.</exception>
- <remarks>This constructor parses the specified string into an <strong>Angle</strong>
- object using the current culture. This constructor can parse any strings created via
- the <strong>ToString</strong> method.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.#ctor(System.String,System.Globalization.CultureInfo)">
- <summary>
- Creates a new instance by converting the specified string using the specified
- culture.
- </summary>
- <param name="value">The value.</param>
- <param name="culture">The culture.</param>
- <exception cref="T:System.ArgumentNullException" caption="ArgumentNullException">The Parse method requires a decimal or sexagesimal measurement.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">Only the right-most portion of a sexagesimal measurement can be a fractional value.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">Extra characters were encountered while parsing an angular measurement. Only hours, minutes, and seconds are allowed.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">The specified text was not fully understood as an angular measurement.</exception>
- <remarks>This constructor parses the specified string into an <strong>Angle</strong>
- object using a specific culture. This constructor can parse any strings created via the
- <strong>ToString</strong> method.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.#ctor(System.Xml.XmlReader)">
- <summary>
- Creates a new instance by deserializing the specified XML.
- </summary>
- <param name="reader">The reader.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.GreaterOf(DotSpatial.Positioning.Angle)">
- <summary>
- Returns the object with the largest value.
- </summary>
- <param name="value">An <strong>Angle</strong> object to compare to the current instance.</param>
- <returns>An <strong>Angle</strong> containing the largest value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.LesserOf(DotSpatial.Positioning.Angle)">
- <summary>
- Returns the object with the smallest value.
- </summary>
- <param name="value">An <strong>Angle</strong> object to compare to the current instance.</param>
- <returns>The <strong>Angle</strong> containing the smallest value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.Mirror">
- <summary>
- Returns an angle opposite of the current instance.
- </summary>
- <returns>An <strong>Angle</strong> representing the mirrored value.</returns>
- <example>
- This example creates a new <strong>Angle</strong> of 45° then calculates its mirror
- of 225°. (45 + 180)
- <code lang="VB" title="[New Example]">
- Dim Angle1 As New Angle(45)
- Dim Angle2 As Angle = Angle1.Mirror()
- Debug.WriteLine(Angle2.ToString())
- ' Output: 225
- </code>
- <code lang="CS" title="[New Example]">
- Angle Angle1 = new Angle(45);
- Angle Angle2 = Angle1.Mirror();
- Console.WriteLine(Angle2.ToString());
- // Output: 225
- </code>
- </example>
- <remarks>This method returns the "opposite" of the current instance. The opposite is
- defined as the point on the other side of an imaginary circle. For example, if an angle
- is 0°, at the top of a circle, this method returns 180°, at the bottom of the
- circle.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.Normalize">
- <summary>
- Modifies a value to its equivalent between 0° and 360°.
- </summary>
- <returns>An <strong>Angle</strong> representing the normalized angle.</returns>
- <seealso cref="M:DotSpatial.Positioning.Angle.Normalize(System.Double)">Normalize(Angle) Method</seealso>
-
- <example>
- This example demonstrates how normalization is used. The Stop statement is hit.
- This example demonstrates how the Normalize method can ensure that an angle fits
- between 0° and 359.9999°. This example normalizes 725° into 5°.
- <code lang="VB">
- Dim MyAngle As New Angle(720)
- MyAngle = MyAngle.Normalize()
- </code>
- <code lang="CS">
- Angle MyAngle = new Angle(720);
- MyAngle = MyAngle.Normalize();
- </code>
- <code lang="VB">
- Dim MyValue As New Angle(725)
- MyValue = MyValue.Normalize()
- </code>
- <code lang="CS">
- Angle MyValue = new Angle(725);
- MyValue = MyValue.Normalize();
- </code>
- </example>
- <remarks>This function is used to ensure that an angular measurement is within the
- allowed bounds of 0° and 360°. If a value of 360° or 720° is passed, a value of 0°
- is returned since 360° and 720° represent the same point on a circle. For the Angle
- class, this function is the same as "value Mod 360".</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.ToRadians">
- <summary>
- Converts the current instance into radians.
- </summary>
- <returns>A <see cref="T:DotSpatial.Positioning.Radian">Radian</see> object.</returns>
- <seealso cref="T:DotSpatial.Positioning.Radian">Radian Class</seealso>
-
- <overloads>Converts an angular measurement into radians before further processing.</overloads>
-
- <example>
- This example converts a measurement of 90° into radians.
- <code lang="VB">
- Dim MyAngle As New Angle(90)
- Dim MyRadians As Radian = MyAngle.ToRadians()
- </code>
- <code lang="CS">
- Angle MyAngle = new Angle(90);
- Radian MyRadians = MyAngle.ToRadians();
- </code>
- </example>
- <remarks>This function is typically used to convert an angular measurement into
- radians before performing a trigonometric function.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.ToString(System.String)">
- <summary>
- Outputs the angle as a string using the specified format.
- </summary>
- <param name="format">The format.</param>
- <returns>A <strong>String</strong> in the specified format.</returns>
- <seealso cref="M:DotSpatial.Positioning.Angle.ToString(System.String,System.IFormatProvider)">ToString Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Angle.Parse(System.String)">Parse Method</seealso>
-
- <example>
- This example uses the <strong>ToString</strong> method to output an angle in a
- custom format. The " <strong>h°</strong> " code represents hours along with a
- degree symbol (Alt+0176 on the keypad), and " <strong>m.mm</strong> " represents
- the minutes out to two decimals. Mmm.
- <code lang="VB">
- Dim MyAngle As New Angle(45, 16.772)
- Debug.WriteLine(MyAngle.ToString("h°m.mm"))
- ' Output: 45°16.78
- </code>
- <code lang="CS">
- Dim MyAngle As New Angle(45, 16.772);
- Debug.WriteLine(MyAngle.ToString("h°m.mm"));
- // Output: 45°16.78
- </code>
- </example>
- <remarks>This method returns the current instance output in a specific format. If no
- value for the format is specified, a default format of "d.dddd°" is used. Any
- string output by this method can be converted back into an Angle object using the
- <strong>Parse</strong> method or <strong>Angle(string)</strong> constructor.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.Ceiling">
- <summary>
- Returns the smallest integer greater than the specified value.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.Floor">
- <summary>
- Returns the largest integer which is smaller than the specified value.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.RoundSeconds">
- <summary>
- Returns a new instance whose Seconds property is evenly divisible by 15.
- </summary>
- <returns>An <strong>Angle</strong> containing the rounded value.</returns>
- <remarks>This method is used to align or "snap" an angle to a regular interval. For
- example, a grid might be easier to read if it were drawn at 30-second intervals instead
- of 24.198-second intervals.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.Round(System.Int32)">
- <summary>
- Returns a new instance whose value is rounded the specified number of decimals.
- </summary>
- <param name="decimals">An <strong>Integer</strong> specifying the number of decimals to round off to.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.RoundSeconds(System.Double)">
- <summary>
- Returns a new angle whose Seconds property is evenly divisible by the specified amount.
- </summary>
- <param name="interval">A <strong>Double</strong> between 0 and 60 indicating the interval to round
- to.</param>
- <returns>An <strong>Angle</strong> containing the rounded value.</returns>
- <remarks>This method is used to align or "snap" an angle to a regular interval. For
- example, a grid might be easier to read if it were drawn at 30-second intervals instead
- of 24.198-second intervals.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.Equals(System.Object)">
- <summary>
- Compares the current value to another Angle object's value.
- </summary>
- <param name="obj">An <strong>Angle</strong>, <strong>Double</strong>, or <strong>Integer</strong>
- to compare with.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the object's DecimalDegrees
- properties match.</returns>
- <remarks>This</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.GetHashCode">
- <summary>
- Returns a unique code for this instance.
- </summary>
- <returns>An <strong>Integer</strong> representing a unique code for the current
- instance.</returns>
- <remarks>Since the <strong>Angle</strong> class is immutable, this property may be used
- safely with hash tables.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.ToString">
- <summary>
- Outputs the angle as a string using the default format.
- </summary>
- <returns>A <strong>String</strong> created using the default format.</returns>
- <seealso cref="M:DotSpatial.Positioning.Angle.Parse(System.String)">Parse Method</seealso>
-
- <example>
- This example outputs a value of 90 degrees in the default format of ###.#°.
- <code lang="VB">
- Dim MyAngle As New Angle(90)
- Debug.WriteLine(MyAngle.ToString)
- ' Output: "90°"
- </code>
- <code lang="CS">
- Angle MyAngle = new Angle(90);
- Debug.WriteLine(MyAngle.ToString());
- // Output: "90°"
- </code>
- </example>
- <remarks>This method formats the current instance using the default format of
- "d.dddd°." Any string output by this method can be converted back into an Angle
- object using the <strong>Parse</strong> method or <strong>Angle(string)</strong>
- constructor.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.Normalize(System.Double)">
- <summary>
- Converts the specified value to its equivalent between 0° and 360°.
- </summary>
- <param name="decimalDegrees">A <strong>Double</strong> value to be normalized.</param>
- <returns>An Angle containing a value equivalent to the value specified, but between 0° and
- 360°.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.ToRadians(DotSpatial.Positioning.Angle)">
- <summary>
- Converts an angular measurement into radians.
- </summary>
- <param name="value">The value.</param>
- <returns>A <see cref="T:DotSpatial.Positioning.Radian"><strong>Radian</strong></see> object.</returns>
- <example>
- This example shows a quick way to convert an angle of 90° into radians.
- <code lang="VB">
- Dim MyRadian As Radian = Angle.ToRadians(90)
- </code>
- <code lang="CS">
- Radian MyRadian = Angle.ToRadians(90);
- </code>
- </example>
- <remarks>This function is typically used to convert an angular measurement into
- radians before performing a trigonometric function.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.FromRadians(DotSpatial.Positioning.Radian)">
- <summary>
- Converts a value in radians into an angular measurement.
- </summary>
- <param name="radians">The radians.</param>
- <returns></returns>
- <seealso cref="M:DotSpatial.Positioning.Angle.ToRadians">ToRadians</seealso>
-
- <seealso cref="T:DotSpatial.Positioning.Radian">Radian Class</seealso>
-
- <example>
- This example uses the <strong>FromRadians</strong> method to convert a value of one
- radian into an <strong>Angle</strong> of 57°.
- <code lang="VB">
- ' Create a new angle equal to one radian
- Dim MyRadians As New Radian(1)
- Dim MyAngle As Angle = Angle.FromRadians(MyRadians)
- Debug.WriteLine(MyAngle.ToString())
- ' Output: 57°
- </code>
- <code lang="CS">
- // Create a new angle equal to one radian
- Radian MyRadians = new Radian(1);
- Angle MyAngle = Angle.FromRadians(MyRadians);
- Console.WriteLine(MyAngle.ToString());
- // Output: 57°
- </code>
- </example>
- <remarks>This function is typically used in conjunction with the
- <see cref="M:DotSpatial.Positioning.Angle.ToRadians">ToRadians</see>
- method after a trigonometric function has completed. The converted value is stored in
- the <see cref="P:DotSpatial.Positioning.Angle.DecimalDegrees">DecimalDegrees</see> property.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.FromRadians(System.Double)">
- <summary>
- Froms the radians.
- </summary>
- <param name="radians">The radians.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.FromSexagesimal(System.Double)">
- <summary>
- Convers a sexagesimal number into an Angle.
- </summary>
- <param name="dms">A Double value, a number in the form of DDD.MMSSSSS format</param>
- <returns>An <strong>Angle</strong> object.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.LesserOf(DotSpatial.Positioning.Angle,DotSpatial.Positioning.Angle)">
- <summary>
- Returns the object with the smallest value.
- </summary>
- <param name="value1">A <strong>Angle</strong> object to compare to value2.</param>
- <param name="value2">A <strong>Angle</strong> object to compare to value1.</param>
- <returns>The <strong>Angle</strong> containing the smallest value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.GreaterOf(DotSpatial.Positioning.Angle,DotSpatial.Positioning.Angle)">
- <summary>
- Returns the object with the largest value.
- </summary>
- <param name="value1">A <strong>Angle</strong> object to compare to value2.</param>
- <param name="value2">A <strong>Angle</strong> object to compare to value1</param>
- <returns>A <strong>Angle</strong> containing the largest value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.Random">
- <summary>
- Returns a random angle between 0° and 360°.
- </summary>
- <returns>An <strong>Angle</strong> containing a random value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.Random(System.Random)">
- <summary>
- Returns a random Angle between 0° and 360°
- </summary>
- <param name="generator">A <strong>Random</strong> object used to ogenerate random values.</param>
- <returns>An <strong>Angle</strong> containing a random value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.op_Explicit(System.Double)~DotSpatial.Positioning.Angle">
- <summary>
- Converts a decimal degree measurement as a Double into an Angle.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.op_Explicit(System.Single)~DotSpatial.Positioning.Angle">
- <summary>
- Converts a decimal degree measurement as a Single into an Angle.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.op_Explicit(DotSpatial.Positioning.Radian)~DotSpatial.Positioning.Angle">
- <summary>
- Converts a measurement in Radians into an Angle.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.op_Explicit(DotSpatial.Positioning.Angle)~System.Double">
- <summary>
- Converts a decimal degree measurement as a Angle into an Double.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.op_Explicit(DotSpatial.Positioning.Angle)~System.Single">
- <summary>
- Converts a decimal degree measurement as a Angle into a Single.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.op_Explicit(System.Int32)~DotSpatial.Positioning.Angle">
- <summary>
- Converts a measurement in degrees as an Integer into an Angle.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.op_Explicit(DotSpatial.Positioning.Azimuth)~DotSpatial.Positioning.Angle">
- <summary>
- Performs an explicit conversion from <see cref="T:DotSpatial.Positioning.Azimuth"/> to <see cref="T:DotSpatial.Positioning.Angle"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.op_Explicit(DotSpatial.Positioning.Elevation)~DotSpatial.Positioning.Angle">
- <summary>
- Performs an explicit conversion from <see cref="T:DotSpatial.Positioning.Elevation"/> to <see cref="T:DotSpatial.Positioning.Angle"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.op_Explicit(DotSpatial.Positioning.Latitude)~DotSpatial.Positioning.Angle">
- <summary>
- Performs an explicit conversion from <see cref="T:DotSpatial.Positioning.Latitude"/> to <see cref="T:DotSpatial.Positioning.Angle"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.op_Explicit(DotSpatial.Positioning.Longitude)~DotSpatial.Positioning.Angle">
- <summary>
- Performs an explicit conversion from <see cref="T:DotSpatial.Positioning.Longitude"/> to <see cref="T:DotSpatial.Positioning.Angle"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.op_Explicit(System.String)~DotSpatial.Positioning.Angle">
- <summary>
- Converts a measurement in the form of a formatted String into an Angle.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.op_Explicit(DotSpatial.Positioning.Angle)~System.String">
- <summary>
- Converts an Angle into a String.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- <remarks>This operator calls the ToString() method using the current culture.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.op_Addition(DotSpatial.Positioning.Angle,DotSpatial.Positioning.Angle)">
- <summary>
- Implements the operator +.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.op_Addition(DotSpatial.Positioning.Angle,System.Double)">
- <summary>
- Implements the operator +.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.op_Subtraction(DotSpatial.Positioning.Angle,DotSpatial.Positioning.Angle)">
- <summary>
- Implements the operator -.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.op_Subtraction(DotSpatial.Positioning.Angle,System.Double)">
- <summary>
- Implements the operator -.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.op_Multiply(DotSpatial.Positioning.Angle,DotSpatial.Positioning.Angle)">
- <summary>
- Implements the operator *.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.op_Multiply(DotSpatial.Positioning.Angle,System.Double)">
- <summary>
- Implements the operator *.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.op_Division(DotSpatial.Positioning.Angle,DotSpatial.Positioning.Angle)">
- <summary>
- Implements the operator /.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.op_Division(DotSpatial.Positioning.Angle,System.Double)">
- <summary>
- Implements the operator /.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.op_Equality(DotSpatial.Positioning.Angle,DotSpatial.Positioning.Angle)">
- <summary>
- Implements the operator ==.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.op_Equality(DotSpatial.Positioning.Angle,System.Double)">
- <summary>
- Implements the operator ==.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.op_Inequality(DotSpatial.Positioning.Angle,DotSpatial.Positioning.Angle)">
- <summary>
- Implements the operator !=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.op_Inequality(DotSpatial.Positioning.Angle,System.Double)">
- <summary>
- Implements the operator !=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.op_GreaterThan(DotSpatial.Positioning.Angle,DotSpatial.Positioning.Angle)">
- <summary>
- Implements the operator >.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.op_GreaterThan(DotSpatial.Positioning.Angle,System.Double)">
- <summary>
- Implements the operator >.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.op_GreaterThanOrEqual(DotSpatial.Positioning.Angle,DotSpatial.Positioning.Angle)">
- <summary>
- Implements the operator >=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.op_GreaterThanOrEqual(DotSpatial.Positioning.Angle,System.Double)">
- <summary>
- Implements the operator >=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.op_LessThan(DotSpatial.Positioning.Angle,DotSpatial.Positioning.Angle)">
- <summary>
- Implements the operator <.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.op_LessThan(DotSpatial.Positioning.Angle,System.Double)">
- <summary>
- Implements the operator <.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.op_LessThanOrEqual(DotSpatial.Positioning.Angle,DotSpatial.Positioning.Angle)">
- <summary>
- Implements the operator <=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.op_LessThanOrEqual(DotSpatial.Positioning.Angle,System.Double)">
- <summary>
- Implements the operator <=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.Increment">
- <summary>
- Returns the current instance increased by one.
- </summary>
- <returns>An <strong>Angle</strong> object.</returns>
- <example>
- This example uses the <strong>Increment</strong> method to increase an angle's
- value. It also demonstrates the subtle error which can be caused if
- <strong>Increment</strong> is called while ignoring the return value.
- <code lang="VB" title="[New Example]">
- ' Correct use of Increment
- Dim Angle1 As New Angle(89)
- Angle1 = Angle1.Increment()
- ' Incorrect use of Increment
- Dim Angle1 = New Angle(89)
- Angle1.Increment()
- ' Notice: Angle1 will still be 89°!
- </code>
- <code lang="CS" title="[New Example]">
- // Correct use of Increment
- Angle Angle1 = new Angle(89);
- Angle1 = Angle1.Increment();
- // Incorrect use of Increment
- Angle Angle1 = new Angle(89);
- Angle1.Increment();
- // Notice: Angle1 will still be 89°!
- </code>
- </example>
- <remarks><para>This method increases the <strong>DecimalDegrees</strong> property by 1.0,
- returned as a new instance.</para>
- <para><font color="red">Since the <strong>Angle</strong> class is immutable, this
- method cannot be used to modify an existing instance.</font></para></remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.Add(System.Double)">
- <summary>
- Increases the current instance by the specified value.
- </summary>
- <param name="value">A <strong>Double</strong> to add to the current instance.</param>
- <returns>A new <strong>Angle</strong> containing the summed values.</returns>
- <example>
- This example adds 45° to the current instance of 45°, returning 90°.
- <code lang="VB" title="[New Example]">
- Dim Angle1 As New Angle(45)
- Angle1 = Angle1.Add(45)
- </code>
- <code lang="CS" title="[New Example]">
- Angle Angle1 = new Angle(45);
- Angle1 = Angle1.Add(45);
- </code>
- </example>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.Add(DotSpatial.Positioning.Angle)">
- <summary>
- Adds the specified angle.
- </summary>
- <param name="angle">The angle.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.Decrement">
- <summary>
- Returns the current instance decreased by one.
- </summary>
- <returns>An <strong>Angle</strong> object.</returns>
- <example>
- This example uses the <strong>Decrement</strong> method to decrease an angle's
- value. It also demonstrates the subtle error which can be caused if
- <strong>Decrement</strong> is called while ignoring the return value.
- <code lang="VB" title="[New Example]">
- ' Correct use of Decrement
- Dim Angle1 As New Angle(91)
- Angle1 = Angle1.Decrement()
- ' Incorrect use of Decrement
- Dim Angle1 = New Angle(91)
- Angle1.Increment()
- ' NOTE: Angle1 will still be 91°!
- </code>
- <code lang="CS" title="[New Example]">
- // Correct use of Decrement
- Angle Angle1 = new Angle(91);
- Angle1 = Angle1.Decrement();
- // Incorrect use of Decrement
- Angle Angle1 = new Angle(91);
- Angle1.Decrement();
- // NOTE: Angle1 will still be 91°!
- </code>
- </example>
- <remarks><para>This method decreases the <strong>DecimalDegrees</strong> property by 1.0,
- returned as a new instance.</para>
- <para><font color="red">Since the <strong>Angle</strong> class is immutable, this
- method cannot be used to modify an existing instance.</font></para></remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.Subtract(System.Double)">
- <summary>
- Decreases the current instance by the specified value.
- </summary>
- <param name="value">A <strong>Double</strong> to subtract from the current instance.</param>
- <returns>A new <strong>Angle</strong> containing the new value.</returns>
- <example>
- This example subtracts 30° from the current instance of 90°, returning 60°.
- <code lang="VB" title="[New Example]">
- Dim Angle1 As New Angle(90)
- Angle1 = Angle1.Subtract(30)
- </code>
- <code lang="CS" title="[New Example]">
- Angle Angle1 = new Angle(90);
- Angle1 = Angle1.Subtract(30);
- </code>
- </example>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.Subtract(DotSpatial.Positioning.Angle)">
- <summary>
- Subtracts the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.Multiply(System.Double)">
- <summary>
- Multiplies the current instance by the specified value.
- </summary>
- <param name="value">A <strong>Double</strong> to multiply with the current instance.</param>
- <returns>A new <strong>Angle</strong> containing the product of the two numbers.</returns>
- <example>
- This example multiplies 30° with three, returning 90°.
- <code lang="VB" title="[New Example]">
- Dim Angle1 As New Angle(30)
- Angle1 = Angle1.Multiply(3)
- </code>
- <code lang="CS" title="[New Example]">
- Angle Angle1 = new Angle(30);
- Angle1 = Angle1.Multiply(3);
- </code>
- </example>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.Multiply(DotSpatial.Positioning.Angle)">
- <summary>
- Multiplies the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.Divide(System.Double)">
- <summary>
- Divides the current instance by the specified value.
- </summary>
- <param name="value">A <strong>Double</strong> representing a denominator to divide by.</param>
- <returns>An <strong>Angle</strong> containing the new value.</returns>
- <example>
- This example divides 90° by three, returning 30°.
- <code lang="VB" title="[New Example]">
- Dim Angle1 As New Angle(90)
- Angle1 = Angle1.Divide(3)
- </code>
- <code lang="CS" title="[New Example]">
- Angle Angle1 = new Angle(90);
- Angle1 = Angle1.Divide(3);
- </code>
- </example>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.Divide(DotSpatial.Positioning.Angle)">
- <summary>
- Divides the specified angle.
- </summary>
- <param name="angle">The angle.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.IsLessThan(DotSpatial.Positioning.Angle)">
- <summary>
- Indicates if the current instance is smaller than the specified value.
- </summary>
- <param name="value">An <strong>Angle</strong> to compare with the current instance.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the current instance is
- smaller than the specified value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.IsLessThan(System.Double)">
- <summary>
- Determines whether [is less than] [the specified value].
- </summary>
- <param name="value">The value.</param>
- <returns><c>true</c> if [is less than] [the specified value]; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.IsLessThanOrEqualTo(DotSpatial.Positioning.Angle)">
- <summary>
- Indicates if the current instance is smaller than or equal to the specified
- value.
- </summary>
- <param name="value">An <strong>Angle</strong> to compare with the current instance.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the current instance is
- smaller than or equal to the specified value.</returns>
- <remarks>This method compares the <strong>DecimalDegrees</strong> property with the
- specified value. This method is the same as the "<=" operator.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.IsLessThanOrEqualTo(System.Double)">
- <summary>
- Determines whether [is less than or equal to] [the specified value].
- </summary>
- <param name="value">The value.</param>
- <returns><c>true</c> if [is less than or equal to] [the specified value]; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.IsGreaterThan(DotSpatial.Positioning.Angle)">
- <summary>
- Indicates if the current instance is larger than the specified value.
- </summary>
- <param name="value">An <strong>Angle</strong> to compare with the current instance.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the current instance is
- greater than the specified value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.IsGreaterThan(System.Double)">
- <summary>
- Determines whether [is greater than] [the specified value].
- </summary>
- <param name="value">The value.</param>
- <returns><c>true</c> if [is greater than] [the specified value]; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.IsGreaterThanOrEqualTo(DotSpatial.Positioning.Angle)">
- <summary>
- Indicates if the current instance is larger than or equal to the specified
- value.
- </summary>
- <param name="value">An <strong>Angle</strong> to compare with the current instance.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the current instance is
- greater than or equal to the specified value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.IsGreaterThanOrEqualTo(System.Double)">
- <summary>
- Determines whether [is greater than or equal to] [the specified value].
- </summary>
- <param name="value">The value.</param>
- <returns><c>true</c> if [is greater than or equal to] [the specified value]; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.Parse(System.String)">
- <summary>
- Converts the specified string into an Angle object.
- </summary>
- <param name="value">The value.</param>
- <returns>A new <strong>Angle</strong> object populated with the specified
- values.</returns>
- <seealso cref="M:DotSpatial.Positioning.Angle.ToString">ToString Method</seealso>
-
- <example>
- This example creates a new angular measurement using the <strong>Parse</strong>
- method.
- <code lang="VB">
- Dim NewAngle As Angle = Angle.Parse("123.45°")
- </code>
- <code lang="CS">
- Angle NewAngle = Angle.Parse("123.45°");
- </code>
- </example>
-
- <exception cref="T:System.ArgumentNullException" caption="ArgumentNullException">The Parse method requires a decimal or sexagesimal measurement.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">Only the right-most portion of a sexagesimal measurement can be a fractional value.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">Extra characters were encountered while parsing an angular measurement. Only hours, minutes, and seconds are allowed.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">The specified text was not fully understood as an angular measurement.</exception>
- <remarks>This method parses the specified string into an <strong>Angle</strong> object
- using the current culture. This constructor can parse any strings created via the
- <strong>ToString</strong> method.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.Parse(System.String,System.Globalization.CultureInfo)">
- <summary>
- Converts the specified string into an <strong>Angle</strong> object using the
- specified culture.
- </summary>
- <param name="value">A <strong>String</strong> describing an angle in the form of decimal degrees or a
- sexagesimal.</param>
- <param name="culture">A <strong>CultureInfo</strong> object describing the numeric format to use during
- conversion.</param>
- <returns>A new <strong>Angle</strong> object equivalent to the specified string.</returns>
- <remarks>This powerful method is typically used to process data from a data store or a
- value input by the user in any culture. This function can accept any format which
- can be output by the ToString method.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.ToDecimalDegrees(System.Int32,System.Int32,System.Double)">
- <summary>
- Converts arbitrary hour, minute and seconds into decimal degrees.
- </summary>
- <param name="hours">The hours.</param>
- <param name="minutes">The minutes.</param>
- <param name="seconds">The seconds.</param>
- <returns>A <strong>Double</strong> containing the decimal degree version of the specified
- values.</returns>
- <seealso cref="P:DotSpatial.Positioning.Latitude.DecimalDegrees">DecimalDegrees Property</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Latitude.Normalize">Normalize Method</seealso>
-
- <example>
- This example converts a value of 10°30'0" into decimal degrees (10.5).
- <code lang="VB" title="ToDecimalDegrees Example (VB)">
- Dim MyValue As Double = Latitude.ToDecimalDegrees(10, 30, 0)
- </code>
- <code lang="CS" title="ToDecimalDegrees Example (C#)">
- double MyValue = Latitude.ToDecimalDegrees(10, 30, 0);
- </code>
- </example>
- <remarks>This function is used to convert three-part measurements into a single value. The
- result of this method is typically assigned to the
- <see cref="P:DotSpatial.Positioning.Latitude.DecimalDegrees">
- DecimalDegrees</see> property. Values are rounded to thirteen decimal
- places, the maximum precision allowed by this type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.ToDecimalDegrees(System.Int32,System.Double)">
- <summary>
- Converts arbitrary hour and decimal minutes into decimal degrees.
- </summary>
- <param name="hours">The hours.</param>
- <param name="decimalMinutes">The decimal minutes.</param>
- <returns>A <strong>Double</strong> containing the decimal degree version of the specified
- values.</returns>
- <remarks>This function is used to convert three-part measurements into a single value. The
- result of this method is typically assigned to the
- <see cref="P:DotSpatial.Positioning.Latitude.DecimalDegrees">
- DecimalDegrees</see> property. Values are rounded to thirteen decimal
- places, the maximum precision allowed by this type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.ToDecimalDegrees(System.Int32)">
- <summary>
- Converts an hour value into decimal degrees.
- </summary>
- <param name="hours">The hours.</param>
- <returns>A <strong>Double</strong> containing the decimal degree version of the specified
- values.</returns>
- <remarks>The specified value will be converted to a double value.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.Clone">
- <summary>
- Creates a copy of the current instance.
- </summary>
- <returns>An <strong>Angle</strong> of the same value as the current instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.CompareTo(DotSpatial.Positioning.Angle)">
- <summary>
- Returns a value indicating the relative order of two objects.
- </summary>
- <param name="other">An <strong>Angle</strong> object to compare with.</param>
- <returns>A value of -1, 0, or 1 as documented by the IComparable interface.</returns>
- <remarks>This method allows collections of <strong>Azimuth</strong> objects to be sorted.
- The <see cref="P:DotSpatial.Positioning.Angle.DecimalDegrees">DecimalDegrees</see> property of each instance is compared.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.Equals(DotSpatial.Positioning.Angle)">
- <summary>
- Compares the current instance to another instance using the specified
- precision.
- </summary>
- <param name="angle">The angle.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the
- <strong>DecimalDegrees</strong> property of the current instance matches the
- specified instance's <strong>DecimalDegrees</strong> property.</returns>
- <seealso cref="M:DotSpatial.Positioning.Angle.Equals(DotSpatial.Positioning.Angle,System.Int32)">Equals Method</seealso>
-
- <example>
- These examples compare two fractional values using specific numbers of digits for
- comparison.
- <code lang="VB" title="[New Example]">
- ' Equals will return False
- Dim Angle1 As New Angle(90.15);
- Dim Angle2 As New Angle(90.12);
- If Angle1.Equals(Angle2, 2) Then
- Debug.WriteLine("The values are the same to two digits of precision.");
- ' Equals will return True
- Dim Angle1 As New Angle(90.15);
- Dim Angle2 As New Angle(90.12);
- If Angle1.Equals(Angle2, 1) Then
- Debug.WriteLine("The values are the same to one digit of precision.");
- </code>
- <code lang="CS" title="[New Example]">
- // Equals will return False
- Angle Angle1 = new Angle(90.15);
- Angle Angle2 = new Angle(90.12);
- if (Angle1.Equals(Angle2, 2))
- Console.WriteLine("The values are the same to two digits of precision.");
- // Equals will return True
- Angle Angle1 = new Angle(90.15);
- Angle Angle2 = new Angle(90.12);
- if (Angle1.Equals(Angle2, 1))
- Console.WriteLine("The values are the same to one digits of precision.");
- </code>
- </example>
- <remarks><para>This is typically used in cases where precision is only significant for a few
- digits and exact comparison is not necessary.</para>
- <para><em>NOTE: This method compares objects by value, not by
- reference.</em></para></remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.Equals(DotSpatial.Positioning.Angle,System.Int32)">
- <summary>
- Compares the current instance to another instance using the specified
- precision.
- </summary>
- <param name="angle">The angle.</param>
- <param name="decimals">The decimals.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the
- <strong>DecimalDegrees</strong> property of the current instance matches the
- specified instance's <strong>DecimalDegrees</strong> property.</returns>
- <seealso cref="M:DotSpatial.Positioning.Angle.Equals(DotSpatial.Positioning.Angle,System.Int32)">Equals Method</seealso>
-
- <example>
- These examples compare two fractional values using specific numbers of digits for
- comparison.
- <code lang="VB" title="[New Example]">
- ' Equals will return False
- Dim Angle1 As New Angle(90.15);
- Dim Angle2 As New Angle(90.12);
- If Angle1.Equals(Angle2, 2) Then
- Debug.WriteLine("The values are the same to two digits of precision.");
- ' Equals will return True
- Dim Angle1 As New Angle(90.15);
- Dim Angle2 As New Angle(90.12);
- If Angle1.Equals(Angle2, 1) Then
- Debug.WriteLine("The values are the same to one digit of precision.");
- </code>
- <code lang="CS" title="[New Example]">
- // Equals will return False
- Angle Angle1 = new Angle(90.15);
- Angle Angle2 = new Angle(90.12);
- if (Angle1.Equals(Angle2, 2))
- Console.WriteLine("The values are the same to two digits of precision.");
- // Equals will return True
- Angle Angle1 = new Angle(90.15);
- Angle Angle2 = new Angle(90.12);
- if (Angle1.Equals(Angle2, 1))
- Console.WriteLine("The values are the same to one digits of precision.");
- </code>
- </example>
- <remarks><para>This is typically used in cases where precision is only significant for a few
- digits and exact comparison is not necessary.</para>
- <para><em>NOTE: This method compares objects by value, not by
- reference.</em></para></remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.ToString(System.String,System.IFormatProvider)">
- <summary>
- Outputs the angle as a string using the specified format.
- </summary>
- <param name="format">The format to use.-or- A null reference (Nothing in Visual Basic) to use the default format defined for the type of the <see cref="T:System.IFormattable"/> implementation.</param>
- <param name="formatProvider">The provider to use to format the value.-or- A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.</param>
- <returns>A <strong>String</strong> in the specified format.</returns>
- <seealso cref="M:DotSpatial.Positioning.Angle.ToString">ToString Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Angle.Parse(System.String)">Parse Method</seealso>
-
- <example>
- This example uses the <strong>ToString</strong> method to output an angle in a
- custom format. The " <strong>h°</strong> " code represents hours along with a
- degree symbol (Alt+0176 on the keypad), and " <strong>m.mm</strong> " represents
- the minutes out to two decimals. Mmm.
- <code lang="VB">
- Dim MyAngle As New Angle(45, 16.772)
- Debug.WriteLine(MyAngle.ToString("h°m.mm", CultureInfo.CurrentCulture))
- ' Output: 45°16.78
- </code>
- <code lang="CS">
- Dim MyAngle As New Angle(45, 16.772);
- Debug.WriteLine(MyAngle.ToString("h°m.mm", CultureInfo.CurrentCulture));
- // Output: 45°16.78
- </code>
- </example>
- <remarks>This method returns the current instance output in a specific format. If no
- value for the format is specified, a default format of "d.dddd" is used. Any string
- output by this method can be converted back into an Angle object using the
- <strong>Parse</strong> method or <strong>Angle(string)</strong> constructor.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.System#Xml#Serialization#IXmlSerializable#GetSchema">
- <summary>
- This method is reserved and should not be used. When implementing the IXmlSerializable interface, you should return null (Nothing in Visual Basic) from this method, and instead, if specifying a custom schema is required, apply the <see cref="T:System.Xml.Serialization.XmlSchemaProviderAttribute"/> to the class.
- </summary>
- <returns>An <see cref="T:System.Xml.Schema.XmlSchema"/> that describes the XML representation of the object that is produced by the <see cref="M:System.Xml.Serialization.IXmlSerializable.WriteXml(System.Xml.XmlWriter)"/> method and consumed by the <see cref="M:System.Xml.Serialization.IXmlSerializable.ReadXml(System.Xml.XmlReader)"/> method.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.WriteXml(System.Xml.XmlWriter)">
- <summary>
- Converts an object into its XML representation.
- </summary>
- <param name="writer">The <see cref="T:System.Xml.XmlWriter"/> stream to which the object is serialized.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Angle.ReadXml(System.Xml.XmlReader)">
- <summary>
- Generates an object from its XML representation.
- </summary>
- <param name="reader">The <see cref="T:System.Xml.XmlReader"/> stream from which the object is deserialized.</param>
- </member>
- <member name="P:DotSpatial.Positioning.Angle.DecimalDegrees">
- <summary>
- Returns the value of the angle as decimal degrees.
- </summary>
- <value>A <strong>Double</strong> value.</value>
- <seealso cref="P:DotSpatial.Positioning.Angle.Hours">Hours Property</seealso>
-
- <seealso cref="P:DotSpatial.Positioning.Angle.Minutes">Minutes Property</seealso>
-
- <seealso cref="P:DotSpatial.Positioning.Angle.Seconds">Seconds Property</seealso>
-
- <example>
- This example demonstrates how the
- <see cref="P:DotSpatial.Positioning.Angle.DecimalDegrees"><strong>DecimalDegrees</strong></see> property is
- calculated automatically when creating an angle using hours, minutes and seconds.
- <code lang="VB">
- ' Create an angle of 20°30'
- Dim MyAngle As New Angle(20, 30)
- ' Setting the DecimalMinutes recalculated other properties
- Debug.WriteLine(MyAngle.DecimalDegrees)
- ' Output: "20.5" the same as 20°30'
- </code>
- <code lang="CS">
- // Create an angle of 20°30'
- Angle MyAngle = New Angle(20, 30);
- // Setting the DecimalMinutes recalculated other properties
- Console.WriteLine(MyAngle.DecimalDegrees)
- // Output: "20.5" the same as 20°30'
- </code>
- </example>
- <remarks>This property returns the value of the angle as a single number.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Angle.DecimalMinutes">
- <summary>
- Returns the minutes and seconds as a single numeric value.
- </summary>
- <value>A <strong>Double</strong> value.</value>
- <seealso cref="P:DotSpatial.Positioning.Angle.Minutes">Minutes Property</seealso>
-
- <seealso cref="P:DotSpatial.Positioning.Angle.DecimalDegrees">DecimalDegrees Property</seealso>
-
- <example>
- This example demonstrates how the <strong>DecimalMinutes</strong> property is
- automatically calculated when creating a new angle.
- <code lang="VB">
- ' Create an angle of 20°10'30"
- Dim MyAngle As New Angle(20, 10, 30)
- ' The DecimalMinutes property is automatically calculated
- Debug.WriteLine(MyAngle.DecimalMinutes)
- ' Output: "10.5"
- </code>
- <code lang="CS">
- // Create an angle of 20°10'30"
- Angle MyAngle = new Angle(20, 10, 30);
- // The DecimalMinutes property is automatically calculated
- Console.WriteLine(MyAngle.DecimalMinutes)
- // Output: "10.5"
- </code>
- </example>
- <remarks>This property is used when minutes and seconds are represented as a single
- decimal value.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Angle.Hours">
- <summary>
- Returns the integer hours (degrees) portion of an angular
- measurement.
- </summary>
- <value>An <strong>Integer</strong> value.</value>
- <seealso cref="P:DotSpatial.Positioning.Angle.Minutes">Minutes Property</seealso>
-
- <seealso cref="P:DotSpatial.Positioning.Angle.Seconds">Seconds Property</seealso>
-
- <example>
- This example creates an angle of 60.5° then outputs the value of the
- <strong>Hours</strong> property, 60.
- <code lang="VB">
- Dim MyAngle As New Angle(60.5)
- Debug.WriteLine(MyAngle.Hours)
- ' Output: 60
- </code>
- <code lang="CS">
- Angle MyAngle = new Angle(60.5);
- Console.WriteLine(MyAngle.Hours);
- // Output: 60
- </code>
- </example>
- <remarks>This property is used in conjunction with the <see cref="P:DotSpatial.Positioning.Angle.Minutes">Minutes</see>
- and <see cref="P:DotSpatial.Positioning.Angle.Seconds">Seconds</see> properties to create a full angular measurement.
- This property is the same as <strong>DecimalDegrees</strong> without any fractional
- value.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Angle.Minutes">
- <summary>
- Returns the integer minutes portion of an angular measurement.
- </summary>
- <value>An <strong>Integer</strong>.</value>
- <seealso cref="P:DotSpatial.Positioning.Angle.Hours">Hours Property</seealso>
-
- <seealso cref="P:DotSpatial.Positioning.Angle.Seconds">Seconds Property</seealso>
-
- <example>
- This example creates an angle of 45.5° then outputs the value of the
- <strong>Minutes</strong> property, 30.
- <code lang="VB">
- Dim MyAngle As New Angle(45.5)
- Debug.WriteLine(MyAngle.Minutes)
- ' Output: 30
- </code>
- <code lang="CS">
- Angle MyAngle = new Angle(45.5);
- Console.WriteLine(MyAngle.Minutes);
- // Output: 30
- </code>
- </example>
- <remarks>This property is used in conjunction with the <see cref="P:DotSpatial.Positioning.Angle.Hours">Hours</see> and
- <see cref="P:DotSpatial.Positioning.Angle.Seconds">Seconds</see> properties to create a sexagesimal
- measurement.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Angle.Seconds">
- <summary>
- Returns the seconds minutes portion of an angular measurement.
- </summary>
- <value>A <strong>Double</strong> value.</value>
- <seealso cref="P:DotSpatial.Positioning.Angle.Hours">Hours Property</seealso>
-
- <seealso cref="P:DotSpatial.Positioning.Angle.Minutes">Minutes Property</seealso>
-
- <example>
- This example creates an angle of 45°10.5' then outputs the value of the
- <strong>Seconds</strong> property, 30.
- <code lang="VB">
- Dim MyAngle As New Angle(45, 10.5)
- Debug.WriteLine(MyAngle.Seconds)
- ' Output: 30
- </code>
- <code lang="CS">
- Dim MyAngle As New Angle(45, 10.5);
- Console.WriteLine(MyAngle.Seconds);
- // Output: 30
- </code>
- </example>
- <remarks>This property is used in conjunction with the <see cref="P:DotSpatial.Positioning.Angle.Hours">Hours</see> and
- <see cref="P:DotSpatial.Positioning.Angle.Minutes">Minutes</see> properties to create a sexagesimal
- measurement.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Angle.IsEmpty">
- <summary>
- Indicates if the current instance has a non-zero value.
- </summary>
- <value>A <strong>Boolean</strong>, <strong>True</strong> if the
- <strong>DecimalDegrees</strong> property is zero.</value>
- <seealso cref="F:DotSpatial.Positioning.Angle.Empty">Empty Field</seealso>
- </member>
- <member name="P:DotSpatial.Positioning.Angle.IsInfinity">
- <summary>
- Indicates if the current instance represents an infinite value.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Angle.IsInvalid">
- <summary>
- Indicates whether the value is invalid or unspecified.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Angle.IsNormalized">
- <summary>
- Indicates whether the value has been normalized and is within the
- allowed bounds of 0° and 360°.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.Area">
- <summary>
- Represents the measurement of surface area of a polygon on Earth's
- surface.
- </summary>
- <example>
- This example demonstrates how to create an <strong>Area</strong> structure and
- convert it to another unit type.
- <code lang="VB">
- ' Declare a Area of 50 meters
- Dim Area1 As New Area(50, AreaUnit.SquareMeters)
- ' Convert it into acres
- Dim Area2 As Area = Area2.ToAcres()
- </code>
- <code lang="CS">
- // Declare a Area of 50 meters
- Area Area1 = new Area(50, AreaUnit.SquareMeters);
- // Convert it into acres
- Area Area2 = Area2.ToAcres();
- </code>
- </example>
- <remarks><para>This structure is used to represent measurements of arbitrary polygons on
- Earth's surface. Measurements can be converted to different unit types, such as
- acres, square kilometers, and square miles.</para>
- <para>Instances of this structure are guaranteed to be thread-safe because they are
- immutable (properties can only be modified via constructors).</para></remarks>
- </member>
- <member name="F:DotSpatial.Positioning.Area.ACRES_PER_SQUARE_METER">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.ACRES_PER_SQUARE_CENTIMETER">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.ACRES_PER_SQUARE_STATUTE_MILE">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.ACRES_PER_SQUARE_KILOMETER">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.ACRES_PER_SQUARE_INCH">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.ACRES_PER_SQUARE_NAUTICAL_MILE">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.ACRES_PER_SQUARE_FOOT">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_FEET_PER_SQUARE_METER">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_FEET_PER_SQUARE_CENTIMETER">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_FEET_PER_SQUARE_STATUTE_MILE">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_FEET_PER_SQUARE_KILOMETER">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_FEET_PER_SQUARE_INCH">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_FEET_PER_SQUARE_NAUTICAL_MILE">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_FEET_PER_ACRE">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_INCHES_PER_SQUARE_METER">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_INCHES_PER_SQUARE_CENTIMETER">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_INCHES_PER_SQUARE_STATUTE_MILE">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_INCHES_PER_SQUARE_KILOMETER">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_INCHES_PER_SQUARE_FOOT">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_INCHES_PER_SQUARE_NAUTICAL_MILE">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_INCHES_PER_ACRE">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_STATUTE_MILES_PER_SQUARE_METER">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_STATUTE_MILES_PER_SQUARE_CENTIMETER">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_STATUTE_MILES_PER_SQUARE_KILOMETER">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_STATUTE_MILES_PER_SQUARE_INCH">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_STATUTE_MILES_PER_SQUARE_FOOT">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_STATUTE_MILES_PER_SQUARE_NAUTICAL_MILE">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_STATUTE_MILES_PER_ACRE">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_NAUTICAL_MILES_PER_SQUARE_METER">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_NAUTICAL_MILES_PER_SQUARE_CENTIMETER">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_NAUTICAL_MILES_PER_SQUARE_KILOMETER">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_NAUTICAL_MILES_PER_SQUARE_INCH">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_NAUTICAL_MILES_PER_SQUARE_FOOT">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_NAUTICAL_MILES_PER_SQUARE_STATUTE_MILE">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_NAUTICAL_MILES_PER_ACRE">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_CENTIMETERS_PER_SQUARE_STATUTE_MILE">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_CENTIMETERS_PER_SQUARE_KILOMETER">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_CENTIMETERS_PER_SQUARE_FOOT">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_CENTIMETERS_PER_SQUARE_INCH">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_CENTIMETERS_PER_SQUARE_METER">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_CENTIMETERS_PER_SQUARE_NAUTICAL_MILE">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_CENTIMETERS_PER_ACRE">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_METERS_PER_SQUARE_STATUTE_MILE">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_METERS_PER_SQUARE_CENTIMETER">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_METERS_PER_SQUARE_KILOMETER">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_METERS_PER_SQUARE_FOOT">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_METERS_PER_SQUARE_INCH">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_METERS_PER_ACRE">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_METERS_PER_SQUARE_NAUTICAL_MILE">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_KILOMETERS_PER_SQUARE_METER">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_KILOMETERS_PER_SQUARE_CENTIMETER">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_KILOMETERS_PER_SQUARE_STATUTE_MILE">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_KILOMETERS_PER_SQUARE_FOOT">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_KILOMETERS_PER_SQUARE_INCH">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_KILOMETERS_PER_SQUARE_NAUTICAL_MILE">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.SQUARE_KILOMETERS_PER_ACRE">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area._value">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area._units">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.Empty">
- <summary>
- Represents an area with no value.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.Infinity">
- <summary>
- Represents an area of infinite value.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.Maximum">
- <summary>
- Represents the largest possible area which can be stored.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.Minimum">
- <summary>
- Represents the smallest possible area which can be stored.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Area.Invalid">
- <summary>
- Represents an invalid or unspecified area.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Area.#ctor(System.Double,DotSpatial.Positioning.AreaUnit)">
- <summary>
- Creates a new instance using the specified value and unit type.
- </summary>
- <param name="value">The value.</param>
- <param name="units">The units.</param>
- <example>
- This example uses a constructor to create a new <strong>Area</strong> of fifty
- square kilometers.
- <code lang="VB">
- Dim MyArea As New Area(50, AreaUnit.SquareKilometers)
- </code>
- <code lang="CS">
- Area MyArea = new Area(50, AreaUnit.SquareKilometers);
- </code>
- </example>
- </member>
- <member name="M:DotSpatial.Positioning.Area.#ctor(System.String)">
- <summary>
- Creates a new instance using the specified string.
- </summary>
- <param name="value">The value.</param>
- <exception cref="T:System.ArgumentNullException" caption="ArgumentNullException">Parse method requires a valid Area measurement.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">1. The numeric portion of the Area measurement was not recognized.<br/>
- 2. The Area unit type was not recognized or not specified.</exception>
-
- <example>
- This example demonstrates how the to use this constructor.
- <code lang="VB">
- Dim MyArea As Area
- ' Create a Area of 50 square kilometers
- MyArea = New Area("50 sq. km")
- ' Create a Area of 14, 387 miles, then convert it into square inches
- MyArea = New Area("14, 387 sq. statute miles").ToSquareInches()
- ' Create a Area of 50 square feet
- MyArea = New Area(" 50 sq ' ")
- </code>
- <code lang="CS">
- Area MyArea;
- ' Create a Area of 50 square kilometers
- MyArea = new Area("50 sq. km");
- ' Create a Area of 14, 387 miles, then convert it into square inches
- MyArea = new Area("14, 387 sq. statute miles").ToSquareInches();
- ' Create a Area of 50 square feet
- MyArea = new Area(" 50 sq ' ");
- </code>
- </example>
-
- <returns>An <strong>Area</strong> object.</returns>
-
- <seealso cref="M:DotSpatial.Positioning.Area.Parse(System.String)">Parse(string) Method</seealso>
- <remarks>This powerful constructor is used to convert an area measurement in the form of a
- string into an object, such as one entered by a user or read from a file. This
- constructor can accept any output created via the <see cref="M:DotSpatial.Positioning.Area.ToString">ToString</see>
- method.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Area.#ctor(System.String,System.Globalization.CultureInfo)">
- <summary>
- Creates a new instance using the specified string and culture.
- </summary>
- <param name="value">The value.</param>
- <param name="culture">The culture.</param>
- <exception cref="T:System.ArgumentNullException" caption="ArgumentNullException">Parse method requires a valid Area measurement.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">1. The numeric portion of the Area measurement was not recognized.<br/>
- 2. The Area unit type was not recognized or not specified.</exception>
-
- <example>
- This example demonstrates how the to use this constructor.
- <code lang="VB">
- Dim MyArea As Area
- ' Create a Area of 50 square kilometers
- MyArea = New Area("50 sq. km", CultureInfo.CurrentCulture)
- ' Create a Area of 14, 387 miles, then convert it into square inches
- MyArea = New Area("14, 387 sq. statute miles", CultureInfo.CurrentCulture).ToSquareInches()
- ' Create a Area of 50 square feet
- MyArea = New Area(" 50 sq ' ", CultureInfo.CurrentCulture)
- </code>
- <code lang="CS">
- Area MyArea;
- ' Create a Area of 50 square kilometers
- MyArea = new Area("50 sq. km", CultureInfo.CurrentCulture);
- ' Create a Area of 14, 387 miles, then convert it into square inches
- MyArea = new Area("14, 387 sq. statute miles", CultureInfo.CurrentCulture).ToSquareInches();
- ' Create a Area of 50 square feet
- MyArea = new Area(" 50 sq ' ", CultureInfo.CurrentCulture);
- </code>
- </example>
-
- <returns>An <strong>Area</strong> object.</returns>
-
- <seealso cref="M:DotSpatial.Positioning.Area.Parse(System.String)">Parse(string) Method</seealso>
- <remarks>This powerful constructor is used to convert an area measurement in the form of a
- string into an object, such as one entered by a user or read from a file. This
- constructor can accept any output created via the <see cref="M:DotSpatial.Positioning.Area.ToString">ToString</see>
- method.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Area.#ctor(System.Xml.XmlReader)">
- <summary>
- Creates a new instance by deserializing the specified XML.
- </summary>
- <param name="reader">The reader.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Area.ToSquareFeet">
- <summary>
- Converts the current measurement into square feet.
- </summary>
- <returns>A new <strong>Area</strong> object containing the converted
- value.</returns>
- <seealso cref="M:DotSpatial.Positioning.Area.ToSquareInches">ToSquareInches Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Area.ToSquareKilometers">ToSquareKilometers Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Area.ToSquareMeters">ToSquareMeters Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Area.ToSquareNauticalMiles">ToSquareNauticalMiles Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Area.ToSquareStatuteMiles">ToSquareStatuteMiles Method</seealso>
-
- <example>
- This example converts various three <strong>Area</strong> objects, each with a
- different unit type, into square feet.
- <code lang="VB">
- ' Create Areas of different unit types
- Dim Area1 As New Area(10, AreaUnit.SquareInches)
- Dim Area2 As New Area(20, AreaUnit.SquareStatuteMiles)
- Dim Area3 As New Area(50, AreaUnit.SquareKilometers)
- ' Convert the Area measurements to square feet and output the result
- Debug.WriteLine(Area1.ToSquareFeet().ToString())
- Debug.WriteLine(Area2.ToSquareFeet().ToString())
- Debug.WriteLine(Area3.ToSquareFeet().ToString())
- </code>
- <code lang="CS">
- // Create Areas of different unit types
- Area Area1 = new Area(10, AreaUnit.SquareInches);
- Area Area2 = new Area(20, AreaUnit.SquareStatuteMiles);
- Area Area3 = new Area(50, AreaUnit.SquareKilometers);
- // Convert the Area measurements to square feet and output the result
- Console.WriteLine(Area1.ToSquareFeet().ToString());
- Console.WriteLine(Area2.ToSquareFeet().ToString());
- Console.WriteLine(Area3.ToSquareFeet().ToString());
- </code>
- </example>
- <remarks>This method will perform a conversion regardless of the current unit type. You
- may convert from any unit type to any other unit type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Area.ToSquareInches">
- <summary>
- Converts the current measurement into square inches.
- </summary>
- <returns>A new <strong>Area</strong> object containing the converted
- value.</returns>
- <example>
- This example converts various three <strong>Area</strong> objects, each with a
- different unit type, into square inches.
- <code lang="VB">
- ' Create Areas of different unit types
- Dim Area1 As New Area(10, AreaUnit.SquareFeet)
- Dim Area2 As New Area(20, AreaUnit.SquareStatuteMiles)
- Dim Area3 As New Area(50, AreaUnit.SquareKilometers)
- ' Convert the Area measurements to square inches and output the result
- Debug.WriteLine(Area1.ToSquareInches().ToString())
- Debug.WriteLine(Area2.ToSquareInches().ToString())
- Debug.WriteLine(Area3.ToSquareInches().ToString())
- </code>
- <code lang="CS">
- // Create Areas of different unit types
- Area Area1 = new Area(10, AreaUnit.SquareFeet);
- Area Area2 = new Area(20, AreaUnit.SquareStatuteMiles);
- Area Area3 = new Area(50, AreaUnit.SquareKilometers);
- // Convert the Area measurements to square inches and output the result
- Console.WriteLine(Area1.ToSquareInches().ToString());
- Console.WriteLine(Area2.ToSquareInches().ToString());
- Console.WriteLine(Area3.ToSquareInches().ToString());
- </code>
- </example>
-
- <seealso cref="M:DotSpatial.Positioning.Area.ToSquareFeet">ToSquareFeet Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Area.ToSquareKilometers">ToSquareKilometers Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Area.ToSquareMeters">ToSquareMeters Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Area.ToSquareNauticalMiles">ToSquareNauticalMiles Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Area.ToSquareStatuteMiles">ToSquareStatuteMiles Method</seealso>
- <remarks>This method will perform a conversion regardless of the current unit type. You
- may convert from any unit type to any other unit type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Area.ToSquareKilometers">
- <summary>
- Converts the current measurement into square kilometers.
- </summary>
- <returns>A new <strong>Area</strong> object containing the converted
- value.</returns>
- <example>
- This example converts various three <strong>Area</strong> objects, each with a
- different unit type, into square kilometers.
- <code lang="VB">
- ' Create Areas of different unit types
- Dim Area1 As New Area(10, AreaUnit.SquareFeet)
- Dim Area2 As New Area(20, AreaUnit.SquareStatuteMiles)
- Dim Area3 As New Area(50, AreaUnit.SquareInches)
- ' Convert the Area measurements to square kilometers and output the result
- Debug.WriteLine(Area1.ToSquareKilometers().ToString())
- Debug.WriteLine(Area2.ToSquareKilometers().ToString())
- Debug.WriteLine(Area3.ToSquareKilometers().ToString())
- </code>
- <code lang="CS">
- // Create Areas of different unit types
- Area Area1 = new Area(10, AreaUnit.SquareFeet);
- Area Area2 = new Area(20, AreaUnit.SquareStatuteMiles);
- Area Area3 = new Area(50, AreaUnit.SquareInches);
- // Convert the Area measurements to square kilometers and output the result
- Console.WriteLine(Area1.ToSquareKilometers().ToString());
- Console.WriteLine(Area2.ToSquareKilometers().ToString());
- Console.WriteLine(Area3.ToSquareKilometers().ToString());
- </code>
- </example>
-
- <seealso cref="M:DotSpatial.Positioning.Area.ToSquareFeet">ToSquareFeet Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Area.ToSquareInches">ToSquareInches Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Area.ToSquareMeters">ToSquareMeters Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Area.ToSquareNauticalMiles">ToSquareNauticalMiles Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Area.ToSquareStatuteMiles">ToSquareStatuteMiles Method</seealso>
- <remarks>This method will perform a conversion regardless of the current unit type. You
- may convert from any unit type to any other unit type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Area.ToSquareMeters">
- <summary>
- Converts the current measurement into square meters.
- </summary>
- <returns>A new <strong>Area</strong> object containing the converted
- value.</returns>
- <example>
- This example converts various three <strong>Area</strong> objects, each with a
- different unit type, into square meters.
- <code lang="VB">
- ' Create Areas of different unit types
- Dim Area1 As New Area(10, AreaUnit.SquareFeet)
- Dim Area2 As New Area(20, AreaUnit.SquareStatuteMiles)
- Dim Area3 As New Area(50, AreaUnit.SquareInches)
- ' Convert the Area measurements to square meters and output the result
- Debug.WriteLine(Area1.ToSquareMeters().ToString())
- Debug.WriteLine(Area2.ToSquareMeters().ToString())
- Debug.WriteLine(Area3.ToSquareMeters().ToString())
- </code>
- <code lang="CS">
- // Create Areas of different unit types
- Area Area1 = new Area(10, AreaUnit.SquareFeet);
- Area Area2 = new Area(20, AreaUnit.SquareStatuteMiles);
- Area Area3 = new Area(50, AreaUnit.SquareInches);
- // Convert the Area measurements to square meters and output the result
- Console.WriteLine(Area1.ToSquareMeters().ToString());
- Console.WriteLine(Area2.ToSquareMeters().ToString());
- Console.WriteLine(Area3.ToSquareMeters().ToString());
- </code>
- </example>
-
- <seealso cref="M:DotSpatial.Positioning.Area.ToSquareFeet">ToSquareFeet Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Area.ToSquareInches">ToSquareInches Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Area.ToSquareKilometers">ToSquareKilometers Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Area.ToSquareNauticalMiles">ToSquareNauticalMiles Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Area.ToSquareStatuteMiles">ToSquareStatuteMiles Method</seealso>
- <remarks>This method will perform a conversion regardless of the current unit type. You
- may convert from any unit type to any other unit type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Area.ToSquareNauticalMiles">
- <summary>
- Converts the current measurement into square nautical miles.
- </summary>
- <returns>A new <strong>Area</strong> object containing the converted
- value.</returns>
- <example>
- This example converts various three <strong>Area</strong> objects, each with a
- different unit type, into square nautical miles.
- <code lang="VB">
- ' Create Areas of different unit types
- Dim Area1 As New Area(10, AreaUnit.SquareFeet)
- Dim Area2 As New Area(20, AreaUnit.SquareStatuteMiles)
- Dim Area3 As New Area(50, AreaUnit.SquareInches)
- ' Convert the Area measurements to square nautical miles and output the result
- Debug.WriteLine(Area1.ToSquareNauticalMiles().ToString())
- Debug.WriteLine(Area2.ToSquareNauticalMiles().ToString())
- Debug.WriteLine(Area3.ToSquareNauticalMiles().ToString())
- </code>
- <code lang="CS">
- // Create Areas of different unit types
- Area Area1 = new Area(10, AreaUnit.SquareFeet);
- Area Area2 = new Area(20, AreaUnit.SquareStatuteMiles);
- Area Area3 = new Area(50, AreaUnit.SquareInches);
- // Convert the Area measurements to square nautical miles and output the result
- Console.WriteLine(Area1.ToSquareNauticalMiles().ToString());
- Console.WriteLine(Area2.ToSquareNauticalMiles().ToString());
- Console.WriteLine(Area3.ToSquareNauticalMiles().ToString());
- </code>
- </example>
-
- <seealso cref="M:DotSpatial.Positioning.Area.ToSquareFeet">ToSquareFeet Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Area.ToSquareInches">ToSquareInches Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Area.ToSquareKilometers">ToSquareKilometers Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Area.ToSquareMeters">ToSquareMeters Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Area.ToSquareStatuteMiles">ToSquareStatuteMiles Method</seealso>
- <remarks>This method will perform a conversion regardless of the current unit type. You
- may convert from any unit type to any other unit type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Area.ToSquareStatuteMiles">
- <summary>
- Converts the current measurement into square miles.
- </summary>
- <returns>A new <strong>Area</strong> object containing the converted
- value.</returns>
- <example>
- This example converts various three <strong>Area</strong> objects, each with a
- different unit type, into square miles.
- <code lang="VB">
- ' Create Areas of different unit types
- Dim Area1 As New Area(10, AreaUnit.SquareFeet)
- Dim Area2 As New Area(20, AreaUnit.SquareStatuteMiles)
- Dim Area3 As New Area(50, AreaUnit.SquareInches)
- ' Convert the Area measurements to square statute miles and output the result
- Debug.WriteLine(Area1.ToSquareStatuteMiles().ToString())
- Debug.WriteLine(Area2.ToSquareStatuteMiles().ToString())
- Debug.WriteLine(Area3.ToSquareStatuteMiles().ToString())
- </code>
- <code lang="CS">
- // Create Areas of different unit types
- Area Area1 = new Area(10, AreaUnit.SquareFeet);
- Area Area2 = new Area(20, AreaUnit.SquareStatuteMiles);
- Area Area3 = new Area(50, AreaUnit.SquareInches);
- // Convert the Area measurements to square statute miles and output the result
- Console.WriteLine(Area1.ToSquareStatuteMiles().ToString());
- Console.WriteLine(Area2.ToSquareStatuteMiles().ToString());
- Console.WriteLine(Area3.ToSquareStatuteMiles().ToString());
- </code>
- </example>
-
- <seealso cref="M:DotSpatial.Positioning.Area.ToSquareFeet">ToSquareFeet Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Area.ToSquareInches">ToSquareInches Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Area.ToSquareKilometers">ToSquareKilometers Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Area.ToSquareMeters">ToSquareMeters Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Area.ToSquareNauticalMiles">ToSquareNauticalMiles Method</seealso>
- <remarks>This method will perform a conversion regardless of the current unit type. A
- "statute mile" is frequently referred to as "mile" by itself.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Area.ToAcres">
- <summary>
- Converts the current measurement into acres.
- </summary>
- <returns>A new <strong>Area</strong> object containing the converted value.</returns>
- <example>
- This example converts various three <strong>Area</strong> objects, each with a
- different unit type, into acres.
- <code lang="VB" title="[New Example]">
- ' Create Areas of different unit types
- Dim Area1 As New Area(10, AreaUnit.SquareFeet)
- Dim Area2 As New Area(20, AreaUnit.SquareStatuteMiles)
- Dim Area3 As New Area(50, AreaUnit.SquareInches)
- ' Convert the Area measurements to acres and output the result
- Debug.WriteLine(Area1.ToAcres().ToString())
- Debug.WriteLine(Area2.ToAcres().ToString())
- Debug.WriteLine(Area3.ToAcres().ToString())
- </code>
- <code lang="CS" title="[New Example]">
- // Create Areas of different unit types
- Area Area1 = new Area(10, AreaUnit.SquareFeet);
- Area Area2 = new Area(20, AreaUnit.SquareStatuteMiles);
- Area Area3 = new Area(50, AreaUnit.SquareInches);
- // Convert the Area measurements to acres and output the result
- Console.WriteLine(Area1.ToAcres().ToString());
- Console.WriteLine(Area2.ToAcres().ToString());
- Console.WriteLine(Area3.ToAcres().ToString());
- </code>
- </example>
- <remarks>This method will perform a conversion regardless of the current unit type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Area.ToSquareCentimeters">
- <summary>
- Converts the current measurement into square centimeters.
- </summary>
- <returns>A new <strong>Area</strong> object containing the converted value.</returns>
- <example>
- This example converts various three <strong>Area</strong> objects, each with a
- different unit type, into square centimeters.
- <code lang="VB" title="[New Example]">
- ' Create Areas of different unit types
- Dim Area1 As New Area(10, AreaUnit.SquareFeet)
- Dim Area2 As New Area(20, AreaUnit.SquareStatuteMiles)
- Dim Area3 As New Area(50, AreaUnit.SquareInches)
- ' Convert the Area measurements to square centimeters and output the result
- Debug.WriteLine(Area1.ToSquareCentimeters().ToString())
- Debug.WriteLine(Area2.ToSquareCentimeters().ToString())
- Debug.WriteLine(Area3.ToSquareCentimeters().ToString())
- </code>
- <code lang="CS" title="[New Example]">
- // Create Areas of different unit types
- Area Area1 = new Area(10, AreaUnit.SquareFeet);
- Area Area2 = new Area(20, AreaUnit.SquareStatuteMiles);
- Area Area3 = new Area(50, AreaUnit.SquareInches);
- // Convert the Area measurements to square centimeters and output the result
- Console.WriteLine(Area1.ToSquareCentimeters().ToString());
- Console.WriteLine(Area2.ToSquareCentimeters().ToString());
- Console.WriteLine(Area3.ToSquareCentimeters().ToString());
- </code>
- </example>
- <remarks>This method will perform a conversion regardless of the current unit type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Area.ToImperialUnitType">
- <summary>
- Converts the current instance to an Imperial unit type which minimizes numeric
- value.
- </summary>
- <returns>An <strong>Area</strong> converted to Imperial units. (i.e. feet, inches,
- miles)</returns>
- <example>
- This example converts a measurement of 10560 feet into 1 square statute mile using
- the <strong>ToMetricUnitType</strong> method.
- <code lang="VB" title="[New Example]">
- Dim Area1 As New Area(27878400, AreaUnit.SquareFeet)
- Dim Area2 As Area = Area1.ToImperialUnitType()
- Debug.WriteLine(Area2.ToString())
- ' Output: 1 square statute mile
- </code>
- <code lang="CS" title="[New Example]">
- Area Area1 = new Area(27878400, AreaUnit.SquareFeet);
- Area Area2 = Area1.ToImperialUnitType();
- Console.WriteLine(Area2.ToString());
- // Output: 1 square statute mile
- </code>
- </example>
- <remarks>This method is used to make an area measurement easier to read by choosing
- another unit type. For example, "27, 878, 400 square feet" would be easier to
- understand as "1 square statute mile." This method converts the current instance to
- Metric unit which brings the <strong>Value</strong> closest to 1, then returns the
- new value. This method will perform a conversion regardless of the current unit
- type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Area.ToMetricUnitType">
- <summary>
- Converts the current instance to a Metric unit type which minimizes numeric
- value.
- </summary>
- <returns>An <strong>Area</strong> converted to Metric units. (i.e. centimeter, meter,
- kilometer)</returns>
- <example>
- This example converts a measurement of 0.0001 kilometers into 1 meter using the
- <strong>ToMetricUnitType</strong> method.
- <code lang="VB" title="[New Example]">
- Dim Area1 As New Area(0.0001, AreaUnit.SquareKilometers)
- Dim Area2 As Area = Area1.ToMetricUnitType()
- Debug.WriteLine(Area2.ToString())
- ' Output: 1 square meter
- </code>
- <code lang="CS" title="[New Example]">
- Area Area1 = new Area(0.0001, AreaUnit.SquareKilometers);
- Area Area2 = Area1.ToMetricUnitType();
- Console.WriteLine(Area2.ToString());
- // Output: 1 square meter
- </code>
- </example>
- <remarks>This method is used to make an area measurement easier to read by choosing
- another unit type. For example, "0.0002 kilometers" would be easier to read as "2
- meters." This method converts the current instance to Metric unit which brings the
- <strong>Value</strong> closest to 1, then returns the new value. This method will
- perform a conversion regardless of the current unit type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Area.ToLocalUnitType">
- <summary>
- Converts the current instance to a Metric or Imperial unit type depending on the
- local culture.
- </summary>
- <returns>An <strong>Area</strong> converted to Metric or Imperial units, depending on the
- local culture.</returns>
- <example>
- See
- <see cref="M:DotSpatial.Positioning.Area.ToImperialUnitType"><strong>ToImperialUnitType</strong></see> and
- <see cref="M:DotSpatial.Positioning.Area.ToMetricUnitType"><strong>ToMetricUnitType</strong></see> methods
- for examples.
- </example>
- <remarks>This method is used to make an area measurement easier to read by choosing
- another unit type. For example, "0.0002 kilometers" would be easier to read as "2
- meters." This method converts the current instance to either a Metric or an Imperial
- unit (depending on the local culture) which brings the <strong>Value</strong> closest
- to 1. This method will perform a conversion regardless of the current unit type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Area.ToUnitType(DotSpatial.Positioning.AreaUnit)">
- <summary>
- Converts the current instance into the specified unit type.
- </summary>
- <param name="value">An <strong>AreaUnit</strong> value specifying the unit type to convert to.</param>
- <returns>A new <strong>Area</strong> object containing the converted value.</returns>
- <example>
- This example uses the <strong>ToUnitType</strong> method to convert an area
- measurement of 27, 878, 400 square feet into 1 square statute mile.
- <code lang="VB" title="[New Example]">
- Dim Area1 As New Area(27878400, AreaUnit.SquareFeet)
- Dim Area2 As Area = Area1.ToUnitType(AreaUnit.SquareStatuteMiles)
- Debug.WriteLine(Area2.ToString())
- ' Output: 1 square statute mile
- </code>
- <code lang="CS" title="[New Example]">
- Area Area1 As New Area(27878400, AreaUnit.SquareFeet);
- Area Area2 As Area = Area1.ToUnitType(AreaUnit.SquareStatuteMiles);
- Console.WriteLine(Area2.ToString());
- // Output: 1 square statute mile
- </code>
- </example>
- <remarks>This method will perform a conversion regardless of the current unit type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Area.ToString(System.String)">
- <summary>
- Outputs the current instance as a string using the specified format.
- </summary>
- <param name="format">The format.</param>
- <returns>A <strong>String</strong> containing the Area in the specified format.</returns>
- <example>
- This example uses the ToString method to populate a TextBox with a Area measurement
- using a custom format.
- <code lang="VB">
- ' Declare a area of 75 square statute miles
- Dim MyArea As New Area(75, AreaUnit.SquareStatuteMiles)
- ' Output the result using the default format
- Debug.WriteLine(MyArea.ToString("v.v uuu"))
- ' Output: 75.0 square statute miles
- </code>
- <code lang="CS">
- // Declare a area of 75 square statute miles
- Area MyArea As New Area(75, AreaUnit.SquareStatuteMiles);
- // Output the result using the default format
- Console.WriteLine(MyArea.ToString("v.v uuu"));
- // Output: 75.0 square statute miles
- </code>
- </example>
- <remarks>This method allows a custom format to be applied to the ToString method. Numeric formats
- will be adjusted to the machine's local UI culture.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Area.Add(DotSpatial.Positioning.Area)">
- <summary>
- Adds the specified area to the current instance.
- </summary>
- <param name="value">The value.</param>
- <returns>A new <strong>Area</strong> structure containing the summed values.</returns>
- <example>
- This example demonstrates how two areas of different unit types can be safely added
- together. A value of 144 square inches (which is the same as one square foot) is
- added to one square foot, producing two square feet.
- <code lang="VB" title="[New Example]">
- Dim Area1 As New Area(1, AreaUnit.SquareFeet)
- Dim Area2 As New Area(144, AreaUnit.SquareInches)
- Dim Area3 As Area = Area1.Add(Area2)
- Debug.WriteLine(Area3.ToString())
- ' Output: 2 square feet
- </code>
- <code lang="CS" title="[New Example]">
- Area Area1 = new Area(1, AreaUnit.SquareFeet);
- Area Area2 = new Area(144, AreaUnit.SquareInches);
- Area Area3 = Area1.Add(Area2);
- Console.WriteLine(Area3.ToString());
- // Output: 2 square feet
- </code>
- </example>
- <remarks>This method can add any <strong>Area</strong> object to the current instance. If
- the unit type of the <strong>Value</strong> parameter does not match that of the
- current instance, the value is converted to the unit type of the current instance
- before adding.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Area.Subtract(DotSpatial.Positioning.Area)">
- <summary>
- Subtracts the specified area from the current instance.
- </summary>
- <param name="value">The value.</param>
- <returns>A new <strong>Area</strong> structure containing the new value.</returns>
- <example>
- This example demonstrates how two areas of different unit types can be safely
- subtracted. A value of 144 square inches (which is the same as one square foot) is
- subtracted from one square foot, producing a result of zero.
- <code lang="VB" title="[New Example]">
- Dim Area1 As New Area(1, AreaUnit.SquareFeet)
- Dim Area2 As New Area(144, AreaUnit.SquareInches)
- Dim Area3 As Area = Area1.Subtract(Area2)
- Debug.WriteLine(Area3.ToString())
- ' Output: 0 square feet
- </code>
- <code lang="CS" title="[New Example]">
- Area Area1 = new Area(1, AreaUnit.SquareFeet);
- Area Area2 = new Area(144, AreaUnit.SquareInches);
- Area Area3 = Area1.Subtract(Area2);
- Console.WriteLine(Area3.ToString());
- // Output: 0 square feet
- </code>
- </example>
- <remarks>This method will subtract any <strong>Area</strong> object from the current
- instance. If the unit type of the <strong>Value</strong> parameter does not match that
- of the current instance, the value is converted to the unit type of the current
- instance before subtracting.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Area.Multiply(DotSpatial.Positioning.Area)">
- <summary>
- Multiplies the specified area with the current instance.
- </summary>
- <param name="value">The value.</param>
- <returns>A new <strong>Area</strong> structure containing the product of the two
- values.</returns>
- <example>
- This example demonstrates how two areas can be multiplied together. A value of 50
- square inches is multiplied by two square inches, producing a result of 100 square
- inches.
- <code lang="VB" title="[New Example]">
- Dim Area1 As New Area(50, AreaUnit.SquareInches)
- Dim Area2 As New Area(2, AreaUnit.SquareInches)
- Dim Area3 As Area = Area1.Multiply(Area2)
- Debug.WriteLine(Area3.ToString())
- ' Output: 100 square inches
- </code>
- <code lang="CS" title="[New Example]">
- Area Area1 = new Area(50, AreaUnit.SquareInches);
- Area Area2 = new Area(2, AreaUnit.SquareInches);
- Area Area3 = Area1.Multiply(Area2);
- Console.WriteLine(Area3.ToString());
- // Output: 100 square inches
- </code>
- </example>
- <remarks>This method will multiply any <strong>Area</strong> object from the current
- instance. If the unit type of the <strong>Value</strong> parameter does not match that
- of the current instance, the value is converted to the unit type of the current
- instance before multiplication.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Area.Divide(DotSpatial.Positioning.Area)">
- <summary>
- Divides the current instance by the specified area.
- </summary>
- <param name="value">The value.</param>
- <returns>A new <strong>Area</strong> structure containing the new value.</returns>
- <example>
- This example demonstrates how two areas can be divided. A value of 100 square
- inches is divided by two square inches, producing a result of 50 square inches.
- <code lang="VB" title="[New Example]">
- Dim Area1 As New Area(100, AreaUnit.SquareInches)
- Dim Area2 As New Area(2, AreaUnit.SquareInches)
- Dim Area3 As Area = Area1.Divide(Area2)
- Debug.WriteLine(Area3.ToString())
- ' Output: 50 square inches
- </code>
- <code lang="CS" title="[New Example]">
- Area Area1 = new Area(100, AreaUnit.SquareInches);
- Area Area2 = new Area(2, AreaUnit.SquareInches);
- Area Area3 = Area1.Divide(Area2);
- Debug.WriteLine(Area3.ToString());
- // Output: 50 square inches
- </code>
- </example>
- <remarks>This method will devide the current instance by any <strong>Area</strong> object.
- If the unit type of the <strong>Value</strong> parameter does not match that of the
- current instance, the value is converted to the unit type of the current instance
- before devision.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Area.Increment">
- <summary>
- Returns the current instance increased by one.
- </summary>
- <returns>A new <strong>Area</strong> structure containing the new value.</returns>
- <example>
- This example uses the <strong>Increment</strong> method to increase an area's
- value. It also demonstrates the subtle error which can be caused if
- <strong>Increment</strong> is called while ignoring the return value.
- <code lang="VB" title="[New Example]">
- ' Correct use of Increment
- Dim Area1 As New Area(1, AreaUnit.SquareMeters)
- Area1 = Area1.Increment()
- ' Incorrect use of Increment
- Dim Area1 As New Area(1, AreaUnit.SquareMeters)
- Area1.Increment()
- ' NOTE: Area1 will still be 1 square meter, not 2!
- </code>
- <code lang="CS" title="[New Example]">
- // Correct use of Increment
- Area Area1 = new Area(1, AreaUnit.SquareMeters);
- Area1 = Area1.Increment();
- // Incorrect use of Increment
- Area Area1 = new Area(1, AreaUnit.SquareMeters);
- Area1.Increment();
- // NOTE: Area1 will still be 1 square meter, not 2!
- </code>
- </example>
- <remarks><para>This method increases the <strong>Value</strong> property by 1.0, returned as
- a new instance. The <strong>Units</strong> property is preserved.</para>
- <para><font color="red"><font color="red">NOTE: Since the <strong>Area</strong>
- class is immutable, this method will not modify the current
- instance.</font></font></para></remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Area.Decrement">
- <summary>
- Returns the current instance decreased by one.
- </summary>
- <returns>A new <strong>Area</strong> structure containing the new value.</returns>
- <example>
- This example uses the <strong>Decrement</strong> method to decrease an area's
- value. It also demonstrates the subtle error which can be caused if
- <strong>Decrement</strong> is called while ignoring the return value.
- <code lang="VB" title="[New Example]">
- ' Correct use of Increment
- Dim Area1 As New Area(1, AreaUnit.SquareMeters)
- Area1 = Area1.Increment()
- ' Incorrect use of Increment
- Dim Area1 As New Area(1, AreaUnit.SquareMeters)
- Area1.Increment()
- ' NOTE: Area1 will still be 1 square meter, not 0!
- </code>
- <code lang="CS" title="[New Example]">
- // Correct use of Increment
- Area Area1 = new Area(1, AreaUnit.SquareMeters);
- Area1 = Area1.Decrement();
- // Incorrect use of Increment
- Area Area1 = new Area(1, AreaUnit.SquareMeters);
- Area1.Decrement();
- // NOTE: Area1 will still be 1 square meter, not 0!
- </code>
- </example>
- <remarks><para>This method decreases the <strong>Value</strong> property by 1.0, returned as
- a new instance. The <strong>Units</strong> property is preserved.</para>
- <para><font color="red">NOTE: Since the <strong>Area</strong> class is immutable,
- this method will not modify the current instance.</font></para></remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Area.IsLessThan(DotSpatial.Positioning.Area)">
- <summary>
- Indicates if the current instance is smaller than the specified value.
- </summary>
- <param name="value">An <strong>Area</strong> to compare with the current instance.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the current instance is
- smaller than the <strong>Value</strong> parameter.</returns>
- <remarks>If the <strong>Value</strong> parameter's unit type does not match the current
- instance, it will be converted to the current instance's unit type before performing
- the comparison.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Area.IsLessThanOrEqualTo(DotSpatial.Positioning.Area)">
- <summary>
- Indicates if the current instance is smaller than or equal to the specified
- value.
- </summary>
- <param name="value">An <strong>Area</strong> to compare with the current instance.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the current instance is
- smaller than or equal to the <strong>Value</strong> parameter.</returns>
- <remarks>If the <strong>Value</strong> parameter's unit type does not match the current
- instance, it will be converted to the current instance's unit type before performing
- the comparison.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Area.IsGreaterThan(DotSpatial.Positioning.Area)">
- <summary>
- Indicates if the current instance is larger than the specified value.
- </summary>
- <param name="value">An <strong>Area</strong> to compare with the current instance.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the current instance is
- larger than the <strong>Value</strong> parameter.</returns>
- <remarks>If the <strong>Value</strong> parameter's unit type does not match the current
- instance, it will be converted to the current instance's unit type before performing
- the comparison.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Area.IsGreaterThanOrEqualTo(DotSpatial.Positioning.Area)">
- <summary>
- Indicates if the current instance is larger than or equal to the specified
- value.
- </summary>
- <param name="value">An <strong>Area</strong> to compare with the current instance.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the current instance is
- larger than or equal to the <strong>Value</strong> parameter.</returns>
- <remarks>If the <strong>Value</strong> parameter's unit type does not match the current
- instance, it will be converted to the current instance's unit type before performing
- the comparison.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Area.Parse(System.String)">
- <summary>
- Creates a new instance using the specified string.
- </summary>
- <param name="value">The value.</param>
- <returns>A new Area object containing the parsed <see cref="P:DotSpatial.Positioning.Area.Value">value</see> and
- <see cref="P:DotSpatial.Positioning.Area.Units">unit</see> type.</returns>
- <exception cref="T:System.ArgumentNullException" caption="ArgumentNullException">Parse method requires a valid Area measurement.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">1. The numeric portion of the Area measurement was not recognized.<br/>
- 2. The Area unit type was not recognized or not specified.</exception>
-
- <example>
- This example demonstrates how the Parse method can convert several string formats
- into a Area object.
- <code lang="VB">
- Dim NewArea As Area
- ' Create a Area of 50 kilometers
- NewArea = Area.Parse("50 km")
- ' Create a Area of 14, 387 miles, then convert it into square inches
- NewArea = Area.Parse("14, 387 statute miles").ToSquareInches()
- ' Parse an untrimmed measurement into 50 feet
- NewArea = Area.Parse(" 50 ' ")
- </code>
- <code lang="CS">
- Area NewArea;
- // Create a Area of 50 kilometers
- NewArea = Area.Parse("50 km");
- // Create a Area of 14, 387 miles, then convert it into square inches
- NewArea = Area.Parse("14, 387 statute miles").ToInches();
- // Parse an untrimmed measurement into 50 feet
- NewArea = Area.Parse(" 50 ' ");
- </code>
- </example>
- <remarks>This powerful method is typically used to convert a string-based Area
- measurement, such as one entered by a user or read from a file, into a
- <strong>Area</strong> object. This method will accept any output created via the
- <see cref="M:DotSpatial.Positioning.Area.ToString">ToString</see> method.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Area.Parse(System.String,System.Globalization.CultureInfo)">
- <summary>
- Creates a new instance using the specified string and culture.
- </summary>
- <param name="value">A <strong>String</strong> describing an area measurement.</param>
- <param name="culture">A <strong>CultureInfo</strong> object specifying which numeric and text formats to use during parsing.</param>
- <returns></returns>
- <example>
- <code lang="VB" title="[New Example]">
- Dim NewArea As Area
- ' Create a Area of 50 kilometers
- NewArea = Area.Parse("50 km", CultureInfo.CurrentCulture)
- ' Create a Area of 14, 387 miles, then convert it into inches
- NewArea = Area.Parse("14, 387 statute miles", CultureInfo.CurrentCulture).ToSquareInches()
- ' Parse an untrimmed measurement into 50 feet
- NewArea = Area.Parse(" 50 ' ", CultureInfo.CurrentCulture)
- </code>
- <code lang="CS" title="[New Example]">
- Area NewArea;
- // Create a Area of 50 kilometers
- NewArea = Area.Parse("50 km", CultureInfo.CurrentCulture);
- // Create a Area of 14, 387 miles, then convert it into square inches
- NewArea = Area.Parse("14, 387 statute miles", CultureInfo.CurrentCulture).ToInches();
- // Parse an untrimmed measurement into 50 feet
- NewArea = Area.Parse(" 50 ' ", CultureInfo.CurrentCulture);
- </code>
- </example>
- <remarks>This powerful method is typically used to convert a string-based Area
- measurement, such as one entered by a user or read from a file, into a
- <strong>Area</strong> object. This method will accept any output created via the
- <see cref="M:DotSpatial.Positioning.Area.ToString">ToString</see> method.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Area.Random">
- <summary>
- Returns a random distance between 0 and 1, 000 square meters.
- </summary>
- <returns>A <strong>Distance</strong> containing a random value, converted to local units.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Area.Random(System.Random)">
- <summary>
- Returns a random distance between 0 and 1, 000 square meters.
- </summary>
- <param name="generator">A <strong>Random</strong> object used to ogenerate random values.</param>
- <returns>A <strong>Distance</strong> containing a random value, converted to local units.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Area.Equals(System.Object)">
- <summary>
- Compares the current instance with the specified object.
- </summary>
- <param name="obj">An <strong>Area</strong> object to compare with.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the two objects have the
- same value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Area.GetHashCode">
- <summary>
- Returns a unique code for the current instance.
- </summary>
- <returns>An <strong>Integer</strong> representing a unique code for the current
- instance.</returns>
- <remarks>Since the <strong>Area</strong> class is immutable, this property may be used
- safely with hash tables.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Area.ToString">
- <summary>
- Outputs the current instance as a string using the default format.
- </summary>
- <returns>A <strong>String</strong> containing the current Area in the default format.</returns>
- <example>
- This example uses the ToString method to populate a TextBox with a Area
- measurement.
- <code lang="VB">
- ' Declare a area of 75 square statute miles
- Dim MyArea As New Area(75, AreaUnit.SquareStatuteMiles)
- ' Output the result using the default format
- Debug.WriteLine(MyArea.ToString())
- ' Output: 75 sq. statute miles
- </code>
- <code lang="CS">
- // Declare a area of 75 square statute miles
- Area MyArea = nre Area(75, AreaUnit.SquareStatuteMiles);
- // Output the result using the default format
- Console.WriteLine(MyArea.ToString());
- // Output: 75 sq. statute miles
- </code>
- </example>
- <remarks>The default format used is "<strong>v uu</strong>" where <strong>v</strong>
- represents the numerical portion of the area and <strong>uu</strong> is the unit
- type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Area.op_Addition(DotSpatial.Positioning.Area,DotSpatial.Positioning.Area)">
- <summary>
- Implements the operator +.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Area.op_Subtraction(DotSpatial.Positioning.Area,DotSpatial.Positioning.Area)">
- <summary>
- Implements the operator -.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Area.op_Multiply(DotSpatial.Positioning.Area,DotSpatial.Positioning.Area)">
- <summary>
- Implements the operator *.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Area.op_Division(DotSpatial.Positioning.Area,DotSpatial.Positioning.Area)">
- <summary>
- Implements the operator /.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Area.op_LessThan(DotSpatial.Positioning.Area,DotSpatial.Positioning.Area)">
- <summary>
- Implements the operator <.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Area.op_LessThanOrEqual(DotSpatial.Positioning.Area,DotSpatial.Positioning.Area)">
- <summary>
- Implements the operator <=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Area.op_Equality(DotSpatial.Positioning.Area,DotSpatial.Positioning.Area)">
- <summary>
- Implements the operator ==.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Area.op_Inequality(DotSpatial.Positioning.Area,DotSpatial.Positioning.Area)">
- <summary>
- Implements the operator !=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Area.op_GreaterThanOrEqual(DotSpatial.Positioning.Area,DotSpatial.Positioning.Area)">
- <summary>
- Implements the operator >=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Area.op_GreaterThan(DotSpatial.Positioning.Area,DotSpatial.Positioning.Area)">
- <summary>
- Implements the operator >.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Area.op_Explicit(System.String)~DotSpatial.Positioning.Area">
- <summary>
- Performs an explicit conversion from <see cref="T:System.String"/> to <see cref="T:DotSpatial.Positioning.Area"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Area.op_Explicit(DotSpatial.Positioning.Area)~System.String">
- <summary>
- Performs an explicit conversion from <see cref="T:DotSpatial.Positioning.Area"/> to <see cref="T:System.String"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Area.CompareTo(DotSpatial.Positioning.Area)">
- <summary>
- Compares the current instance to the specified area.
- </summary>
- <param name="other">An <strong>Area</strong> object to compare with.</param>
- <returns>An <strong>Integer</strong>: 0 if the object's values are equivalent, -1 if the
- current instance is smaller, or 1 if the current instance is larger.</returns>
- <remarks>If the <strong>Value</strong> parameter's unit type does not match the current
- instance, it will be converted to the current instance's unit type before performing
- the comparison.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Area.Equals(DotSpatial.Positioning.Area)">
- <summary>
- Compares the current instance to the specified <strong>Area</strong>
- object.
- </summary>
- <param name="value">A <strong>Area</strong> object to compare with.</param>
- <returns>A <strong>Boolean</strong>, True if the values are equivalent.</returns>
- <remarks><para>This method will compare the <em>value</em> of the current instance against
- the <strong>Value</strong> parameter. If the <strong>Value</strong> parameter's
- unit type does not match the current instance, it will be converted to the current
- instance's unit type before performing the comparison.</para>
- <para><em>NOTE: This method compares objects by value, not by
- reference.</em></para></remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Area.Equals(DotSpatial.Positioning.Area,System.Int32)">
- <summary>
- Compares the current instance to the specified <strong>Area</strong>
- object.
- </summary>
- <param name="value">A <strong>Area</strong> object to compare with.</param>
- <param name="decimals">An <strong>integer</strong> specifies the precision for the comparison.</param>
- <returns>A <strong>Boolean</strong>, True if the values are equivalent.</returns>
- <remarks><para>This method will compare the <em>value</em> of the current instance against
- the <strong>Value</strong> parameter. If the <strong>Value</strong> parameter's
- unit type does not match the current instance, it will be converted to the current
- instance's unit type before performing the comparison.</para>
- <para><em>NOTE: This method compares objects by value, not by
- reference.</em></para></remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Area.ToString(System.String,System.IFormatProvider)">
- <summary>
- Outputs the current instance as a string using the specified format and local culture.
- </summary>
- <param name="format">The format to use.-or- A null reference (Nothing in Visual Basic) to use the default format defined for the type of the <see cref="T:System.IFormattable"/> implementation.</param>
- <param name="formatProvider">The provider to use to format the value.-or- A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.</param>
- <returns>A <strong>String</strong> containing the Area in the specified format.</returns>
- <example>
- This example uses the ToString method to populate a TextBox with a Area measurement
- using a custom format and culture information.
- <code lang="VB">
- ' Declare a area of 75 square statute miles
- Dim MyArea As New Area(75, AreaUnit.SquareStatuteMiles)
- ' Output the result using the default format
- Debug.WriteLine(MyArea.ToString("v.v uuu", CultureInfo.CurrentCulture))
- ' Output: 75.0 square statute miles
- </code>
- <code lang="CS">
- // Declare a area of 75 square statute miles
- Area MyArea As New Area(75, AreaUnit.SquareStatuteMiles);
- // Output the result using the default format
- Console.WriteLine(MyArea.ToString("v.v uuu", CultureInfo.CurrentCulture));
- // Output: 75.0 square statute miles
- </code>
- </example>
- <remarks>This method allows a custom format to be applied to the ToString method. Numeric formats
- will be adjusted to the machine's local UI culture.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Area.System#Xml#Serialization#IXmlSerializable#GetSchema">
- <summary>
- This method is reserved and should not be used. When implementing the IXmlSerializable interface, you should return null (Nothing in Visual Basic) from this method, and instead, if specifying a custom schema is required, apply the <see cref="T:System.Xml.Serialization.XmlSchemaProviderAttribute"/> to the class.
- </summary>
- <returns>An <see cref="T:System.Xml.Schema.XmlSchema"/> that describes the XML representation of the object that is produced by the <see cref="M:System.Xml.Serialization.IXmlSerializable.WriteXml(System.Xml.XmlWriter)"/> method and consumed by the <see cref="M:System.Xml.Serialization.IXmlSerializable.ReadXml(System.Xml.XmlReader)"/> method.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Area.WriteXml(System.Xml.XmlWriter)">
- <summary>
- Converts an object into its XML representation.
- </summary>
- <param name="writer">The <see cref="T:System.Xml.XmlWriter"/> stream to which the object is serialized.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Area.ReadXml(System.Xml.XmlReader)">
- <summary>
- Generates an object from its XML representation.
- </summary>
- <param name="reader">The <see cref="T:System.Xml.XmlReader"/> stream from which the object is deserialized.</param>
- </member>
- <member name="P:DotSpatial.Positioning.Area.Units">
- <summary>
- Returns the units portion of an area measurement.
- </summary>
- <value>An <strong>AreaUnit</strong> value. Default is <strong>Meters</strong>.</value>
- <seealso cref="P:DotSpatial.Positioning.Area.Value">Value Property</seealso>
- <remarks>Each area measurement consists of a numeric value paired with a unit type
- describing the value. It is not possible to create an area measurement without also
- specifying a value.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Area.Value">
- <summary>
- Returns the numeric portion of an area measurement.
- </summary>
- <value>A <strong>Double</strong> value.</value>
- <seealso cref="P:DotSpatial.Positioning.Area.Units">Units Property</seealso>
- <remarks>This property is paired with the <strong>Units</strong> property to form a
- complete area measurement.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Area.IsEmpty">
- <summary>
- Indicates if the value of the current instance is zero.
- </summary>
- <value>A <strong>Boolean</strong>, <strong>True</strong> if the <strong>Value</strong>
- property is zero.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Area.IsMetric">
- <summary>
- Indicates if the current instance is using a Metric unit.
- </summary>
- <value>A <strong>Boolean</strong>, <strong>True</strong> if the <strong>Units</strong>
- property is <strong>SquareCentimeters</strong>, <strong>SquareMeters</strong> or
- <strong>SquareKilometers</strong>.</value>
- <remarks>This property is typically used to see if an area measurement is in a unit type
- used by a specific culture. Area measurements can be adjusted to either Metric or
- Imperial units using the <strong>ToMetricUnitType</strong> and
- <strong>ToImperialUnitType</strong> methods.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Area.IsInfinity">
- <summary>
- Indicates if the current instance represents an infinite value.
- </summary>
- <value>A <strong>Boolean</strong>, <strong>True</strong> if the current instance
- represents an infinite value.</value>
- </member>
- <member name="T:DotSpatial.Positioning.AreaUnit">
- <summary>
- Indicates the unit of measure for area measurements.
- </summary>
- <seealso cref="P:DotSpatial.Positioning.Area.Value">Value Property (Area Class)</seealso>
-
- <seealso cref="P:DotSpatial.Positioning.Area.Units">Units Property (Area Class)</seealso>
-
- <example>
- This example uses the <strong>AreaUnit</strong> enumeration to create a new
- <strong>Area</strong> object.
- <code lang="VB" title="[New Example]">
- Dim Area1 As New Area(1, AreaUnit.SquareKilometers)
- </code>
- <code lang="CS" title="[New Example]">
- Area Area1 = new Area(1, AreaUnit.SquareKilometers);
- </code>
- </example>
- <remarks>This enumeration is most frequently used by the Units property of the Area
- structure to describe an area measurement.</remarks>
- </member>
- <member name="F:DotSpatial.Positioning.AreaUnit.SquareKilometers">
- <summary>Metric System. Kilometers (thousands of meters).</summary>
- </member>
- <member name="F:DotSpatial.Positioning.AreaUnit.SquareMeters">
- <summary>Metric System. 1/1000th of a square kilometer.</summary>
- </member>
- <member name="F:DotSpatial.Positioning.AreaUnit.SquareCentimeters">
- <summary>Metric System. 1/100th of a square meter.</summary>
- </member>
- <member name="F:DotSpatial.Positioning.AreaUnit.SquareStatuteMiles">
- <summary>Imperial System. A statute mile, most often referred to just as "mile."</summary>
- </member>
- <member name="F:DotSpatial.Positioning.AreaUnit.SquareNauticalMiles">
- <summary>Nautical miles, also known as "sea miles".</summary>
- </member>
- <member name="F:DotSpatial.Positioning.AreaUnit.SquareFeet">
- <summary>Imperial System. Feet.</summary>
- </member>
- <member name="F:DotSpatial.Positioning.AreaUnit.SquareInches">
- <summary>Imperial System. Inches.</summary>
- </member>
- <member name="F:DotSpatial.Positioning.AreaUnit.Acres">
- <summary>Imperial System. Inches.</summary>
- </member>
- <member name="T:DotSpatial.Positioning.Azimuth">
- <summary>
- Represents an angular measurement around the horizon between 0° and
- 360°.
- </summary>
- <example>
- These examples create new instances of an Azimuth object using different
- techniques.
- <code lang="VB" description="Create a new instance of 45° (northeast).">
- Dim MyAzimuth As New Azimuth(45)
- </code>
- <code lang="CS" description="Create a new instance of 45° (northeast).">
- Azimuth MyAzimuth = new Azimuth(45);
- </code>
- <code lang="VB" description="Create a new instance of 45°30'15.">
- Dim MyAzimuth As New Azimuth(45, 30, 15)
- </code>
- <code lang="CS" description="Create a new instance of 45°30'15.">
- Azimuth MyAzimuth = new Azimuth(45, 30, 15);
- </code>
- <code lang="VB" description="Create a new instance equal to a known compass direction.">
- Dim MyAzimuth As Azimuth = Azimuth.NorthNorthwest
- </code>
- <code lang="CS" description="Create a new instance equal to a known compass direction.">
- Azimuth MyAzimuth = Azimuth.NorthNorthwest;
- </code>
- </example>
- <remarks>This class is used to indicate a horizontal direction of travel, such as the
- bearing from one point on Earth to another. This class can also be combined with an
- Elevation object to form a three-dimensional direction towards an object in space,
- such as a GPS satellite.</remarks>
- </member>
- <member name="F:DotSpatial.Positioning.Azimuth.MAXIMUM_PRECISION_DIGITS">
- <summary>
- Controls the number of digits of precision supported by the class.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Azimuth._decimalDegrees">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.#ctor(System.Double)">
- <summary>
- Creates a new instance with the specified decimal degrees.
- </summary>
- <param name="decimalDegrees">The decimal degrees.</param>
- <example>
- This example demonstrates how to create an angle with a measurement of 90°.
- <code lang="VB">
- Dim MyAzimuth As New Azimuth(90)
- </code>
- <code lang="CS">
- Azimuth MyAzimuth = new Azimuth(90);
- </code>
- </example>
-
- <returns>An <strong>Azimuth</strong> containing the specified value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.#ctor(System.Int32)">
- <summary>
- Creates a new instance with the specified degrees.
- </summary>
- <param name="hours">The hours.</param>
- <returns>An <strong>Azimuth</strong> containing the specified value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.#ctor(System.Int32,System.Int32,System.Double)">
- <summary>
- Creates a new instance with the specified hours, minutes and
- seconds.
- </summary>
- <param name="hours">The hours.</param>
- <param name="minutes">The minutes.</param>
- <param name="seconds">The seconds.</param>
- <example>
- This example demonstrates how to create an angular measurement of 34°12'29.2 in
- hours, minutes and seconds.
- <code lang="VB">
- Dim MyAzimuth As New Azimuth(34, 12, 29.2)
- </code>
- <code lang="CS">
- Azimuth MyAzimuth = new Azimuth(34, 12, 29.2);
- </code>
- </example>
-
- <returns>An <strong>Azimuth</strong> containing the specified value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.#ctor(System.Int32,System.Double)">
- <summary>
- Creates a new instance with the specified hours and decimal minutes.
- </summary>
- <param name="hours">The hours.</param>
- <param name="decimalMinutes">The decimal minutes.</param>
- <example>
- This example demonstrates how an angle can be created when only the hours and
- minutes (in decimal form) are known. This creates a value of 12°42.345'.
- <code lang="VB">
- Dim MyAzimuth As New Azimuth(12, 42.345)
- </code>
- <code lang="VB">
- Azimuth MyAzimuth = new Azimuth(12, 42.345);
- </code>
- </example>
- <remarks>An <strong>Azimuth</strong> containing the specified value.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.#ctor(System.String)">
- <summary>
- Creates a new instance by converting the specified string.
- </summary>
- <param name="value">The value.</param>
- <seealso cref="M:DotSpatial.Positioning.Azimuth.Parse(System.String)">Parse Method</seealso>
-
- <example>
- This example creates a new instance by parsing a string. (Notice The double-quote is
- doubled up to represent a single double-quote in the string.)
- <code lang="VB">
- Dim MyAzimuth As New Azimuth("123°45'67.8""")
- </code>
- <code lang="CS">
- Azimuth MyAzimuth = new Azimuth("123°45'67.8\"");
- </code>
- </example>
-
- <example>
- This example creates a new <strong>Azimuth</strong> object by converting the string
- "NW," short for Northwest. or 315°.
- <code lang="VB" title="[New Example]">
- Dim NewAzimuth As New Azimuth("NW")
- </code>
- <code lang="CS" title="[New Example]">
- Azimuth NewAzimuth = new Azimuth("NW");
- </code>
- </example>
-
- <returns>An <strong>Azimuth</strong> containing the specified value.</returns>
-
- <exception cref="T:System.ArgumentNullException" caption="ArgumentNullException">The Parse method requires a decimal or sexagesimal measurement.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">Only the right-most portion of a sexagesimal measurement can be a fractional value.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">Extra characters were encountered while parsing an angular measurement. Only hours, minutes, and seconds are allowed.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">The specified text was not fully understood as an angular measurement.</exception>
- <remarks>This constructor parses the specified string into an <strong>Azimuth</strong>
- object using the current culture. This constructor can parse any strings created via
- the <strong>ToString</strong> method.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.#ctor(System.String,System.Globalization.CultureInfo)">
- <summary>
- Creates a new instance by converting the specified string using the specified
- culture.
- </summary>
- <param name="value">The value.</param>
- <param name="culture">The culture.</param>
- <example>
- This example creates a new <strong>Azimuth</strong> object by converting the string
- "NW," short for Northwest. or 315°.
- <code lang="VB" title="[New Example]">
- Dim NewAzimuth As New Azimuth("NW", CultureInfo.CurrentCulture)
- </code>
- <code lang="CS" title="[New Example]">
- Azimuth NewAzimuth = new Azimuth("NW", CultureInfo.CurrentCulture);
- </code>
- </example>
- <remarks>This constructor parses the specified string into an <strong>Azimuth</strong>
- object using the specified culture. This constructor can parse any strings created via
- the <strong>ToString</strong> method.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.#ctor(System.Xml.XmlReader)">
- <summary>
- Creates a new instance by deserializing the specified XML.
- </summary>
- <param name="reader">The reader.</param>
- </member>
- <member name="F:DotSpatial.Positioning.Azimuth.Minimum">
- <summary>
- Represents the minimum value of an angle in one turn of a circle.
- </summary>
- <example>
- This example creates an angle representing the minimum allowed value.
- <code lang="VB">
- Dim MyAzimuth As Azimuth = Azimuth.Minimum
- </code>
- <code lang="CS">
- Azimuth MyAzimuth = Azimuth.Minimum;
- </code>
- <code lang="C++">
- Azimuth MyAzimuth = Azimuth.Minimum;
- </code>
- </example>
-
- <value>An Azimuth with a value of -359.999999°.</value>
- </member>
- <member name="F:DotSpatial.Positioning.Azimuth.Empty">
- <summary>
- Represents an angle with no value.
- </summary>
- <value>An Azimuth containing a value of zero (0°).</value>
-
- <seealso cref="P:DotSpatial.Positioning.Azimuth.IsEmpty">IsEmpty Property</seealso>
- </member>
- <member name="F:DotSpatial.Positioning.Azimuth.Infinity">
- <summary>
- Represents an angle with infinite value.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Azimuth.Maximum">
- <summary>
- Represents the maximum value of an angle in one turn of a circle.
- </summary>
- <example>
- This example creates an angle representing the maximum allowed value of 359.9999°.
- <code lang="VB">
- Dim MyAzimuth As Azimuth = Azimuth.Maximum
- </code>
- <code lang="CS">
- Azimuth MyAzimuth = Azimuth.Maximum;
- </code>
- </example>
- </member>
- <member name="F:DotSpatial.Positioning.Azimuth.North">
- <summary>
- Represents a direction of travel of 0°.
- </summary>
- <example>
- This example creates an Azimuth representing North.
- <code lang="VB">
- Dim MyAzimuth As Azimuth = Azimuth.North
- </code>
- <code lang="CS">
- Azimuth MyAzimuth = Azimuth.North;
- </code>
- </example>
- </member>
- <member name="F:DotSpatial.Positioning.Azimuth.NorthNortheast">
- <summary>
- Represents a direction of travel of 22.5°, between north and northeast.
- </summary>
- <example>
- <code lang="VB">
- Dim MyAzimuth As Azimuth = Azimuth.NorthNortheast
- </code>
- <code lang="CS">
- Azimuth MyAzimuth = Azimuth.NorthNortheast;
- </code>
- </example>
- </member>
- <member name="F:DotSpatial.Positioning.Azimuth.Northeast">
- <summary>
- Represents a direction of travel of 45°.
- </summary>
- <example>
- <code lang="VB">
- Dim MyAzimuth As Azimuth = Azimuth.Northeast
- </code>
- <code lang="CS">
- Azimuth MyAzimuth = Azimuth.Northeast;
- </code>
- </example>
- </member>
- <member name="F:DotSpatial.Positioning.Azimuth.EastNortheast">
- <summary>
- Represents a direction of travel of 67.5°.
- </summary>
- <example>
- <code lang="VB">
- Dim MyAzimuth As Azimuth = Azimuth.EastNortheast
- </code>
- <code lang="CS">
- Azimuth MyAzimuth = Azimuth.EastNortheast;
- </code>
- </example>
- </member>
- <member name="F:DotSpatial.Positioning.Azimuth.East">
- <summary>
- Represents a direction of travel of 90°.
- </summary>
- <example>
- <code lang="VB">
- Dim MyAzimuth As Azimuth = Azimuth.East
- </code>
- <code lang="CS">
- Azimuth MyAzimuth = Azimuth.East;
- </code>
- </example>
- </member>
- <member name="F:DotSpatial.Positioning.Azimuth.EastSoutheast">
- <summary>
- Represents a direction of travel of 112.5°, between east and southeast.
- </summary>
- <example>
- <code lang="VB">
- Dim MyAzimuth As Azimuth = Azimuth.EastSoutheast
- </code>
- <code lang="CS">
- Azimuth MyAzimuth = Azimuth.EastSoutheast;
- </code>
- </example>
- </member>
- <member name="F:DotSpatial.Positioning.Azimuth.Southeast">
- <summary>
- Represents a direction of travel of 135°.
- </summary>
- <example>
- <code lang="VB">
- Dim MyAzimuth As Azimuth = Azimuth.Southeast
- </code>
- <code lang="CS">
- Azimuth MyAzimuth = Azimuth.Southeast;
- </code>
- </example>
- </member>
- <member name="F:DotSpatial.Positioning.Azimuth.SouthSoutheast">
- <summary>
- Represents a direction of travel of 157.5°, between south and southeast.
- </summary>
- <example>
- <code lang="VB">
- Dim MyAzimuth As Azimuth = Azimuth.SouthSoutheast
- </code>
- <code lang="CS">
- Azimuth MyAzimuth = Azimuth.SouthSoutheast;
- </code>
- </example>
- </member>
- <member name="F:DotSpatial.Positioning.Azimuth.South">
- <summary>
- Represents a direction of travel of 180°.
- </summary>
- <example>
- <code lang="VB">
- Dim MyAzimuth As Azimuth = Azimuth.South
- </code>
- <code lang="CS">
- Azimuth MyAzimuth = Azimuth.South;
- </code>
- </example>
- </member>
- <member name="F:DotSpatial.Positioning.Azimuth.SouthSouthwest">
- <summary>
- Represents a direction of travel of 202.5°, between south and southwest.
- </summary>
- <example>
- <code lang="VB">
- Dim MyAzimuth As Azimuth = Azimuth.SouthSouthwest
- </code>
- <code lang="CS">
- Azimuth MyAzimuth = Azimuth.SouthSouthwest;
- </code>
- </example>
- </member>
- <member name="F:DotSpatial.Positioning.Azimuth.Southwest">
- <summary>
- Represents a direction of travel of 225°.
- </summary>
- <example>
- <code lang="VB">
- Dim MyAzimuth As Azimuth = Azimuth.Southwest
- </code>
- <code lang="CS">
- Azimuth MyAzimuth = Azimuth.Southwest;
- </code>
- </example>
- </member>
- <member name="F:DotSpatial.Positioning.Azimuth.WestSouthwest">
- <summary>
- Represents a direction of travel of 247.5°, between west and southwest.
- </summary>
- <example>
- <code lang="VB">
- Dim MyAzimuth As Azimuth = Azimuth.WestSouthwest
- </code>
- <code lang="CS">
- Azimuth MyAzimuth = Azimuth.WestSouthwest;
- </code>
- </example>
- </member>
- <member name="F:DotSpatial.Positioning.Azimuth.West">
- <summary>
- Represents a direction of travel of 270°.
- </summary>
- <example>
- <code lang="VB">
- Dim MyAzimuth As Azimuth = Azimuth.West
- </code>
- <code lang="CS">
- Azimuth MyAzimuth = Azimuth.West;
- </code>
- </example>
- </member>
- <member name="F:DotSpatial.Positioning.Azimuth.WestNorthwest">
- <summary>
- Represents a direction of travel of 292.5°, between west and northwest.
- </summary>
- <example>
- <code lang="VB">
- Dim MyAzimuth As Azimuth = Azimuth.WestNorthwest
- </code>
- <code lang="CS">
- Azimuth MyAzimuth = Azimuth.WestNorthwest;
- </code>
- </example>
- </member>
- <member name="F:DotSpatial.Positioning.Azimuth.Northwest">
- <summary>
- Represents a direction of travel of 315°.
- </summary>
- <example>
- <code lang="VB">
- Dim MyAzimuth As Azimuth = Azimuth.Northwest
- </code>
- <code lang="CS">
- Azimuth MyAzimuth = Azimuth.Northwest;
- </code>
- </example>
- </member>
- <member name="F:DotSpatial.Positioning.Azimuth.NorthNorthwest">
- <summary>
- Represents a direction of travel of 337.5°, between north and northwest.
- </summary>
- <example>
- <code lang="VB">
- Dim MyAzimuth As Azimuth = Azimuth.NorthNorthwest
- </code>
- <code lang="CS">
- Azimuth MyAzimuth = Azimuth.NorthNorthwest;
- </code>
- </example>
- </member>
- <member name="F:DotSpatial.Positioning.Azimuth.Invalid">
- <summary>
- Represents an invalid or unspecified value.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.Normalize">
- <summary>
- Modifies a value to its equivalent between 0° and 360°.
- </summary>
- <returns>An <strong>Azimuth</strong> representing the normalized angle.</returns>
- <seealso cref="M:DotSpatial.Positioning.Azimuth.Normalize">Normalize(Azimuth) Method</seealso>
-
- <example>
- This example demonstrates how normalization is used. The Stop statement is hit.
- This example demonstrates how the Normalize method can ensure that an angle fits
- between 0° and 359.9999°. This example normalizes 725° into 5°.
- <code lang="VB">
- Dim MyAzimuth As New Azimuth(720)
- MyAzimuth = MyAzimuth.Normalize()
- </code>
- <code lang="CS">
- Azimuth MyAzimuth = new Azimuth(720);
- MyAzimuth = MyAzimuth.Normalize();
- </code>
- <code lang="VB">
- Dim MyValue As New Azimuth(725)
- MyValue = MyValue.Normalize()
- </code>
- <code lang="CS">
- Azimuth MyValue = new Azimuth(725);
- MyValue = MyValue.Normalize();
- </code>
- </example>
- <remarks>This function is used to ensure that an angular measurement is within the
- allowed bounds of 0° and 360°. If a value of 360° or 720° is passed, a value of 0°
- is returned since 360° and 720° represent the same point on a circle. For the Azimuth
- class, this function is the same as "value Mod 360".</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.IsBetween(DotSpatial.Positioning.Azimuth,DotSpatial.Positioning.Azimuth)">
- <summary>
- Returns whether the current value is between the specified values.
- </summary>
- <param name="start">An <strong>Azimuth</strong> marking the start of a range.</param>
- <param name="end">An <strong>Azimuth</strong> marking the end of a range.</param>
- <returns>A <strong>Boolean</strong> value.</returns>
- <remarks>This property is used to determine whether a value is within a specified range. If the
- starting value is less than the end value, a basic greater-than or less-than comparison is performed.
- If, however, the end value is greater than the start, it is assumed that the range crosses the 0/360
- boundary. For example, if the start is 270 and the end is 90, a value of <strong>True</strong> is
- returned if the current value is between 270 and 360, or 0 and 90.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.Ceiling">
- <summary>
- Returns the smallest integer greater than the specified value.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.Floor">
- <summary>
- Returns the largest integer which is smaller than the specified value.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.Round(System.Int32)">
- <summary>
- Returns a new instance whose value is rounded the specified number of decimals.
- </summary>
- <param name="decimals">An <strong>Integer</strong> specifying the number of decimals to round off to.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.RoundSeconds">
- <summary>
- Returns a new instance whose Seconds property is evenly divisible by 15.
- </summary>
- <returns>An <strong>Azimuth</strong> containing the rounded value.</returns>
- <remarks>This method is used to align or "snap" an angle to a regular interval. For
- example, a grid might be easier to read if it were drawn at 30-second intervals instead
- of 24.198-second intervals.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.RoundSeconds(System.Double)">
- <summary>
- Returns a new angle whose Seconds property is evenly divisible by the specified amount.
- </summary>
- <param name="interval">A <strong>Double</strong> between 0 and 60 indicating the interval to round
- to.</param>
- <returns>An <strong>Azimuth</strong> containing the rounded value.</returns>
- <remarks>This method is used to align or "snap" an angle to a regular interval. For
- example, a grid might be easier to read if it were drawn at 30-second intervals instead
- of 24.198-second intervals.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.ToString(System.String)">
- <summary>
- Outputs the azimuth as a string using the specified format.
- </summary>
- <param name="format"><para>A <strong>String</strong> consisting of any number of the following
- codes:</para>
- <para>
- <list type="table">
- <item>
- <term><strong>c</strong></term>
- <description>The object is output as an abbreviated direction.
- <strong>N</strong>, <strong>NE</strong>,
- <strong>NNW</strong></description>
- </item>
- <item>
- <term><strong>cc</strong></term>
- <description>The object is output as a full direction.
- <strong>North</strong>, <strong>Northeast</strong>,
- <strong>North-Northwest</strong></description>
- </item>
- <item>
- <term><strong>d</strong></term>
- <description>Represents one digit from the
- <strong>DecimalDegrees</strong> property.</description>
- </item>
- <item>
- <term><strong>h</strong></term>
- <description>Represents one digit from the
- <strong>Hours</strong> property.</description>
- </item>
- <item>
- <term><strong>m</strong></term>
- <description>Represents one digit from the <strong>Minutes</strong>
- property.</description>
- </item>
- <item>
- <term><strong>s</strong></term>
- <description>Represents one digit from the <strong>Seconds</strong>
- property.</description>
- </item>
- </list>
- </para></param>
- <returns>A <strong>String</strong> in the specified format.</returns>
- <seealso cref="M:DotSpatial.Positioning.Azimuth.ToString">ToString Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Azimuth.Parse(System.String)">Parse Method</seealso>
-
- <example>
- This example uses the <strong>ToString</strong> method to output an azimuth in a
- custom format. The " <strong>d.dd</strong> " code represents decimal degrees
- rounded to two digits, and " <strong>cc</strong> " represents the direction in
- verbose form.
- <code lang="VB">
- Dim MyAzimuth As New Azimuth(90.946)
- Debug.WriteLine(MyAzimuth.ToString("d.dd (cc)"))
- ' Output: 90.95 (East)
- </code>
- <code lang="CS">
- Azimuth MyAzimuth = new Azimuth(90.946);
- Console.WriteLine(MyAzimuth.ToString("d.dd (cc)"));
- // Output: 90.95 (East)
- </code>
- </example>
- <remarks>This method returns the current instance output in a specific format. If no
- value for the format is specified, a default format of "cc" is used. Any string
- output by this method can be converted back into an Azimuth object using the
- <strong>Parse</strong> method or <strong>Azimuth(string)</strong>
- constructor.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.LesserOf(DotSpatial.Positioning.Azimuth)">
- <summary>
- Returns the object with the smallest value.
- </summary>
- <param name="value">An <strong>Azimuth</strong> object to compare to the current instance.</param>
- <returns>The <strong>Azimuth</strong> containing the smallest value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.GreaterOf(DotSpatial.Positioning.Azimuth)">
- <summary>
- Returns the object with the largest value.
- </summary>
- <param name="value">An <strong>Azimuth</strong> object to compare to the current instance.</param>
- <returns>An <strong>Azimuth</strong> containing the largest value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.Mirror">
- <summary>
- Returns an angle opposite of the current instance.
- </summary>
- <returns>An <strong>Azimuth</strong> representing the mirrored value.</returns>
- <example>
- This example creates a new <strong>Azimuth</strong> of 45° then calculates its mirror
- of 225°. (45 + 180)
- <code lang="VB" title="[New Example]">
- Dim Azimuth1 As New Azimuth(45)
- Dim Azimuth2 As Azimuth = Azimuth1.Mirror()
- Debug.WriteLine(Azimuth2.ToString())
- ' Output: 225
- </code>
- <code lang="CS" title="[New Example]">
- Azimuth Azimuth1 = new Azimuth(45);
- Azimuth Azimuth2 = Azimuth1.Mirror();
- Console.WriteLine(Azimuth2.ToString());
- // Output: 225
- </code>
- </example>
- <remarks>This method returns the "opposite" of the current instance. The opposite is
- defined as the point on the other side of an imaginary circle. For example, if an angle
- is 0°, at the top of a circle, this method returns 180°, at the bottom of the
- circle.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.ToRadians">
- <summary>
- Converts the current instance into radians.
- </summary>
- <returns>A <see cref="T:DotSpatial.Positioning.Radian">Radian</see> object.</returns>
- <seealso cref="T:DotSpatial.Positioning.Radian">Radian Class</seealso>
-
- <overloads>Converts an angular measurement into radians before further processing.</overloads>
-
- <example>
- This example converts a measurement of 90° into radians.
- <code lang="VB">
- Dim MyAzimuth As New Azimuth(90)
- Dim MyRadians As Radian = MyAzimuth.ToRadians()
- </code>
- <code lang="CS">
- Azimuth MyAzimuth = new Azimuth(90);
- Radian MyRadians = MyAzimuth.ToRadians();
- </code>
- </example>
- <remarks>This function is typically used to convert an angular measurement into
- radians before performing a trigonometric function.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.Equals(System.Object)">
- <summary>
- Compares the current value to another Azimuth object's value.
- </summary>
- <param name="obj">An <strong>Azimuth</strong>, <strong>Double</strong>, or <strong>Integer</strong>
- to compare with.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the object's DecimalDegrees
- properties match.</returns>
- <remarks>This</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.GetHashCode">
- <summary>
- Returns a unique code for this instance.
- </summary>
- <returns>An <strong>Integer</strong> representing a unique code for the current
- instance.</returns>
- <remarks>Since the <strong>Azimuth</strong> class is immutable, this property may be used
- safely with hash tables.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.ToString">
- <summary>
- Outputs the current instance as a string using the default format.
- </summary>
- <returns>A <strong>String</strong> representing the current instance.</returns>
- <seealso cref="M:DotSpatial.Positioning.Azimuth.Parse(System.String)">Parse Method</seealso>
-
- <example>
- This example outputs a value of 90 degrees in the default format of ###.#°.
- <code lang="VB">
- Dim MyAzimuth As New Azimuth(90)
- Debug.WriteLine(MyAzimuth.ToString)
- ' Output: "90°"
- </code>
- <code lang="CS">
- Azimuth MyAzimuth = new Azimuth(90);
- Debug.WriteLine(MyAzimuth.ToString());
- // Output: "90°"
- </code>
- </example>
- <remarks>This method formats the current instance using the default format of "cc." Any
- string output by this method can be converted back into an Azimuth object using the
- <strong>Parse</strong> method or <strong>Azimuth(string)</strong> constructor.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.Normalize(System.Double)">
- <summary>
- Converts the specified value to its equivalent between 0° and 360°.
- </summary>
- <param name="decimalDegrees">A <strong>Double</strong> value to be normalized.</param>
- <returns>An Azimuth containing a value equivalent to the value specified, but between 0° and
- 360°.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.FromDirection(DotSpatial.Positioning.Direction)">
- <summary>
- Converts a <strong>Direction</strong> value into an <strong>Azimuth</strong>
- object.
- </summary>
- <param name="direction">A value from the <strong>Direction</strong> enumeration to convert.</param>
- <returns>An <strong>Azimuth</strong> equivalent to the specified direction.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.Random">
- <summary>
- Returns a random angle between 0° and 360°.
- </summary>
- <returns>An <strong>Azimuth</strong> containing a random value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.Random(System.Random)">
- <summary>
- Returns a random Azimuth between 0° and 360° using the specified random number
- seed.
- </summary>
- <param name="generator">A <strong>Random</strong> object used to generate random values.</param>
- <returns>An <strong>Azimuth</strong> containing a random value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.ToDecimalDegrees(System.Int32,System.Int32,System.Double)">
- <summary>
- Converts arbitrary hour, minute and seconds into decimal degrees.
- </summary>
- <param name="hours">The hours.</param>
- <param name="minutes">The minutes.</param>
- <param name="seconds">The seconds.</param>
- <returns>A <strong>Double</strong> containing the decimal degree version of the specified
- values.</returns>
- <seealso cref="P:DotSpatial.Positioning.Latitude.DecimalDegrees">DecimalDegrees Property</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Latitude.Normalize">Normalize Method</seealso>
-
- <example>
- This example converts a value of 10°30'0" into decimal degrees (10.5).
- <code lang="VB" title="ToDecimalDegrees Example (VB)">
- Dim MyValue As Double = Latitude.ToDecimalDegrees(10, 30, 0)
- </code>
- <code lang="CS" title="ToDecimalDegrees Example (C#)">
- double MyValue = Latitude.ToDecimalDegrees(10, 30, 0);
- </code>
- </example>
- <remarks>This function is used to convert three-part measurements into a single value. The
- result of this method is typically assigned to the
- <see cref="P:DotSpatial.Positioning.Latitude.DecimalDegrees">
- DecimalDegrees</see> property. Values are rounded to thirteen decimal
- places, the maximum precision allowed by this type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.ToDecimalDegrees(System.Int32,System.Double)">
- <summary>
- Converts arbitrary hour and decimal minutes into decimal degrees.
- </summary>
- <param name="hours">The hours.</param>
- <param name="decimalMinutes">The decimal minutes.</param>
- <returns>A <strong>Double</strong> containing the decimal degree version of the specified
- values.</returns>
- <remarks>This function is used to convert three-part measurements into a single value. The
- result of this method is typically assigned to the
- <see cref="P:DotSpatial.Positioning.Latitude.DecimalDegrees">
- DecimalDegrees</see> property. Values are rounded to thirteen decimal
- places, the maximum precision allowed by this type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.ToDecimalDegrees(System.Int32)">
- <summary>
- Converts an hour value into decimal degrees.
- </summary>
- <param name="hours">The hours.</param>
- <returns>A <strong>Double</strong> containing the decimal degree version of the specified
- values.</returns>
- <remarks>The specified value will be converted to a double value.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.LesserOf(DotSpatial.Positioning.Azimuth,DotSpatial.Positioning.Azimuth)">
- <summary>
- Returns the object with the smallest value.
- </summary>
- <param name="value1">A <strong>Azimuth</strong> object to compare to value2.</param>
- <param name="value2">A <strong>Azimuth</strong> object to compare to value1.</param>
- <returns>The <strong>Azimuth</strong> containing the smallest value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.GreaterOf(DotSpatial.Positioning.Azimuth,DotSpatial.Positioning.Azimuth)">
- <summary>
- Returns the object with the largest value.
- </summary>
- <param name="value1">A <strong>Azimuth</strong> object to compare to value2.</param>
- <param name="value2">A <strong>Azimuth</strong> object to compare to value1.</param>
- <returns>A <strong>Azimuth</strong> containing the largest value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.Parse(System.String)">
- <summary>
- Converts the specified string into an Azimuth object.
- </summary>
- <param name="value">The value.</param>
- <returns>A new <strong>Azimuth</strong> object populated with the specified
- values.</returns>
- <seealso cref="M:DotSpatial.Positioning.Azimuth.ToString">ToString Method</seealso>
-
- <example>
- This example creates a new angular measurement using the <strong>Parse</strong>
- method.
- <code lang="VB">
- Dim NewAzimuth As Azimuth = Azimuth.Parse("123.45°")
- </code>
- <code lang="CS">
- Azimuth NewAzimuth = Azimuth.Parse("123.45°");
- </code>
- </example>
-
- <exception cref="T:System.ArgumentNullException" caption="ArgumentNullException">The Parse method requires a decimal or sexagesimal measurement.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">Only the right-most portion of a sexagesimal measurement can be a fractional value.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">Extra characters were encountered while parsing an angular measurement. Only hours, minutes, and seconds are allowed.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">The specified text was not fully understood as an angular measurement.</exception>
- <remarks>This method parses the specified string into an <strong>Azimuth</strong> object
- using the current culture. This constructor can parse any strings created via the
- <strong>ToString</strong> method.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.Parse(System.String,System.Globalization.CultureInfo)">
- <summary>
- Converts the specified string into an <strong>Azimuth</strong> object using the
- specified culture.
- </summary>
- <param name="value">A <strong>String</strong> describing an angle in the form of decimal degrees or a
- sexagesimal.</param>
- <param name="culture">A <strong>CultureInfo</strong> object describing the numeric format to use during
- conversion.</param>
- <returns>A new <strong>Azimuth</strong> object equivalent to the specified string.</returns>
- <example>
- This example creates a new <strong>Azimuth</strong> object by converting the string
- "NW," short for Northwest. or 315°.
- <code lang="VB" title="[New Example]">
- Dim NewAzimuth As Azimuth = Azimuth.Parse("NW", CultureInfo.CurrentCulture)
- </code>
- <code lang="CS" title="[New Example]">
- Azimuth NewAzimuth = Azimuth.Parse("NW", CultureInfo.CurrentCulture);
- </code>
- </example>
- <remarks>This method parses the specified string into an <strong>Azimuth</strong>
- object using the specified culture. This method can parse any string created via
- the <strong>ToString</strong> method.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.ToRadians(DotSpatial.Positioning.Azimuth)">
- <summary>
- Converts an angular measurement into radians.
- </summary>
- <param name="value">The value.</param>
- <returns>A <see cref="T:DotSpatial.Positioning.Radian"><strong>Radian</strong></see> object.</returns>
- <example>
- This example shows a quick way to convert an angle of 90° into radians.
- <code lang="VB">
- Dim MyRadian As Radian = Azimuth.ToRadians(90)
- </code>
- <code lang="CS">
- Radian MyRadian = Azimuth.ToRadians(90);
- </code>
- </example>
- <remarks>This function is typically used to convert an angular measurement into
- radians before performing a trigonometric function.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.FromRadians(DotSpatial.Positioning.Radian)">
- <summary>
- Converts a value in radians into an angular measurement.
- </summary>
- <param name="radians">The radians.</param>
- <returns></returns>
- <seealso cref="M:DotSpatial.Positioning.Azimuth.ToRadians">ToRadians</seealso>
-
- <seealso cref="T:DotSpatial.Positioning.Radian">Radian Class</seealso>
-
- <example>
- This example uses the <strong>FromRadians</strong> method to convert a value of one
- radian into an <strong>Azimuth</strong> of 57°.
- <code lang="VB">
- ' Create a new angle equal to one radian
- Dim MyRadians As New Radian(1)
- Dim MyAzimuth As Azimuth = Azimuth.FromRadians(MyRadians)
- Debug.WriteLine(MyAzimuth.ToString())
- ' Output: 57°
- </code>
- <code lang="CS">
- // Create a new angle equal to one radian
- Radian MyRadians = new Radian(1);
- Azimuth MyAzimuth = Azimuth.FromRadians(MyRadians);
- Console.WriteLine(MyAzimuth.ToString());
- // Output: 57°
- </code>
- </example>
- <remarks>This function is typically used in conjunction with the
- <see cref="M:DotSpatial.Positioning.Azimuth.ToRadians">ToRadians</see>
- method after a trigonometric function has completed. The converted value is stored in
- the <see cref="P:DotSpatial.Positioning.Azimuth.DecimalDegrees">DecimalDegrees</see> property.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.FromRadians(System.Double)">
- <summary>
- Froms the radians.
- </summary>
- <param name="radians">The radians.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.op_Explicit(DotSpatial.Positioning.Radian)~DotSpatial.Positioning.Azimuth">
- <summary>
- Converts a measurement in Radians into an Azimuth.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.op_Explicit(System.Double)~DotSpatial.Positioning.Azimuth">
- <summary>
- Converts a decimal degree measurement as a Double into an Azimuth.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.op_Explicit(System.Single)~DotSpatial.Positioning.Azimuth">
- <summary>
- Converts a decimal degree measurement as a Double into an Azimuth.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.op_Explicit(DotSpatial.Positioning.Azimuth)~System.Double">
- <summary>
- Converts a decimal degree measurement as a Double into an Azimuth.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.op_Explicit(DotSpatial.Positioning.Azimuth)~System.Single">
- <summary>
- Converts a decimal degree measurement as a Double into an Azimuth.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.op_Explicit(DotSpatial.Positioning.Azimuth)~DotSpatial.Positioning.Direction">
- <summary>
- Performs an explicit conversion from <see cref="T:DotSpatial.Positioning.Azimuth"/> to <see cref="T:DotSpatial.Positioning.Direction"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.op_Explicit(DotSpatial.Positioning.Direction)~DotSpatial.Positioning.Azimuth">
- <summary>
- Performs an explicit conversion from <see cref="T:DotSpatial.Positioning.Direction"/> to <see cref="T:DotSpatial.Positioning.Azimuth"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.op_Explicit(System.Int32)~DotSpatial.Positioning.Azimuth">
- <summary>
- Converts a measurement in degrees as an Integer into an Azimuth.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.op_Explicit(DotSpatial.Positioning.Angle)~DotSpatial.Positioning.Azimuth">
- <summary>
- Performs an explicit conversion from <see cref="T:DotSpatial.Positioning.Angle"/> to <see cref="T:DotSpatial.Positioning.Azimuth"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.op_Explicit(DotSpatial.Positioning.Elevation)~DotSpatial.Positioning.Azimuth">
- <summary>
- Performs an explicit conversion from <see cref="T:DotSpatial.Positioning.Elevation"/> to <see cref="T:DotSpatial.Positioning.Azimuth"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.op_Explicit(DotSpatial.Positioning.Latitude)~DotSpatial.Positioning.Azimuth">
- <summary>
- Performs an explicit conversion from <see cref="T:DotSpatial.Positioning.Latitude"/> to <see cref="T:DotSpatial.Positioning.Azimuth"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.op_Explicit(DotSpatial.Positioning.Longitude)~DotSpatial.Positioning.Azimuth">
- <summary>
- Performs an explicit conversion from <see cref="T:DotSpatial.Positioning.Longitude"/> to <see cref="T:DotSpatial.Positioning.Azimuth"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.op_Explicit(System.String)~DotSpatial.Positioning.Azimuth">
- <summary>
- Converts a measurement in the form of a formatted String into an Azimuth.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.op_Explicit(DotSpatial.Positioning.Azimuth)~System.String">
- <summary>
- Converts an Azimuth into a String.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- <remarks>This operator calls the ToString() method using the current culture.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.op_Addition(DotSpatial.Positioning.Azimuth,DotSpatial.Positioning.Azimuth)">
- <summary>
- Implements the operator +.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.op_Addition(DotSpatial.Positioning.Azimuth,System.Double)">
- <summary>
- Implements the operator +.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.op_Subtraction(DotSpatial.Positioning.Azimuth,DotSpatial.Positioning.Azimuth)">
- <summary>
- Implements the operator -.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.op_Subtraction(DotSpatial.Positioning.Azimuth,System.Double)">
- <summary>
- Implements the operator -.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.op_Multiply(DotSpatial.Positioning.Azimuth,DotSpatial.Positioning.Azimuth)">
- <summary>
- Implements the operator *.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.op_Multiply(DotSpatial.Positioning.Azimuth,System.Double)">
- <summary>
- Implements the operator *.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.op_Division(DotSpatial.Positioning.Azimuth,DotSpatial.Positioning.Azimuth)">
- <summary>
- Implements the operator /.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.op_Division(DotSpatial.Positioning.Azimuth,System.Double)">
- <summary>
- Implements the operator /.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.op_Equality(DotSpatial.Positioning.Azimuth,DotSpatial.Positioning.Azimuth)">
- <summary>
- Implements the operator ==.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.op_Equality(DotSpatial.Positioning.Azimuth,System.Double)">
- <summary>
- Implements the operator ==.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.op_Inequality(DotSpatial.Positioning.Azimuth,DotSpatial.Positioning.Azimuth)">
- <summary>
- Implements the operator !=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.op_Inequality(DotSpatial.Positioning.Azimuth,System.Double)">
- <summary>
- Implements the operator !=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.op_GreaterThan(DotSpatial.Positioning.Azimuth,DotSpatial.Positioning.Azimuth)">
- <summary>
- Implements the operator >.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.op_GreaterThan(DotSpatial.Positioning.Azimuth,System.Double)">
- <summary>
- Implements the operator >.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.op_GreaterThanOrEqual(DotSpatial.Positioning.Azimuth,DotSpatial.Positioning.Azimuth)">
- <summary>
- Implements the operator >=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.op_GreaterThanOrEqual(DotSpatial.Positioning.Azimuth,System.Double)">
- <summary>
- Implements the operator >=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.op_LessThan(DotSpatial.Positioning.Azimuth,DotSpatial.Positioning.Azimuth)">
- <summary>
- Implements the operator <.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.op_LessThan(DotSpatial.Positioning.Azimuth,System.Double)">
- <summary>
- Implements the operator <.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.op_LessThanOrEqual(DotSpatial.Positioning.Azimuth,DotSpatial.Positioning.Azimuth)">
- <summary>
- Implements the operator <=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.op_LessThanOrEqual(DotSpatial.Positioning.Azimuth,System.Double)">
- <summary>
- Implements the operator <=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.Increment">
- <summary>
- Returns the current instance increased by one.
- </summary>
- <returns>An <strong>Azimuth</strong> object.</returns>
- <example>
- This example uses the <strong>Increment</strong> method to increase an Azimuth's
- value. It also demonstrates the subtle error which can be caused if
- <strong>Increment</strong> is called while ignoring the return value.
- <code lang="VB" title="[New Example]">
- ' Correct use of Increment
- Dim Azimuth1 As New Azimuth(89)
- Azimuth1 = Azimuth1.Increment()
- ' Incorrect use of Increment
- Dim Azimuth1 = New Azimuth(89)
- Azimuth1.Increment()
- ' NOTE: Azimuth1 will still be 89°!
- </code>
- <code lang="CS" title="[New Example]">
- // Correct use of Increment
- Azimuth Azimuth1 = new Azimuth(89);
- Azimuth1 = Azimuth1.Increment();
- // Incorrect use of Increment
- Azimuth Azimuth1 = new Azimuth(89);
- Azimuth1.Increment();
- // NOTE: Azimuth1 will still be 89°!
- </code>
- </example>
- <remarks><para>This method increases the <strong>DecimalDegrees</strong> property by 1.0,
- returned as a new instance.</para>
- <para><font color="red">Since the <strong>Azimuth</strong> class is immutable, this
- method cannot be used to modify an existing instance.</font></para></remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.Add(System.Double)">
- <summary>
- Increases the current instance by the specified value.
- </summary>
- <param name="value">A <strong>Double</strong> to add to the current instance.</param>
- <returns>A new <strong>Azimuth</strong> containing the summed values.</returns>
- <example>
- This example adds 45° to the current instance of 45°, returning 90°.
- <code lang="VB" title="[New Example]">
- Dim Azimuth1 As New Azimuth(45)
- Azimuth1 = Azimuth1.Add(45)
- </code>
- <code lang="CS" title="[New Example]">
- Azimuth Azimuth1 = new Azimuth(45);
- Azimuth1 = Azimuth1.Add(45);
- </code>
- </example>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.Add(DotSpatial.Positioning.Azimuth)">
- <summary>
- Adds the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.Decrement">
- <summary>
- Returns the current instance decreased by one.
- </summary>
- <returns>An <strong>Azimuth</strong> object.</returns>
- <example>
- This example uses the <strong>Decrement</strong> method to decrease an Azimuth's
- value. It also demonstrates the subtle error which can be caused if
- <strong>Decrement</strong> is called while ignoring the return value.
- <code lang="VB" title="[New Example]">
- ' Correct use of Decrement
- Dim Azimuth1 As New Azimuth(91)
- Azimuth1 = Azimuth1.Decrement()
- ' Incorrect use of Decrement
- Dim Azimuth1 = New Azimuth(91)
- Azimuth1.Increment()
- ' NOTE: Azimuth1 will still be 91°!
- </code>
- <code lang="CS" title="[New Example]">
- // Correct use of Decrement
- Azimuth Azimuth1 = new Azimuth(91);
- Azimuth1 = Azimuth1.Decrement();
- // Incorrect use of Decrement
- Azimuth Azimuth1 = new Azimuth(91);
- Azimuth1.Decrement();
- // NOTE: Azimuth1 will still be 91°!
- </code>
- </example>
- <remarks><para>This method decreases the <strong>DecimalDegrees</strong> property by 1.0,
- returned as a new instance.</para>
- <para><font color="red">Since the <strong>Azimuth</strong> class is immutable, this
- method cannot be used to modify an existing instance.</font></para></remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.Subtract(System.Double)">
- <summary>
- Decreases the current instance by the specified value.
- </summary>
- <param name="value">A <strong>Double</strong> to subtract from the current instance.</param>
- <returns>A new <strong>Azimuth</strong> containing the new value.</returns>
- <example>
- This example subtracts 30° from the current instance of 90°, returning 60°.
- <code lang="VB" title="[New Example]">
- Dim Azimuth1 As New Azimuth(90)
- Azimuth1 = Azimuth1.Subtract(30)
- </code>
- <code lang="CS" title="[New Example]">
- Azimuth Azimuth1 = new Azimuth(90);
- Azimuth1 = Azimuth1.Subtract(30);
- </code>
- </example>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.Subtract(DotSpatial.Positioning.Azimuth)">
- <summary>
- Subtracts the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.Multiply(System.Double)">
- <summary>
- Multiplies the current instance by the specified value.
- </summary>
- <param name="value">A <strong>Double</strong> to multiply with the current instance.</param>
- <returns>A new <strong>Azimuth</strong> containing the product of the two numbers.</returns>
- <example>
- This example multiplies 30° with three, returning 90°.
- <code lang="VB" title="[New Example]">
- Dim Azimuth1 As New Azimuth(30)
- Azimuth1 = Azimuth1.Multiply(3)
- </code>
- <code lang="CS" title="[New Example]">
- Azimuth Azimuth1 = new Azimuth(30);
- Azimuth1 = Azimuth1.Multiply(3);
- </code>
- </example>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.Multiply(DotSpatial.Positioning.Azimuth)">
- <summary>
- Multiplies the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.Divide(System.Double)">
- <summary>
- Divides the current instance by the specified value.
- </summary>
- <param name="value">A <strong>Double</strong> representing a denominator to divide by.</param>
- <returns>An <strong>Azimuth</strong> containing the new value.</returns>
- <example>
- This example divides 90° by three, returning 30°.
- <code lang="VB" title="[New Example]">
- Dim Azimuth1 As New Azimuth(90)
- Azimuth1 = Azimuth1.Divide(3)
- </code>
- <code lang="CS" title="[New Example]">
- Azimuth Azimuth1 = new Azimuth(90);
- Azimuth1 = Azimuth1.Divide(3);
- </code>
- </example>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.Divide(DotSpatial.Positioning.Azimuth)">
- <summary>
- Divides the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.IsLessThan(DotSpatial.Positioning.Azimuth)">
- <summary>
- Indicates if the current instance is smaller than the specified value.
- </summary>
- <param name="value">An <strong>Azimuth</strong> to compare with the current instance.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the current instance is
- smaller than the specified value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.IsLessThan(System.Double)">
- <summary>
- Determines whether [is less than] [the specified value].
- </summary>
- <param name="value">The value.</param>
- <returns><c>true</c> if [is less than] [the specified value]; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.IsLessThanOrEqualTo(DotSpatial.Positioning.Azimuth)">
- <summary>
- Indicates if the current instance is smaller than or equal to the specified
- value.
- </summary>
- <param name="value">An <strong>Azimuth</strong> to compare with the current instance.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the current instance is
- smaller than or equal to the specified value.</returns>
- <remarks>This method compares the <strong>DecimalDegrees</strong> property with the
- specified value. This method is the same as the "<=" operator.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.IsLessThanOrEqualTo(System.Double)">
- <summary>
- Determines whether [is less than or equal to] [the specified value].
- </summary>
- <param name="value">The value.</param>
- <returns><c>true</c> if [is less than or equal to] [the specified value]; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.IsGreaterThan(DotSpatial.Positioning.Azimuth)">
- <summary>
- Indicates if the current instance is larger than the specified value.
- </summary>
- <param name="value">An <strong>Azimuth</strong> to compare with the current instance.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the current instance is
- greater than the specified value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.IsGreaterThan(System.Double)">
- <summary>
- Determines whether [is greater than] [the specified value].
- </summary>
- <param name="value">The value.</param>
- <returns><c>true</c> if [is greater than] [the specified value]; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.IsGreaterThanOrEqualTo(DotSpatial.Positioning.Azimuth)">
- <summary>
- Indicates if the current instance is larger than or equal to the specified
- value.
- </summary>
- <param name="value">An <strong>Azimuth</strong> to compare with the current instance.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the current instance is
- greater than or equal to the specified value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.IsGreaterThanOrEqualTo(System.Double)">
- <summary>
- Determines whether [is greater than or equal to] [the specified value].
- </summary>
- <param name="value">The value.</param>
- <returns><c>true</c> if [is greater than or equal to] [the specified value]; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.Clone">
- <summary>
- Creates a copy of the current instance.
- </summary>
- <returns>An <strong>Azimuth</strong> of the same value as the current instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.CompareTo(DotSpatial.Positioning.Azimuth)">
- <summary>
- Returns a value indicating the relative order of two objects.
- </summary>
- <param name="other">An <strong>Azimuth</strong> object to compare with.</param>
- <returns>A value of -1, 0, or 1 as documented by the IComparable interface.</returns>
- <remarks>This method allows collections of <strong>Azimuth</strong> objects to be sorted.
- The <see cref="P:DotSpatial.Positioning.Azimuth.DecimalDegrees">DecimalDegrees</see> property of each instance is compared.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.Equals(DotSpatial.Positioning.Azimuth,System.Int32)">
- <summary>
- Compares the current instance to another instance using the specified
- precision.
- </summary>
- <param name="value">The value.</param>
- <param name="decimals">The decimals.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the
- <strong>DecimalDegrees</strong> property of the current instance matches the
- specified instance's <strong>DecimalDegrees</strong> property.</returns>
- <example>
- These examples compare two fractional values using specific numbers of digits for
- comparison.
- <code lang="VB" title="[New Example]">
- ' Equals will return False
- Dim Azimuth1 As New Azimuth(90.15);
- Dim Azimuth2 As New Azimuth(90.12);
- If Azimuth1.Equals(Azimuth2, 2) Then
- Debug.WriteLine("The values are the same to two digits of precision.");
- ' Equals will return True
- Dim Azimuth1 As New Azimuth(90.15);
- Dim Azimuth2 As New Azimuth(90.12);
- If Azimuth1.Equals(Azimuth2, 1) Then
- Debug.WriteLine("The values are the same to one digit of precision.");
- </code>
- <code lang="CS" title="[New Example]">
- // Equals will return False
- Azimuth Azimuth1 = new Azimuth(90.15);
- Azimuth Azimuth2 = new Azimuth(90.12);
- if (Azimuth1.Equals(Azimuth2, 2))
- Console.WriteLine("The values are the same to two digits of precision.");
- // Equals will return True
- Azimuth Azimuth1 = new Azimuth(90.15);
- Azimuth Azimuth2 = new Azimuth(90.12);
- if (Azimuth1.Equals(Azimuth2, 1))
- Console.WriteLine("The values are the same to one digits of precision.");
- </code>
- </example>
- <remarks><para>This is typically used in cases where precision is only significant for a few
- digits and exact comparison is not necessary.</para>
- <para><em>NOTE: This method compares objects by value, not by
- reference.</em></para></remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.Equals(DotSpatial.Positioning.Azimuth)">
- <summary>
- Equalses the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.Equals(DotSpatial.Positioning.Direction)">
- <summary>
- Compares the current instance to the specified compass direction.
- </summary>
- <param name="value">A <strong>Direction</strong> value to compare with the current instance.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the current instance's
- Direction property matches the specified value.</returns>
- <remarks>This method is typically used to approximate if two directions are equivalent.
- For example, if two objects are traveling at a bearing of 41° and 46°, they both could
- be considered to be traveling Northeast even though their bearings are not precisely
- the same.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.ToString(System.String,System.IFormatProvider)">
- <summary>
- Outputs the azimuth as a string using the specified format.
- </summary>
- <param name="format"><para>A <strong>String</strong> consisting of any number of the following
- codes:</para>
- <para>
- <list type="table">
- <item>
- <term><strong>c</strong></term>
- <description>The object is output as an abbreviated direction.
- <strong>N</strong>, <strong>NE</strong>,
- <strong>NNW</strong></description>
- </item>
- <item>
- <term><strong>cc</strong></term>
- <description>The object is output as a full direction.
- <strong>North</strong>, <strong>Northeast</strong>,
- <strong>North-Northwest</strong></description>
- </item>
- <item>
- <term><strong>d</strong></term>
- <description>Represents one digit from the
- <strong>DecimalDegrees</strong> property.</description>
- </item>
- <item>
- <term><strong>h</strong></term>
- <description>Represents one digit from the
- <strong>Hours</strong> property.</description>
- </item>
- <item>
- <term><strong>m</strong></term>
- <description>Represents one digit from the <strong>Minutes</strong>
- property.</description>
- </item>
- <item>
- <term><strong>s</strong></term>
- <description>Represents one digit from the <strong>Seconds</strong>
- property.</description>
- </item>
- </list>
- </para></param>
- <param name="formatProvider">A <strong>CultureInfo</strong> object used to properly format numeric
- information.</param>
- <returns>A <strong>String</strong> in the specified format.</returns>
- <seealso cref="M:DotSpatial.Positioning.Azimuth.ToString">ToString Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Azimuth.Parse(System.String)">Parse Method</seealso>
-
- <example>
- This example uses the <strong>ToString</strong> method to output an azimuth in a
- custom format. The " <strong>d.dd</strong> " code represents decimal degrees
- rounded to two digits, and " <strong>cc</strong> " represents the direction in
- verbose form.
- <code lang="VB">
- Dim MyAzimuth As New Azimuth(90.946)
- Debug.WriteLine(MyAzimuth.ToString("d.dd (cc)", CultureInfo.CurrentCulture))
- ' Output: 90.95 (East)
- </code>
- <code lang="CS">
- Azimuth MyAzimuth = new Azimuth(90.946);
- Console.WriteLine(MyAzimuth.ToString("d.dd (cc)", CultureInfo.CurrentCulture));
- // Output: 90.95 (East)
- </code>
- </example>
- <remarks>This method returns the current instance output in a specific format. If no
- value for the format is specified, a default format of "cc" is used. Any string
- output by this method can be converted back into an Azimuth object using the
- <strong>Parse</strong> method or <strong>Azimuth(string)</strong>
- constructor.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.System#Xml#Serialization#IXmlSerializable#GetSchema">
- <summary>
- This method is reserved and should not be used. When implementing the IXmlSerializable interface, you should return null (Nothing in Visual Basic) from this method, and instead, if specifying a custom schema is required, apply the <see cref="T:System.Xml.Serialization.XmlSchemaProviderAttribute"/> to the class.
- </summary>
- <returns>An <see cref="T:System.Xml.Schema.XmlSchema"/> that describes the XML representation of the object that is produced by the <see cref="M:System.Xml.Serialization.IXmlSerializable.WriteXml(System.Xml.XmlWriter)"/> method and consumed by the <see cref="M:System.Xml.Serialization.IXmlSerializable.ReadXml(System.Xml.XmlReader)"/> method.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.WriteXml(System.Xml.XmlWriter)">
- <summary>
- Converts an object into its XML representation.
- </summary>
- <param name="writer">The <see cref="T:System.Xml.XmlWriter"/> stream to which the object is serialized.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Azimuth.ReadXml(System.Xml.XmlReader)">
- <summary>
- Generates an object from its XML representation.
- </summary>
- <param name="reader">The <see cref="T:System.Xml.XmlReader"/> stream from which the object is deserialized.</param>
- </member>
- <member name="P:DotSpatial.Positioning.Azimuth.DecimalDegrees">
- <summary>
- Returns the value of the angle as decimal degrees.
- </summary>
- <value>A <strong>Double</strong> value.</value>
- <seealso cref="P:DotSpatial.Positioning.Azimuth.Hours">Hours Property</seealso>
-
- <seealso cref="P:DotSpatial.Positioning.Azimuth.Minutes">Minutes Property</seealso>
-
- <seealso cref="P:DotSpatial.Positioning.Azimuth.Seconds">Seconds Property</seealso>
-
- <example>
- This example demonstrates how the
- <see cref="P:DotSpatial.Positioning.Azimuth.DecimalDegrees"><strong>DecimalDegrees</strong></see> property is
- calculated automatically when creating an angle using hours, minutes and seconds.
- <code lang="VB">
- ' Create an angle of 20°30'
- Dim MyAzimuth As New Azimuth(20, 30)
- ' Setting the DecimalMinutes recalculated other properties
- Debug.WriteLine(MyAzimuth.DecimalDegrees)
- ' Output: "20.5" the same as 20°30'
- </code>
- <code lang="CS">
- // Create an angle of 20°30'
- Azimuth MyAzimuth = New Azimuth(20, 30);
- // Setting the DecimalMinutes recalculated other properties
- Console.WriteLine(MyAzimuth.DecimalDegrees)
- // Output: "20.5" the same as 20°30'
- </code>
- </example>
- <remarks>This property returns the value of the angle as a single number.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Azimuth.DecimalMinutes">
- <summary>
- Returns the minutes and seconds as a single numeric value.
- </summary>
- <value>A <strong>Double</strong> value.</value>
- <seealso cref="P:DotSpatial.Positioning.Azimuth.Minutes">Minutes Property</seealso>
-
- <seealso cref="P:DotSpatial.Positioning.Azimuth.DecimalDegrees">DecimalDegrees Property</seealso>
-
- <example>
- This example demonstrates how the <strong>DecimalMinutes</strong> property is
- automatically calculated when creating a new angle.
- <code lang="VB">
- ' Create an angle of 20°10'30"
- Dim MyAzimuth As New Azimuth(20, 10, 30)
- ' The DecimalMinutes property is automatically calculated
- Debug.WriteLine(MyAzimuth.DecimalMinutes)
- ' Output: "10.5"
- </code>
- <code lang="CS">
- // Create an angle of 20°10'30"
- Azimuth MyAzimuth = new Azimuth(20, 10, 30);
- // The DecimalMinutes property is automatically calculated
- Console.WriteLine(MyAzimuth.DecimalMinutes)
- // Output: "10.5"
- </code>
- </example>
- <remarks>This property is used when minutes and seconds are represented as a single
- decimal value.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Azimuth.Hours">
- <summary>
- Returns the integer hours (degrees) portion of an angular
- measurement.
- </summary>
- <value>An <strong>Integer</strong> value.</value>
- <seealso cref="P:DotSpatial.Positioning.Azimuth.Minutes">Minutes Property</seealso>
-
- <seealso cref="P:DotSpatial.Positioning.Azimuth.Seconds">Seconds Property</seealso>
-
- <example>
- This example creates an angle of 60.5° then outputs the value of the
- <strong>Hours</strong> property, 60.
- <code lang="VB">
- Dim MyAzimuth As New Azimuth(60.5)
- Debug.WriteLine(MyAzimuth.Hours)
- ' Output: 60
- </code>
- <code lang="CS">
- Azimuth MyAzimuth = new Azimuth(60.5);
- Console.WriteLine(MyAzimuth.Hours);
- // Output: 60
- </code>
- </example>
- <remarks>This property is used in conjunction with the <see cref="P:DotSpatial.Positioning.Azimuth.Minutes">Minutes</see>
- and <see cref="P:DotSpatial.Positioning.Azimuth.Seconds">Seconds</see> properties to create a full angular measurement.
- This property is the same as <strong>DecimalDegrees</strong> without any fractional
- value.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Azimuth.Minutes">
- <summary>
- Returns the integer minutes portion of an angular measurement.
- </summary>
- <value>An <strong>Integer</strong>.</value>
- <seealso cref="P:DotSpatial.Positioning.Azimuth.Hours">Hours Property</seealso>
-
- <seealso cref="P:DotSpatial.Positioning.Azimuth.Seconds">Seconds Property</seealso>
-
- <example>
- This example creates an angle of 45.5° then outputs the value of the
- <strong>Minutes</strong> property, 30.
- <code lang="VB">
- Dim MyAzimuth As New Azimuth(45.5)
- Debug.WriteLine(MyAzimuth.Minutes)
- ' Output: 30
- </code>
- <code lang="CS">
- Azimuth MyAzimuth = new Azimuth(45.5);
- Console.WriteLine(MyAzimuth.Minutes);
- // Output: 30
- </code>
- </example>
- <remarks>This property is used in conjunction with the <see cref="P:DotSpatial.Positioning.Azimuth.Hours">Hours</see> and
- <see cref="P:DotSpatial.Positioning.Azimuth.Seconds">Seconds</see> properties to create a sexagesimal
- measurement.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Azimuth.Seconds">
- <summary>
- Returns the seconds minutes portion of an angular measurement.
- </summary>
- <value>A <strong>Double</strong> value.</value>
- <seealso cref="P:DotSpatial.Positioning.Azimuth.Hours">Hours Property</seealso>
-
- <seealso cref="P:DotSpatial.Positioning.Azimuth.Minutes">Minutes Property</seealso>
-
- <example>
- This example creates an angle of 45°10.5' then outputs the value of the
- <strong>Seconds</strong> property, 30.
- <code lang="VB">
- Dim MyAzimuth As New Azimuth(45, 10.5)
- Debug.WriteLine(MyAzimuth.Seconds)
- ' Output: 30
- </code>
- <code lang="CS">
- Dim MyAzimuth As New Azimuth(45, 10.5);
- Console.WriteLine(MyAzimuth.Seconds);
- // Output: 30
- </code>
- </example>
- <remarks>This property is used in conjunction with the <see cref="P:DotSpatial.Positioning.Azimuth.Hours">Hours</see> and
- <see cref="P:DotSpatial.Positioning.Azimuth.Minutes">Minutes</see> properties to create a sexagesimal
- measurement.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Azimuth.Direction">
- <summary>
- Returns the current instance expressed as a compass direction.
- </summary>
- <value>A <strong>Direction</strong> value.</value>
- <example>
- This example outputs the direction associated 272°, which is <strong>West</strong>.
- <code lang="VB">
- Dim MyAzimuth As New Azimuth(272)
- Debug.WriteLine(MyAzimuth.Direction.ToString())
- ' Output: West
- </code>
- <code lang="CS">
- Azimuth MyAzimuth = new Azimuth(272);
- Console.WriteLine(MyAzimuth.Direction.ToString());
- // Output: West
- </code>
- </example>
- <remarks>This property converts an azimuth to the nearest of sixteen compass directions.
- For example, an azimuth of 89° points almost east, therefore a value of
- <strong>East</strong> would be returned. This property is typically used for user
- interfaces to express an azimuth in a form that is easy to understand.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Azimuth.IsEmpty">
- <summary>
- Indicates if the current instance has a non-zero value.
- </summary>
- <value>A <strong>Boolean</strong>, <strong>True</strong> if the
- <strong>DecimalDegrees</strong> property is zero.</value>
- <seealso cref="F:DotSpatial.Positioning.Azimuth.Empty">Empty Field</seealso>
- </member>
- <member name="P:DotSpatial.Positioning.Azimuth.IsInfinity">
- <summary>
- Indicates if the current instance represents an infinite value.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Azimuth.IsInvalid">
- <summary>
- Indicates whether the value is invalid or unspecified.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Azimuth.IsNormalized">
- <summary>
- Indicates whether the value has been normalized and is within the
- allowed bounds of 0° and 360°.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.Direction">
- <summary>
- Represents an approximate direction of motion.
- </summary>
- <example>
- This example outputs the direction associated 272°, which is <strong>West</strong>
- .
- <code lang="VB" title="[New Example]">
- Dim MyAzimuth As New Azimuth(272)
- Debug.WriteLine(MyAzimuth.Direction.ToString())
- ' Output: West
- </code>
- <code lang="CS" title="[New Example]">
- Azimuth MyAzimuth = new Azimuth(272);
- Console.WriteLine(MyAzimuth.Direction.ToString());
- // Output: West
- </code>
- </example>
- <remarks>This enumeration is used primarily by the <strong>Azimuth</strong> class when
- converting a numeric angle measurement into a compass direction.</remarks>
- </member>
- <member name="F:DotSpatial.Positioning.Direction.North">
- <summary>An azimuth of approximately 0°</summary>
- </member>
- <member name="F:DotSpatial.Positioning.Direction.NorthNortheast">
- <summary>Between north and northeast</summary>
- </member>
- <member name="F:DotSpatial.Positioning.Direction.Northeast">
- <summary>Between north and east</summary>
- </member>
- <member name="F:DotSpatial.Positioning.Direction.EastNortheast">
- <summary>Between east and northeast</summary>
- </member>
- <member name="F:DotSpatial.Positioning.Direction.East">
- <summary>An azimuth of approximately 90°</summary>
- </member>
- <member name="F:DotSpatial.Positioning.Direction.EastSoutheast">
- <summary>Between east and southeast</summary>
- </member>
- <member name="F:DotSpatial.Positioning.Direction.Southeast">
- <summary>Between south and east</summary>
- </member>
- <member name="F:DotSpatial.Positioning.Direction.SouthSoutheast">
- <summary>Between south and southeast</summary>
- </member>
- <member name="F:DotSpatial.Positioning.Direction.South">
- <summary>An azimuth of approximately 180°</summary>
- </member>
- <member name="F:DotSpatial.Positioning.Direction.SouthSouthwest">
- <summary>Between south and southwest</summary>
- </member>
- <member name="F:DotSpatial.Positioning.Direction.Southwest">
- <summary>Between south and west</summary>
- </member>
- <member name="F:DotSpatial.Positioning.Direction.WestSouthwest">
- <summary>Between west and southwest</summary>
- </member>
- <member name="F:DotSpatial.Positioning.Direction.West">
- <summary>An azimuth of approximately 270°</summary>
- </member>
- <member name="F:DotSpatial.Positioning.Direction.WestNorthwest">
- <summary>Between west and northwest</summary>
- </member>
- <member name="F:DotSpatial.Positioning.Direction.Northwest">
- <summary>Between north and west</summary>
- </member>
- <member name="F:DotSpatial.Positioning.Direction.NorthNorthwest">
- <summary>Between north and northwest</summary>
- </member>
- <member name="T:DotSpatial.Positioning.BinaryPacket">
- <summary>
- Represents a base class for designing GPS packets which store binary data.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.Packet">
- <summary>
- Represents a base class for designing GPS data packets.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Packet.ToByteArray">
- <summary>
- Converts the packet into an array of bytes.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Packet.ToString">
- <summary>
- Returns a string representation of the packet
- </summary>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Packet.ToString(System.String,System.IFormatProvider)">
- <summary>
- Returns a string representing the packet
- </summary>
- <param name="format">The format to use.-or- A null reference (Nothing in Visual Basic) to use the default format defined for the type of the <see cref="T:System.IFormattable"/> implementation.</param>
- <param name="formatProvider">The provider to use to format the value.-or- A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.</param>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="P:DotSpatial.Positioning.Packet.IsValid">
- <summary>
- Returns whether the pack data is well-formed.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.BinaryPacket._data">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.BinaryPacket.#ctor">
- <summary>
- Creates a BinaryPacket
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.BinaryPacket.#ctor(System.Int32)">
- <summary>
- BinaryPacket with the specified capacity
- </summary>
- <param name="capacity">The capacity.</param>
- </member>
- <member name="M:DotSpatial.Positioning.BinaryPacket.#ctor(System.Collections.Generic.IEnumerable{System.Byte})">
- <summary>
- Creates a BinaryPacket from an IEnumerable
- </summary>
- <param name="bytes">The bytes.</param>
- </member>
- <member name="M:DotSpatial.Positioning.BinaryPacket.IndexOf(System.Byte)">
- <summary>
- Returns the index of the specified byte
- </summary>
- <param name="item">The object to locate in the <see cref="T:System.Collections.Generic.IList`1"/>.</param>
- <returns>The index of <paramref name="item"/> if found in the list; otherwise, -1.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.BinaryPacket.Insert(System.Int32,System.Byte)">
- <summary>
- Inserts a byte at the specified index
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The object to insert into the <see cref="T:System.Collections.Generic.IList`1"/>.</param>
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="index"/> is not a valid index in the <see cref="T:System.Collections.Generic.IList`1"/>.
- </exception>
-
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:System.Collections.Generic.IList`1"/> is read-only.
- </exception>
- </member>
- <member name="M:DotSpatial.Positioning.BinaryPacket.RemoveAt(System.Int32)">
- <summary>
- Removes the <see cref="T:System.Collections.Generic.IList`1"/> item at the specified index.
- </summary>
- <param name="index">The zero-based index of the item to remove.</param>
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="index"/> is not a valid index in the <see cref="T:System.Collections.Generic.IList`1"/>.
- </exception>
-
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:System.Collections.Generic.IList`1"/> is read-only.
- </exception>
- </member>
- <member name="M:DotSpatial.Positioning.BinaryPacket.Add(System.Byte)">
- <summary>
- Adds an item to the <see cref="T:System.Collections.Generic.ICollection`1"/>.
- </summary>
- <param name="item">The object to add to the <see cref="T:System.Collections.Generic.ICollection`1"/>.</param>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:System.Collections.Generic.ICollection`1"/> is read-only.
- </exception>
- </member>
- <member name="M:DotSpatial.Positioning.BinaryPacket.Clear">
- <summary>
- Removes all items from the <see cref="T:System.Collections.Generic.ICollection`1"/>.
- </summary>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:System.Collections.Generic.ICollection`1"/> is read-only.
- </exception>
- </member>
- <member name="M:DotSpatial.Positioning.BinaryPacket.Contains(System.Byte)">
- <summary>
- Determines whether the <see cref="T:System.Collections.Generic.ICollection`1"/> contains a specific value.
- </summary>
- <param name="item">The object to locate in the <see cref="T:System.Collections.Generic.ICollection`1"/>.</param>
- <returns>true if <paramref name="item"/> is found in the <see cref="T:System.Collections.Generic.ICollection`1"/>; otherwise, false.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.BinaryPacket.CopyTo(System.Byte[],System.Int32)">
- <summary>
- Copies to.
- </summary>
- <param name="array">The array.</param>
- <param name="arrayIndex">Index of the array.</param>
- </member>
- <member name="M:DotSpatial.Positioning.BinaryPacket.Remove(System.Byte)">
- <summary>
- Removes the first occurrence of a specific object from the <see cref="T:System.Collections.Generic.ICollection`1"/>.
- </summary>
- <param name="item">The object to remove from the <see cref="T:System.Collections.Generic.ICollection`1"/>.</param>
- <returns>true if <paramref name="item"/> was successfully removed from the <see cref="T:System.Collections.Generic.ICollection`1"/>; otherwise, false. This method also returns false if <paramref name="item"/> is not found in the original <see cref="T:System.Collections.Generic.ICollection`1"/>.</returns>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:System.Collections.Generic.ICollection`1"/> is read-only.
- </exception>
- </member>
- <member name="M:DotSpatial.Positioning.BinaryPacket.GetEnumerator">
- <summary>
- Returns an enumerator that iterates through the collection.
- </summary>
- <returns>A <see cref="T:System.Collections.Generic.IEnumerator`1"/> that can be used to iterate through the collection.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.BinaryPacket.System#Collections#IEnumerable#GetEnumerator">
- <summary>
- Returns an enumerator that iterates through a collection.
- </summary>
- <returns>An <see cref="T:System.Collections.IEnumerator"/> object that can be used to iterate through the collection.</returns>
- </member>
- <member name="P:DotSpatial.Positioning.BinaryPacket.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <returns>
- The element at the specified index.
- </returns>
-
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="index"/> is not a valid index in the <see cref="T:System.Collections.Generic.IList`1"/>.
- </exception>
-
- <exception cref="T:System.NotSupportedException">
- The property is set and the <see cref="T:System.Collections.Generic.IList`1"/> is read-only.
- </exception>
- </member>
- <member name="P:DotSpatial.Positioning.BinaryPacket.Count">
- <summary>
- Gets the number of elements contained in the <see cref="T:System.Collections.Generic.ICollection`1"/>.
- </summary>
- <returns>
- The number of elements contained in the <see cref="T:System.Collections.Generic.ICollection`1"/>.
- </returns>
- </member>
- <member name="P:DotSpatial.Positioning.BinaryPacket.IsReadOnly">
- <summary>
- Gets a value indicating whether the <see cref="T:System.Collections.Generic.ICollection`1"/> is read-only.
- </summary>
- <returns>true if the <see cref="T:System.Collections.Generic.ICollection`1"/> is read-only; otherwise, false.
- </returns>
- </member>
- <member name="T:DotSpatial.Positioning.BluetoothAddress">
- <summary>
- Represents an address used to identify a unique Bluetooth device.
- </summary>
- <remarks>Each Bluetooth device has a unique address, in the form of a six-byte address.</remarks>
- </member>
- <member name="F:DotSpatial.Positioning.BluetoothAddress._bytes">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothAddress.#ctor(System.Byte[])">
- <summary>
- Creates a new instance from the specified byte array.
- </summary>
- <param name="address">The address.</param>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothAddress.#ctor(System.UInt64)">
- <summary>
- Creates a new instance using the specified unsigned 64-bit integer.
- </summary>
- <param name="address">The address.</param>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothAddress.#ctor(System.Int64)">
- <summary>
- Creates a new instance using the specified 64-bit integer.
- </summary>
- <param name="address">The address.</param>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothAddress.#ctor(System.String)">
- <summary>
- Creates a new instance using the specified string.
- </summary>
- <param name="address">The address.</param>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothAddress.ToInt64">
- <summary>
- Returns the address as a 64-bit integer.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothAddress.GetHashCode">
- <summary>
- Returns a hash code for this instance.
- </summary>
- <returns>A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothAddress.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
- </summary>
- <param name="obj">Another object to compare to.</param>
- <returns><c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothAddress.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothAddress.Parse(System.String)">
- <summary>
- Converts the specified string into an address.
- </summary>
- <param name="address">The address.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothAddress.op_Explicit(System.String)~DotSpatial.Positioning.BluetoothAddress">
- <summary>
- Bluetooth Address
- </summary>
- <param name="address">The address.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothAddress.op_Explicit(System.Int64)~DotSpatial.Positioning.BluetoothAddress">
- <summary>
- Bluetooth address
- </summary>
- <param name="address">The address.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothAddress.op_Explicit(System.UInt64)~DotSpatial.Positioning.BluetoothAddress">
- <summary>
- Bluetooth address
- </summary>
- <param name="address">The address.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothAddress.op_Explicit(DotSpatial.Positioning.BluetoothAddress)~System.String">
- <summary>
- Bluetooth address
- </summary>
- <param name="address">The address.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothAddress.ToString(System.String,System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format to use.-or- A null reference (Nothing in Visual Basic) to use the default format defined for the type of the <see cref="T:System.IFormattable"/> implementation.</param>
- <param name="formatProvider">The provider to use to format the value.-or- A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.</param>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothAddress.Equals(DotSpatial.Positioning.BluetoothAddress)">
- <summary>
- Indicates whether the current object is equal to another object of the same type.
- </summary>
- <param name="other">An object to compare with this object.</param>
- <returns>true if the current object is equal to the <paramref name="other"/> parameter; otherwise, false.</returns>
- </member>
- <member name="P:DotSpatial.Positioning.BluetoothAddress.Address">
- <summary>
- Returns the bytes of the address.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.BluetoothDevice">
- <summary>
- Represents a service on a Bluetooth(tm) device.
- </summary>
- <remarks>Bluetooth GPS devices often provide access to data using sockets. In order to establish a connection
- to a Bluetooth GPS device,</remarks>
- </member>
- <member name="T:DotSpatial.Positioning.NetworkDevice">
- <summary>
- Represents a GPS device which is accessed via a socket connection.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.Device">
- <summary>
- Represents a device on the local machine.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Device.DEFAULT_REGISTRY_VALUE_NAME">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Device._allowConnections">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Device._isGpsDevice">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Device._isDetectionCompleted">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Device._isOpen">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Device._successfulDetectionCount">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Device._failedDetectionCount">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Device._dateDetected">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Device._dateConnected">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Device._connectionStarted">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Device._connectionTime">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Device._baseStream">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Device._detectionThread">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Device._detectionStartedWaitHandle">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Device._detectionCompleteWaitHandle">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Device._syncRoot">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Device._defaultReadTimeout">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Device._defaultWriteTimeout">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Device.Finalize">
- <summary>
- Releases unmanaged resources and performs other cleanup operations before the <see cref="T:DotSpatial.Positioning.Device"/> is reclaimed by garbage collection.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Device.OnConnecting">
- <summary>
- Occurs when a connection is about to be attempted.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Device.OnConnected">
- <summary>
- Occurs when a connection has been successfully established.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Device.OnDisconnecting">
- <summary>
- Occurs when an open connection is about to be closed.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Device.OnDisconnected">
- <summary>
- Occurs when an open connection has been successfully closed.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Device.SetDateConnected(System.DateTime)">
- <summary>
- Updates the date a connection was last opened.
- </summary>
- <param name="date">The date.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Device.SetDateDetected(System.DateTime)">
- <summary>
- Updates the date the device was last confirmed as a GPS device.
- </summary>
- <param name="date">The date.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Device.SetTotalConnectionTime(System.TimeSpan)">
- <summary>
- Updates the total time spent connecting to this device.
- </summary>
- <param name="time">The time.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Device.SetFailedDetectionCount(System.Int32)">
- <summary>
- Updates the number of times detection has failed.
- </summary>
- <param name="count">The count.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Device.SetSuccessfulDetectionCount(System.Int32)">
- <summary>
- Updates the number of times detection has succeeded.
- </summary>
- <param name="count">The count.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Device.OpenStream(System.IO.FileAccess,System.IO.FileShare)">
- <summary>
- Creates a new Stream object for the device.
- </summary>
- <param name="access">The access.</param>
- <param name="sharing">The sharing.</param>
- <returns>A <strong>Stream</strong> object.</returns>
- <remarks>Developers who design their own GPS device classes will need to override this method and use it to establish
- a new connection. This method is called by the <strong>Open</strong> method. The <strong>Stream</strong> returned by
- this method will be assigned to the <strong>BaseStream</strong> property, it it will be used for all device communications,
- including GPS protocol detection.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Device.OnCacheWrite">
- <summary>
- Records information about this device to the registry.
- </summary>
- <remarks>In order to organize and maximize performance of GPS device detection, information about devices
- is saved to the registry. This method, when overridden, serializes the device to the registry. All registry
- keys should be saved under the branch <strong>HKLM\Software\DotSpatial.Positioning\GPS.NET\3.0\Devices\[Type]\[ID]</strong>, where
- <strong>[Type]</strong> is the name of the technology used by the device (e.g. Serial, Bluetooth, etc.), and <strong>[ID]</strong>
- is a unique ID for the device (e.g. "COM3", an address, etc.). Enough information should be written to be able to
- establish a connection to the device after reading registry values.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Device.OnCacheRead">
- <summary>
- Reads information about this device from the registry.
- </summary>
- <remarks>In order to organize and maximize performance of GPS device detection, information about devices
- is saved to the registry. This method, when overridden, reads information for this device from the registry. All registry
- values should have been previously saved via the <strong>OnCacheWrite</strong> method.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Device.OnCacheRemove">
- <summary>
- Removes previously cached information for this device from the registry.
- </summary>
- <remarks>In some cases, the information about previously detected devices may interfere with system changes such as adding
- a replacement GPS device. This method will remove the entire registry key for a device, causing GPS.NET 3.0 to start over when
- GPS devices need to be detected.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Device.DetectProtocol">
- <summary>
- Performs a test on the device to confirm that it transmits GPS data.
- </summary>
- <returns>A <strong>Boolean</strong> value, <strong>True</strong> if the device is confirmed.</returns>
- <remarks><para>This method will open a connection if necessary via the <strong>Open</strong> method, then proceed to
- examine it for GPS data. This method will always be called on a separate thread to keep detection from slowing
- down or blocking the main application.</para>
- <para>Developers who override this method should ensure that the method can clean up any resources used, even if a
- ThreadAbortException is raised, as a result of the detection thread being aborted. This can be done by wrapping all code in a
- <strong>try..catch</strong> block, and placing all clean-up code in a <strong>finally</strong> block.</para></remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Device.Open">
- <summary>
- Opens a new connection to the device.
- </summary>
- <remarks>This method will create a new connection to the device. The connection will be created in the form of a
- <strong>Stream</strong> object. If a connection is already open, this method has no effect.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Device.Open(System.IO.FileAccess,System.IO.FileShare)">
- <summary>
- Opens a new connection to the device.
- </summary>
- <param name="access">The access.</param>
- <param name="sharing">The sharing.</param>
- <remarks>This method will create a new connection to the device. The connection will be created in the form of a
- <strong>Stream</strong> object. If a connection is already open, this method has no effect.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Device.Reset">
- <summary>
- Forces a device to a closed state without disposing the underlying stream.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Device.Undetect">
- <summary>
- Cancels detection and removes any cached information about the device.
- Use the <see cref="M:DotSpatial.Positioning.Device.BeginDetection"/> method to re-detect the device and re-add it to the device cache.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Device.Test">
- <summary>
- Performs an analysis of the device and its capabilities.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Device.BeginDetection">
- <summary>
- Starts a new thread which checks the device for GPS data in the background.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Device.Close">
- <summary>
- Closes any open connection to the device.
- </summary>
- <remarks>This method will close any open connection to the device. Any associated <strong>Stream</strong> object
- will be disposed. If no open connection exists, this method has no effect. This method is called automatically
- when the device is disposed, either manually or automatically via the finalizer.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Device.WaitForDetection">
- <summary>
- Waits for the device to be checked for GPS data.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Device.WaitForDetection(System.TimeSpan)">
- <summary>
- Waits for the device to be checked for GPS data, up to the specified timeout period.
- </summary>
- <param name="timeout">The timeout.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Device.CancelDetection">
- <summary>
- Stops any GPS protocol detection in progress.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Device.DetectionThreadProc">
- <summary>
- Detections the thread proc.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Device.SetIsGpsDevice(System.Boolean)">
- <summary>
- Sets the is GPS device.
- </summary>
- <param name="value">if set to <c>true</c> [value].</param>
- </member>
- <member name="M:DotSpatial.Positioning.Device.PrecisionEstimate(DotSpatial.Positioning.FixQuality)">
- <summary>
- Esitmates device prcision based on the fix quality.
- </summary>
- <param name="quality">The current fix quality of a device or emulation</param>
- <returns>The estimated error of latitude/longitude coordinates attributed to the device.</returns>
- <remarks>If a the fix quality is unknown or NoFix, this method returns the value stored
- in the DillutionOfPrecision.CurrentAverageDevicePrecision property.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Device.BestDeviceComparer(DotSpatial.Positioning.Device,DotSpatial.Positioning.Device)">
- <summary>
- Compares two devices for the purpose of finding the device most likely to provide a successful connection.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>An <strong>Integer</strong> value.</returns>
- <remarks>This method is used during <strong>Sort</strong> methods to choose the device most likely to respond.
- The date the device last successfully opened a connection is examined, along with historical connection statistics.
- The "best" device is the device which has most recently opened a connection successfully, with the fewest amount of
- connection failures.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Device.Dispose">
- <summary>
- Disposes of any managed or unmanaged resources used by the device.
- </summary>
- <remarks>Since the <strong>Device</strong> class implements the <strong>IDisposable</strong> interface, all managed or
- unmanaged resources used by the class will be disposed. Any open connection will be closed. The <strong>Dispose</strong>
- method is also called (if necessary) during the finalizer for this class.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Device.Dispose(System.Boolean)">
- <summary>
- Disposes of any unmanaged (or optionally, managed) resources used by the device.
- </summary>
- <param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
- <remarks>This method is called when the object is no longer needed. Typically, this happens during the shutdown of the parent
- application. If device detection is in progress, it will be immediately cancelled. If any connection is open, it will immediately
- be closed and disposed. This method is called via the finalizer if necessary, thus removing the need for explicit calls. Developers
- who prefer to call this method explicitly, however, may do so.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Device.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Device.ToString(System.String,System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format to use.-or- A null reference (Nothing in Visual Basic) to use the default format defined for the type of the <see cref="T:System.IFormattable"/> implementation.</param>
- <param name="formatProvider">The provider to use to format the value.-or- A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.</param>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Device.CompareTo(DotSpatial.Positioning.Device)">
- <summary>
- Compares two devices for the purpose of finding the device most likely to provide a successful connection.
- </summary>
- <param name="other">An object to compare with this object.</param>
- <returns>An <strong>Integer</strong> value.</returns>
- <remarks>This method is used during <strong>Sort</strong> methods to choose the device most likely to respond.
- The date the device last successfully opened a connection is examined, along with historical connection statistics.
- The "best" device is the device which has most recently opened a connection successfully, with the fewest amount of
- connection failures.</remarks>
- </member>
- <member name="E:DotSpatial.Positioning.Device.Connecting">
- <summary>
- Occurs when a connection is about to be opened.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Device.Connected">
- <summary>
- Occurs when a new connection has opened successfully.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Device.Disconnecting">
- <summary>
- Occurs when an open connection is about to be closed.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Device.Disconnected">
- <summary>
- Occurs when an open connection has been closed.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Device.Name">
- <summary>
- Returns a natural language name for the device.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Device.DetectionWaitHandle">
- <summary>
- Returns a reset event used to determine when GPS detection has completed.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Device.IsOpen">
- <summary>
- Returns whether a connection is established with the device.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Device.BaseStream">
- <summary>
- Returns the stream associated with this device.
- </summary>
- <remarks>This property is provided solely for more advanced developers who need to interact directly with a device.
- During normal operations, the stream returned by this property is managed by this class. As a result, it is not necessary
- to dispose of this stream. If no connection is open, this property will return <strong>null</strong>.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Device.DateDetected">
- <summary>
- Returns the date and time the device was last confirmed as a GPS device.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Device.DateConnected">
- <summary>
- Returns the date and time the device last opened a connection.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Device.IsDetectionInProgress">
- <summary>
- Returns whether the device is currently being examined for GPS data.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Device.AllowConnections">
- <summary>
- Controls whether the device can be queried for GPS data.
- </summary>
- <value><c>true</c> if [allow connections]; otherwise, <c>false</c>.</value>
- <remarks>In some cases, an attempt to open a connection to a device can cause problems. For example,
- a serial port may be assigned to a barcode reader, or a Bluetooth device may represent a downstairs neighbor's
- computer. This property allows a device to be left alone; no connection will be attempted to the device
- for any reason.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Device.IsDetectionCompleted">
- <summary>
- Returns whether GPS protocol detection has been completed.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Device.IsGpsDevice">
- <summary>
- Returns whether the device has been confirmed as a GPS device.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Device.SuccessfulDetectionCount">
- <summary>
- Controls the number of times this device has been confirmed as a GPS device.
- </summary>
- <remarks>In order to maximize the performance of detecting GPS devices, statistics are maintained for each device. This
- property indicates how many times the device has been confirmed as a GPS device. It will be incremented automatcially if
- a call to <strong>DetectProtocol</strong> has been successful.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Device.FailedDetectionCount">
- <summary>
- Controls the number of times this device has failed to identify itself as a GPS device.
- </summary>
- <remarks>In order to prioritize and maximize performance of GPS device detection, statistics are kept for each device.
- These statistics control how detection is performed in the future. For example, a device with a success rate of 100 and a failure
- rate of 1 would be tested before a device with a success rate of zero. This property is updated automatically based on the
- results of a call to <strong>DetectProtocol</strong>.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Device.Reliability">
- <summary>
- Returns the chance that a connection to the device will be successful.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Device.AverageConnectionTime">
- <summary>
- Returns the average amount of time required to open a connection.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Device.TotalConnectionTime">
- <summary>
- Returns the total amount of time spent so far opening a connection.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Device.DefaultReadTimeout">
- <summary>
- Controls the amount of time to wait before aborting a read operation.
- </summary>
- <value>The default read timeout.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Device.DefaultWriteTimeout">
- <summary>
- Controls the amount of time to wait before aborting a write operation.
- </summary>
- <value>The default write timeout.</value>
- </member>
- <member name="F:DotSpatial.Positioning.NetworkDevice.ROOT_KEY_NAME">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NetworkDevice._addressFamily">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NetworkDevice._socketType">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NetworkDevice._protocolType">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NetworkDevice._endPoint">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NetworkDevice._socket">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NetworkDevice._defaultConnectTimeout">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.NetworkDevice.#ctor(System.Net.Sockets.AddressFamily,System.Net.Sockets.SocketType,System.Net.Sockets.ProtocolType)">
- <summary>
- Creates a NetworkDevice from the specified parameters
- </summary>
- <param name="addressFamily">The address family.</param>
- <param name="socketType">Type of the socket.</param>
- <param name="protocolType">Type of the protocol.</param>
- </member>
- <member name="M:DotSpatial.Positioning.NetworkDevice.#ctor(System.Net.Sockets.AddressFamily,System.Net.Sockets.SocketType,System.Net.Sockets.ProtocolType,System.Net.EndPoint)">
- <summary>
- Creates a NetworkDevice from the specified parameters
- </summary>
- <param name="addressFamily">The address family.</param>
- <param name="socketType">Type of the socket.</param>
- <param name="protocolType">Type of the protocol.</param>
- <param name="endPoint">The end point.</param>
- </member>
- <member name="M:DotSpatial.Positioning.NetworkDevice.Open(System.Net.EndPoint)">
- <summary>
- Creates a new connection to the specified endpoint.
- </summary>
- <param name="endPoint">The end point.</param>
- </member>
- <member name="M:DotSpatial.Positioning.NetworkDevice.OnConfigureSocket">
- <summary>
- Occurs immediately before a socket is opened.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.NetworkDevice.OpenStream(System.IO.FileAccess,System.IO.FileShare)">
- <summary>
- Creates a new Stream object for the device.
- </summary>
- <param name="access">The access.</param>
- <param name="sharing">The sharing.</param>
- <returns>A <strong>Stream</strong> object.</returns>
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.NetworkDevice.Dispose(System.Boolean)">
- <summary>
- Disposes of any unmanaged (or optionally, managed) resources used by the device.
- </summary>
- <param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
- </member>
- <member name="M:DotSpatial.Positioning.NetworkDevice.OnCacheRemove">
- <summary>
- Removes previously cached information for this device from the registry.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.NetworkDevice.OnCacheWrite">
- <summary>
- Records information about this device to the registry.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.NetworkDevice.OnCacheRead">
- <summary>
- Reads information about this device from the registry.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.NetworkDevice.AddressFamily">
- <summary>
- Returns the addressing scheme the socket can use.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.NetworkDevice.SocketType">
- <summary>
- Returns the type of protocol used by the socket.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.NetworkDevice.ProtocolType">
- <summary>
- Returns the protocol supported by the socket.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.NetworkDevice.EndPoint">
- <summary>
- Returns the network address for the device.
- </summary>
- <value>The end point.</value>
- </member>
- <member name="P:DotSpatial.Positioning.NetworkDevice.Socket">
- <summary>
- Returns the socket associated with this device.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.NetworkDevice.DefaultConnectTimeout">
- <summary>
- Controls the amount of time allowed for a connection to be successfully opened.
- </summary>
- <value>The default connect timeout.</value>
- </member>
- <member name="P:DotSpatial.Positioning.NetworkDevice.Name">
- <summary>
- Returns a natural language name for the device.
- </summary>
- <inheritdocs/>
- </member>
- <member name="F:DotSpatial.Positioning.BluetoothDevice.MY_ROOT_KEY_NAME">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.BluetoothDevice.BLUETOOTH_FAMILY">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.BluetoothDevice.RF_COMM">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.BluetoothDevice._name">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.BluetoothDevice._address">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.BluetoothDevice._virtualSerialPort">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.BluetoothDevice._class">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.BluetoothDevice._minorClass">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.BluetoothDevice._serviceClass">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.BluetoothDevice.DeviceDiscoveryThread">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.BluetoothDevice._discoveryStartedWaitHandle">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.BluetoothDevice._isDeviceDiscoveryInProgress">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.BluetoothDevice._isDeviceDiscoveryCacheFlushed">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.BluetoothDevice._discoveryTimeout">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.BluetoothDevice._maximumAllowedFailures">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.BluetoothDevice._rfCommServiceGuid">
- <summary>
- Returns a GUID which represents the RFComm service.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothDevice.#ctor(DotSpatial.Positioning.BluetoothAddress)">
- <summary>
- Creates a new instance using the specified address.
- </summary>
- <param name="address">The address.</param>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothDevice.#ctor(DotSpatial.Positioning.BluetoothAddress,System.String)">
- <summary>
- Creates a new instance using the specified address and name.
- </summary>
- <param name="address">The address.</param>
- <param name="name">The name.</param>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothDevice.#ctor(DotSpatial.Positioning.BluetoothEndPoint,System.String)">
- <summary>
- Creates a new instance using the specified endpoint and friendly name.
- </summary>
- <param name="endPoint">The end point.</param>
- <param name="name">The name.</param>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothDevice.Dispose(System.Boolean)">
- <summary>
- Releases unmanaged and - optionally - managed resources.
- </summary>
- <param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothDevice.DetectProtocol">
- <summary>
- Performs a test on the device to confirm that it transmits GPS data.
- </summary>
- <returns>A <strong>Boolean</strong> value, <strong>True</strong> if the device is confirmed.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothDevice.OnCacheRemove">
- <summary>
- Called when [cache remove].
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothDevice.OnCacheWrite">
- <summary>
- Called when [cache write].
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothDevice.OnCacheRead">
- <summary>
- Called when [cache read].
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothDevice.DiscoverDevices">
- <summary>
- Searches the room for Bluetooth devices.
- </summary>
- <remarks>This method will perform discovery of nearby Bluetooth devices. Discovery will take place on a separate thread,
- and the <strong>DeviceDiscovered</strong> event will be raised for each device service discovered. If a device publishes multiple
- services, multiple events will be raised for each service.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothDevice.DiscoverDevices(System.Boolean)">
- <summary>
- Searches the room for Bluetooth devices.
- </summary>
- <param name="isCacheFlushed">A <strong>Boolean</strong> indicating whether the cache of Bluetooth information should be cleared.</param>
- <remarks><para>This method will perform discovery of nearby Bluetooth devices. Discovery will take place on a separate thread,
- and the <strong>DeviceDiscovered</strong> event will be raised for each device service discovered. If a device publishes multiple
- services, multiple events will be raised for each service.</para>
- <para>If the <strong>IsCacheFlushed</strong> parameter is <strong>True</strong>, any cached information will be cleared, and a
- wireless scan of devices will be performed. This kind of scan is preferable since it can detect which devices are actually responding
- right now, even though the query will take several seconds to occur. A value of <strong>False</strong> is typically used if a
- device scan was recently performed and responsiveness is necessary.</para></remarks>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothDevice.WaitForDiscovery">
- <summary>
- Wait for discovery
- </summary>
- <returns>boolean</returns>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothDevice.WaitForDiscovery(System.TimeSpan)">
- <summary>
- Waits for discovery, specifying a timeout
- </summary>
- <param name="timeout">The TimeSpan specifying the timeout where waiting ends.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothDevice.DiscoverDevicesThreadProc">
- <summary>
- Discovers the devices thread proc.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothDevice.Refresh">
- <summary>
- Refreshes this instance.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothDevice.LoadCachedDevices(System.Collections.Generic.IList{DotSpatial.Positioning.BluetoothDevice})">
- <summary>
- Loads the Bluetooth devices that have been cached by GPS.Net. This list contains previously-detected GPS devices,
- along with devices which were tested but found to NOT be GPS devices. By keeping these statistics,
- the detection system can become faster over time by first testing devices which have a better success rate.
- </summary>
- <param name="devices">The list to which the cached devices are added.</param>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothDevice.LoadWindowsDevices(System.Collections.Generic.IList{DotSpatial.Positioning.BluetoothDevice})">
- <summary>
- Loads the Bluetooth devices that have already been discovered by Windows. This list includes non-GPS devices.
- </summary>
- <param name="devices">The list to which the devices are added.</param>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothDevice.Equals(DotSpatial.Positioning.BluetoothDevice)">
- <summary>
- Indicates whether the current object is equal to another object of the same type.
- </summary>
- <param name="other">An object to compare with this object.</param>
- <returns>true if the current object is equal to the <paramref name="other"/> parameter; otherwise, false.</returns>
- </member>
- <member name="E:DotSpatial.Positioning.BluetoothDevice.DeviceDiscovered">
- <summary>
- Occurs when a new Bluetooth device has been detected.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.BluetoothDevice.Address">
- <summary>
- Returns the address of the device.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.BluetoothDevice.Class">
- <summary>
- Returns the primary purpose of the device.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.BluetoothDevice.MinorClass">
- <summary>
- Returns a sub-category describing the purpose of the device.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.BluetoothDevice.ServiceClass">
- <summary>
- Returns the major type of device.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.BluetoothDevice.VirtualSerialPort">
- <summary>
- Returns a serial device which has been linked to this device.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.BluetoothDevice.Name">
- <summary>
- Returns the name of the Bluetooth device.
- </summary>
- <inheritdocs/>
- <remarks>If the device has been identified, the actual name of the device will be returned. Otherwise, the
- device's address will be returned.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.BluetoothDevice.AllowConnections">
- <summary>
- Controls whether the device can be queried for GPS data.
- </summary>
- <value><c>true</c> if [allow connections]; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:DotSpatial.Positioning.BluetoothDevice.MaximumAllowedFailures">
- <summary>
- Controls the maximum allowed detection failures before a device is excluded from detection.
- </summary>
- <value>The maximum allowed failures.</value>
- <remarks>Some devices involved with device detection are not GPS devices. For example, a Bluetooth search
- could return wireless headphones, or the neighbor's computer. This property controls how many times a device will be
- tested before it is no longer included for searches. If a device's failure count goes beyond this number, attempts
- will no longer be made to connect to the device.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.BluetoothDevice.Cache">
- <summary>
- Returns a list of known Bluetooth devices.
- </summary>
- <remarks><para>To maximize performance, GPS.NET will record information about each device it encounters for the purposes of organizing
- and speeding up the GPS device detection process. This property returns a list of all known Bluetooth devices.</para>
- <para>Since this list is managed automatically, it should not be modified.</para></remarks>
- </member>
- <member name="P:DotSpatial.Positioning.BluetoothDevice.DiscoveryTimeout">
- <summary>
- Controls the amount of time spent searching for Bluetooth devices.
- </summary>
- <value>The discovery timeout.</value>
- </member>
- <member name="T:DotSpatial.Positioning.DeviceClass">
- <summary>
- Indicates the classification of a Bluetooth device.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DeviceClass.Miscellaneous">
- <summary>
- Misc
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DeviceClass.Computer">
- <summary>
- Computer
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DeviceClass.Phone">
- <summary>
- Phone
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DeviceClass.LAN">
- <summary>
- Lan
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DeviceClass.AudioVideo">
- <summary>
- Audio
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DeviceClass.Peripheral">
- <summary>
- Peripheral
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DeviceClass.Imaging">
- <summary>
- Imaging
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DeviceClass.Unclassified">
- <summary>
- Unclassified
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.ServiceClass">
- <summary>
- Indicates the kind of service provided by a Bluetooth device.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.ServiceClass.None">
- <summary>
- None
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.ServiceClass.LimitedDiscoverableMode">
- <summary>
- Limited Disoverable mode
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.ServiceClass.Positioning">
- <summary>
- Positioning
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.ServiceClass.Networking">
- <summary>
- Networking
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.ServiceClass.Rendering">
- <summary>
- Rendering
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.ServiceClass.Capturing">
- <summary>
- Capturing
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.ServiceClass.ObjectTransfer">
- <summary>
- Object Transfer
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.ServiceClass.Audio">
- <summary>
- Audio
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.ServiceClass.Telephony">
- <summary>
- Telephony
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.ServiceClass.Information">
- <summary>
- Information
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.ServiceClass.All">
- <summary>
- all
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.BluetoothEndPoint">
- <summary>
- Represents a Bluetooth service on a device.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.BluetoothEndPoint.BLUETOOTH_FAMILY">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.BluetoothEndPoint.PACKET_SIZE">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.BluetoothEndPoint.ADDRESS_OFFSET">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.BluetoothEndPoint.SERVICE_GUID_OFFSET">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.BluetoothEndPoint.PORT_OFFSET">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.BluetoothEndPoint.DEFAULT_PORT">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.BluetoothEndPoint._socketAddress">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.BluetoothEndPoint._address">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.BluetoothEndPoint._service">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.BluetoothEndPoint._port">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.BluetoothEndPoint._name">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.BluetoothEndPoint._successfulDetectionCount">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.BluetoothEndPoint._failedDetectionCount">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothEndPoint.#ctor(DotSpatial.Positioning.BluetoothAddress)">
- <summary>
- Creates a new instance using the specified address.
- </summary>
- <param name="address">The address.</param>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothEndPoint.#ctor(DotSpatial.Positioning.BluetoothAddress,System.Guid)">
- <summary>
- Creates a new instance using the specified address and service GUID.
- </summary>
- <param name="address">The address.</param>
- <param name="service">The service.</param>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothEndPoint.#ctor(DotSpatial.Positioning.BluetoothAddress,System.Guid,System.Int32)">
- <summary>
- Creates a new instance using the specified address, service GUID, and remote port number.
- </summary>
- <param name="address">The address.</param>
- <param name="service">The service.</param>
- <param name="port">The port.</param>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothEndPoint.#ctor(System.Net.SocketAddress)">
- <summary>
- Creates a new instance from the specified socket address.
- </summary>
- <param name="socketAddress">The socket address.</param>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothEndPoint.SetName(System.String)">
- <summary>
- Sets the name.
- </summary>
- <param name="name">The name.</param>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothEndPoint.GetHashCode">
- <summary>
- Returns a hash code for this instance.
- </summary>
- <returns>A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothEndPoint.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
- </summary>
- <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
- <returns><c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothEndPoint.Create(System.Net.SocketAddress)">
- <summary>
- Creates an <see cref="T:System.Net.EndPoint"/> instance from a <see cref="T:System.Net.SocketAddress"/> instance.
- </summary>
- <param name="socketAddress">The socket address that serves as the endpoint for a connection.</param>
- <returns>A new <see cref="T:System.Net.EndPoint"/> instance that is initialized from the specified <see cref="T:System.Net.SocketAddress"/> instance.</returns>
- <exception cref="T:System.NotImplementedException">Any attempt is made to access the method when the method is not overridden in a descendant class. </exception>
-
- <PermissionSet>
- <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode, ControlEvidence"/>
- </PermissionSet>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothEndPoint.Serialize">
- <summary>
- Serializes endpoint information into a <see cref="T:System.Net.SocketAddress"/> instance.
- </summary>
- <returns>A <see cref="T:System.Net.SocketAddress"/> instance that contains the endpoint information.</returns>
- <exception cref="T:System.NotImplementedException">Any attempt is made to access the method when the method is not overridden in a descendant class. </exception>
-
- <PermissionSet>
- <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode, ControlEvidence"/>
- </PermissionSet>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothEndPoint.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothEndPoint.Equals(DotSpatial.Positioning.BluetoothEndPoint)">
- <summary>
- Indicates whether the current object is equal to another object of the same type.
- </summary>
- <param name="other">An object to compare with this object.</param>
- <returns>true if the current object is equal to the <paramref name="other"/> parameter; otherwise, false.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothEndPoint.ToString(System.String,System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format to use.-or- A null reference (Nothing in Visual Basic) to use the default format defined for the type of the <see cref="T:System.IFormattable"/> implementation.</param>
- <param name="formatProvider">The provider to use to format the value.-or- A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.</param>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="P:DotSpatial.Positioning.BluetoothEndPoint.Service">
- <summary>
- Returns a GUID indentifying the service.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.BluetoothEndPoint.Port">
- <summary>
- Returns the port used for opening connections.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.BluetoothEndPoint.Name">
- <summary>
- Returns a friendly name for the endpoint.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.BluetoothEndPoint.Address">
- <summary>
- Returns the unique address of the device, used for connections.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.BluetoothEndPoint.SuccessfulDetectionCount">
- <summary>
- Controls the number of times this endpoint has been identified as a GPS service.
- </summary>
- <value>The successful detection count.</value>
- </member>
- <member name="P:DotSpatial.Positioning.BluetoothEndPoint.FailedDetectionCount">
- <summary>
- Controls the number of times this endpoint has failed to identify itself as a GPS service.
- </summary>
- <value>The failed detection count.</value>
- </member>
- <member name="P:DotSpatial.Positioning.BluetoothEndPoint.AddressFamily">
- <summary>
- Gets the address family to which the endpoint belongs.
- </summary>
- <returns>One of the <see cref="T:System.Net.Sockets.AddressFamily"/> values.</returns>
-
- <exception cref="T:System.NotImplementedException">Any attempt is made to get or set the property when the property is not overridden in a descendant class. </exception>
-
- <PermissionSet>
- <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode, ControlEvidence"/>
- </PermissionSet>
- </member>
- <member name="T:DotSpatial.Positioning.BluetoothRadio">
- <summary>
- Represents a Bluetooth radio.
- </summary>
- <remarks>Most computers have a single Bluetooth radio attached to them. The radio is responsible for wireless communications
- with all Bluetooth devices. This class provides the ability to enable or disable the radio, as well as to access devices which
- the radio can detect.</remarks>
- </member>
- <member name="F:DotSpatial.Positioning.BluetoothRadio._handle">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.BluetoothRadio._name">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.BluetoothRadio._class">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.BluetoothRadio._minorClass">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.BluetoothRadio._serviceClass">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.BluetoothRadio._current">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothRadio.#cctor">
- <summary>
- Initializes a new instance of the <see cref="T:System.Object"/> class.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothRadio.#ctor(System.IntPtr)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.BluetoothRadio"/> class.
- </summary>
- <param name="handle">The handle.</param>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothRadio.GetIsConnectable">
- <summary>
- Controls whether the radio can accept incoming connections.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothRadio.SetIsConnectable(System.Boolean)">
- <summary>
- Controls whether the radio can accept incoming connections.
- </summary>
- <param name="value">if set to <c>true</c> [value].</param>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothRadio.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
- </summary>
- <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
- <returns><c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothRadio.GetHashCode">
- <summary>
- Returns a hash code for this instance.
- </summary>
- <returns>A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothRadio.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.BluetoothRadio.Equals(DotSpatial.Positioning.BluetoothRadio)">
- <summary>
- Indicates whether the current object is equal to another object of the same type.
- </summary>
- <param name="other">An object to compare with this object.</param>
- <returns>true if the current object is equal to the <paramref name="other"/> parameter; otherwise, false.</returns>
- </member>
- <member name="P:DotSpatial.Positioning.BluetoothRadio.Current">
- <summary>
- Returns the current Bluetooth radio if one is installed.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.BluetoothRadio.Handle">
- <summary>
- Gets the handle.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.BluetoothRadio.Name">
- <summary>
- Returns the name of the radio.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.BluetoothRadio.Class">
- <summary>
- Returns the primary purpose of the device.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.BluetoothRadio.MinorClass">
- <summary>
- Returns a sub-category describing the purpose of the device.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.BluetoothRadio.ServiceClass">
- <summary>
- Returns the major type of device.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.CartesianPoint">
- <summary>
- Represents an Earth-centered, Earth-fixed (ECEF) Cartesian coordinate.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.CartesianPoint._x">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.CartesianPoint._y">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.CartesianPoint._z">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.CartesianPoint.#ctor(DotSpatial.Positioning.Distance,DotSpatial.Positioning.Distance,DotSpatial.Positioning.Distance)">
- <summary>
- Creates a new instance using the specified X, Y and Z values.
- </summary>
- <param name="x">The x.</param>
- <param name="y">The y.</param>
- <param name="z">The z.</param>
- </member>
- <member name="M:DotSpatial.Positioning.CartesianPoint.#ctor(System.Xml.XmlReader)">
- <summary>
- Creates a new instance from the specified block of GML.
- </summary>
- <param name="reader">The reader.</param>
- </member>
- <member name="F:DotSpatial.Positioning.CartesianPoint.Empty">
- <summary>
- Returns a cartesian coordinate with empty values.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.CartesianPoint.Infinity">
- <summary>
- Returns a cartesian point with infinite values.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.CartesianPoint.Invalid">
- <summary>
- Represents an invalid or unspecified value.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.CartesianPoint.ToPosition3D">
- <summary>
- Converts the current instance to a geodetic (latitude/longitude) coordinate.
- </summary>
- <returns>A <strong>Position</strong> object containing the converted result.</returns>
- <remarks>The conversion formula will convert the Cartesian coordinate to
- latitude and longitude using the WGS1984 ellipsoid (the default ellipsoid for
- GPS coordinates).</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.CartesianPoint.ToPosition3D(DotSpatial.Positioning.Ellipsoid)">
- <summary>
- Converts the current instance to a geodetic (latitude/longitude) coordinate using the specified ellipsoid.
- </summary>
- <param name="ellipsoid">The ellipsoid.</param>
- <returns>A <strong>Position</strong> object containing the converted result.</returns>
- <remarks>The conversion formula will convert the Cartesian coordinate to
- latitude and longitude using the WGS1984 ellipsoid (the default ellipsoid for
- GPS coordinates). The resulting three-dimensional coordinate is accurate to within two millimeters
- (2 mm).</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.CartesianPoint.DistanceTo(DotSpatial.Positioning.CartesianPoint)">
- <summary>
- Returns the distance from the current instance to the specified cartesian point.
- </summary>
- <param name="point">A <strong>CartesianPoint</strong> object representing the end of a segment.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.CartesianPoint.ToString(System.String)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format.</param>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.CartesianPoint.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
- </summary>
- <param name="obj">Another object to compare to.</param>
- <returns><c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.CartesianPoint.GetHashCode">
- <summary>
- Returns a hash code for this instance.
- </summary>
- <returns>A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.CartesianPoint.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.CartesianPoint.ToString(System.String,System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format to use.-or- A null reference (Nothing in Visual Basic) to use the default format defined for the type of the <see cref="T:System.IFormattable"/> implementation.</param>
- <param name="formatProvider">The provider to use to format the value.-or- A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.</param>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.CartesianPoint.Equals(DotSpatial.Positioning.CartesianPoint)">
- <summary>
- Indicates whether the current object is equal to another object of the same type.
- </summary>
- <param name="other">An object to compare with this object.</param>
- <returns>true if the current object is equal to the <paramref name="other"/> parameter; otherwise, false.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.CartesianPoint.System#Xml#Serialization#IXmlSerializable#GetSchema">
- <summary>
- This method is reserved and should not be used. When implementing the IXmlSerializable interface, you should return null (Nothing in Visual Basic) from this method, and instead, if specifying a custom schema is required, apply the <see cref="T:System.Xml.Serialization.XmlSchemaProviderAttribute"/> to the class.
- </summary>
- <returns>An <see cref="T:System.Xml.Schema.XmlSchema"/> that describes the XML representation of the object that is produced by the <see cref="M:System.Xml.Serialization.IXmlSerializable.WriteXml(System.Xml.XmlWriter)"/> method and consumed by the <see cref="M:System.Xml.Serialization.IXmlSerializable.ReadXml(System.Xml.XmlReader)"/> method.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.CartesianPoint.WriteXml(System.Xml.XmlWriter)">
- <summary>
- Converts an object into its XML representation.
- </summary>
- <param name="writer">The <see cref="T:System.Xml.XmlWriter"/> stream to which the object is serialized.</param>
- </member>
- <member name="M:DotSpatial.Positioning.CartesianPoint.ReadXml(System.Xml.XmlReader)">
- <summary>
- Generates an object from its XML representation.
- </summary>
- <param name="reader">The <see cref="T:System.Xml.XmlReader"/> stream from which the object is deserialized.</param>
- </member>
- <member name="M:DotSpatial.Positioning.CartesianPoint.op_Addition(DotSpatial.Positioning.CartesianPoint,DotSpatial.Positioning.CartesianPoint)">
- <summary>
- Implements the operator +.
- </summary>
- <param name="a">A.</param>
- <param name="b">The b.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.CartesianPoint.op_Subtraction(DotSpatial.Positioning.CartesianPoint,DotSpatial.Positioning.CartesianPoint)">
- <summary>
- Implements the operator -.
- </summary>
- <param name="a">A.</param>
- <param name="b">The b.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.CartesianPoint.op_Multiply(DotSpatial.Positioning.CartesianPoint,DotSpatial.Positioning.CartesianPoint)">
- <summary>
- Implements the operator *.
- </summary>
- <param name="a">A.</param>
- <param name="b">The b.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.CartesianPoint.op_Division(DotSpatial.Positioning.CartesianPoint,DotSpatial.Positioning.CartesianPoint)">
- <summary>
- Implements the operator /.
- </summary>
- <param name="a">A.</param>
- <param name="b">The b.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.CartesianPoint.op_Explicit(DotSpatial.Positioning.Position)~DotSpatial.Positioning.CartesianPoint">
- <summary>
- Performs an explicit conversion from <see cref="T:DotSpatial.Positioning.Position"/> to <see cref="T:DotSpatial.Positioning.CartesianPoint"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.CartesianPoint.op_Explicit(DotSpatial.Positioning.Position3D)~DotSpatial.Positioning.CartesianPoint">
- <summary>
- Performs an explicit conversion from <see cref="T:DotSpatial.Positioning.Position3D"/> to <see cref="T:DotSpatial.Positioning.CartesianPoint"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="P:DotSpatial.Positioning.CartesianPoint.X">
- <summary>
- Returns the horizontal (longitude) portion of a Cartesian coordinate.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.CartesianPoint.Y">
- <summary>
- Returns the vertical (latitude) portion of a Cartesian coordinate.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.CartesianPoint.Z">
- <summary>
- Returns the altitude portion of a Cartesian coordinate.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.CartesianPoint.IsEmpty">
- <summary>
- Indicates whether the current instance has no value.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.CartesianPoint.IsInvalid">
- <summary>
- Indicates whether the current instance is invalid or unspecified.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.DeviceEventArgs">
- <summary>
- Represents information about a GPS device when a device-related event is raised.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DeviceEventArgs._device">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DeviceEventArgs.Empty">
- <summary>
- A default instance
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.DeviceEventArgs.#ctor(DotSpatial.Positioning.Device)">
- <summary>
- Creates a new instance of the event args
- </summary>
- <param name="device">The device.</param>
- </member>
- <member name="P:DotSpatial.Positioning.DeviceEventArgs.Device">
- <summary>
- The device
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.DeviceAnalysis">
- <summary>
- Represents an examination of a GPS device for its capabilities and health.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DeviceAnalysis._device">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DeviceAnalysis._isWorkingProperly">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DeviceAnalysis._log">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DeviceAnalysis._supportedSentences">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DeviceAnalysis._isPositionSupported">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DeviceAnalysis._isAltitudeSupported">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DeviceAnalysis._isBearingSupported">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DeviceAnalysis._isPrecisionSupported">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DeviceAnalysis._isSpeedSupported">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DeviceAnalysis._isSatellitesSupported">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.DeviceAnalysis.#ctor(DotSpatial.Positioning.Device,System.Boolean,System.String,System.String[],System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.DeviceAnalysis"/> class.
- </summary>
- <param name="device">The device.</param>
- <param name="isWorkingProperly">if set to <c>true</c> [is working properly].</param>
- <param name="log">The log.</param>
- <param name="supportedSentences">The supported sentences.</param>
- <param name="isPositionSupported">if set to <c>true</c> [is position supported].</param>
- <param name="isAltitudeSupported">if set to <c>true</c> [is altitude supported].</param>
- <param name="isBearingSupported">if set to <c>true</c> [is bearing supported].</param>
- <param name="isPrecisionSupported">if set to <c>true</c> [is precision supported].</param>
- <param name="isSpeedSupported">if set to <c>true</c> [is speed supported].</param>
- <param name="isSatellitesSupported">if set to <c>true</c> [is satellites supported].</param>
- </member>
- <member name="M:DotSpatial.Positioning.DeviceAnalysis.SendAnonymousLog">
- <summary>
- Sends this analysis anonymously to DotSpatial.Positioning for further study.
- </summary>
- <returns>A <strong>Boolean</strong> value, <strong>True</strong> if the HTTP response indicates success.</returns>
- <remarks><para>DotSpatial.Positioning collects device detection information for the purposes of improving
- software, widening support for devices, and providing faster technical support. This method
- will cause an HTTP POST to be sent to the DotSpatial.Positioning web server with the values in this class.
- The information is collected anonymously.</para>
- <para>One benefit of sending an analysis is that it can instantly update statistics for supported
- GPS devices. The anonymous results will be compiled into an RSS feed which developers can use to
- instantly be notified of both healthy and problematic devices.</para>
- <para>The DotSpatial.Positioning server can handle repeated calls to this method, though requests should not
- be sent more than every few seconds. Duplicate reports are automatically ignored by our system. So
- long as customers are aware of the implications of an HTTP request (such as possible cell phone charges),
- you are welcome to use this functionality in your application.</para></remarks>
- </member>
- <member name="M:DotSpatial.Positioning.DeviceAnalysis.SendAnonymousLog(System.Uri)">
- <summary>
- Sends this analysis anonymously to the specified Uri for further study.
- </summary>
- <param name="uri">The URI.</param>
- <returns>A <strong>Boolean</strong> value, <strong>True</strong> if the HTTP response indicates success.</returns>
- <remarks><para>Developers may wish to generate detection logs from customers for the purposes of
- improving technical support. This can also be used to collect statistics about GPS devices which
- customers use. This method will create an HTTP POST to the specified address with the information in this
- class.</para>
- <para>The actual fields sent will vary depending on the type of object being reported. Currently, this
- feature works for SerialDevice, BluetoothDevice, and GpsIntermediateDriver device objects.</para></remarks>
- </member>
- <member name="P:DotSpatial.Positioning.DeviceAnalysis.Log">
- <summary>
- Returns a log of activity while the device was tested.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.DeviceAnalysis.IsWorkingProperly">
- <summary>
- Returns whether the device is healthy
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.DeviceAnalysis.SupportedSentences">
- <summary>
- Returns NMEA sentences discovered during analysis.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.DeviceAnalysis.IsPositionSupported">
- <summary>
- Returns whether real-time latitude and longitude are reported by the device.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.DeviceAnalysis.IsAltitudeSupported">
- <summary>
- Returns whether the distance above sea level is reported by the device.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.DeviceAnalysis.IsBearingSupported">
- <summary>
- Returns whether the real-time direction of travel is reported by the device.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.DeviceAnalysis.IsPrecisionSupported">
- <summary>
- Returns whether dilution of precision information is reported by the device.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.DeviceAnalysis.IsSpeedSupported">
- <summary>
- Returns whether the real-time rate of travel is reported by the device.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.DeviceAnalysis.IsSatellitesSupported">
- <summary>
- Returns whether real-time satellite information is reported by the device.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.Devices">
- <summary>
- Encapsulates GPS device detection features and information about known devices.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Devices.DEBUG_CATEGORY">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Devices.ROOT_KEY_NAME">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Devices._currentlyDetectingWaitHandles">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Devices._serialDevices">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Devices._bluetoothDevices">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Devices._gpsDevices">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Devices._detectionThread">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Devices._isDetectionInProgress">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Devices._isClockSynchronizationEnabled">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Devices._deviceDetectedWaitHandle">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Devices._detectionCompleteWaitHandle">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Devices._deviceDetectionTimeout">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Devices._isStreamNeeded">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Devices._isOnlyFirstDeviceDetected">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Devices._allowBluetoothConnections">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Devices._allowSerialConnections">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Devices._allowExhaustiveSerialPortScanning">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Devices._maximumSerialPortNumber">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Devices._position">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Devices._altitude">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Devices._utcDateTime">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Devices._bearing">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Devices._heading">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Devices._speed">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Devices._satellites">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Devices.#cctor">
- <summary>
- Initializes a new instance of the <see cref="T:System.Object"/> class.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Devices.CancelDetection">
- <summary>
- Aborts the process of finding GPS devices and blocks until the cancellation is complete.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Devices.CancelDetection(System.Boolean)">
- <summary>
- Aborts the process of finding GPS devices and optionally blocks until the cancellation is complete.
- </summary>
- <param name="isAsync">If set to <see langword="true"/>, then the method will return immediately rather than waiting
- for the cancellation to complete.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Devices.BeginDetection">
- <summary>
- Starts looking for GPS devices on a separate thread.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Devices.Undetect">
- <summary>
- Cancels detection and removes any cached information about known devices.
- Use the <see cref="M:DotSpatial.Positioning.Devices.BeginDetection"/> method to re-detect devices and re-create the device cache.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Devices.WaitForDevice">
- <summary>
- Waits for any GPS device to be detected.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Devices.WaitForDevice(System.TimeSpan)">
- <summary>
- Waits for any GPS device to be detected up to the specified timeout period.
- </summary>
- <param name="timeout">The timeout.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Devices.WaitForDetection">
- <summary>
- Waits for device detection to complete.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Devices.WaitForDetection(System.TimeSpan)">
- <summary>
- Waits for device detection to complete up to the specified timeout period.
- </summary>
- <param name="timeout">The timeout.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Devices.RaiseFixLost(DotSpatial.Positioning.DeviceEventArgs)">
- <summary>
- Raises the <see cref="E:DotSpatial.Positioning.Devices.FixLost"/> event.
- </summary>
- <param name="e">The <see cref="T:DotSpatial.Positioning.DeviceEventArgs"/> instance containing the event data.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Devices.RaiseFixAcquired(DotSpatial.Positioning.DeviceEventArgs)">
- <summary>
- Raises the <see cref="E:DotSpatial.Positioning.Devices.FixAcquired"/> event.
- </summary>
- <param name="e">The <see cref="T:DotSpatial.Positioning.DeviceEventArgs"/> instance containing the event data.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Devices.BluetoothDevice_DeviceDiscovered(System.Object,DotSpatial.Positioning.DeviceEventArgs)">
- <summary>
- Handles the DeviceDiscovered event of the BluetoothDevice control.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">The <see cref="T:DotSpatial.Positioning.DeviceEventArgs"/> instance containing the event data.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Devices.DetectionThreadProc">
- <summary>
- Detections the thread proc.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Devices.DetectionThreadProcWatcher(System.Object)">
- <summary>
- This method, spawned by the ThreadPool, monitors detection and aborts it if it's taking too long.
- </summary>
- <param name="over9000">The over9000.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Devices.BeginBluetoothDetection">
- <summary>
- Begins detecting all bluetooth devices to determine if they are GPS devices.
- All detection is done asynchronously, so this method returns immediately.
- Use the <see cref="M:DotSpatial.Positioning.Devices.WaitForDetection"/> method if you need to block until detection is completed.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Devices.BeginSerialDetection(System.Boolean)">
- <summary>
- Begins detecting all serial devices to determine if they are GPS devices.
- All detection is done asynchronously, so this method returns immediately.
- Use the <see cref="M:DotSpatial.Positioning.Devices.WaitForDetection"/> method if you need to block until detection is completed.
- </summary>
- <param name="omitColonSuffix">If set to <see langword="true"/>, the colon character (":") will be omitted from the port names.
- This is required on some systems in order for the device to be detected properly.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Devices.DiscoverBluetoothDevices">
- <summary>
- Discovers any new bluetooth devices.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Devices.WaitForDetectionInternal">
- <summary>
- Waits for device detection to complete.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Devices.RenameDevice(DotSpatial.Positioning.SerialDevice,System.String)">
- <summary>
- Renames the specified serial device, only if there is not already another serial device with the specified name.
- </summary>
- <param name="device">The device to be renamed.</param>
- <param name="newName">The new name for the device.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Devices.ClearDeviceCache">
- <summary>
- Clears the <see cref="P:DotSpatial.Positioning.Devices.BluetoothDevices"/>, <see cref="P:DotSpatial.Positioning.Devices.SerialDevices"/>, and <see cref="P:DotSpatial.Positioning.Devices.GpsDevices"/> lists.
- This will cause the lists to be rebuilt the next time the <see cref="M:DotSpatial.Positioning.Devices.BeginBluetoothDetection"/> or
- <see cref="M:DotSpatial.Positioning.Devices.BeginSerialDetection(System.Boolean)"/> methods are called.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Devices.OnDeviceDetectionAttempted(DotSpatial.Positioning.Device)">
- <summary>
- Called when [device detection attempted].
- </summary>
- <param name="device">The device.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Devices.OnDeviceDetectionAttemptFailed(DotSpatial.Positioning.DeviceDetectionException)">
- <summary>
- Called when [device detection attempt failed].
- </summary>
- <param name="exception">The exception.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Devices.OnDeviceDetectionStarted">
- <summary>
- Called when [device detection started].
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Devices.OnDeviceDetectionCompleted">
- <summary>
- Called when [device detection completed].
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Devices.OnDeviceDiscovered(DotSpatial.Positioning.Device)">
- <summary>
- Called when [device discovered].
- </summary>
- <param name="device">The device.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Devices.Add(DotSpatial.Positioning.Device)">
- <summary>
- Adds a GPS device to the list of known GPS devices.
- </summary>
- <param name="device">The device.</param>
- </member>
- <member name="E:DotSpatial.Positioning.Devices.DeviceDetectionStarted">
- <summary>
- Occurs when the process of finding GPS devices has begun.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Devices.DeviceDetectionAttempted">
- <summary>
- Occurs immediately before a device is about to be tested for GPS data.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Devices.DeviceDetectionAttemptFailed">
- <summary>
- Occurs when a device has failed to transmit recognizable GPS data.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Devices.DeviceDetected">
- <summary>
- Occurs when a device is responding and transmitting GPS data.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Devices.DeviceDiscovered">
- <summary>
- Occurs when a Bluetooth device has been found.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Devices.DeviceDetectionCanceled">
- <summary>
- Occurs when the process of finding GPS devices has been interrupted.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Devices.DeviceDetectionCompleted">
- <summary>
- Occurs when the process of finding GPS devices has finished.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Devices.PositionChanged">
- <summary>
- Occurs when any interpreter detects a change in the current location.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Devices.AltitudeChanged">
- <summary>
- Occurs when any interpreter detects a change in the distance above sea level.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Devices.SpeedChanged">
- <summary>
- Occurs when any interpreter detects a change in the current rate of travel.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Devices.SatellitesChanged">
- <summary>
- Occurs when any interpreter detects a change in GPS satellite information.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Devices.BearingChanged">
- <summary>
- Occurs when any interpreter detects a change in the direction of travel.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Devices.HeadingChanged">
- <summary>
- Occurs when any interpreter detects a change in the direction of heading.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Devices.FixLost">
- <summary>
- Occurs when any interpreter detects when a GPS device can no longer calculate the current location.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Devices.FixAcquired">
- <summary>
- Occurs when any interpreter detects when a GPS device becomes able to calculate the current location.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Devices.UtcDateTimeChanged">
- <summary>
- Occurs when any interpreter detects a change in the satellite-derived date and time.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Devices.Any">
- <summary>
- Returns a GPS device which is connectable and is reporting data.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Devices.AllowBluetoothConnections">
- <summary>
- Controls whether Bluetooth devices are included in the search for GPS devices.
- </summary>
- <value><c>true</c> if [allow bluetooth connections]; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Devices.AllowSerialConnections">
- <summary>
- Controls whether serial devices are included in the search for GPS devices.
- </summary>
- <value><c>true</c> if [allow serial connections]; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Devices.AllowExhaustiveSerialPortScanning">
- <summary>
- Controls whether a complete range of serial devices is searched, regardless of which device appear to actually exist.
- </summary>
- <value><c>true</c> if [allow exhaustive serial port scanning]; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Devices.MaximumSerialPortNumber">
- <summary>
- Controls the maximum serial port to test when exhaustive detection is enabled.
- </summary>
- <value>The maximum serial port number.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Devices.GpsDevices">
- <summary>
- Returns a list of confirmed GPS devices.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Devices.BluetoothDevices">
- <summary>
- Returns a list of known wireless Bluetooth devices (not necessarily GPS devices).
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Devices.SerialDevices">
- <summary>
- Returns a list of known serial devices (not necessarily GPS devices).
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Devices.DeviceDetectionTimeout">
- <summary>
- Controls the amount of time allowed for device detection to complete before it is aborted.
- </summary>
- <value>The device detection timeout.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Devices.IsOnlyFirstDeviceDetected">
- <summary>
- Controls whether detection is aborted once one device has been found.
- </summary>
- <value><c>true</c> if this instance is only first device detected; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Devices.IsClockSynchronizationEnabled">
- <summary>
- Controls whether the system clock should be synchronized to GPS-derived date and time.
- </summary>
- <value><c>true</c> if this instance is clock synchronization enabled; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Devices.IsBluetoothEnabled">
- <summary>
- Controls whether the Bluetooth receiver is on and accepting connections.
- </summary>
- <value><c>true</c> if this instance is bluetooth enabled; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Devices.IsBluetoothSupported">
- <summary>
- Returns whether the Bluetooth stack on the local machine is supported by GPS.NET.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Devices.IsDeviceDetected">
- <summary>
- Returns whether a GPS device has been found.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Devices.IsDetectionInProgress">
- <summary>
- Returns whether the process of finding a GPS device is still working.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Devices.Position">
- <summary>
- Controls the current location on Earth's surface.
- </summary>
- <value>The position.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Devices.Speed">
- <summary>
- Controls the current rate of travel.
- </summary>
- <value>The speed.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Devices.Satellites">
- <summary>
- Controls the current list of GPS satellites.
- </summary>
- <value>The satellites.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Devices.UtcDateTime">
- <summary>
- Controls the current satellite-derived date and time.
- </summary>
- <value>The UTC date time.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Devices.DateTime">
- <summary>
- Controls the current satellite-derived date and time.
- </summary>
- <value>The date time.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Devices.Altitude">
- <summary>
- Controls the current distance above sea level.
- </summary>
- <value>The altitude.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Devices.Bearing">
- <summary>
- Controls the current direction of travel.
- </summary>
- <value>The bearing.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Devices.Heading">
- <summary>
- Controls the current direction of heading.
- </summary>
- <value>The heading.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Devices.IsStreamNeeded">
- <summary>
- Gets a value indicating whether this instance is stream needed.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.DeviceDetectionException">
- <summary>
- Represents a problem which has occured during device detection.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DeviceDetectionException._device">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.DeviceDetectionException.#ctor(DotSpatial.Positioning.Device,System.Exception)">
- <summary>
- Creates a new instance of a DeviceDetectionException
- </summary>
- <param name="device">The device.</param>
- <param name="innerException">The inner exception.</param>
- </member>
- <member name="M:DotSpatial.Positioning.DeviceDetectionException.#ctor(DotSpatial.Positioning.Device,System.String)">
- <summary>
- Creates a new instance of a DeviceDetectionException
- </summary>
- <param name="device">The device.</param>
- <param name="message">The message.</param>
- </member>
- <member name="M:DotSpatial.Positioning.DeviceDetectionException.#ctor(DotSpatial.Positioning.Device,System.String,System.Exception)">
- <summary>
- Creates a new instance of a DeviceDetectionException
- </summary>
- <param name="device">The device.</param>
- <param name="message">The message.</param>
- <param name="innerException">The inner exception.</param>
- </member>
- <member name="P:DotSpatial.Positioning.DeviceDetectionException.Device">
- <summary>
- The device that caused the exception
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.DeviceDetectionExceptionEventArgs">
- <summary>
- Represents information about a device detection problem during detection-related events.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DeviceDetectionExceptionEventArgs._exception">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.DeviceDetectionExceptionEventArgs.#ctor(DotSpatial.Positioning.DeviceDetectionException)">
- <summary>
- Creates a new instance of the DeviceDetectionException event arguments.
- </summary>
- <param name="exception">The exception.</param>
- </member>
- <member name="P:DotSpatial.Positioning.DeviceDetectionExceptionEventArgs.Device">
- <summary>
- The device that is involved in the event
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.DeviceDetectionExceptionEventArgs.Exception">
- <summary>
- The exception
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.DilutionOfPrecision">
- <summary>
- Represents a confidence level in the precision of GPS data.
- </summary>
- <remarks><para>Dilution of Precision (or "DOP" for short) is a very important concept for GPS software
- developers. When GPS devices calculate the current location on Earth's surface, inaccuracies
- can cause the calculated position to be incorrect by as much as an American football field! To
- help minimize these effects, the GPS device also reports DOP values. A low DOP value (such as 2)
- indicates excellent precision, whereas a high value (such as 50) indicates that precision is very
- poor.</para>
- <para>As a rule of thumb, a DOP value can be multiplied by the average precision of a GPS device
- to get a measurable amount of error. Most consumer GPS devices are capable of about four to six meters
- of precision at their best, or as low as one to three meters if DGPS services such as WAAS or EGNOS are
- being utilized. Or, an average of five meters without DGPS, and an average of two meters with DGPS.
- So, if the current Dilution of Precision is four, and WAAS is in effect, the current precision is
- "2 meters * four = 8 meters" of precision.</para>
- <para>GPS.NET includes features to help you monitor and control the precision of your GPS devices. Properties
- such as <strong>MaximumHorizontalDilutionOfPrecision</strong> will cause a GPS.NET interpreter to throw out
- any real-time data until the DOP is at or below a specific number. To help you determine this maximum number for
- your application, an article is available to help you. You can find it online at the DotSpatial.Positioning web site here:
- http://dotspatial.codeplex.com/Articles/WritingApps2_1.aspx. </para></remarks>
- </member>
- <member name="F:DotSpatial.Positioning.DilutionOfPrecision._value">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DilutionOfPrecision.TypicalPrecision">
- <summary>
- Represents the typical precision of a consumer-grade GPS device: six meters.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DilutionOfPrecision.TypicalPrecisionWithDgps">
- <summary>
- Represents the typical precision of a consumer-grade GPS device with WAAS, MSAS or EGNOS: two meters.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DilutionOfPrecision.Maximum">
- <summary>
- Represents the worst possible DOP value of fifty.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DilutionOfPrecision.Minimum">
- <summary>
- Represents the best possible DOP value of one.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DilutionOfPrecision.Excellent">
- <summary>
- Represents a DOP reading signifying nearly-ideal precision.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DilutionOfPrecision.Fair">
- <summary>
- Represents a DOP reading signifying inaccurate positional measurements.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DilutionOfPrecision.Poor">
- <summary>
- Represents a FOP reading signifying grossly inaccurate positional
- measurements.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DilutionOfPrecision.Ideal">
- <summary>
- Represents a value of 1, where the GPS device is making the most accurate
- measurements possible.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DilutionOfPrecision.Moderate">
- <summary>
- Represents a DOP reading signifying inaccurate positional measurements.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DilutionOfPrecision.Good">
- <summary>
- Represents a DOP reading signifying fairly accurate positional
- measurements.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DilutionOfPrecision.Invalid">
- <summary>
- Represents an invalid or unspecified DOP value.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DilutionOfPrecision._currentAverageDevicePrecision">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.DilutionOfPrecision.#ctor(System.Single)">
- <summary>
- Creates a new instance using the specified value.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:DotSpatial.Positioning.DilutionOfPrecision.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
- </summary>
- <param name="obj">Another object to compare to.</param>
- <returns><c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.DilutionOfPrecision.GetHashCode">
- <summary>
- Returns a hash code for this instance.
- </summary>
- <returns>A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.DilutionOfPrecision.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.DilutionOfPrecision.Equals(DotSpatial.Positioning.DilutionOfPrecision)">
- <summary>
- Indicates whether the current object is equal to another object of the same type.
- </summary>
- <param name="other">An object to compare with this object.</param>
- <returns>true if the current object is equal to the <paramref name="other"/> parameter; otherwise, false.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.DilutionOfPrecision.ToString(System.String,System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format to use.-or- A null reference (Nothing in Visual Basic) to use the default format defined for the type of the <see cref="T:System.IFormattable"/> implementation.</param>
- <param name="formatProvider">The provider to use to format the value.-or- A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.</param>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.DilutionOfPrecision.CompareTo(DotSpatial.Positioning.DilutionOfPrecision)">
- <summary>
- Compares the current object with another object of the same type.
- </summary>
- <param name="other">An object to compare with this object.</param>
- <returns>A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has the following meanings:
- Value
- Meaning
- Less than zero
- This object is less than the <paramref name="other"/> parameter.
- Zero
- This object is equal to <paramref name="other"/>.
- Greater than zero
- This object is greater than <paramref name="other"/>.</returns>
- </member>
- <member name="P:DotSpatial.Positioning.DilutionOfPrecision.Value">
- <summary>
- Returns the numeric value of the rating.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.DilutionOfPrecision.IsEmpty">
- <summary>
- Returns whether the value is zero.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.DilutionOfPrecision.IsInvalid">
- <summary>
- Returns whether the value is invalid or unspecified.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.DilutionOfPrecision.EstimatedPrecision">
- <summary>
- Returns the estimated precision as a measurable distance.
- </summary>
- <remarks>The precision estimate is a product of this value and the value of the
- CurrentAverageDevicePrecision static property.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.DilutionOfPrecision.Rating">
- <summary>
- Returns a friendly name for the level of precision.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.DilutionOfPrecision.CurrentAverageDevicePrecision">
- <summary>
- Controls the estimated average precision possible by the current GPS device.
- </summary>
- <value>The current average device precision.</value>
- <remarks>Most consumer GPS devces are capable of about six meters of precision without DGPS features
- such as WAAS or EGNOS. When DGPS features are utilized, a typical cunsumer device is capable of about
- two meters of precision. If you know of a specific amount for your device, you can set this property to
- assist GPS.NET in calculating the current estimated measurable amount of error in latitude/longitude reports.</remarks>
- </member>
- <member name="T:DotSpatial.Positioning.DilutionOfPrecisionRating">
- <summary>
- Indicates an interpretation of the accuracy of a measurement made by the GPS
- device.
- </summary>
- <remarks>This enumeration is used by the
- <see cref="P:DotSpatial.Positioning.DilutionOfPrecision.Rating">Rating</see> property of the
- <see cref="T:DotSpatial.Positioning.DilutionOfPrecision">
- DilutionOfPrecision</see> class. This interpretation is subject to discussion as to
- what precisely constitutes a "good" versus "bad" DOP. Use your own best judgement based
- on the needs of your application. Generally speaking, a DOP of six or less is
- recommended for en-route navigation, and three or less for highly-precise measurements.
- A rating of <strong>Moderate</strong> corresponds with six or better, a rating of
- <strong>Excellent</strong> means three or less, and a rating of <strong>Ideal</strong>
- means the best value of one.</remarks>
- </member>
- <member name="F:DotSpatial.Positioning.DilutionOfPrecisionRating.Unknown">
- <summary>The rating is unknown or not yet available.</summary>
- </member>
- <member name="F:DotSpatial.Positioning.DilutionOfPrecisionRating.Ideal">
- <summary>
- Represents a value of 1, where the GPS device is making the most accurate
- measurements possible.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DilutionOfPrecisionRating.Excellent">
- <summary>
- The GPS device is making high-quality measurements, good enough for applications
- requiring higher levels of precision. Represents a value of 2 or 3.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DilutionOfPrecisionRating.Good">
- <summary>
- The GPS device is making measurements accurate enough for en-route navigation.
- Represents a value between 4 and 6.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DilutionOfPrecisionRating.Moderate">
- <summary>
- The GPS device is making measurements good enough to indicate the approximate
- location, but should be ignored by applications requiring high accuracy. Represents a
- value of 7 or 8.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DilutionOfPrecisionRating.Fair">
- <summary>
- The GPS device is making measurements with an accuracy which should only be used
- to indicate the approximate location, but is not accurate enough for en-route
- navigation. Represents a value between 9 and 20.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DilutionOfPrecisionRating.Poor">
- <summary>
- The GPS device is calculating the current location, but the accuracy is extremely
- low and may be off by a factor of fifty. Represents a value between 21 and the maximum
- possible of 50.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.DilutionOfPrecisionEventArgs">
- <summary>
- Represents information about a DOP measurement when an DOP-related event is raised.
- </summary>
- <example>This example demonstrates how to use this class when raising an event.
- <code lang="VB">
- ' Declare a new event
- Dim MyDilutionOfPrecisionEvent As EventHandler
- ' Create a DilutionOfPrecision of 30 horizontal
- Dim MyDilutionOfPrecision As New DilutionOfPrecision(DilutionOfPrecisionType.Horizontal, 30.0)
- Sub Main()
- ' Raise our custom event
- RaiseEvent MyDilutionOfPrecisionEvent(Me, New DilutionOfPrecisionEventArgs(MyDilutionOfPrecision))
- End Sub
- </code>
- <code lang="C#">
- // Declare a new event
- EventHandler MyDilutionOfPrecisionEvent;
- // Create a DilutionOfPrecision of 30 horizontal
- DilutionOfPrecision MyDilutionOfPrecision = new DilutionOfPrecision(DilutionOfPrecisionType.Horizontal, 30.0);
- void Main()
- {
- // Raise our custom event
- MyDilutionOfPrecisionEvent(this, New DilutionOfPrecisionEventArgs(MyDilutionOfPrecision));
- }
- </code>
- </example>
-
- <seealso cref="P:DotSpatial.Positioning.DilutionOfPrecisionEventArgs.DilutionOfPrecision">DilutionOfPrecision Class</seealso>
-
- <seealso cref="T:System.EventHandler">EventHandler Delegate</seealso>
- <remarks>This class is typically used for events in the <see cref="P:DotSpatial.Positioning.DilutionOfPrecisionEventArgs.DilutionOfPrecision">DilutionOfPrecision</see> class to
- provide notification when hours, minutes, decimal minutes or seconds properties have changed.</remarks>
- </member>
- <member name="F:DotSpatial.Positioning.DilutionOfPrecisionEventArgs._dilutionOfPrecision">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.DilutionOfPrecisionEventArgs.#ctor(DotSpatial.Positioning.DilutionOfPrecision)">
- <summary>
- Creates a new instance with the specified DOP measurement.
- </summary>
- <param name="dilutionOfPrecision">The dilution of precision.</param>
- </member>
- <member name="P:DotSpatial.Positioning.DilutionOfPrecisionEventArgs.DilutionOfPrecision">
- <summary>
- A DilutionOfPrecision object which is the target of the event.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.Emulator">
- <summary>
- Represents a simulated GPS device.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Emulator._name">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Emulator._readDataAvailableWaitHandle">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Emulator._readBuffer">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Emulator._writeDataAvailableWaitHandle">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Emulator._writeBuffer">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Emulator._thread">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Emulator._emulationIntervalWaitHandle">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Emulator._readTimeout">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Emulator._writeTimeout">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Emulator._isDisposed">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Emulator._isRunning">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Emulator._utcDateTime">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Emulator._speed">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Emulator._bearing">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Emulator._currentPosition">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Emulator._currentDestination">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Emulator._altitude">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Emulator._route">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Emulator._routeIndex">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Emulator._satellites">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Emulator._fixQuality">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Emulator._fixMode">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Emulator._fixMethod">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Emulator._fixStatus">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Emulator._horizontalDop">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Emulator._verticalDop">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Emulator._meanDop">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Emulator._interval">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Emulator._seed">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Emulator._speedLow">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Emulator._speedHigh">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Emulator._bearingStart">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Emulator._bearingArc">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Emulator._isRandom">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Emulator._defaultReadBufferSize">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Emulator._defaultWriteBufferSize">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Emulator._defaultReadTimeout">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Emulator._defaultWriteTimeout">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Emulator.ExceptionOccurred">
- <summary>
- An Excpetion occured
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Emulator.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:System.IO.Stream"/> class.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Emulator.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.Emulator"/> class.
- </summary>
- <param name="name">The name.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Emulator.Open">
- <summary>
- Open
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Emulator.EmulatorThreadProc">
- <summary>
- Emulators the thread proc.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Emulator.OnEmulation">
- <summary>
- Called when [emulation].
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Emulator.SetRandom(System.Boolean)">
- <summary>
- Toggles the IsRandom flag.
- </summary>
- <param name="isRandom">The state to toggle the flag.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Emulator.Randomize">
- <summary>
- Randomizes the emulation by changing speed and direction
- </summary>
- <remarks>GPS coordinate emulation can be randomized by any number of factors, depending on the emulator type used.
- Any emulation can have it's direction and speed randomized within specified tolerances. By default, speed is
- limited to between 0 (low) and 5 (high) meters/second and bearing changes are limited to +/- 45 degrees
- (a 90 degree arc) from North (0) degrees.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Emulator.Randomize(System.Random,DotSpatial.Positioning.Speed,DotSpatial.Positioning.Speed,DotSpatial.Positioning.Azimuth,DotSpatial.Positioning.Azimuth)">
- <summary>
- Randomizes the emulation by changing speed and direction
- </summary>
- <param name="seed">The randomizer to use.</param>
- <param name="speedLow">The minimum travel speed.</param>
- <param name="speedHigh">The maximum travel speed.</param>
- <param name="bearingStart">The initial direction of travel.</param>
- <param name="bearingArc">The arc in which random directional changes will occur.</param>
- <remarks>GPS coordinate emulation can be randomized by any number of factors, depending on the emulator type used.
- Any emulation can have it's direction and speed randomized within specified tolerances. By default, speed is
- limited to between 0 (low) and 5 (high) meters/second and bearing changes are limited to +/- 45 degrees
- (a 90 degree arc) from North (0) degrees.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Emulator.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.Emulator.Flush">
- <summary>
- When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device.
- </summary>
- <exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
- </member>
- <member name="M:DotSpatial.Positioning.Emulator.Seek(System.Int64,System.IO.SeekOrigin)">
- <summary>
- When overridden in a derived class, sets the position within the current stream.
- </summary>
- <param name="offset">A byte offset relative to the <paramref name="origin"/> parameter.</param>
- <param name="origin">A value of type <see cref="T:System.IO.SeekOrigin"/> indicating the reference point used to obtain the new position.</param>
- <returns>The new position within the current stream.</returns>
- <exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
-
- <exception cref="T:System.NotSupportedException">The stream does not support seeking, such as if the stream is constructed from a pipe or console output. </exception>
-
- <exception cref="T:System.ObjectDisposedException">Methods were called after the stream was closed. </exception>
- </member>
- <member name="M:DotSpatial.Positioning.Emulator.SetLength(System.Int64)">
- <summary>
- When overridden in a derived class, sets the length of the current stream.
- </summary>
- <param name="value">The desired length of the current stream in bytes.</param>
- <exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
-
- <exception cref="T:System.NotSupportedException">The stream does not support both writing and seeking, such as if the stream is constructed from a pipe or console output. </exception>
-
- <exception cref="T:System.ObjectDisposedException">Methods were called after the stream was closed. </exception>
- </member>
- <member name="M:DotSpatial.Positioning.Emulator.Read(System.Byte[],System.Int32,System.Int32)">
- <summary>
- When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
- </summary>
- <param name="buffer">An array of bytes. When this method returns, the buffer contains the specified byte array with the values between <paramref name="offset"/> and (<paramref name="offset"/> + <paramref name="count"/> - 1) replaced by the bytes read from the current source.</param>
- <param name="offset">The zero-based byte offset in <paramref name="buffer"/> at which to begin storing the data read from the current stream.</param>
- <param name="count">The maximum number of bytes to be read from the current stream.</param>
- <returns>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached.</returns>
- <exception cref="T:System.ArgumentException">The sum of <paramref name="offset"/> and <paramref name="count"/> is larger than the buffer length. </exception>
-
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is null. </exception>
-
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="offset"/> or <paramref name="count"/> is negative. </exception>
-
- <exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
-
- <exception cref="T:System.NotSupportedException">The stream does not support reading. </exception>
-
- <exception cref="T:System.ObjectDisposedException">Methods were called after the stream was closed. </exception>
- </member>
- <member name="M:DotSpatial.Positioning.Emulator.ReadByte">
- <summary>
- Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream.
- </summary>
- <returns>The unsigned byte cast to an Int32, or -1 if at the end of the stream.</returns>
- <exception cref="T:System.NotSupportedException">The stream does not support reading. </exception>
-
- <exception cref="T:System.ObjectDisposedException">Methods were called after the stream was closed. </exception>
- </member>
- <member name="M:DotSpatial.Positioning.Emulator.Write(System.Byte[],System.Int32,System.Int32)">
- <summary>
- When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
- </summary>
- <param name="buffer">An array of bytes. This method copies <paramref name="count"/> bytes from <paramref name="buffer"/> to the current stream.</param>
- <param name="offset">The zero-based byte offset in <paramref name="buffer"/> at which to begin copying bytes to the current stream.</param>
- <param name="count">The number of bytes to be written to the current stream.</param>
- <exception cref="T:System.ArgumentException">The sum of <paramref name="offset"/> and <paramref name="count"/> is greater than the buffer length. </exception>
-
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is null. </exception>
-
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="offset"/> or <paramref name="count"/> is negative. </exception>
-
- <exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
-
- <exception cref="T:System.NotSupportedException">The stream does not support writing. </exception>
-
- <exception cref="T:System.ObjectDisposedException">Methods were called after the stream was closed. </exception>
- </member>
- <member name="M:DotSpatial.Positioning.Emulator.WriteByte(System.Byte)">
- <summary>
- Writes a byte to the current position in the stream and advances the position within the stream by one byte.
- </summary>
- <param name="value">The byte to write to the stream.</param>
- <exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
-
- <exception cref="T:System.NotSupportedException">The stream does not support writing, or the stream is already closed. </exception>
-
- <exception cref="T:System.ObjectDisposedException">Methods were called after the stream was closed. </exception>
- </member>
- <member name="M:DotSpatial.Positioning.Emulator.Close">
- <summary>
- Closes the emulation stream, but doesn't dispose of it.
- </summary>
- <remarks>The Emulator.Close() method simply terminates the thread that feeds data to
- a virtual Device. This allows the emulator to be reused indefinately.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Emulator.Dispose(System.Boolean)">
- <summary>
- Releases the unmanaged resources used by the <see cref="T:System.IO.Stream"/> and optionally releases the managed resources.
- </summary>
- <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
- </member>
- <member name="P:DotSpatial.Positioning.Emulator.DefaultReadBufferSize">
- <summary>
- Default Read Buffer Size
- </summary>
- <value>The default size of the read buffer.</value>
- <exception cref="T:System.ArgumentOutOfRangeException"></exception>
- </member>
- <member name="P:DotSpatial.Positioning.Emulator.DefaultWriteBufferSize">
- <summary>
- Default Write Buffer Size
- </summary>
- <value>The default size of the write buffer.</value>
- <exception cref="T:System.ArgumentOutOfRangeException"></exception>
- </member>
- <member name="P:DotSpatial.Positioning.Emulator.DefaultReadTimeout">
- <summary>
- Default Read Timeout
- </summary>
- <value>The default read timeout.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Emulator.DefaultWriteTimeout">
- <summary>
- The Timespan of before the write operation times out.
- </summary>
- <value>The default write timeout.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Emulator.IsEmulationThreadAlive">
- <summary>
- Gets a value indicating whether this instance is emulation thread alive.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Emulator.Seed">
- <summary>
- Returns the current randomizer for emulation.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Emulator.Interval">
- <summary>
- Returns the amount of time the emulator waits before processing new data.
- </summary>
- <value>The interval.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Emulator.IsFixed">
- <summary>
- Indicates whether enough satellite signals exist to determine the current location.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Emulator.IsRandom">
- <summary>
- Gets a value indicating whether or not the emulator is generating data that
- changes in random manner.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Emulator.Name">
- <summary>
- the string Name ofhte emulator
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Emulator.Altitude">
- <summary>
- The string altitude
- </summary>
- <value>The altitude.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Emulator.Speed">
- <summary>
- the speed
- </summary>
- <value>The speed.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Emulator.Bearing">
- <summary>
- The Directional azimuth angle
- </summary>
- <value>The bearing.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Emulator.FixedSatelliteCount">
- <summary>
- The integer count of fixed satellites
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Emulator.FixQuality">
- <summary>
- The quality of the GPS signal
- </summary>
- <value>The fix quality.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Emulator.FixMode">
- <summary>
- The mode of the signal fix
- </summary>
- <value>The fix mode.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Emulator.FixMethod">
- <summary>
- the fix method
- </summary>
- <value>The fix method.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Emulator.FixStatus">
- <summary>
- The status of the fix
- </summary>
- <value>The fix status.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Emulator.HorizontalDilutionOfPrecision">
- <summary>
- the Horizontal Dilution of Precision (HPDOP)
- </summary>
- <value>The horizontal dilution of precision.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Emulator.VerticalDilutionOfPrecision">
- <summary>
- The Vertical Dilution of Precision (VPDOP)
- </summary>
- <value>The vertical dilution of precision.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Emulator.MeanDilutionOfPrecision">
- <summary>
- The average of the Dilution of precision values.
- </summary>
- <value>The mean dilution of precision.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Emulator.Satellites">
- <summary>
- Gets the list of satellites.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Emulator.Route">
- <summary>
- Gets the list of positions that make up this route
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Emulator.CurrentPosition">
- <summary>
- Gets the Position structure for the current position
- </summary>
- <value>The current position.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Emulator.CurrentDestination">
- <summary>
- Gets or sets the position with the new destination
- </summary>
- <value>The current destination.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Emulator.DateTime">
- <summary>
- Gets the DateTime structure for Now
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Emulator.UtcDateTime">
- <summary>
- Gets the UtcCorrected value for Now
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Emulator.CanRead">
- <summary>
- When overridden in a derived class, gets a value indicating whether the current stream supports reading.
- </summary>
- <returns>true if the stream supports reading; otherwise, false.</returns>
- </member>
- <member name="P:DotSpatial.Positioning.Emulator.CanSeek">
- <summary>
- When overridden in a derived class, gets a value indicating whether the current stream supports seeking.
- </summary>
- <returns>true if the stream supports seeking; otherwise, false.</returns>
- </member>
- <member name="P:DotSpatial.Positioning.Emulator.CanTimeout">
- <summary>
- Gets a value that determines whether the current stream can time out.
- </summary>
- <returns>A value that determines whether the current stream can time out.</returns>
- </member>
- <member name="P:DotSpatial.Positioning.Emulator.ReadBuffer">
- <summary>
- Gets the read buffer.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Emulator.ReadDataAvailableWaitHandle">
- <summary>
- Gets the read data available wait handle.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Emulator.WriteBuffer">
- <summary>
- Gets the write buffer.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Emulator.WriteDataAvailableWaitHandle">
- <summary>
- Gets the write data available wait handle.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Emulator.Position">
- <summary>
- When overridden in a derived class, gets or sets the position within the current stream.
- </summary>
- <value>The position.</value>
- <returns>The current position within the stream.</returns>
-
- <exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
-
- <exception cref="T:System.NotSupportedException">The stream does not support seeking. </exception>
-
- <exception cref="T:System.ObjectDisposedException">Methods were called after the stream was closed. </exception>
- </member>
- <member name="P:DotSpatial.Positioning.Emulator.Length">
- <summary>
- When overridden in a derived class, gets the length in bytes of the stream.
- </summary>
- <returns>A long value representing the length of the stream in bytes.</returns>
-
- <exception cref="T:System.NotSupportedException">A class derived from Stream does not support seeking. </exception>
-
- <exception cref="T:System.ObjectDisposedException">Methods were called after the stream was closed. </exception>
- </member>
- <member name="P:DotSpatial.Positioning.Emulator.CanWrite">
- <summary>
- When overridden in a derived class, gets a value indicating whether the current stream supports writing.
- </summary>
- <returns>true if the stream supports writing; otherwise, false.</returns>
- </member>
- <member name="P:DotSpatial.Positioning.Emulator.ReadTimeout">
- <summary>
- Gets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out.
- </summary>
- <value>The read timeout.</value>
- <returns>A value, in miliseconds, that determines how long the stream will attempt to read before timing out.</returns>
-
- <exception cref="T:System.InvalidOperationException">The <see cref="P:System.IO.Stream.ReadTimeout"/> method always throws an <see cref="T:System.InvalidOperationException"/>. </exception>
- </member>
- <member name="P:DotSpatial.Positioning.Emulator.WriteTimeout">
- <summary>
- Gets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out.
- </summary>
- <value>The write timeout.</value>
- <returns>A value, in miliseconds, that determines how long the stream will attempt to write before timing out.</returns>
-
- <exception cref="T:System.InvalidOperationException">The <see cref="P:System.IO.Stream.WriteTimeout"/> method always throws an <see cref="T:System.InvalidOperationException"/>. </exception>
- </member>
- <member name="T:DotSpatial.Positioning.FixQuality">
- <summary>
- Indicates which devices are being used to obtain a fix, other than the GPS device
- itself.
- </summary>
- <example>
- <code lang="VB">
- ' Declare a new receiver
- Private WithEvents MyReceiver As New Receiver()
- ' Raised when the fix quality has changed
- Private Sub OnFixQualityChanged(ByVal sender As Object, ByVal e As FixQualityEventArgs)
- ' What is the new fix quality°
- Select Case e.FixQuality
- Case FixQuality.NoFix
- ' No fix is obtained
- Debug.WriteLine("No fix is currently obtained.")
- Case FixQuality.GpsFix
- ' A fix is present
- Debug.WriteLine("A fix has been obtained using only GPS satellites.")
- Case FixQuality.DifferentialGpsFix
- ' A differential fix is present
- Debug.WriteLine("A fix has been obtained using GPS satellites and correction information from DGPS/WAAS ground stations.")
- Case FixQuality.Estimated
- ' A fix is being estimated (not an actual fix)
- Debug.WriteLine("A fix is currently being estimated. ")
- End Select
- End Sub
- </code>
- <code lang="C#">
- // Declare a new receiver
- Receiver MyReceiver = new Receiver();
- // Raised when the fix quality has changed
- void OnFixQualityChanged(Object sender, FixQualityEventArgs e)
- {
- // What is the new fix quality°
- switch (e.FixQuality)
- {
- case FixQuality.NoFix:
- // No fix is obtained
- Debug.WriteLine("No fix is currently obtained.");
- case FixQuality.GpsFix:
- // A fix is present
- Debug.WriteLine("A fix has been obtained using only GPS satellites.");
- case FixQuality.DifferentialGpsFix:
- // A differential fix is present
- Debug.WriteLine("A fix has been obtained using GPS satellites and correction information from DGPS/WAAS ground stations.");
- case FixQuality.Estimated:
- // A fix is being estimated (not an actual fix)
- Debug.WriteLine("A fix is currently being estimated. ");
- }
- }
- </code>
- </example>
- <remarks>This enumeration is typically used by the</remarks>
- </member>
- <member name="F:DotSpatial.Positioning.FixQuality.Unknown">
- <summary>
- Not enough information is available to specify the current fix quality.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.FixQuality.NoFix">
- <summary>No fix is currently obtained.</summary>
- </member>
- <member name="F:DotSpatial.Positioning.FixQuality.GpsFix">
- <summary>A fix is currently obtained using GPS satellites only.</summary>
- </member>
- <member name="F:DotSpatial.Positioning.FixQuality.DifferentialGpsFix">
- <summary>A fix is obtained using both GPS satellites and DGPS/WAAS ground
- stations. Position error is as low as 0.5-5 meters.</summary>
- </member>
- <member name="F:DotSpatial.Positioning.FixQuality.PulsePerSecond">
- <summary>
- A PPS or pulse-per-second fix. PPS signals very accurately indicate the start of a second.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.FixQuality.FixedRealTimeKinematic">
- <summary>
- Used for surveying. A fix is obtained with the assistance of a reference station. Position error is as low as 1-5 centimeters.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.FixQuality.FloatRealTimeKinematic">
- <summary>
- Used for surveying. A fix is obtained with the assistance of a reference station. Position error is as low as 20cm to 1 meter.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.FixQuality.Estimated">
- <summary>
- The fix is being estimated.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.FixQuality.ManualInput">
- <summary>
- The fix is being input manually.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.FixQuality.Simulated">
- <summary>
- The fix is being simulated.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.FixMethod">
- <summary>
- Indicates whether a fix is present and if altitude can be calculated along with
- latitude and longitude.
- </summary>
- <example>
- This example demonstrates how to use the FixMethod enumeration to tell if altitude
- measurements can be made. Notice: Some devices have built-in altimeters. These devices
- can report altitude even when there is no fix present. To support such devices, avoid
- using this property entirely and use any non-zero altitude measurement.
- <code lang="VB">
- Private WithEvents MyReceiver As New Receiver()
- ' Raised whenever the fix method has changed
- Private Sub OnFixMethodChanged(ByVal sender As Object, ByVal e As FixMethodEventArgs)
- ' What is the new fix method°
- Select Case e.FixMethod
- Case FixMethod.NoFix
- ' We have neither position or altitude
- Debug.WriteLine("Your position is: Not Yet Available")
- Debug.WriteLine("Your altitude is: Not Yet Available")
- Case FixMethod.Fix2D
- ' We have a position but no altitude
- Debug.WriteLine("Your position is: " & MyReceiver.Position.ToString)
- Debug.WriteLine("Your altitude is: Not Yet Available")
- Case FixMethod.Fix3D
- ' We have both position and altitude
- Debug.WriteLine("Your position is: " & MyReceiver.Position.ToString)
- Debug.WriteLine("Your altitude is: " & MyReceiver.Altitude.ToString)
- End Select
- End Sub
- </code>
- <code lang="C#">
- // Declare a new receiver
- Private WithEvents MyReceiver As New Receiver()
- // Raised whenever the fix method has changed
- void OnFixMethodChanged(Object sender, FixMethodEventArgs e)
- {
- // What is the new fix method°
- switch (e.FixMethod)
- {
- case FixMethod.NoFix:
- // We have neither position or altitude
- Debug.WriteLine("Your position is: Not Yet Available");
- Debug.WriteLine("Your altitude is: Not Yet Available");
- case FixMethod.Fix2D:
- // We have a position but no altitude
- Debug.WriteLine("Your position is: " & MyReceiver.Position.ToString());
- Debug.WriteLine("Your altitude is: Not Yet Available");
- case FixMethod.Fix3D:
- // We have both position and altitude
- Debug.WriteLine("Your position is: " & MyReceiver.Position.ToString());
- Debug.WriteLine("Your altitude is: " & MyReceiver.Altitude.ToString());
- }
- }
- </code>
- </example>
- <remarks>This enumeration is used by the
- class to indicate if altitude measurements are possible. Altitude measurements are
- possible whenever there are four or more satellites involved in a fix.</remarks>
- </member>
- <member name="F:DotSpatial.Positioning.FixMethod.NoFix">
- <summary>The GPS device does not have a fix on the current position.</summary>
- </member>
- <member name="F:DotSpatial.Positioning.FixMethod.Fix2D">
- <summary>The GPS device is reporting latitude and longitude.</summary>
- </member>
- <member name="F:DotSpatial.Positioning.FixMethod.Fix3D">
- <summary>The GPS device is reporting latitude, longitude, and altitude.</summary>
- </member>
- <member name="F:DotSpatial.Positioning.FixMethod.Unknown">
- <summary>
- The fix method is not yet known.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.FixStatus">
- <summary>
- Indicates whether a satellite fix is currently active.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.FixStatus.Unknown">
- <summary>
- The satellite fix is untested
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.FixStatus.NoFix">
- <summary>
- The satellite fix is inactive
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.FixStatus.Fix">
- <summary>
- The satellite fix is active
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.FixLikelihood">
- <summary>
- Indicates the likelihood that a GPS satellite fix will be obtained or
- sustained.
- </summary>
- <example>
- This example uses the FixLikelihood enumeration to make a judgement call on the
- stability of the fix.
- <code lang="VB">
- ' Declare a new receiver
- Private WithEvents MyReceiver As New Receiver()
- Sub Main()
- ' Start listening for messages
- MyReceiver.Start
- End Sub
- Sub OnFixLikelihoodChanged(ByVal sender As Object, ByVal e As FixLikelihoodEventArgs) Handles MyReceiver.FixLikelihoodChanged
- ' Do we have a fix currently°
- If MyReceiver.IsFixObtained Then
- ' Yes. What's the likelihood that the fix will be sustained°
- Select Case MyReceiver.FixLikelihood
- Case FixLikelihood.Unlikely
- Debug.WriteLine("The current fix is about to be lost!")
- Case FixLikelihood.Possible
- Debug.WriteLine("The current fix is unstable. Find a more open view of the sky soon.")
- Case FixLikelihood.Likely
- Debug.WriteLine("The current fix is nearly stable.")
- Case FixLikelihood.Certain
- Debug.WriteLine("The current fix is stable.")
- End Select
- Else
- ' No. What's the likelihood that a fix will be obtained°
- Select Case MyReceiver.FixLikelihood
- Case FixLikelihood.Unlikely
- Debug.WriteLine("A fix is not possible. Find a more open view of the sky.")
- Case FixLikelihood.Possible
- Debug.WriteLine("A fix is possible, but satellite signals are still mostly obscured.")
- Case FixLikelihood.Likely
- Debug.WriteLine("A fix should occur within the next several seconds.")
- Case FixLikelihood.Certain
- Debug.WriteLine("A fix will occur in a few seconds.")
- End Select
- End If
- End Sub
- </code>
- <code lang="CS">
- ' Declare a new receiver
- Private Receiver MyReceiver = new Receiver();
- void Main()
- {
- // Start listening for messages
- MyReceiver.Start();
- }
- void OnFixLikelihoodChanged(Object sender, FixLikelihoodEventArgs e)
- {
- // Do we have a fix currently°
- if (MyReceiver.IsFixObtained)
- {
- // Yes. What's the likelihood that the fix will be sustained°
- switch (MyReceiver.FixLikelihood)
- {
- case FixLikelihood.Unlikely:
- Debug.WriteLine("The current fix is about to be lost!");
- break;
- case FixLikelihood.Possible:
- Debug.WriteLine("The current fix is unstable. Find a more open view of the sky soon.");
- break;
- case FixLikelihood.Likely:
- Debug.WriteLine("The current fix is nearly stable.");
- break;
- case FixLikelihood.Certain:
- Debug.WriteLine("The current fix is stable.");
- break;
- }
- }
- else
- {
- // No. What's the likelihood that a fix will be obtained°
- switch (MyReceiver.FixLikelihood)
- {
- case FixLikelihood.Unlikely:
- Debug.WriteLine("A fix is not possible. Find a more open view of the sky.");
- break;
- case FixLikelihood.Possible:
- Debug.WriteLine("A fix is possible, but satellite signals are still mostly obscured.");
- break;
- case FixLikelihood.Likely:
- Debug.WriteLine("A fix should occur within the next several seconds.");
- break;
- case FixLikelihood.Certain:
- Debug.WriteLine("A fix will occur in a few seconds.");
- break;
- }
- }
- }
- </code>
- </example>
- </member>
- <member name="F:DotSpatial.Positioning.FixLikelihood.Unlikely">
- <summary>Indicates that a fix would probably be lost if a fix is acquired.</summary>
- <remarks>When this value is returned, nearly all of the available GPS satellite signals are being obscured by buildings, trees, or other solid objects. The device should be moved into a more open view of the sky.</remarks>
- </member>
- <member name="F:DotSpatial.Positioning.FixLikelihood.Possible">
- <summary>
- Indicates that a fix would probably be lost after a short period of time if a fix
- is acquired.
- </summary>
- <remarks>When this value is returned, a few satellite signals are available, but the combined signals are too weak to maintain a fix for long. The device should be moved into a more open view of the sky.</remarks>
- </member>
- <member name="F:DotSpatial.Positioning.FixLikelihood.Likely">
- <summary>
- Indicates that a fix would probably last for a longer period of time if a fix is
- acquired.
- </summary>
- <remarks>When this value is returned, at least three satellite signals are being received clearly. If conditions stay the same or improve, a fix is imminent.</remarks>
- </member>
- <member name="F:DotSpatial.Positioning.FixLikelihood.Certain">
- <summary>
- Indicates that a fix is very likely to be sustained given the current satellite
- signal strengths.
- </summary>
- <remarks>When this value is returned, several satellite signals are being received and are strong enough to maintain a fix.</remarks>
- </member>
- <member name="T:DotSpatial.Positioning.FixMode">
- <summary>
- Indicates if the GPS device is automatically deciding between a 2-D and a 3-D
- fix.
- </summary>
- <remarks>This enumeration is used by the
- class. A vast majority of GPS devices use a setting of Automatic because there is no
- complicated math behind figuring out if a 2-D fix or 3-D fix is present. If there are
- three satellites involved in a fix, only the latitude and longitude can be calculated,
- so the fix is 2-D. If more than three involved, the fix is 3-D.</remarks>
- </member>
- <member name="F:DotSpatial.Positioning.FixMode.Automatic">
- <summary>Typical value. The GPS device is automatically deciding between a two- and three-dimensional fix.</summary>
- </member>
- <member name="F:DotSpatial.Positioning.FixMode.Manual">
- <summary>Rare value. The user must specify whether a two- or three-dimensional fix is to be used.</summary>
- </member>
- <member name="F:DotSpatial.Positioning.FixMode.Unknown">
- <summary>
- The fix mode is not yet known.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.FixMethodEventArgs">
- <summary>
- Represents information about the method used to obtain a fix when a fix-related event is raised.
- </summary>
- <example>This example demonstrates how to use this class when raising an event.
- <code lang="VB">
- ' Declare a new event
- Dim MyFixMethodEvent As EventHandler
- ' Create a FixMethod signifying a 3-D fix (both position and altitude)
- Dim MyFixMethod As FixMethod = FixMethod.Fix3D
- Sub Main()
- ' Raise our custom event
- RaiseEvent MyFixMethodEvent(Me, New FixMethodEventArgs(MyFixMethod))
- End Sub
- </code>
- <code lang="C#">
- // Declare a new event
- EventHandler MyFixMethodEvent;
- // Create a FixMethod signifying a 3-D fix (both position and altitude)
- FixMethod MyFixMethod = FixMethod.Fix3D;
- void Main()
- {
- // Raise our custom event
- MyFixMethodEvent(this, New FixMethodEventArgs(MyFixMethod));
- }
- </code>
- </example>
- <remarks>This object is used primarily by the FixMethodChanged
- event of the Receiver class to provide notification when
- updated fix method information has been received from the GPS device.</remarks>
- </member>
- <member name="F:DotSpatial.Positioning.FixMethodEventArgs._fixMethod">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.FixMethodEventArgs.#ctor(DotSpatial.Positioning.FixMethod)">
- <summary>
- Creates a new instance with the specified fix method.
- </summary>
- <param name="fixMethod">The fix method.</param>
- </member>
- <member name="P:DotSpatial.Positioning.FixMethodEventArgs.FixMethod">
- <summary>
- Indicates if the GPS device has no fix, a 2-D fix, or a 3-D fix.
- </summary>
- <value>A value from the <strong>FixMethod</strong> enumeration.</value>
- <seealso cref="P:DotSpatial.Positioning.FixMethodEventArgs.FixMethod">FixMethod Property (Receiver Class)</seealso>
- <remarks>A device is considered to have a "2-D" fix if there are three satellites
- involved in the fix. A 2-D fix means that position information is available, but not
- altitude. If at least four satellites are fixed, both position and altitude are known,
- and the fix is considered 3-D.</remarks>
- </member>
- <member name="T:DotSpatial.Positioning.FixLikelihoodEventArgs">
- <summary>
- Represents information about the likelihood that a fix will be sustained (or obtained) when a when a fix-related event is raised.
- </summary>
- <example>This example demonstrates how to use this class when raising an event.
- <code lang="VB">
- ' Declare a new event
- Dim MyFixLikelihoodEvent As FixLikelihoodEventHandler
- ' Create a FixLikelihood signifying a 3-D fix (both position and altitude)
- Dim MyFixLikelihood As FixLikelihood = FixLikelihood.Fix3D
- Sub Main()
- ' Raise our custom event
- RaiseEvent MyFixLikelihoodEvent(Me, New FixLikelihoodEventArgs(MyFixLikelihood))
- End Sub
- </code>
- <code lang="C#">
- // Declare a new event
- FixLikelihoodEventHandler MyFixLikelihoodEvent;
- // Create a FixLikelihood signifying a 3-D fix (both position and altitude)
- FixLikelihood MyFixLikelihood = FixLikelihood.Fix3D;
- void Main()
- {
- // Raise our custom event
- MyFixLikelihoodEvent(this, New FixLikelihoodEventArgs(MyFixLikelihood));
- }
- </code>
- </example>
- <remarks>This object is used primarily by the FixLikelihoodChanged
- event of the Receiver class to provide notification when
- combined satellite radio signal strength has changed.</remarks>
- </member>
- <member name="F:DotSpatial.Positioning.FixLikelihoodEventArgs._fixLikelihood">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.FixLikelihoodEventArgs.#ctor(DotSpatial.Positioning.FixLikelihood)">
- <summary>
- Creates a new instance with the specified fix Likelihood.
- </summary>
- <param name="fixLikelihood">The fix likelihood.</param>
- </member>
- <member name="P:DotSpatial.Positioning.FixLikelihoodEventArgs.FixLikelihood">
- <summary>
- Indicates if the GPS device has no fix, a 2-D fix, or a 3-D fix.
- </summary>
- <value>A value from the <strong>FixLikelihood</strong> enumeration.</value>
- <remarks>A device is considered to have a "2-D" fix if there are three satellites
- involved in the fix. A 2-D fix means that position information is available, but not
- altitude. If at least four satellites are fixed, both position and altitude are known,
- and the fix is considered 3-D.</remarks>
- </member>
- <member name="T:DotSpatial.Positioning.FixModeEventArgs">
- <summary>
- Represents information about whether the fix method is chosen automatically when a fix-related event is raised.
- </summary>
- <example>This example demonstrates how to use this class when raising an event.
- <code lang="VB">
- ' Declare a new event
- Dim MyFixModeEvent As EventHandler
- ' Create a FixMode signifying that the fix method is being chosen automatically
- Dim MyFixMode As FixMode = FixMode.Automatic
- Sub Main()
- ' Raise our custom event
- RaiseEvent MyFixModeEvent(Me, New FixModeEventArgs(MyFixMode))
- End Sub
- </code>
- <code lang="C#">
- // Declare a new event
- EventHandler MyFixModeEvent;
- // Create a FixMode signifying that the fix method is being chosen automatically
- FixMode MyFixMode = FixMode.Automatic;
- void Main()
- {
- // Raise our custom event
- MyFixModeEvent(this, New FixModeEventArgs(MyFixMode));
- }
- </code>
- </example>
- <remarks>This object is used primarily by the FixModeChanged
- event of the Receiver class to provide notification when
- the receiver switches fix modes from <strong>Automatic</strong> to <strong>Manual</strong> or vice-versa.</remarks>
- </member>
- <member name="F:DotSpatial.Positioning.FixModeEventArgs._fixMode">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.FixModeEventArgs.#ctor(DotSpatial.Positioning.FixMode)">
- <summary>
- Creates a new instance with the specified fix method.
- </summary>
- <param name="fixMode">The fix mode.</param>
- </member>
- <member name="P:DotSpatial.Positioning.FixModeEventArgs.FixMode">
- <summary>
- Indicates if the GPS device is choosing the <see cref="T:DotSpatial.Positioning.FixMethod">fix method</see> automatically.
- </summary>
- <value>A value from the <strong>FixMode</strong> enumeration.</value>
- <seealso cref="P:DotSpatial.Positioning.FixModeEventArgs.FixMode">FixMode Property (Receiver Class)</seealso>
- <remarks>A vast majority of GPS devices calculate the fix mode automatically. This is because
- the process of determining the fix mode is a simple process: if there are three fixed satellites,
- a 2-D fix is obtained; if there are four or more fixed satellites, a 3-D fix is in progress. Any
- less than three satellites means that no fix is possible.</remarks>
- </member>
- <member name="T:DotSpatial.Positioning.FixQualityEventArgs">
- <summary>
- Represents information about the type of fix obtained when fix-related event is raised.
- </summary>
- <example>This example demonstrates how to use this class when raising an event.
- <code lang="VB">
- ' Declare a new event
- Dim MyFixQualityEvent As EventHandler
- ' Create a FixQuality signifying that a differential GPS fix is obtained
- Dim MyFixQuality As FixQuality = FixQuality.DifferentialGpsFix
- Sub Main()
- ' Raise our custom event
- RaiseEvent MyFixQualityEvent(Me, New FixQualityEventArgs(MyFixQuality))
- End Sub
- </code>
- <code lang="C#">
- // Declare a new event
- EventHandler MyFixQualityEvent;
- // Create a FixQuality signifying that a differential GPS fix is obtained
- FixQuality MyFixQuality = FixQuality.DifferentialGpsFix;
- void Main()
- {
- // Raise our custom event
- MyFixQualityEvent(this, New FixQualityEventArgs(MyFixQuality));
- }
- </code>
- </example>
- <remarks>This object is used primarily by the FixQualityChanged
- event of the Receiver class to provide notification when
- the receiver switches fix modes from <strong>Automatic</strong> to <strong>Manual</strong> or vice-versa.</remarks>
- </member>
- <member name="F:DotSpatial.Positioning.FixQualityEventArgs._fixQuality">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.FixQualityEventArgs.#ctor(DotSpatial.Positioning.FixQuality)">
- <summary>
- Creates a new instance with the specified fix quality measurement.
- </summary>
- <param name="fixQuality">The fix quality.</param>
- </member>
- <member name="P:DotSpatial.Positioning.FixQualityEventArgs.FixQuality">
- <summary>
- Indicates whether the current fix involves satellites and/or DGPS/WAAS ground stations.
- </summary>
- <value>A value from the <strong>FixQuality</strong> enumeration.</value>
- </member>
- <member name="T:DotSpatial.Positioning.PrecisionFilter">
- <summary>
- Kalman filter for improved positioning
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.PrecisionFilter._defaultFilter">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.PrecisionFilter.Initialize(DotSpatial.Positioning.Position)">
- <summary>
- Initialise the filter from a specified Position
- </summary>
- <param name="gpsPosition">The GPS position.</param>
- </member>
- <member name="M:DotSpatial.Positioning.PrecisionFilter.Initialize(DotSpatial.Positioning.Position3D)">
- <summary>
- Initialise the filter from a specified Position3D
- </summary>
- <param name="gpsPosition">The GPS position.</param>
- </member>
- <member name="M:DotSpatial.Positioning.PrecisionFilter.Filter(DotSpatial.Positioning.Position)">
- <summary>
- Filter the Position
- </summary>
- <param name="gpsPosition">The GPS position.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.PrecisionFilter.Filter(DotSpatial.Positioning.Position,DotSpatial.Positioning.Distance,DotSpatial.Positioning.DilutionOfPrecision,DotSpatial.Positioning.DilutionOfPrecision,DotSpatial.Positioning.Azimuth,DotSpatial.Positioning.Speed)">
- <summary>
- Return filtered position from specified parameters
- </summary>
- <param name="gpsPosition">The GPS position.</param>
- <param name="deviceError">The device error.</param>
- <param name="horizontalDOP">The horizontal DOP.</param>
- <param name="verticalDOP">The vertical DOP.</param>
- <param name="bearing">The bearing.</param>
- <param name="speed">The speed.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.PrecisionFilter.Filter(DotSpatial.Positioning.Position3D)">
- <summary>
- Return a filtered Position3d
- </summary>
- <param name="gpsPosition">The GPS position.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.PrecisionFilter.Filter(DotSpatial.Positioning.Position3D,DotSpatial.Positioning.Distance,DotSpatial.Positioning.DilutionOfPrecision,DotSpatial.Positioning.DilutionOfPrecision,DotSpatial.Positioning.Azimuth,DotSpatial.Positioning.Speed)">
- <summary>
- Return a filtered Position3D from the specified parameters
- </summary>
- <param name="gpsPosition">The GPS position.</param>
- <param name="deviceError">The device error.</param>
- <param name="horizontalDOP">The horizontal DOP.</param>
- <param name="verticalDOP">The vertical DOP.</param>
- <param name="bearing">The bearing.</param>
- <param name="speed">The speed.</param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Positioning.PrecisionFilter.Default">
- <summary>
- The default Kalman filter
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.PrecisionFilter.ObservedPosition">
- <summary>
- The obsedrved position
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.PrecisionFilter.FilteredPosition">
- <summary>
- The filtered position
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.PrecisionFilter.ObservedLocation">
- <summary>
- The observed location
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.PrecisionFilter.FilteredLocation">
- <summary>
- The filtered location
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.PrecisionFilter.IsInitialized">
- <summary>
- Is the precision filter enabled
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.PrecisionFilter.Delay">
- <summary>
- Gets the delay
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.GpggaSentence">
- <summary>
- $GPGGA, hhmmss.ss, ddmm.mmmm, n, dddmm.mmmm, e, q, ss, y.y, a.a, z, g.g, z, t.t, iii*CC
- http://aprs.gids.nl/nmea/#gga
- Global Positioning System Fix Data. Time, location and fix related data for a GPS receiver.
- eg2. $--GGA, hhmmss.ss, llll.ll, a, yyyyy.yy, a, x, xx, x.x, x.x, M, x.x, M, x.x, xxxx
- hhmmss.ss = UTC of location
- llll.ll = latitude of location
- a = N or S
- yyyyy.yy = Longitude of location
- a = E or W
- x = GPS Quality indicator (0=no fix, 1=GPS fix, 2=Dif. GPS fix)
- xx = number of satellites in use
- x.x = horizontal dilution of precision
- x.x = Antenna altitude above mean-sea-level
- M = units of antenna altitude, meters
- x.x = Geoidal separation
- M = units of geoidal separation, meters
- x.x = Age of Differential GPS data (seconds)
- xxxx = Differential reference station ID
- eg3. $GPGGA, hhmmss.ss, hhmm.mm, i, hhhmm.mm, i, f, ss, x.x, x.x, M, x.x, M, x.x, xxxx*hh
- 0 = Time in UTC
- 1 = Latitude
- 2 = N or S
- 3 = Longitude
- 4 = E or W
- 5 = GPS quality indicator (0=invalid; 1=GPS fix; 2=Diff. GPS fix)
- 6 = Number of satellites in use [not those in view]
- 7 = Horizontal dilution of precision
- 8 = Antenna altitude above/below mean sea level (geoid)
- 9 = Meters (Antenna height unit)
- 10 = Geoidal separation (Diff. between WGS-84 earth ellipsoid and
- mean sea level. -=geoid is below WGS-84 ellipsoid)
- 11 = Meters (Units of geoidal separation)
- 12 = Age in seconds since last update from diff. reference station
- 13 = Diff. reference station ID#
- 14 = Checksum
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.NmeaSentence">
- <summary>
- Represents a single line of NMEA GPS data.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NmeaSentence.NmeaCultureInfo">
- <summary>
- Represents the culture used to process all NMEA GPS data, including numbers and dates.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaSentence.#ctor">
- <summary>
- Creates a new instance.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaSentence.#ctor(System.String)">
- <summary>
- Creates a new instance from the specified string.
- </summary>
- <param name="sentence"></param>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaSentence.#ctor(System.String,System.String,System.String[],System.String)">
- <summary>
- Creates a new instance from known values.
- </summary>
- <param name="sentence">A <strong>String</strong> containing the entire text of the sentence.</param>
- <param name="commandWord">A <strong>String</strong>, the first word of the sentence.</param>
- <param name="words">A <strong>String</strong> array, the comma-separated strings between the command word and checksum.</param>
- <param name="validChecksum">A <strong>String</strong>, the correct checksum for the sentence.</param>
- <remarks>This constructor is typically used when it some processing of the sentence has already occurred.
- GPS.NET performs an analysis of the sentence to determine its type. For the sake of speed, processed information can
- be preserved using this constructor. To process an entire sentence, use the entire NMEA string as a constructor.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaSentence.AppendChecksum">
- <summary>
- Calculates and adds a checksum to the end of the sentence if the senctence doesn't have a checksum.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaSentence.SetPropertiesFromSentence">
- <summary>
- Sets this classes properties from the Sentence.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaSentence.ParseAzimuth(System.Int32)">
- <summary>
- Parses the word at the given position to Azimuth.
- </summary>
- <param name="position">Position of the Words array that gets parsed to Azimuth.</param>
- <returns>Invalid if position is outside of Words array or word at the position is empty.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaSentence.ParseDilution(System.Int32)">
- <summary>
- Parses the word at the given position to DilutionOfPrecision.
- </summary>
- <param name="position">Position of the Words array that gets parsed to DilutionOfPrecision.</param>
- <returns>Invalid if position is outside of Words array or word at the position is empty.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaSentence.ParseDistance(System.Int32,DotSpatial.Positioning.DistanceUnit)">
- <summary>
- Parses the word at the given position to Distance.
- </summary>
- <param name="position">Position of the Words array that gets parsed to Distance.</param>
- <param name="unit">DistanceUnit that is used for parsing.</param>
- <returns>Invalid if position is outside of Words array or word at the position is empty.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaSentence.ParseFixMethod(System.Int32,System.Boolean)">
- <summary>
- Parses the word at the given position to FixMethode. Expected is (0 = noFix, 1 = Fix2D, 2 = Fix3D). If the order is correct but noFix starts at 1 set noFixAt1 to true.
- </summary>
- <param name="position">Position of the word that will be parsed.</param>
- <param name="noFixAt1">Indicates that noFix starts at 1 instead of 0.</param>
- <returns>Unknown if the position was outside of the Word array or the word was empty or contained an unknown value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaSentence.ParseFixMode(System.Int32)">
- <summary>
- Parses the FixMode from the given position of the Words array. (A = Automatic, M = Manual, everything else = Unknown)
- </summary>
- <param name="position">Position of the Word array that will be parsed.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaSentence.ParseFixQuality(System.Int32)">
- <summary>
- Parses the FixQuality from the given position of the Words array. (0 = NoFix, 1 = GpsFix, 2 = DifferentialGpsFix, 3 = PulsePerSecond, 4 = FixedRealTimeKinematic, 5 = FloatRealTimeKinematic,
- 6 = Estimated, 7 = ManualInput, 8 = Simulated, everything else = Unknown)
- </summary>
- <param name="position">Position of the Word array that will be parsed.</param>
- <returns>Unknown if position is outside of Words array or word at the position is empty or the given value is not between 0 and 8.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaSentence.ParseFixStatus(System.Int32)">
- <summary>
- Parses the word at the given position to FixStatus (A = Fix, everything else = NoFix).
- </summary>
- <param name="position">Position of the Words array that gets parsed to FixStatus.</param>
- <returns>Unknown if position is outside of Words array or word at the position is empty.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaSentence.ParsePosition(System.Int32,System.Int32,System.Int32,System.Int32)">
- <summary>
- Parses the Position based on the given indizes and the Words array.
- </summary>
- <param name="latitudeValuePosition">Position of the latitude value inside the Words array.</param>
- <param name="latitudeHemispherePosition">Position of the latitude hemisphere inside the Words array.</param>
- <param name="longitudeValuePosition">Position of the longitude value inside the Words array.</param>
- <param name="longitudeHemispherePosition">Position of the longitude hemisphere inside the Words array.</param>
- <returns>Position.Invalid, if the Words array is to short or at least one of the fields is empty.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaSentence.ParseSpeed(System.Int32,DotSpatial.Positioning.SpeedUnit)">
- <summary>
- Parses the word at the given position to Speed based on the given unit.
- </summary>
- <param name="position">Position of the Words array that gets parsed to speed.</param>
- <param name="unit">SpeedUnit that is used for parsing.</param>
- <returns>Invalid if position is outside of Words array or word at the position is empty.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaSentence.ParseUtcDateTime(System.Int32,System.Int32)">
- <summary>
- Parses the word at the given position to UtcDateTime.
- </summary>
- <param name="timePosition">Position of the Words array that contains the time that gets parsed to UtcDateTime. Expected is a string of format hhmmss. Every number after that will be parsed to milliseconds.</param>
- <param name="datePosition">Position of the Words array that contains the date that gets parsed to UtcDateTime. Expected is a string of format ddmmyy. The Year will be added to 2000, because we expect the year to be of this millennium.</param>
- <returns>MinValue if the bigger position is outside of Words array or if one of the words is empty.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaSentence.ParseUtcTimeSpan(System.Int32)">
- <summary>
- Parses the word at the given position to UtcTimeSpan. Expected is a String of format hhmmss. Every number after that will be parsed to milliseconds.
- </summary>
- <param name="position">Position of the Words array that gets parsed to UtcTimeSpan.</param>
- <returns>MinValue if position is outside of Words array or word at the position is empty.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaSentence.ToByteArray">
- <summary>
- Converts the packet into an array of bytes.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaSentence.ToString(System.String,System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format to use.-or- A null reference (Nothing in Visual Basic) to use the default format defined for the type of the <see cref="T:System.IFormattable"/> implementation.</param>
- <param name="formatProvider">The provider to use to format the value.-or- A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.</param>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaSentence.Equals(DotSpatial.Positioning.NmeaSentence)">
- <summary>
- Indicates whether the current object is equal to another object of the same type.
- </summary>
- <param name="other">An object to compare with this object.</param>
- <returns>true if the current object is equal to the <paramref name="other"/> parameter; otherwise, false.</returns>
- </member>
- <member name="P:DotSpatial.Positioning.NmeaSentence.Words">
- <summary>
- Returns the body of the sentence split by commas into strings.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.NmeaSentence.CommandWord">
- <summary>
- Returns the first word of the sentence which indicates its purpose.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.NmeaSentence.ExistingChecksum">
- <summary>
- Returns the current checksum of the sentence.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.NmeaSentence.CorrectChecksum">
- <summary>
- Returns the checksum which matches the content of the sentence.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.NmeaSentence.Sentence">
- <summary>
- Returns a string representing the entire NMEA sentence.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.NmeaSentence.IsValid">
- <summary>
- Returns whether the pack data is well-formed.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.IPositionSentence">
- <summary>
- Represents an NMEA sentence which contains latitude and longitude values.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.IPositionSentence.Position">
- <summary>
- Represents an NMEA sentence which contains a position.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.IUtcTimeSentence">
- <summary>
- Represents an NMEA sentence which contains time in UTC.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.IUtcTimeSentence.UtcTime">
- <summary>
- Gets the time in UTC from the IUtcTimeSentence
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.IAltitudeSentence">
- <summary>
- Represents an NMEA sentence which contains
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.IAltitudeSentence.Altitude">
- <summary>
- The Altitude
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.IGeoidalSeparationSentence">
- <summary>
- Represents an NMEA sentence which contains
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.IGeoidalSeparationSentence.GeoidalSeparation">
- <summary>
- The Geoidal Separation
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.IDifferentialGpsSentence">
- <summary>
- Represents an NMEA sentence which contains differential GPS information.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.IDifferentialGpsSentence.DifferentialGpsStationID">
- <summary>
- Gets the Differential Gps Station ID
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.IDifferentialGpsSentence.DifferentialGpsAge">
- <summary>
- Gets the age of the Differential Gps
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.IFixQualitySentence">
- <summary>
- Represents an NMEA sentence which describes how the fix is being obtained.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.IFixQualitySentence.FixQuality">
- <summary>
- The Fix Quality
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.IHorizontalDilutionOfPrecisionSentence">
- <summary>
- Represents an NMEA sentence which contains
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.IHorizontalDilutionOfPrecisionSentence.HorizontalDilutionOfPrecision">
- <summary>
- The Horizontal Dilution of Precision
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.IFixedSatelliteCountSentence">
- <summary>
- Represents an NMEA sentence which returns the number of GPS satellites involved in the current fix.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.IFixedSatelliteCountSentence.FixedSatelliteCount">
- <summary>
- The Fixed Satellite Count
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.GpggaSentence.#ctor(System.String)">
- <summary>
- Creates a new GpggaSentence
- </summary>
- <param name="sentence">The sentence.</param>
- </member>
- <member name="M:DotSpatial.Positioning.GpggaSentence.#ctor(System.String,System.String,System.String[],System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.GpggaSentence"/> class.
- </summary>
- <param name="sentence">The sentence.</param>
- <param name="commandWord">The command word.</param>
- <param name="words">The words.</param>
- <param name="validChecksum">The valid checksum.</param>
- </member>
- <member name="M:DotSpatial.Positioning.GpggaSentence.#ctor(System.TimeSpan,DotSpatial.Positioning.Position,DotSpatial.Positioning.FixQuality,System.Int32,DotSpatial.Positioning.DilutionOfPrecision,DotSpatial.Positioning.Distance,DotSpatial.Positioning.Distance,System.TimeSpan,System.Int32)">
- <summary>
- Creates a new sentence
- </summary>
- <param name="utcTime">The UTC time.</param>
- <param name="position">The position.</param>
- <param name="fixQuality">The fix quality.</param>
- <param name="trackedSatelliteCount">The tracked satellite count.</param>
- <param name="horizontalDilutionOfPrecision">The horizontal dilution of precision.</param>
- <param name="altitude">The altitude.</param>
- <param name="geoidalSeparation">The geoidal separation.</param>
- <param name="differentialGpsAge">The differential GPS age.</param>
- <param name="differentialGpsStationId">The differential GPS station ID.</param>
- </member>
- <member name="M:DotSpatial.Positioning.GpggaSentence.SetPropertiesFromSentence">
- <summary>
- Corrects this classes properties after the base sentence was changed.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GpggaSentence.Position">
- <summary>
- Represents an NMEA sentence which contains a position.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GpggaSentence.UtcTime">
- <summary>
- Gets the time in UTC from the IUtcTimeSentence
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GpggaSentence.Altitude">
- <summary>
- The Altitude
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GpggaSentence.HorizontalDilutionOfPrecision">
- <summary>
- The Horizontal Dilution of Precision
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GpggaSentence.GeoidalSeparation">
- <summary>
- The Geoidal Separation
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GpggaSentence.FixQuality">
- <summary>
- The Fix Quality
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GpggaSentence.DifferentialGpsStationID">
- <summary>
- The integer ID of the GPS Station
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GpggaSentence.DifferentialGpsAge">
- <summary>
- Differntial GPS Age
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GpggaSentence.FixedSatelliteCount">
- <summary>
- The Fixed Satellite Count
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.GpggkSentence">
- <summary>
- $--GGK Header including Talker ID
- hhmmss.ss UTC time of location
- mmddyy UTC date
- llll.ll(Latitude)
- a(Hemisphere, North Or South)
- yyyyy.yy(Longitude)
- a(East Or West)
- x GPS quality indicator
- 0 = Fix not available or invalid
- 1 = No real-time location, navigation fix
- 2 = Real-time location, ambiguities not fixed
- 3 = Real-time location, ambiguities fixed
- xx Number of satellites in use, 00 to 12.
- x.x(GDOP)
- EHT Ellipsoidal height
- x.x Altitude of location marker as local ellipsoidal height. If the local ellipsoidal
- height is not available, the WGS 1984 ellipsoidal height will be exported.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.IUtcDateTimeSentence">
- <summary>
- Represents an NMEA sentence which contains date and time in UTC.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.IUtcDateTimeSentence.UtcDateTime">
- <summary>
- Represents an NMEA sentence which contains date and time in UTC.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.IPositionDilutionOfPrecisionSentence">
- <summary>
- Represents an NMEA sentence which contains
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.IPositionDilutionOfPrecisionSentence.PositionDilutionOfPrecision">
- <summary>
- The Position Dilution of Precision (PDOP)
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.IAltitudeAboveEllipsoidSentence">
- <summary>
- Represents an NMEA sentence which contains
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.IAltitudeAboveEllipsoidSentence.AltitudeAboveEllipsoid">
- <summary>
- The Altitude Above Ellipsoid
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.GpggkSentence.#ctor(System.String)">
- <summary>
- Creates a GpggkSentence from the specified string
- </summary>
- <param name="sentence">The sentence.</param>
- </member>
- <member name="M:DotSpatial.Positioning.GpggkSentence.#ctor(System.String,System.String,System.String[],System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.GpggkSentence"/> class.
- </summary>
- <param name="sentence">The sentence.</param>
- <param name="commandWord">The command word.</param>
- <param name="words">The words.</param>
- <param name="validChecksum">The valid checksum.</param>
- </member>
- <member name="M:DotSpatial.Positioning.GpggkSentence.SetPropertiesFromSentence">
- <summary>
- Corrects this classes properties after the base sentence was changed.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GpggkSentence.Position">
- <summary>
- Represents an NMEA sentence which contains a position.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GpggkSentence.FixQuality">
- <summary>
- The Fix Quality
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GpggkSentence.PositionDilutionOfPrecision">
- <summary>
- The Position Dilution of Precision (PDOP)
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GpggkSentence.AltitudeAboveEllipsoid">
- <summary>
- The Altitude Above Ellipsoid
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GpggkSentence.UtcDateTime">
- <summary>
- Represents an NMEA sentence which contains date and time in UTC.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.GpgllSentence">
- <summary>
- $GPGLL
- Geographic Position, Latitude / Longitude and time.
- http://aprs.gids.nl/nmea/#gll
- eg1. $GPGLL, 3751.65, S, 14507.36, E*77
- eg2. $GPGLL, 4916.45, N, 12311.12, W, 225444, A
- 4916.46, N Latitude 49 deg. 16.45 min. North
- 12311.12, W Longitude 123 deg. 11.12 min. West
- 225444 Fix taken at 22:54:44 UTC
- A Data valid
- eg3. $GPGLL, 5133.81, N, 00042.25, W*75
- 1 2 3 4 5
- 1 5133.81 Current latitude
- 2 N North/South
- 3 00042.25 Current longitude
- 4 W East/West
- 5 *75 checksum
- $--GLL, lll.ll, a, yyyyy.yy, a, hhmmss.ss, A
- llll.ll = Latitude of location
- a = N or S
- yyyyy.yy = Longitude of location
- a = E or W
- hhmmss.ss = UTC of location
- A = status: A = valid data
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.IFixStatusSentence">
- <summary>
- Represents an NMEA sentence which contains whether a fix is currently acquired.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.IFixStatusSentence.FixStatus">
- <summary>
- The Fix Status
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.GpgllSentence.#ctor(System.String,System.String,System.String[],System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.GpgllSentence"/> class.
- </summary>
- <param name="sentence">The sentence.</param>
- <param name="commandWord">The command word.</param>
- <param name="words">The words.</param>
- <param name="validChecksum">The valid checksum.</param>
- </member>
- <member name="M:DotSpatial.Positioning.GpgllSentence.#ctor(System.String)">
- <summary>
- Creates a GpgllSentence from the specified string
- </summary>
- <param name="sentence">The sentence.</param>
- </member>
- <member name="M:DotSpatial.Positioning.GpgllSentence.#ctor(DotSpatial.Positioning.Position,System.TimeSpan,DotSpatial.Positioning.FixStatus)">
- <summary>
- Creates a GpgllSentence from the specified parameters
- </summary>
- <param name="position">The position.</param>
- <param name="utcTime">The UTC time.</param>
- <param name="fixStatus">The fix status.</param>
- </member>
- <member name="M:DotSpatial.Positioning.GpgllSentence.SetPropertiesFromSentence">
- <summary>
- Corrects this classes properties after the base sentence was changed.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GpgllSentence.UtcTime">
- <summary>
- Gets the time in UTC from the IUtcTimeSentence
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GpgllSentence.Position">
- <summary>
- Represents an NMEA sentence which contains a position.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GpgllSentence.FixStatus">
- <summary>
- The Fix Status
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.GpgsaSentence">
- <summary>
- $GPGSA
- GPS DOP and active satellites
- eg1. $GPGSA,A,3,,,,,,16,18,,22,24,,,3.6,2.1,2.2*3C
- $GPGSA,A,1,,,,,,,,,,,,,6,6,6
- eg2. $GPGSA,A,3,19,28,14,18,27,22,31,39,,,,,1.7,1.0,1.3*35
- 1 = Method:
- M=Manual, forced to operate in 2D or 3D
- A=Automatic, 3D/2D
- 2 = Mode:
- 1=Fix not available
- 2=2D
- 3=3D
- 3-14 = IDs of SVs used in position fix (null for unused fields)
- 15 = PDOP
- 16 = HDOP
- 17 = VDOP
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.IFixMethodSentence">
- <summary>
- Represents an NMEA sentence which contains the method used to acquire a fix.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.IFixMethodSentence.FixMethod">
- <summary>
- The Fix Method
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.IFixModeSentence">
- <summary>
- Represents an NMEA sentence which describes the current fix.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.IFixModeSentence.FixMode">
- <summary>
- Gets the fix mode
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.IFixedSatellitesSentence">
- <summary>
- Represents an NMEA sentence which contains a list of fixed GPS satellites.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.IFixedSatellitesSentence.FixedSatellites">
- <summary>
- the list of FixedSatellites
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.IVerticalDilutionOfPrecisionSentence">
- <summary>
- Represents an NMEA sentence which contains
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.IVerticalDilutionOfPrecisionSentence.VerticalDilutionOfPrecision">
- <summary>
- The Vertical Dilution of Precision
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.GpgsaSentence.#ctor(System.String)">
- <summary>
- Creates a GpgsaSentence from the specified string
- </summary>
- <param name="sentence">The sentence.</param>
- </member>
- <member name="M:DotSpatial.Positioning.GpgsaSentence.#ctor(System.String,System.String,System.String[],System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.GpgsaSentence"/> class.
- </summary>
- <param name="sentence">The sentence.</param>
- <param name="commandWord">The command word.</param>
- <param name="words">The words.</param>
- <param name="validChecksum">The valid checksum.</param>
- </member>
- <member name="M:DotSpatial.Positioning.GpgsaSentence.#ctor(DotSpatial.Positioning.FixMode,DotSpatial.Positioning.FixMethod,System.Collections.Generic.IEnumerable{DotSpatial.Positioning.Satellite},DotSpatial.Positioning.DilutionOfPrecision,DotSpatial.Positioning.DilutionOfPrecision,DotSpatial.Positioning.DilutionOfPrecision)">
- <summary>
- Creates a new GpgsaSentence
- </summary>
- <param name="fixMode">The fix mode.</param>
- <param name="fixMethod">The fix method.</param>
- <param name="satellites">The satellites.</param>
- <param name="positionDilutionOfPrecision">The position dilution of precision.</param>
- <param name="horizontalDilutionOfPrecision">The horizontal dilution of precision.</param>
- <param name="verticalDilutionOfPrecision">The vertical dilution of precision.</param>
- </member>
- <member name="M:DotSpatial.Positioning.GpgsaSentence.SetPropertiesFromSentence">
- <summary>
- Corrects this classes properties after the base sentence was changed.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GpgsaSentence.FixedSatellites">
- <summary>
- the list of FixedSatellites
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GpgsaSentence.FixMethod">
- <summary>
- The Fix Method
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GpgsaSentence.PositionDilutionOfPrecision">
- <summary>
- The Position Dilution of Precision (PDOP)
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GpgsaSentence.VerticalDilutionOfPrecision">
- <summary>
- The Vertical Dilution of Precision
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GpgsaSentence.HorizontalDilutionOfPrecision">
- <summary>
- The Horizontal Dilution of Precision
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GpgsaSentence.FixMode">
- <summary>
- Gets the fix mode
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.GpgsvSentence">
- <summary>
- Represents a $GPGSV sentence describing the location and signal strength of GPS
- satellites.
- </summary>
- <remarks>This sentence is used to determine the location of GPS satellites relative
- to the current location, as well as to indicate the strength of a satellite's radio
- signal.</remarks>
- </member>
- <member name="T:DotSpatial.Positioning.ISatelliteCollectionSentence">
- <summary>
- Represents an NMEA sentence which contains GPS satellite information.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.ISatelliteCollectionSentence.Satellites">
- <summary>
- The Satellites
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.GpgsvSentence.#ctor(System.String)">
- <summary>
- Creates a GPGSV sentence instance from the specified string.
- </summary>
- <param name="sentence">The sentence.</param>
- </member>
- <member name="M:DotSpatial.Positioning.GpgsvSentence.#ctor(System.String,System.String,System.String[],System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.GpgsvSentence"/> class.
- </summary>
- <param name="sentence">The sentence.</param>
- <param name="commandWord">The command word.</param>
- <param name="words">The words.</param>
- <param name="validChecksum">The valid checksum.</param>
- </member>
- <member name="M:DotSpatial.Positioning.GpgsvSentence.#ctor(System.Int32,System.Int32,System.Int32,System.Collections.Generic.IList{DotSpatial.Positioning.Satellite})">
- <summary>
- Creates a GPSV sentence instance from the specified parameters describing the location and signal strength of GPS satellites
- </summary>
- <param name="totalMessageCount">The total message count.</param>
- <param name="currentMessageNumber">The current message number.</param>
- <param name="satellitesInView">The satellites in view.</param>
- <param name="satellites">The satellites.</param>
- </member>
- <member name="M:DotSpatial.Positioning.GpgsvSentence.SetPropertiesFromSentence">
- <summary>
- Corrects this classes properties after the base sentence was changed.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.GpgsvSentence.FromSatellites(System.Collections.Generic.IList{DotSpatial.Positioning.Satellite})">
- <summary>
- Returns a collection of $GPGSV sentences fully describing the specified collection of satellites.
- </summary>
- <param name="satellites">The satellites.</param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Positioning.GpgsvSentence.Satellites">
- <summary>
- Returns a collection of <strong>Satellite</strong> objects describing current
- satellite information.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GpgsvSentence.TotalMessageCount">
- <summary>
- Returns the total number of $GPGSV sentence in a sequence.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GpgsvSentence.CurrentMessageNumber">
- <summary>
- Returns the current message index when the sentence is one of several
- messages.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GpgsvSentence.SatellitesInView">
- <summary>
- Returns the number of satellites whose signals are detected by the GPS
- device.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.GphdtSentence">
- <summary>
- Heading, True
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.IHeadingSentence">
- <summary>
- Represents an NMEA sentence which contains the direction of heading.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.IHeadingSentence.Heading">
- <summary>
- the Heading
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.GphdtSentence.#ctor(System.String)">
- <summary>
- Creates a heading sentence instance from the specified sentence
- </summary>
- <param name="sentence">The sentence.</param>
- </member>
- <member name="M:DotSpatial.Positioning.GphdtSentence.#ctor(System.String,System.String,System.String[],System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.GphdtSentence"/> class.
- </summary>
- <param name="sentence">The sentence.</param>
- <param name="commandWord">The command word.</param>
- <param name="words">The words.</param>
- <param name="validChecksum">The valid checksum.</param>
- </member>
- <member name="M:DotSpatial.Positioning.GphdtSentence.SetPropertiesFromSentence">
- <summary>
- Corrects this classes properties after the base sentence was changed.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GphdtSentence.Heading">
- <summary>
- the Heading
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.GprmcSentence">
- <summary>
- Represents the "recommended minimum" GPS sentence.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.IBearingSentence">
- <summary>
- Represents an NMEA sentence which contains the direction of travel.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.IBearingSentence.Bearing">
- <summary>
- the Bearing
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.ISpeedSentence">
- <summary>
- Represents an NMEA sentence which contains
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.ISpeedSentence.Speed">
- <summary>
- The Speed
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.IMagneticVariationSentence">
- <summary>
- Represents an NMEA sentence which contains
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.IMagneticVariationSentence.MagneticVariation">
- <summary>
- The Magnetic Variation
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.GprmcSentence.#ctor(System.String,System.String,System.String[],System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.GprmcSentence"/> class.
- </summary>
- <param name="sentence">The sentence.</param>
- <param name="commandWord">The command word.</param>
- <param name="words">The words.</param>
- <param name="validChecksum">The valid checksum.</param>
- </member>
- <member name="M:DotSpatial.Positioning.GprmcSentence.#ctor(System.String)">
- <summary>
- Creates a GprmcSentence from the specified string.
- </summary>
- <param name="sentence">The sentence.</param>
- </member>
- <member name="M:DotSpatial.Positioning.GprmcSentence.#ctor(System.DateTime,System.Boolean,DotSpatial.Positioning.Position,DotSpatial.Positioning.Speed,DotSpatial.Positioning.Azimuth,DotSpatial.Positioning.Longitude)">
- <summary>
- Creates a GprmcSentence from the specified parameters.
- </summary>
- <param name="utcDateTime">The UTC date time.</param>
- <param name="isFixAcquired">if set to <c>true</c> [is fix acquired].</param>
- <param name="position">The position.</param>
- <param name="speed">The speed.</param>
- <param name="bearing">The bearing.</param>
- <param name="magneticVariation">The magnetic variation.</param>
- </member>
- <member name="M:DotSpatial.Positioning.GprmcSentence.SetPropertiesFromSentence">
- <summary>
- Corrects this classes properties after the base sentence was changed.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GprmcSentence.Position">
- <summary>
- Represents an NMEA sentence which contains a position.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GprmcSentence.UtcDateTime">
- <summary>
- Represents an NMEA sentence which contains date and time in UTC.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GprmcSentence.Bearing">
- <summary>
- the Bearing
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GprmcSentence.Speed">
- <summary>
- The Speed
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GprmcSentence.MagneticVariation">
- <summary>
- The Magnetic Variation
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GprmcSentence.FixStatus">
- <summary>
- The Fix Status
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.GpvtgSentence">
- <summary>
- Track made good and ground speed sentence
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.GpvtgSentence.#ctor(System.String)">
- <summary>
- Creates a track made good and ground speed sentence instance from the specified sentence
- </summary>
- <param name="sentence">The sentence.</param>
- </member>
- <member name="M:DotSpatial.Positioning.GpvtgSentence.#ctor(System.String,System.String,System.String[],System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.GpvtgSentence"/> class.
- </summary>
- <param name="sentence">The sentence.</param>
- <param name="commandWord">The command word.</param>
- <param name="words">The words.</param>
- <param name="validChecksum">The valid checksum.</param>
- </member>
- <member name="M:DotSpatial.Positioning.GpvtgSentence.SetPropertiesFromSentence">
- <summary>
- Corrects this classes properties after the base sentence was changed.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GpvtgSentence.Bearing">
- <summary>
- the Bearing
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GpvtgSentence.Speed">
- <summary>
- The Speed
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GpvtgSentence.MagneticVariation">
- <summary>
- The Magnetic Variation
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.Interpreter">
- <summary>
- Represents a base class for designing a GPS data interpreter.
- </summary>
- <seealso cref="M:DotSpatial.Positioning.Interpreter.OnReadPacket">OnReadPacket Method</seealso>
- <remarks><para>This class serves as the base class for all GPS data interpreters, regardless
- of the protocol being used. For example, the <strong>NmeaInterpreter</strong> class
- inherits from this class to process NMEA-0183 data from any data source. This class
- provides basic functionality to start, pause, resume and stop the processing of GPS
- data, and provides management of a thread used to process the next set of incoming
- data.</para>
- <para>Inheritors should override the <strong>OnReadPacket</strong> event and
- provide functionality to read the next packet of data from the underlying stream.
- All raw GPS data must be provided in the form of a <strong>Stream</strong> object,
- and the method should read and process only a single packet of data.</para></remarks>
- </member>
- <member name="F:DotSpatial.Positioning.Interpreter._utcDateTime">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpreter._dateTime">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpreter._geoidalSeparation">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpreter._altitude">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpreter._altitudeAboveEllipsoid">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpreter._speed">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpreter._bearing">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpreter._heading">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpreter._position">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpreter._magneticVariation">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpreter._fixStatus">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpreter._fixMode">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpreter._fixMethod">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpreter._fixQuality">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpreter._fixedSatelliteCount">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpreter._isFixRequired">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpreter._maximumHorizontalDop">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpreter._maximumVerticalDop">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpreter._horizontalDop">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpreter._verticalDop">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpreter._meanDop">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpreter._satellites">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpreter._filter">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpreter._isFilterEnabled">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpreter._isRunning">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpreter._device">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpreter._threadPriority">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpreter._parsingThread">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpreter._pausedWaitHandle">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpreter._maximumReconnectionAttempts">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpreter._reconnectionAttemptCount">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpreter._recordingStream">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpreter._isDisposed">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpreter._allowAutomaticReconnection">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpreter._positionChangedAsyncResult">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpreter._commandTimeout">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpreter._readTimeout">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpreter.SyncRoot">
- <summary>
- Represents a synchronization object which is locked during state changes.
- </summary>
- <value>An <strong>Object</strong>.</value>
- </member>
- <member name="F:DotSpatial.Positioning.Interpreter.RecordingSyncRoot">
- <summary>
- Represents a synchronization object which is locked during state changes to recording.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Interpreter.OnStarting">
- <summary>
- Occurs immediately before a connection is attempted.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Interpreter.OnStarted">
- <summary>
- Occurs immediately before data is processed.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Interpreter.OnStopping">
- <summary>
- Occurs immediately before the interpreter is shut down.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Interpreter.OnStopped">
- <summary>
- Occurs immediately after the interpreter has been shut down.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Interpreter.OnConnectionLost(System.Exception)">
- <summary>
- Occurs when a connection to a GPS device is suddenly lost.
- </summary>
- <param name="ex">An <strong>Exception</strong> which further explains why the connection was lost.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Interpreter.OnPaused">
- <summary>
- Occurs when the interpreter has temporarily stopped processing data.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Interpreter.OnResumed">
- <summary>
- Occurs when the interpreter is no longer paused.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Interpreter.OnExceptionOccurred(System.Exception)">
- <summary>
- Occurs when an exception is trapped by the interpreter's thread.
- </summary>
- <param name="ex">The ex.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Interpreter.Start">
- <summary>
- Starts processing GPS data using any available GPS device.
- </summary>
- <remarks>This method is used to begin processing GPS data. If no GPS devices are known, GPS.NET will search for GPS devices and use the
- first device it finds. If no device can be found, an exception is raised.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Interpreter.Start(DotSpatial.Positioning.Device)">
- <summary>
- Starts processing GPS data from the specified stream.
- </summary>
- <param name="device">A device object providing GPS data to process.</param>
- <remarks>This method will start the <strong>Interpreter</strong> using a separate thread.
- The <strong>OnReadPacket</strong> is then called repeatedly from that thread to process
- incoming data. The Pause, Resume and Stop methods are typically called after this
- method to change the interpreter's behavior. Finally, a call to
- <strong>Dispose</strong> will close the underlying stream, stop all processing, and
- shut down the processing thread.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Interpreter.StartRecording(System.IO.Stream)">
- <summary>
- Begins recording all received data to the specified stream.
- </summary>
- <param name="output">The output.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Interpreter.StopRecording">
- <summary>
- Causes the interpreter to no longer record incoming GPS data.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Interpreter.Stop">
- <summary>
- Stops all processing of GPS data.
- </summary>
- <remarks>This method is used some time after a call to the <strong>Start</strong> method.
- When called, the GPS processing thread is immediately shut down and all processing
- stops.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Interpreter.Pause">
- <summary>
- Temporarily halts processing of GPS data.
- </summary>
- <remarks>This method will suspend the processing of GPS data, but will keep the thread and
- raw GPS data stream open. This method is intended as a temporary means of stopping
- processing. An interpreter should not be paused for an extended period of time because
- it can cause a backlog of GPS data</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Interpreter.Resume">
- <summary>
- Un-pauses the interpreter from a previously paused state.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Interpreter.Initialize">
- <summary>
- Resets the interpreter to it's default values.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Interpreter.DoInitialize">
- <summary>
- Does the initialize.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Interpreter.SetDateTimes(System.DateTime)">
- <summary>
- Updates the UTC and local date/time to the specified UTC value.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Interpreter.SetFixQuality(DotSpatial.Positioning.FixQuality)">
- <summary>
- Updates the fix quality to the specified value.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Interpreter.SetFixMode(DotSpatial.Positioning.FixMode)">
- <summary>
- Updates the fix mode to the specified value.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Interpreter.SetFixMethod(DotSpatial.Positioning.FixMethod)">
- <summary>
- Updates the fix method to the specified value.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Interpreter.SetHorizontalDilutionOfPrecision(DotSpatial.Positioning.DilutionOfPrecision)">
- <summary>
- Updates the precision as it relates to latitude and longitude.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Interpreter.SetVerticalDilutionOfPrecision(DotSpatial.Positioning.DilutionOfPrecision)">
- <summary>
- Updates the precision as it relates to altitude.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Interpreter.SetMeanDilutionOfPrecision(DotSpatial.Positioning.DilutionOfPrecision)">
- <summary>
- Updates the precision as it relates to latitude, longitude and altitude.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Interpreter.SetFixStatus(DotSpatial.Positioning.FixStatus)">
- <summary>
- Updates the fix status to the specified value.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Interpreter.SetMagneticVariation(DotSpatial.Positioning.Longitude)">
- <summary>
- Updates the difference between Magnetic North and True North.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Interpreter.SetPosition(DotSpatial.Positioning.Position)">
- <summary>
- Updates the current location on Earth's surface.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Interpreter.SetBearing(DotSpatial.Positioning.Azimuth)">
- <summary>
- Updates the current direction of travel.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Interpreter.SetHeading(DotSpatial.Positioning.Azimuth)">
- <summary>
- Updates the current direction of heading.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Interpreter.AppendSatellites(System.Collections.Generic.IList{DotSpatial.Positioning.Satellite})">
- <summary>
- Updates the list of known GPS satellites.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Interpreter.SetFixedSatelliteCount(System.Int32)">
- <summary>
- Sets the fixed satellite count.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Interpreter.SetFixedSatellites(System.Collections.Generic.IList{DotSpatial.Positioning.Satellite})">
- <summary>
- Updates the list of fixed GPS satellites.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Interpreter.SetSpeed(DotSpatial.Positioning.Speed)">
- <summary>
- Updates the current rate of travel.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Interpreter.SetGeoidalSeparation(DotSpatial.Positioning.Distance)">
- <summary>
- Updates the distance between the ellipsoid surface and the current altitude.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Interpreter.SetAltitude(DotSpatial.Positioning.Distance)">
- <summary>
- Updates the current distance above sea level.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Interpreter.SetAltitudeAboveEllipsoid(DotSpatial.Positioning.Distance)">
- <summary>
- Updates the current distance above the ellipsoid surface.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Interpreter.OnReadPacket">
- <summary>
- Occurs when new data should be read from the underlying device.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Interpreter.OnDeviceChanged">
- <summary>
- Occurs when the interpreter is using a different device for raw data.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Interpreter.Dispose(System.Boolean)">
- <summary>
- Releases the unmanaged resources used by the <see cref="T:System.ComponentModel.Component"/> and optionally releases the managed resources.
- </summary>
- <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Interpreter.ParsingThreadProc">
- <summary>
- Parsings the thread proc.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Interpreter.Reset">
- <summary>
- Forces the current device to a closed state without disposing the underlying stream.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Interpreter.QueryReconnectAllowed">
- <summary>
- Determines if automatic reconnection is currently allowed, based on the values of
- <see cref="P:DotSpatial.Positioning.Interpreter.AllowAutomaticReconnection"/>, <see cref="P:DotSpatial.Positioning.Interpreter.MaximumReconnectionAttempts"/>, and <see cref="F:DotSpatial.Positioning.Interpreter._reconnectionAttemptCount"/>.
- If reconnection is allowed, then <see cref="F:DotSpatial.Positioning.Interpreter._reconnectionAttemptCount"/> is incremented after a short delay.
- </summary>
- <returns><see langword="true">True</see> if another reconnection attempt should be made; otherwise, <see langword="false"/>.</returns>
- </member>
- <member name="E:DotSpatial.Positioning.Interpreter.AltitudeChanged">
- <summary>
- Occurs when the current distance above sea level has changed.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Interpreter.AltitudeReceived">
- <summary>
- Occurs when a new altitude report has been received, even if the value has not changed.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Interpreter.AltitudeAboveEllipsoidChanged">
- <summary>
- Occurs when the current distance above the ellipsoid has changed.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Interpreter.AltitudeAboveEllipsoidReceived">
- <summary>
- Occurs when a new altitude-above-ellipsoid report has been received, even if the value has not changed.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Interpreter.BearingChanged">
- <summary>
- Occurs when the current direction of travel has changed.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Interpreter.HeadingChanged">
- <summary>
- Occurs when the current direction of heading has changed.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Interpreter.BearingReceived">
- <summary>
- Occurs when a new bearing report has been received, even if the value has not changed.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Interpreter.HeadingReceived">
- <summary>
- Occurs when a new heading report has been received, even if the value has not changed.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Interpreter.FixQualityChanged">
- <summary>
- Occurs when the fix quality has changed.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Interpreter.FixModeChanged">
- <summary>
- Occurs when the fix mode has changed.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Interpreter.FixMethodChanged">
- <summary>
- Occurs when the fix method has changed.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Interpreter.GeoidalSeparationChanged">
- <summary>
- Occurs when the geodal separation changes
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Interpreter.UtcDateTimeChanged">
- <summary>
- Occurs when the GPS-derived date and time has changed.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Interpreter.DateTimeChanged">
- <summary>
- Occurs when the GPS-derived local time has changed.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Interpreter.FixAcquired">
- <summary>
- Occurs when at least three GPS satellite signals are available to calculate the current location.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Interpreter.FixLost">
- <summary>
- Occurs when less than three GPS satellite signals are available.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Interpreter.PositionChanged">
- <summary>
- Occurs when the current location on Earth has changed.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Interpreter.PositionReceived">
- <summary>
- Occurs when a new position report has been received, even if the value has not changed.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Interpreter.MagneticVariationAvailable">
- <summary>
- Occurs when the magnetic variation for the current location becomes known.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Interpreter.SpeedChanged">
- <summary>
- Occurs when the current rate of travel has changed.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Interpreter.SpeedReceived">
- <summary>
- Occurs when a new speed report has been received, even if the value has not changed.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Interpreter.HorizontalDilutionOfPrecisionChanged">
- <summary>
- Occurs when precision as it relates to latitude and longitude has changed.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Interpreter.VerticalDilutionOfPrecisionChanged">
- <summary>
- Occurs when precision as it relates to altitude has changed.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Interpreter.MeanDilutionOfPrecisionChanged">
- <summary>
- Occurs when precision as it relates to latitude, longitude and altitude has changed.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Interpreter.SatellitesChanged">
- <summary>
- Occurs when GPS satellite information has changed.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Interpreter.Starting">
- <summary>
- Occurs when the interpreter is about to start.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Interpreter.Started">
- <summary>
- Occurs when the interpreter is now processing GPS data.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Interpreter.Stopping">
- <summary>
- Occurs when the interpreter is about to stop.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Interpreter.Stopped">
- <summary>
- Occurs when the interpreter has stopped processing GPS data.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Interpreter.Paused">
- <summary>
- Occurs when the interpreter has temporarily stopped processing GPS data.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Interpreter.Resumed">
- <summary>
- Occurs when the interpreter is no longer paused.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Interpreter.ExceptionOccurred">
- <summary>
- Occurs when an exception has happened during processing.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.Interpreter.ConnectionLost">
- <summary>
- Occurs when the flow of GPS data has been suddenly interrupted.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Interpreter.ReadTimeout">
- <summary>
- Controls the amount of time to wait for the next packet of GPS data to arrive.
- </summary>
- <value>The read timeout.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Interpreter.CommandTimeout">
- <summary>
- Controls the amount of time allowed to perform a start, stop, pause or resume action.
- </summary>
- <value>The command timeout.</value>
- <remarks>The <strong>Interpreter</strong> class is multithreaded and is also thread-safe. Still, however, in some rare cases,
- two threads may attempt to change the state of the interpreter at the same time. Critical sections will allow both threads to
- succees whenever possible, but in the event of a deadlock, this property control how much time to allow before giving up.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Interpreter.Device">
- <summary>
- Returns the device providing raw GPS data to the interpreter.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Interpreter.ThreadPriority">
- <summary>
- Controls the priority of the thread which processes GPS data.
- </summary>
- <value>The thread priority.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Interpreter.DateTime">
- <summary>
- Returns the GPS-derived date and time, adjusted to the local time zone.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Interpreter.UtcDateTime">
- <summary>
- Returns the GPS-derived date and time in UTC (GMT-0).
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Interpreter.HorizontalDilutionOfPrecision">
- <summary>
- Returns the current estimated precision as it relates to latitude and longitude.
- </summary>
- <remarks>Horizontal Dilution of Precision (HDOP) is the accumulated
- error of latitude and longitude coordinates in X and Y directions
- (displacement on the surface of the ellipsoid).</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Interpreter.VerticalDilutionOfPrecision">
- <summary>
- Returns the current estimated precision as it relates to altitude.
- </summary>
- <remarks>Vertical Dilution of Precision (VDOP) is the accumulated
- error of latitude and longitude coordinates in the Z direction (measurement
- from the center of the ellipsoid).</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Interpreter.FixMode">
- <summary>
- Returns the kind of fix acquired by the GPS device.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Interpreter.FixedSatelliteCount">
- <summary>
- Returns the number of satellites being used to calculate the current location.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Interpreter.FixQuality">
- <summary>
- Returns the quality of the fix and what kinds of technologies are involved.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Interpreter.IsFixRequired">
- <summary>
- Controls whether GPS data is ignored until a fix is acquired.
- </summary>
- <value><c>true</c> if this instance is fix required; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Interpreter.IsFixed">
- <summary>
- Returns whether a fix is currently acquired by the GPS device.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Interpreter.MagneticVariation">
- <summary>
- Returns the difference between magnetic North and True North.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Interpreter.Position">
- <summary>
- Returns the current location on Earth's surface.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Interpreter.IsRunning">
- <summary>
- Gets a value indicating whether this instance is running.
- </summary>
- <value>
- <c>true</c> if this instance is running; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:DotSpatial.Positioning.Interpreter.FixPrecisionEstimate">
- <summary>
- Returns the avereage precision tolerance based on the fix quality reported
- by the device.
- </summary>
- <remarks>This property returns the estimated error attributed to the device. To get
- a total error estimation, add the Horizontal or the Mean DOP to the
- FixPrecisionEstimate.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Interpreter.Speed">
- <summary>
- Returns the current rate of travel.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Interpreter.Altitude">
- <summary>
- Returns the current distance above sea level.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Interpreter.Bearing">
- <summary>
- Gets the current direction of travel as an Azimuth
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Interpreter.MaximumHorizontalDilutionOfPrecision">
- <summary>
- Controls the largest amount of precision error allowed before GPS data is ignored.
- </summary>
- <value>The maximum horizontal dilution of precision.</value>
- <remarks>This property is important for commercial GPS softwaqre development because it helps the interpreter determine
- when GPS data reports are precise enough to utilize. Live GPS data can be inaccurate by up to a factor of fifty, or nearly
- the size of an American football field! As a result, setting a vlue for this property can help to reduce precision errors.
- When set, reports of latitude, longitude, speed, and bearing are ignored if precision is not at or below the set value.
- For more on Dilution of Precision and how to determine your precision needs, please refer to our online article here:
- http://dotspatial.codeplex.com/Articles/WritingApps2_1.aspx.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Interpreter.MaximumReconnectionAttempts">
- <summary>
- Controls the maximum number of consecutive reconnection retries allowed.
- </summary>
- <value>The maximum reconnection attempts.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Interpreter.MaximumVerticalDilutionOfPrecision">
- <summary>
- Controls the largest amount of precision error allowed before GPS data is ignored.
- </summary>
- <value>The maximum vertical dilution of precision.</value>
- <remarks>This property is important for commercial GPS softwaqre development because it helps the interpreter determine
- when GPS data reports are precise enough to utilize. Live GPS data can be inaccurate by up to a factor of fifty, or nearly
- the size of an American football field! As a result, setting a vlue for this property can help to reduce precision errors.
- When set, reports of altitude are ignored if precision is not at or below the set value.
- For more on Dilution of Precision and how to determine your precision needs, please refer to our online article here:
- http://dotspatial.codeplex.com/Articles/WritingApps2_1.aspx.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Interpreter.IsFilterEnabled">
- <summary>
- Controls whether real-time GPS data is made more precise using a filter.
- </summary>
- <value><c>true</c> if this instance is filter enabled; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Interpreter.Filter">
- <summary>
- Controls the technology used to reduce GPS precision error.
- </summary>
- <value>The filter.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Interpreter.AllowAutomaticReconnection">
- <summary>
- Controls whether the interpreter will try to automatically attempt to reconnect anytime a connection is lost.
- </summary>
- <value><c>true</c> if [allow automatic reconnection]; otherwise, <c>false</c>.</value>
- <remarks><para>Interpreters are able to automatically try to recover from connection failures. When this property is set to <strong>True</strong>,
- the interpreter will detect a sudden loss of connection, then attempt to make a new connection to restore the flow of data. If multiple GPS
- devices have been detected, any of them may be utilized as a "fail-over device." Recovery attempts will continue repeatedly until a connection
- is restored, the interpreter is stopped, or the interpreter is disposed.</para>
- <para>For most applications, this property should be enabled to help improve the stability of the application. In most cases, a sudden loss of
- data is only temporary, caused by a loss of battery power or when a wireless device moves too far out of range.</para></remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Interpreter.Satellites">
- <summary>
- Returns a list of known GPS satellites.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Interpreter.IsDisposed">
- <summary>
- Returns whether resources in this object has been shut down.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Interpreter.RecordingStream">
- <summary>
- Returns the stream used to output data received from the GPS device.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.KalmanSystemState">
- <summary>
- Represents the state of a KalmanFilter
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.KalmanSystemState._interval">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.KalmanSystemState._lastObservation">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.KalmanSystemState._delay">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.KalmanSystemState._deviceError">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.KalmanSystemState._horizontalDOP">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.KalmanSystemState._verticalDOP">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.KalmanSystemState._errorState">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.KalmanSystemState._ellipsoid">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.KalmanSystemState._x">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.KalmanSystemState._z">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.KalmanSystemState._u">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.KalmanSystemState._a">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.KalmanSystemState._p">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.KalmanSystemState._b">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.KalmanSystemState._q">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.KalmanSystemState._r">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.KalmanSystemState._h">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.KalmanSystemState.#ctor(DotSpatial.Positioning.Position3D,DotSpatial.Positioning.Distance,DotSpatial.Positioning.DilutionOfPrecision,DotSpatial.Positioning.Ellipsoid)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.KalmanSystemState"/> struct.
- </summary>
- <param name="gpsPosition">The GPS position.</param>
- <param name="deviceError">The device error.</param>
- <param name="meanDOP">The mean DOP.</param>
- <param name="ellipsoid">The ellipsoid.</param>
- </member>
- <member name="M:DotSpatial.Positioning.KalmanSystemState.#ctor(DotSpatial.Positioning.Position3D,DotSpatial.Positioning.Distance,DotSpatial.Positioning.DilutionOfPrecision,DotSpatial.Positioning.DilutionOfPrecision,DotSpatial.Positioning.Ellipsoid)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.KalmanSystemState"/> struct.
- </summary>
- <param name="gpsPosition">The GPS position.</param>
- <param name="deviceError">The device error.</param>
- <param name="horizontalDOP">The horizontal DOP.</param>
- <param name="verticalDOP">The vertical DOP.</param>
- <param name="ellipsoid">The ellipsoid.</param>
- </member>
- <member name="M:DotSpatial.Positioning.KalmanSystemState.#ctor(DotSpatial.Positioning.Position3D,DotSpatial.Positioning.Distance,DotSpatial.Positioning.DilutionOfPrecision,DotSpatial.Positioning.DilutionOfPrecision,DotSpatial.Positioning.Ellipsoid,DotSpatial.Positioning.CartesianPoint,DotSpatial.Positioning.CartesianPoint,DotSpatial.Positioning.CartesianPoint,DotSpatial.Positioning.SquareMatrix3D,DotSpatial.Positioning.SquareMatrix3D,DotSpatial.Positioning.SquareMatrix3D,DotSpatial.Positioning.SquareMatrix3D,DotSpatial.Positioning.SquareMatrix3D,DotSpatial.Positioning.SquareMatrix3D)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.KalmanSystemState"/> struct.
- </summary>
- <param name="gpsPosition">The GPS position.</param>
- <param name="deviceError">The device error.</param>
- <param name="horizontalDOP">The horizontal DOP.</param>
- <param name="verticalDOP">The vertical DOP.</param>
- <param name="ellipsoid">The ellipsoid.</param>
- <param name="u">The u.</param>
- <param name="x">The x.</param>
- <param name="z">The z.</param>
- <param name="a">A.</param>
- <param name="b">The b.</param>
- <param name="h">The h.</param>
- <param name="p">The p.</param>
- <param name="q">The q.</param>
- <param name="r">The r.</param>
- </member>
- <member name="M:DotSpatial.Positioning.KalmanSystemState.ObservedLocation">
- <summary>
- The position reported by the GPS device
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.KalmanSystemState.CorrectedLocation">
- <summary>
- The corrected position
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.KalmanSystemState.Initialize(DotSpatial.Positioning.Position3D)">
- <summary>
- Initializes the state to the supplied observation.
- </summary>
- <param name="z">The z.</param>
- </member>
- <member name="M:DotSpatial.Positioning.KalmanSystemState.UpdateState(DotSpatial.Positioning.DilutionOfPrecision,DotSpatial.Positioning.Position3D)">
- <summary>
- Updates the state.
- </summary>
- <param name="currentDOP">The current DOP.</param>
- <param name="z">The z.</param>
- </member>
- <member name="M:DotSpatial.Positioning.KalmanSystemState.UpdateState(DotSpatial.Positioning.Distance,DotSpatial.Positioning.DilutionOfPrecision,DotSpatial.Positioning.DilutionOfPrecision,DotSpatial.Positioning.Azimuth,DotSpatial.Positioning.Speed,DotSpatial.Positioning.Position3D)">
- <summary>
- Updates the state.
- </summary>
- <param name="deviceError">The device error.</param>
- <param name="horizontalDOP">The horizontal DOP.</param>
- <param name="verticalDOP">The vertical DOP.</param>
- <param name="bearing">The bearing.</param>
- <param name="speed">The speed.</param>
- <param name="z">The z.</param>
- </member>
- <member name="P:DotSpatial.Positioning.KalmanSystemState.Delay">
- <summary>
- Gets the delay.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.KalmanSystemState.CurrentError">
- <summary>
- Gets the current error.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.KalmanSystemState.ErrorState">
- <summary>
- Gets the state of the error.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.KalmanSystemState.DeviceError">
- <summary>
- Gets the device error.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.KalmanSystemState.HorizontalDilutionOfPrecision">
- <summary>
- Gets the horizontal dilution of precision.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.KalmanSystemState.VerticalDilutionOfPrecision">
- <summary>
- Gets the vertical dilution of precision.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.KalmanSystemState.IsInitialized">
- <summary>
- Determines if the Kalman state has an initial observation
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.KalmanSystemState.IntervalCount">
- <summary>
- Returns the number of intervals that have been applied to the Kalman state
- </summary>
- <remarks>The number of intervals is the number of observations accumulated in the state
- interval. The greater the number of observations, the more precise the filter
- becomes.</remarks>
- </member>
- <member name="T:DotSpatial.Positioning.KalmanFilter">
- <summary>
- A class that employs a Kalman Filter algorithm to reduce error in GPS
- precision.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.KalmanFilter._currentState">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.KalmanFilter.#ctor">
- <summary>
- Kalman Filter
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.KalmanFilter.#ctor(DotSpatial.Positioning.Position3D,DotSpatial.Positioning.Distance,DotSpatial.Positioning.DilutionOfPrecision,DotSpatial.Positioning.DilutionOfPrecision,DotSpatial.Positioning.Ellipsoid)">
- <summary>
- Kalman Filter with parameters
- </summary>
- <param name="initialObservation">The initial observation.</param>
- <param name="deviceError">The device error.</param>
- <param name="horizontalDOP">The horizontal DOP.</param>
- <param name="verticalDOP">The vertical DOP.</param>
- <param name="ellipsoid">The ellipsoid.</param>
- </member>
- <member name="M:DotSpatial.Positioning.KalmanFilter.Initialize(DotSpatial.Positioning.Position)">
- <summary>
- Initializes the Kalman Filter using an initial observation (position)
- </summary>
- <param name="gpsPosition">The position at which tfilter is to begin opperating.</param>
- <remarks>The results of a Kalman filter are cumulative. Each
- position processed changes the state of the filter, thus making
- the results more accurate with each subsequent position.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.KalmanFilter.Initialize(DotSpatial.Positioning.Position,DotSpatial.Positioning.Distance)">
- <summary>
- Initializes the Kalman Filter using an initial observation (position)
- </summary>
- <param name="gpsPosition">The position at which tfilter is to begin opperating.</param>
- <param name="deviceError">Distance of the error</param>
- </member>
- <member name="M:DotSpatial.Positioning.KalmanFilter.Initialize(DotSpatial.Positioning.Position,DotSpatial.Positioning.DilutionOfPrecision)">
- <summary>
- Initializes the Kalman Filter using an initial observation (position)
- </summary>
- <param name="gpsPosition">The position at which tfilter is to begin opperating.</param>
- <param name="meanDOP">The mean dilution of precision</param>
- </member>
- <member name="M:DotSpatial.Positioning.KalmanFilter.Initialize(DotSpatial.Positioning.Position,DotSpatial.Positioning.Distance,DotSpatial.Positioning.DilutionOfPrecision)">
- <summary>
- Initializes the Kalman Filter using an initial observation (position)
- </summary>
- <param name="gpsPosition">The position at which tfilter is to begin opperating.</param>
- <param name="deviceError">Distance of the error</param>
- <param name="meanDOP">The mean dilution of precision</param>
- </member>
- <member name="M:DotSpatial.Positioning.KalmanFilter.Initialize(DotSpatial.Positioning.Position,DotSpatial.Positioning.Distance,DotSpatial.Positioning.DilutionOfPrecision,DotSpatial.Positioning.Ellipsoid)">
- <summary>
- Initializes the Kalman Filter using an initial observation (position)
- </summary>
- <param name="gpsPosition">The position at which tfilter is to begin opperating.</param>
- <param name="deviceError">Distance of the error</param>
- <param name="meanDOP">The mean dilution of precision</param>
- <param name="ellipsoid">The ellipsoid</param>
- </member>
- <member name="M:DotSpatial.Positioning.KalmanFilter.Initialize(DotSpatial.Positioning.Position,DotSpatial.Positioning.Distance,DotSpatial.Positioning.DilutionOfPrecision,DotSpatial.Positioning.DilutionOfPrecision,DotSpatial.Positioning.Ellipsoid)">
- <summary>
- Initializes the Kalman Filter using an initial observation (position)
- </summary>
- <param name="gpsPosition">The position at which tfilter is to begin opperating.</param>
- <param name="deviceError">Distance of the error</param>
- <param name="horizontalDOP">The horizontal dilution of precision</param>
- <param name="verticalDOP">The vertical dilution of precision</param>
- <param name="ellipsoid">The ellipsoid</param>
- </member>
- <member name="M:DotSpatial.Positioning.KalmanFilter.Initialize(DotSpatial.Positioning.Position3D)">
- <summary>
- Initializes the Kalman Filter using an initial observation (position)
- </summary>
- <param name="gpsPosition">The position at which tfilter is to begin opperating.</param>
- <remarks>The results of a Kalman filter are cumulative. Each
- position processed changes the state of the filter, thus making
- the results more accurate with each subsequent position.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.KalmanFilter.Initialize(DotSpatial.Positioning.Position3D,DotSpatial.Positioning.Distance)">
- <summary>
- Initializes the Kalman Filter using an initial observation (position)
- </summary>
- <param name="gpsPosition">The position at which tfilter is to begin opperating.</param>
- <param name="deviceError">A distance measure of device error</param>
- </member>
- <member name="M:DotSpatial.Positioning.KalmanFilter.Initialize(DotSpatial.Positioning.Position3D,DotSpatial.Positioning.DilutionOfPrecision)">
- <summary>
- Initializes the Kalman Filter using an initial observation (position)
- </summary>
- <param name="gpsPosition">The position at which tfilter is to begin opperating.</param>
- <param name="meanDOP">The mean dilution of precision</param>
- </member>
- <member name="M:DotSpatial.Positioning.KalmanFilter.Initialize(DotSpatial.Positioning.Position3D,DotSpatial.Positioning.Distance,DotSpatial.Positioning.DilutionOfPrecision)">
- <summary>
- Initializes the Kalman Filter using an initial observation (position)
- </summary>
- <param name="gpsPosition">The position at which tfilter is to begin opperating.</param>
- <param name="deviceError">A distance measure of device error</param>
- <param name="meanDOP">The mean dilution of precision</param>
- </member>
- <member name="M:DotSpatial.Positioning.KalmanFilter.Initialize(DotSpatial.Positioning.Position3D,DotSpatial.Positioning.Distance,DotSpatial.Positioning.DilutionOfPrecision,DotSpatial.Positioning.Ellipsoid)">
- <summary>
- Initializes the Kalman Filter using an initial observation (position)
- </summary>
- <param name="gpsPosition">The position at which tfilter is to begin opperating.</param>
- <param name="deviceError">A distance measure of device error</param>
- <param name="meanDOP">The mean dilution of precision</param>
- <param name="ellipsoid">The ellipsoid</param>
- </member>
- <member name="M:DotSpatial.Positioning.KalmanFilter.Initialize(DotSpatial.Positioning.Position3D,DotSpatial.Positioning.Distance,DotSpatial.Positioning.DilutionOfPrecision,DotSpatial.Positioning.DilutionOfPrecision,DotSpatial.Positioning.Ellipsoid)">
- <summary>
- Initializes the Kalman Filter using an initial observation (position)
- </summary>
- <param name="gpsPosition">The position at which tfilter is to begin opperating.</param>
- <param name="deviceError">A distance measure of device error</param>
- <param name="horizontalDOP">The horizontal dilution of precision</param>
- <param name="verticalDOP">The vertical dilution of precision</param>
- <param name="ellipsoid">The ellipsoid</param>
- </member>
- <member name="M:DotSpatial.Positioning.KalmanFilter.Filter(DotSpatial.Positioning.Position)">
- <summary>
- Filter the Position
- </summary>
- <param name="gpsPosition">The GPS position.</param>
- <returns></returns>
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.KalmanFilter.Filter(DotSpatial.Positioning.Position,DotSpatial.Positioning.DilutionOfPrecision)">
- <summary>
- Returns the position
- </summary>
- <param name="gpsPosition">The gps Position</param>
- <param name="currentDOP">The current dilution of precision</param>
- <returns>A Position sturcture</returns>
- </member>
- <member name="M:DotSpatial.Positioning.KalmanFilter.Filter(DotSpatial.Positioning.Position,DotSpatial.Positioning.DilutionOfPrecision,DotSpatial.Positioning.Azimuth,DotSpatial.Positioning.Speed)">
- <summary>
- Returns the position
- </summary>
- <param name="gpsPosition">The gps Position</param>
- <param name="currentDOP">The current dilution of precision</param>
- <param name="bearing">the directional azimuth</param>
- <param name="speed">the magnitude of the velocity</param>
- <returns>A Position sturcture</returns>
- </member>
- <member name="M:DotSpatial.Positioning.KalmanFilter.Filter(DotSpatial.Positioning.Position,DotSpatial.Positioning.Distance,DotSpatial.Positioning.DilutionOfPrecision,DotSpatial.Positioning.DilutionOfPrecision,DotSpatial.Positioning.Azimuth,DotSpatial.Positioning.Speed)">
- <summary>
- Return filtered position from specified parameters
- </summary>
- <param name="gpsPosition">The GPS position.</param>
- <param name="deviceError">The device error.</param>
- <param name="horizontalDOP">The horizontal DOP.</param>
- <param name="verticalDOP">The vertical DOP.</param>
- <param name="bearing">The bearing.</param>
- <param name="speed">The speed.</param>
- <returns></returns>
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.KalmanFilter.Filter(DotSpatial.Positioning.Position3D)">
- <summary>
- Returns the 3D position
- </summary>
- <param name="gpsPosition">The gps Position</param>
- <returns>A Position3D sturcture</returns>
- </member>
- <member name="M:DotSpatial.Positioning.KalmanFilter.Filter(DotSpatial.Positioning.Position3D,DotSpatial.Positioning.DilutionOfPrecision)">
- <summary>
- Returns the 3D position
- </summary>
- <param name="gpsPosition">The gps Position</param>
- <param name="currentDOP">The current dilution of precision</param>
- <returns>A Position3D sturcture</returns>
- </member>
- <member name="M:DotSpatial.Positioning.KalmanFilter.Filter(DotSpatial.Positioning.Position3D,DotSpatial.Positioning.DilutionOfPrecision,DotSpatial.Positioning.Azimuth,DotSpatial.Positioning.Speed)">
- <summary>
- Returns the 3D position
- </summary>
- <param name="gpsPosition">The gps Position</param>
- <param name="currentDOP">The current dilution of precision</param>
- <param name="bearing">the directional azimuth</param>
- <param name="speed">the magnitude of the velocity</param>
- <returns>A Position3D sturcture</returns>
- </member>
- <member name="M:DotSpatial.Positioning.KalmanFilter.Filter(DotSpatial.Positioning.Position3D,DotSpatial.Positioning.Distance,DotSpatial.Positioning.DilutionOfPrecision,DotSpatial.Positioning.DilutionOfPrecision,DotSpatial.Positioning.Azimuth,DotSpatial.Positioning.Speed)">
- <summary>
- Return a filtered Position3D from the specified parameters
- </summary>
- <param name="gpsPosition">The GPS position.</param>
- <param name="deviceError">The device error.</param>
- <param name="horizontalDOP">The horizontal DOP.</param>
- <param name="verticalDOP">The vertical DOP.</param>
- <param name="bearing">The bearing.</param>
- <param name="speed">The speed.</param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Positioning.KalmanFilter.FilteredLocation">
- <summary>
- The filtered location
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.KalmanFilter.ObservedLocation">
- <summary>
- The observed location
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.KalmanFilter.Delay">
- <summary>
- Represents the latency between the current obervation and the filter state
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.KalmanFilter.IsInitialized">
- <summary>
- Returns a value indicationg whether or not the filter has been initialized.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.KalmanFilter.CurrentMeanDilutionOfPrecision">
- <summary>
- Returns the DilutionOfPrecision used in the most recent
- Kalman filter calculation.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.KalmanFilter.CurrentDeviceError">
- <summary>
- Returns the device error margin used in the most recent
- Kalman filter calculation.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.KalmanFilter.CurrentStateSampleCount">
- <summary>
- Retrns the of position samples that have been evaluated by
- the current Kalman state.
- </summary>
- <remarks>The results of a Kalman filter are cumulative. Each
- position processed changes the state of the filter, thus making
- the results more accurate with each subsequent position.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.KalmanFilter.ErrorState">
- <summary>
- Returns the accumulated average error accounted for the Kalman system.
- </summary>
- <remarks>The results of a Kalman filter are cumulative. Each
- position processed changes the state of the filter, thus making
- the results more accurate with each subsequent position.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.KalmanFilter.CurrentErrorEstimate">
- <summary>
- Returns the current precision estimate for the Kalman state
- </summary>
- <remarks>The results of a Kalman filter are cumulative. Each
- position processed changes the state of the filter, thus making
- the results more accurate with each subsequent position.</remarks>
- </member>
- <member name="T:DotSpatial.Positioning.NativeMethods2">
- <summary>
- An internal class for hosting windows members.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.KERNEL32">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.BTHNS_RESULT_DEVICE_CONNECTED">
- <summary>
- Device Connected
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.BTHNS_RESULT_DEVICE_REMEMBERED">
- <summary>
- Device Remembered
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.BTHNS_RESULT_DEVICE_AUTHENTICATED">
- <summary>
- Device Authenticated
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.NS_BTH">
- <summary>
- The namespace of Bluetooth, used by the WSAQUERYSET structure
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.ERROR_SUCCESS">
- <summary>
- The error code for success
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.DIGCF_DEFAULT">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.DIGCF_PRESENT">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.DIGCF_ALLCLASSES">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.DIGCF_PROFILE">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.DIGCF_DEVICEINTERFACE">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.InvalidHandle">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.NativeMethods2.CloseHandle(System.IntPtr)">
- <summary>
- Closes an open object handle.
- </summary>
- <param name="handle">A valid handle to an open object.</param>
- <returns>If the function succeeds, the return value is nonzero.
- If the function fails, the return value is zero. To get extended error information, call GetLastError.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.NativeMethods2.DeviceIoControl(System.IntPtr,System.UInt32,System.IntPtr,System.UInt32,System.IntPtr,System.UInt32,System.UInt32@,System.IntPtr)">
- <summary>
- Sends a control code directly to a specified device driver, causing the corresponding device to perform the corresponding operation.
- </summary>
- <param name="hDevice">A handle to the device on which the operation is to be performed. The device is typically a volume,
- directory, file, or stream. To retrieve a device handle, use the CreateFile function. For more information, see Remarks.</param>
- <param name="dwIoControlCode">The control code for the operation. This value identifies the specific operation to be
- performed and the type of device on which to perform it. For a list of the control codes, see Remarks.
- The documentation for each control code provides usage details for the lpInBuffer, nInBufferSize, lpOutBuffer,
- and nOutBufferSize parameters.</param>
- <param name="lpInBuffer">A pointer to the input buffer that contains the data required to perform the operation. The format of this data depends on the value of the dwIoControlCode parameter.
- This parameter can be NULL if dwIoControlCode specifies an operation that does not require input data.</param>
- <param name="nInBufferSize">The size of the input buffer, in bytes.</param>
- <param name="lpOutBuffer">A pointer to the output buffer that is to receive the data returned by the operation. The format of this data
- depends on the value of the dwIoControlCode parameter.
- This parameter can be NULL if dwIoControlCode specifies an operation that does not return data.</param>
- <param name="nOutBufferSize">The size of the output buffer, in bytes.</param>
- <param name="lpBytesReturned">The number of bytes returned in the out buffer.</param>
- <param name="lpOverlapped">A pointer to a callback for async commands.</param>
- <returns>If the operation completes successfully, the return value is nonzero.
- If the operation fails or is pending, the return value is zero. To get extended error information, call GetLastError.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.NativeMethods2.CreateFile(System.String,System.IO.FileAccess,System.IO.FileShare,System.UInt32,System.IO.FileMode,System.IO.FileAttributes,System.IntPtr)">
- <summary>
- Creates or opens a file or I/O device. The most commonly used I/O devices are as follows: file, file stream,
- directory, physical disk, volume, console buffer, tape drive, communications resource, mailslot, and pipe.
- The function returns a handle that can be used to access the file or device for various types of I/O depending
- on the file or device and the flags and attributes specified.
- To perform this operation as a transacted operation, which results in a handle that can be used for transacted
- I/O, use the CreateFileTransacted function.
- </summary>
- <param name="lpFileName">The name of the file or device to be created or opened.</param>
- <param name="dwDesiredAccess">The requested access to the file or device, which can be summarized as read, write, both or neither zero).</param>
- <param name="dwShareMode">The requested sharing mode of the file or device, which can be read, write, both,
- delete, all of these, or none (refer to the following table). Access requests to attributes or extended
- attributes are not affected by this flag.</param>
- <param name="lpSecurityAttributes">A pointer to a SECURITY_ATTRIBUTES structure that contains two separate but related data members:
- an optional security descriptor, and a Boolean value that determines whether the returned handle can be
- inherited by child processes.</param>
- <param name="dwCreationDisposition">An action to take on a file or device that exists or does not exist.</param>
- <param name="dwFlagsAndAttributes">The file or device attributes and flags, FILE_ATTRIBUTE_NORMAL being the most common default value for files.</param>
- <param name="hTemplateFile">A valid handle to a template file with the GENERIC_READ access right. The template file supplies file attributes and extended attributes for the file that is being created.</param>
- <returns>A handle to the device.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.NativeMethods2.ReadFile(System.IntPtr,System.Byte[],System.UInt32,System.UInt32@,System.IntPtr)">
- <summary>
- Reads data from the specified file or input/output (I/O) device. Reads occur at the position
- specified by the file pointer if supported by the device.
- </summary>
- <param name="handle">A handle to the device (for example, a file, file stream, physical disk, volume, console buffer,
- tape drive, socket, communications resource, mailslot, or pipe).</param>
- <param name="lpBuffer">A pointer to the buffer that receives the data read from a file or device.</param>
- <param name="nNumberOfBytesToRead">The maximum number of bytes to be read.</param>
- <param name="lpNumberOfBytesRead">A pointer to the variable that receives the number of bytes read when using
- a synchronous hFile parameter. ReadFile sets this value to zero before doing any work or error checking.
- Use NULL for this parameter if this is an asynchronous operation to avoid potentially erroneous results.</param>
- <param name="lpOverlapped">A pointer to an OVERLAPPED structure is required if the hFile parameter was opened
- with FILE_FLAG_OVERLAPPED, otherwise it can be NULL.</param>
- <returns>If the function succeeds, the return value is nonzero (TRUE).</returns>
- </member>
- <member name="M:DotSpatial.Positioning.NativeMethods2.WriteFile(System.IntPtr,System.Byte[],System.UInt32,System.UInt32@,System.IntPtr)">
- <summary>
- Writes data to the specified file or input/output (I/O) device.
- This function is designed for both synchronous and asynchronous operation. For a similar function
- designed solely for asynchronous operation, see WriteFileEx.
- </summary>
- <param name="handle">A handle to the file or I/O device (for example, a file, file stream, physical disk, volume,
- console buffer, tape drive, socket, communications resource, mailslot, or pipe).</param>
- <param name="lpBuffer">A pointer to the buffer containing the data to be written to the file or device.</param>
- <param name="nNumberOfBytesToWrite">The number of bytes to be written to the file or device.</param>
- <param name="lpNumberOfBytesWritten">A pointer to the variable that receives the number of bytes written when using
- a synchronous hFile parameter. WriteFile sets this value to zero before doing any work or error checking.
- Use NULL for this parameter if this is an asynchronous operation to avoid potentially erroneous results.</param>
- <param name="lpOverlapped">A pointer to an OVERLAPPED structure is required if the hFile parameter was opened
- with FILE_FLAG_OVERLAPPED, otherwise this parameter can be NULL.</param>
- <returns>If the function succeeds, the return value is nonzero (TRUE).</returns>
- </member>
- <member name="M:DotSpatial.Positioning.NativeMethods2.SetLocalTime(DotSpatial.Positioning.NativeMethods2.SystemTime@)">
- <summary>
- Sets the current local time and date.
- </summary>
- <param name="time">A pointer to a SYSTEMTIME structure that contains the new local date and time.</param>
- <returns>If the function succeeds, the return value is nonzero.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.NativeMethods2.SetSystemTime(DotSpatial.Positioning.NativeMethods2.SystemTime@)">
- <summary>
- Sets the current system time and date. The system time is expressed in Coordinated Universal Time (UTC).
- </summary>
- <param name="time">A pointer to a SYSTEMTIME structure that contains the new system date and time.</param>
- <returns>If the function succeeds, the return value is nonzero.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.NativeMethods2.SetupDiClassGuidsFromName(System.Text.StringBuilder,System.IntPtr,System.Int32,System.Int32@)">
- <summary>
- The SetupDiClassGuidsFromName function retrieves the GUID(s) associated with the specified class name.
- This list is built based on the classes currently installed on the system.
- </summary>
- <param name="className">Supplies the name of the class for which to retrieve the class GUID.</param>
- <param name="classGuidList">Supplies a pointer to an array to receive the list of GUIDs associated with the specified class name.</param>
- <param name="classGuidListSize">Supplies the number of GUIDs in the ClassGuidList array.</param>
- <param name="requiredSize">Supplies a pointer to a variable that receives the number of GUIDs associated with the class name.
- If this number is greater than the size of the ClassGuidList buffer, the number indicates how large
- the array must be in order to store all the GUIDs.</param>
- <returns>The function returns TRUE if it is successful. Otherwise, it returns FALSE and the logged
- error can be retrieved with a call to GetLastError.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.NativeMethods2.CM_Get_Parent(System.UInt32@,System.UInt32,System.Int32)">
- <summary>
- The CM_Get_Parent function obtains a device instance handle to the parent node of a
- specified device node (devnode) in the local machine's device tree.
- </summary>
- <param name="pdnDevInst">Caller-supplied pointer to the device instance handle to the
- parent node that this function retrieves. The retrieved handle is bound to the local machine.</param>
- <param name="dnDevInst">Caller-supplied device instance handle that is bound to the local machine.</param>
- <param name="ulFlags">Not used, must be zero.</param>
- <returns>If the operation succeeds, the function returns CR_SUCCESS. Otherwise, it returns one of the
- CR_-prefixed error codes defined in Cfgmgr32.h.</returns>
- <remarks>For information about using a device instance handle that is bound to the local machine, see CM_Get_Child.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.NativeMethods2.CM_Get_Device_ID(System.UInt32,System.IntPtr,System.Int32,System.Int32)">
- <summary>
- The CM_Get_Device_ID function retrieves the device instance ID for a specified device instance on the local machine.
- </summary>
- <param name="dnDevInst">Caller-supplied device instance handle that is bound to the local machine.</param>
- <param name="buffer">Address of a buffer to receive a device instance ID string. The required buffer size
- can be obtained by calling CM_Get_Device_ID_Size, then incrementing the received value to allow room for
- the string's terminating NULL.</param>
- <param name="bufferLen">Caller-supplied length, in characters, of the buffer specified by Buffer.</param>
- <param name="ulFlags">Not used, must be zero.</param>
- <returns>If the operation succeeds, the function returns CR_SUCCESS. Otherwise, it returns one of the CR_-prefixed error codes defined in Cfgmgr32.h.</returns>
- <remarks>The function appends a NULL terminator to the supplied device instance ID string, unless the buffer is too
- small to hold the string. In this case, the function supplies as much of the identifier string as will fit
- into the buffer, and then returns CR_BUFFER_SMALL.
- For information about device instance IDs, see Device Identification Strings.
- For information about using device instance handles that are bound to the local machine, see CM_Get_Child.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.NativeMethods2.SetupDiDestroyDeviceInfoList(System.IntPtr)">
- <summary>
- The SetupDiDestroyDeviceInfoList function deletes a device information set and frees all associated memory.
- </summary>
- <param name="hDevInfo">A handle to the device information set to delete.</param>
- <returns>The function returns TRUE if it is successful. Otherwise, it returns FALSE and the
- logged error can be retrieved with a call to GetLastError.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.NativeMethods2.SetupDiGetClassDevs(System.Guid@,System.IntPtr,System.IntPtr,System.Int32)">
- <summary>
- The SetupDiGetClassDevs function returns a handle to a device information set that contains requested
- device information elements for a local computer.
- </summary>
- <param name="classGuid">A pointer to the GUID for a device setup class or a device interface class.
- This pointer is optional and can be NULL. For more information about how to set ClassGuid, see the
- following Remarks section.</param>
- <param name="enumerator">A pointer to a NULL-terminated string that specifies:
- * An identifier (ID) of a Plug and Play (PnP) enumerator. This ID can either be the value's globally
- unique identifier (GUID) or symbolic name. For example, "PCI" can be used to specify the PCI PnP value.
- Other examples of symbolic names for PnP values include "USB," "PCMCIA," and "SCSI".
- * A PnP device instance ID. When specifying a PnP device instance ID, DIGCF_DEVICEINTERFACE must be set
- in the Flags parameter.
- This pointer is optional and can be NULL. If an enumeration value is not used to select devices,
- set Enumerator to NULL
- For more information about how to set the Enumerator value, see the following Remarks section.</param>
- <param name="hwndParent">A handle to the top-level window to be used for a user interface that is
- associated with installing a device instance in the device information set. This handle is optional
- and can be NULL.</param>
- <param name="flags">A variable of type DWORD that specifies control options that filter the device information
- elements that are added to the device information set. This parameter can be a bitwise OR of zero
- or more of the following flags. For more information about combining these flags, see the following
- Remarks section.
- DIGCF_ALLCLASSES
- Return a list of installed devices for all device setup classes or all device interface classes.
- DIGCF_DEVICEINTERFACE
- Return devices that support device interfaces for the specified device interface classes.
- This flag must be set in the Flags parameter if the Enumerator parameter specifies a device instance ID.
- DIGCF_DEFAULT
- Return only the device that is associated with the system default device interface, if one is set,
- for the specified device interface classes.
- DIGCF_PRESENT
- Return only devices that are currently present in a system.
- DIGCF_PROFILE
- Return only devices that are a part of the current hardware profile.</param>
- <returns>If the operation succeeds, SetupDiGetClassDevs returns a handle to a device information set that contains
- all installed devices that matched the supplied parameters. If the operation fails, the function returns
- INVALID_HANDLE_VALUE. To get extended error information, call GetLastError.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.NativeMethods2.SetupDiEnumDeviceInfo(System.IntPtr,System.UInt32,DotSpatial.Positioning.NativeMethods2.SpDevinfoData@)">
- <summary>
- The SetupDiEnumDeviceInfo function returns a SP_DEVINFO_DATA structure that specifies a device
- information element in a device information set.
- </summary>
- <param name="hDevInfo">A handle to the device information set for which to return an SP_DEVINFO_DATA
- structure that represents a device information element.</param>
- <param name="memberIndex">A zero-based index of the device information element to retrieve.</param>
- <param name="devInfo">A pointer to an SP_DEVINFO_DATA structure to receive information about an enumerated device information
- element. The caller must set DeviceInfoData.cbSize to sizeof(SP_DEVINFO_DATA).</param>
- <returns>The function returns TRUE if it is successful. Otherwise, it returns FALSE and the logged error
- can be retrieved with a call to GetLastError.</returns>
- <remarks>Repeated calls to this function return a device information element for a different device. This function
- can be called repeatedly to get information about all devices in the device information set.
- To enumerate device information elements, an installer should initially call SetupDiEnumDeviceInfo with
- the MemberIndex parameter set to 0. The installer should then increment MemberIndex and call
- SetupDiEnumDeviceInfo until there are no more values (the function fails and a call to GetLastError
- returns ERROR_NO_MORE_ITEMS).
- Call SetupDiEnumDeviceInterfaces to get a context structure for a device interface element (versus a device information element).</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.NativeMethods2.SetupDiEnumDeviceInterfaces(System.IntPtr,System.IntPtr,System.Guid@,System.UInt32,DotSpatial.Positioning.NativeMethods2.SpDeviceInterfaceData@)">
- <summary>
- The SetupDiEnumDeviceInterfaces function enumerates the device interfaces that are contained in a device information set.
- </summary>
- <param name="hDevInfo">A pointer to a device information set that contains the device interfaces for which to return information.
- This handle is typically returned by SetupDiGetClassDevs.</param>
- <param name="devInfo">A pointer to an SP_DEVINFO_DATA structure that specifies a device information element in DeviceInfoSet.
- This parameter is optional and can be NULL. If this parameter is specified, SetupDiEnumDeviceInterfaces
- constrains the enumeration to the interfaces that are supported by the specified device. If this parameter
- is NULL, repeated calls to SetupDiEnumDeviceInterfaces return information about the interfaces that are
- associated with all the device information elements in DeviceInfoSet. This pointer is typically returned
- by SetupDiEnumDeviceInfo.</param>
- <param name="interfaceClassGuid">A pointer to a GUID that specifies the device interface class for the requested interface.</param>
- <param name="memberIndex">A zero-based index into the list of interfaces in the device information set. The caller should call
- this function first with MemberIndex set to zero to obtain the first interface. Then, repeatedly increment
- MemberIndex and retrieve an interface until this function fails and GetLastError returns ERROR_NO_MORE_ITEMS.
- If DeviceInfoData specifies a particular device, the MemberIndex is relative to only the interfaces exposed
- by that device.</param>
- <param name="deviceInterfaceData">A pointer to a caller-allocated buffer that contains, on successful return, a completed SP_DEVICE_INTERFACE_DATA
- structure that identifies an interface that meets the search parameters. The caller must set DeviceInterfaceData.cbSize
- to sizeof(SP_DEVICE_INTERFACE_DATA) before calling this function.</param>
- <returns>SetupDiEnumDeviceInterfaces returns TRUE if the function completed without error. If the function completed
- with an error, FALSE is returned and the error code for the failure can be retrieved by calling GetLastError.</returns>
- <remarks>Repeated calls to this function return an SP_DEVICE_INTERFACE_DATA structure for a different device interface.
- This function can be called repeatedly to get information about interfaces in a device information set that
- are associated with a particular device information element or that are associated with all device information
- elements.
- DeviceInterfaceData points to a structure that identifies a requested device interface. To get detailed
- information about an interface, call SetupDiGetDeviceInterfaceDetail. The detailed information includes
- the name of the device interface that can be passed to a Win32 function such as CreateFile
- (described in Microsoft Windows SDK documentation) to get a handle to the interface.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.NativeMethods2.SetupDiGetDeviceInterfaceDetail(System.IntPtr,DotSpatial.Positioning.NativeMethods2.SpDeviceInterfaceData@,DotSpatial.Positioning.NativeMethods2.SpDeviceInterfaceDetailData@,System.UInt32,System.UInt32@,DotSpatial.Positioning.NativeMethods2.SpDevinfoData@)">
- <summary>
- The SetupDiGetDeviceInterfaceDetail function returns details about a device interface.
- </summary>
- <param name="hDevInfo">A pointer to the device information set that contains the interface
- for which to retrieve details. This handle is typically returned by SetupDiGetClassDevs.</param>
- <param name="deviceInterfaceData">A pointer to an SP_DEVICE_INTERFACE_DATA structure that specifies
- the interface in DeviceInfoSet for which to retrieve details. A pointer of this type is typically
- returned by SetupDiEnumDeviceInterfaces.</param>
- <param name="deviceInterfaceDetailData">A pointer to an SP_DEVICE_INTERFACE_DETAIL_DATA structure to receive information about the specified
- interface. This parameter is optional and can be NULL. This parameter must be NULL if
- DeviceInterfaceDetailSize is zero. If this parameter is specified, the caller must set
- DeviceInterfaceDetailData.cbSize to sizeof(SP_DEVICE_INTERFACE_DETAIL_DATA) before calling this function.
- The cbSize member always contains the size of the fixed part of the data structure, not a size reflecting
- the variable-length string at the end.</param>
- <param name="deviceInterfaceDetailDataSize">The size of the DeviceInterfaceDetailData buffer. The buffer must be at least
- (offsetof(SP_DEVICE_INTERFACE_DETAIL_DATA, DevicePath) + sizeof(TCHAR)) bytes, to contain the fixed part
- of the structure and a single NULL to terminate an empty MULTI_SZ string.
- This parameter must be zero if DeviceInterfaceDetailData is NULL.</param>
- <param name="requiredSize">A pointer to a variable of type DWORD that receives the required size of the DeviceInterfaceDetailData buffer.
- This size includes the size of the fixed part of the structure plus the number of bytes required for the
- variable-length device path string. This parameter is optional and can be NULL.</param>
- <param name="deviceInfoData">A pointer to a buffer that receives information about the device that supports the requested interface.
- The caller must set DeviceInfoData.cbSize to sizeof(SP_DEVINFO_DATA). This parameter is optional and can
- be NULL.</param>
- <returns>SetupDiGetDeviceInterfaceDetail returns TRUE if the function completed without error. If the function
- completed with an error, FALSE is returned and the error code for the failure can be retrieved by calling
- GetLastError.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.NativeMethods2.BluetoothGetDeviceInfo(System.IntPtr,DotSpatial.Positioning.NativeMethods2.BluetoothDeviceInfo@)">
- <summary>
- The BluetoothGetDeviceInfo function retrieves information about a remote Bluetooth device.
- The Bluetooth device must have been previously identified through a successful device inquiry function call.
- </summary>
- <param name="hRadio">A handle to a local radio, obtained from a call to the BluetoothFindFirstRadio or similar functions,
- or from a call to the SetupDiEnumerateDeviceInterfaces function.</param>
- <param name="pbtdi">A pointer to a BLUETOOTH_DEVICE_INFO structure into which data about the first Bluetooth device will be placed.
- For more information, see Remarks.</param>
- <returns>Returns ERROR_SUCCESS upon success, indicating that data about the remote Bluetooth device was retrieved.
- Returns error codes upon failure. The following table lists common error codes associated with the
- BluetoothGetDeviceInfo function.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.NativeMethods2.BluetoothGetRadioInfo(System.IntPtr,DotSpatial.Positioning.NativeMethods2.BluetoothRadioInfo@)">
- <summary>
- The BluetoothGetRadioInfo function obtains information about a Bluetooth radio.
- </summary>
- <param name="hRadio">A handle to a local Bluetooth radio, obtained by calling the
- BluetoothFindFirstRadio or similar functions, or the SetupDiEnumerateDeviceInterfances function.</param>
- <param name="pbtdi">A pointer to a BLUETOOTH_RADIO_INFO structure into which information about the radio
- will be placed. The dwSize member of the BLUETOOTH_RADIO_INFO structure must match the size of the structure.</param>
- <returns>The following table lists common return values.
- ERROR_SUCCESS - The radio information was retrieved successfully.
- ERROR_INVALID_PARAMETER - The hRadio or pRadioInfo parameter is NULL.
- ERROR_REVISION_MISMATCH - The dwSize member of the BLUETOOTH_RADIO_INFO structure pointed to by pRadioInfo is not valid.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.NativeMethods2.BluetoothFindFirstRadio(DotSpatial.Positioning.NativeMethods2.BluetoothFindRadioParams,System.IntPtr@)">
- <summary>
- The BluetoothFindFirstRadio function begins the enumeration of local Bluetooth radios.
- </summary>
- <param name="pbtfrp">Pointer to a BLUETOOTH_FIND_RADIO_PARAMS structure. The dwSize member of the BLUETOOTH_FIND_RADIO_PARAMS
- structure pointed to by pbtfrp must match the size of the structure. See Return Values for additional
- information about this parameter.</param>
- <param name="phRadio">Pointer to where the first enumerated radio handle will be returned. When no longer needed, this handle
- must be closed via CloseHandle.</param>
- <returns>In addition to the handle indicated by phRadio, calling this function will also create a
- HBLUETOOTH_RADIO_FIND handle for use with the BluetoothFindNextRadio function. When this handle
- is no longer needed, it must be closed via the BluetoothFindRadioClose.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.NativeMethods2.BluetoothFindRadioClose(System.IntPtr)">
- <summary>
- The BluetoothFindRadioClose function closes the enumeration handle associated with finding Bluetooth radios.
- </summary>
- <param name="hFind">Enumeration handle to close, obtained with a previous call to the BluetoothFindFirstRadio function.</param>
- <returns>Returns TRUE when the handle is successfully closed. Returns FALSE if the attempt fails to close the
- enumeration handle. For additional information on possible errors associated with closing the handle,
- call the GetLastError function.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.NativeMethods2.BluetoothIsConnectable(System.IntPtr)">
- <summary>
- The BluetoothIsConnectable function determines whether a Bluetooth radio or radios is connectable.
- </summary>
- <param name="hRadio">Valid local radio handle, or NULL. If NULL, all local radios are checked for
- connectability; if any radio is connectable, the function call succeeds.</param>
- <returns>Returns TRUE if at least one Bluetooth radio is accepting incoming connections.
- Returns FALSE if no radios are accepting incoming connections.</returns>
- <remarks>If multiple Bluetooth radios exist, the first radio to return that it is connectable causes the
- BluetoothIsConnectable function to succeed.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.NativeMethods2.BluetoothIsDiscoverable(System.IntPtr)">
- <summary>
- The BluetoothIsDiscoverable function determines whether a Bluetooth radio or radios is discoverable.
- </summary>
- <param name="hRadio">Valid local radio handle, or NULL. If NULL, discovery is determined for all local radios;
- if any radio is discoverable, the function call succeeds.</param>
- <returns>Returns TRUE if at least one Bluetooth radio is discoverable. Returns FALSE if no Bluetooth radios are discoverable.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.NativeMethods2.BluetoothEnableDiscovery(System.IntPtr,System.Boolean)">
- <summary>
- The BluetoothEnableDiscovery function changes the discovery state of a local Bluetooth radio or radios.
- </summary>
- <param name="hRadio">Valid local radio handle, or NULL. If NULL, discovery is modified on all local radios;
- if any radio is modified by the call, the function call succeeds.</param>
- <param name="fEnabled">Flag specifying whether discovery is to be enabled or disabled. Set to TRUE to enable discovery,
- set to FALSE to disable discovery.</param>
- <returns>Returns TRUE if the discovery state was successfully changed. If hRadio is NULL, a return value of
- TRUE indicates that at least one local radio state was successfully changed. Returns FALSE if discovery
- state was not changed; if hRadio was NULL, no radio accepted the state change.</returns>
- <remarks>Use the BluetoothIsDiscoverable function to determine the current state of a Bluetooth radio. Windows ensures that a discoverable system is connectable, and as such, the radio must allow incoming connections prior to making a radio discoverable. Failure to allow incoming connections results in the BluetoothEnableDiscovery function call failing.
- When BluetoothEnableDiscovery changes the discovery state, the new state is valid for the lifetime of the
- calling application. Additionally, if a Bluetooth radio previously made discoverable with this function
- is disabled and re-enabled via the application, discoverability will not persist. Once the calling application
- terminates, the discovery state of the specified Bluetooth radio reverts to the state it was in before
- BluetoothEnableDiscovery was called.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.NativeMethods2.BluetoothEnableIncomingConnections(System.IntPtr,System.Boolean)">
- <summary>
- The BluetoothEnableIncomingConnections function modifies whether a local Bluetooth radio accepts incoming connections.
- </summary>
- <param name="hRadio">Valid local radio handle for which to change whether incoming connections are enabled, or NULL. If NULL,
- the attempt to modify incoming connection acceptance iterates through all local radios; if any radio is
- modified by the call, the function call succeeds.</param>
- <param name="fEnabled">Flag specifying whether incoming connection acceptance is to be enabled or disabled. Set to TRUE to
- enable incoming connections, set to FALSE to disable incoming connections.</param>
- <returns>Returns TRUE if the incoming connection state was successfully changed. If hRadio is NULL, a return
- value of TRUE indicates that at least one local radio state was successfully changed. Returns FALSE
- if incoming connection state was not changed; if hRadio was NULL, no radio accepted the state change.</returns>
- <remarks>A radio that is non-connectable is non-discoverable. The radio must be made non-discoverable prior
- to making a radio non-connectable. Failure to make a radio non-discoverable prior to making it
- non-connectable will result in failure of the BluetoothEnableIncomingConnections function call.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.NativeMethods2.WSAStartup(System.UInt16,DotSpatial.Positioning.NativeMethods2.WsaData)">
- <summary>
- The WSAStartup function initiates use of the Winsock DLL by a process.
- </summary>
- <param name="wVersionRequested">The highest version of Windows Sockets specification that the caller can use.
- The high-order byte specifies the minor version number; the low-order byte specifies the major version number.</param>
- <param name="wsaData">A pointer to the WSADATA data structure that is to receive details of the Windows Sockets implementation.</param>
- <returns>If successful, the WSAStartup function returns zero. Otherwise, it returns one of the error codes listed below.
- WSASYSNOTREADY - The underlying network subsystem is not ready for network communication.
- WSAVERNOTSUPPORTED - The version of Windows Sockets support requested is not provided by this particular Windows Sockets implementation.
- WSAEINPROGRESS - A blocking Windows Sockets 1.1 operation is in progress.
- WSAEPROCLIM - A limit on the number of tasks supported by the Windows Sockets implementation has been reached.
- WSAEFAULT - The lpWSAData parameter is not a valid pointer.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.NativeMethods2.WSACleanup">
- <summary>
- The WSACleanup function terminates use of the Winsock 2 DLL (Ws2_32.dll).
- </summary>
- <returns>The return value is zero if the operation was successful.
- Otherwise, the value SOCKET_ERROR is returned, and a specific error number
- can be retrieved by calling WSAGetLastError.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.NativeMethods2.WSALookupServiceBegin(DotSpatial.Positioning.NativeMethods2.WsaQuerySet,DotSpatial.Positioning.NativeMethods2.WasLookupControlOptions,System.IntPtr@)">
- <summary>
- The WSALookupServiceBegin function initiates a client query that is constrained by the
- information contained within a WSAQUERYSET structure. WSALookupServiceBegin only returns a
- handle, which should be used by subsequent calls to WSALookupServiceNext to get the actual results.
- </summary>
- <param name="qsRestrictions">Pointer to the search criteria. See the following for details.</param>
- <param name="dwControlControlOptions">Flag that controls the depth of the search.</param>
- <param name="lphLookup">Handle to be used when calling WSALookupServiceNext in order to start retrieving the results set.</param>
- <returns>The return value is zero if the operation was successful. Otherwise, the value SOCKET_ERROR is returned,
- and a specific error number can be retrieved by calling WSAGetLastError.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.NativeMethods2.WSALookupServiceNext(System.IntPtr,DotSpatial.Positioning.NativeMethods2.WasLookupControlOptions,System.Int32@,System.Byte[])">
- <summary>
- The WSALookupServiceNext function is called after obtaining a handle from a previous call to
- WSALookupServiceBegin in order to retrieve the requested service information.
- The provider will pass back a WSAQUERYSET structure in the lpqsResults buffer. The client should
- continue to call this function until it returns WSA_E_NO_MORE, indicating that all of WSAQUERYSET
- has been returned.
- </summary>
- <param name="hLookup">Handle returned from the previous call to WSALookupServiceBegin.</param>
- <param name="dwControlControlOptions">Flags to control the next operation. Currently, only LUP_FLUSHPREVIOUS is defined as a means to cope
- with a result set that is too large. If an application does not (or cannot) supply a large enough buffer,
- setting LUP_FLUSHPREVIOUS instructs the provider to discard the last result set—which was too large—and
- move on to the next set for this call.</param>
- <param name="lpdwBufferLength">On input, the number of bytes contained in the buffer pointed to by lpqsResults.
- On output, if the function fails and the error is WSAEFAULT, then it contains the minimum number
- of bytes to pass for the lpqsResults to retrieve the record.</param>
- <param name="pqsResults">Pointer to a block of memory, which will contain one result set in a WSAQUERYSET structure on return.</param>
- <returns>The return value is zero if the operation was successful. Otherwise, the value SOCKET_ERROR is returned,
- and a specific error number can be retrieved by calling WSAGetLastError.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.NativeMethods2.WSALookupServiceEnd(System.IntPtr)">
- <summary>
- The WSALookupServiceEnd function is called to free the handle after previous calls to WSALookupServiceBegin and WSALookupServiceNext.
- If you call WSALookupServiceEnd from another thread while an existing WSALookupServiceNext is blocked, the end call will have the same effect as a cancel and will cause the WSALookupServiceNext call to return immediately.
- </summary>
- <param name="hLookup">Handle previously obtained by calling WSALookupServiceBegin.</param>
- <returns>The return value is zero if the operation was successful. Otherwise, the value SOCKET_ERROR is returned,
- and a specific error number can be retrieved by calling WSAGetLastError.</returns>
- </member>
- <member name="T:DotSpatial.Positioning.NativeMethods2.Blob">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.Blob.Size">
- <summary>
- Size of the block of data pointed to by pBlobData, in bytes. cbSize.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.Blob.Info">
- <summary>
- Pointer to a block of data. pInfo.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.NativeMethods2.BthDeviceInfo">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.BthDeviceInfo.Flags">
- <summary>
- Flags
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.BthDeviceInfo.AddressCode">
- <summary>
- The blue tooth address.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.BthDeviceInfo.ClassOfDevice">
- <summary>
- The unsigned integer representing the class of the device.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.BthDeviceInfo.NameBinary">
- <summary>
- The binary representation of the name.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.NativeMethods2.BthDeviceInfo.ToDevice">
- <summary>
- Converts the object into a BluetoothDevice object.
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Positioning.NativeMethods2.BthDeviceInfo.Address">
- <summary>
- Returns the address of the device.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.NativeMethods2.BthDeviceInfo.Name">
- <summary>
- Returns the friendly nameof the device.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.NativeMethods2.BluetoothDeviceFlags">
- <summary>
- Bluetooth device status states that can be combined.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.BluetoothDeviceFlags.AddressIsPresent">
- <summary>
- The bluetooth address is present.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.BluetoothDeviceFlags.ClassOfDeviceIsPresent">
- <summary>
- The class of the device is present.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.BluetoothDeviceFlags.NameIsPresent">
- <summary>
- The name of the device is present.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.BluetoothDeviceFlags.Paired">
- <summary>
- Whether or not the device is paired.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.BluetoothDeviceFlags.Remembered">
- <summary>
- The bluetooth device is remembered.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.BluetoothDeviceFlags.Connected">
- <summary>
- The bluetooth device is connected.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.NativeMethods2.BluetoothFindRadioParams">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.BluetoothFindRadioParams.ByteSize">
- <summary>
- Size of the BLUETOOTH_FIND_RADIO_PARAMS structure, in bytes. dwSize.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.NativeMethods2.BluetoothDeviceInfo">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.BluetoothDeviceInfo.ByteSize">
- <summary>
- Size of the BluetoothDeviceInfo structure, in bytes. dwSize.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.BluetoothDeviceInfo.Address">
- <summary>
- Address of the device.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.BluetoothDeviceInfo.DeviceClass">
- <summary>
- Class of the device. ulClassofDevice.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.BluetoothDeviceInfo.Connected">
- <summary>
- Specifies whether the device is connected. fConnected.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.BluetoothDeviceInfo.Remembered">
- <summary>
- Specifies whether the device is a remembered device. Not all remembered devices are authenticated. fRemembered.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.BluetoothDeviceInfo.Authenticated">
- <summary>
- Specifies whether the device is authenticated, paired, or bonded. All authenticated devices are remembered. fAuthenticated.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.BluetoothDeviceInfo.LastSeen">
- <summary>
- Last time the device was seen, in the form of a SYSTEMTIME structure. stLastSeen.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.BluetoothDeviceInfo.LastUsed">
- <summary>
- Last time the device was used, in the form of a SYSTEMTIME structure. stLastUsed.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.BluetoothDeviceInfo.Name">
- <summary>
- Name of the device. szName.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.NativeMethods2.BluetoothDeviceInfo.#ctor(System.Int64)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.NativeMethods2.BluetoothDeviceInfo"/> struct.
- </summary>
- <param name="address">The address.</param>
- </member>
- <member name="T:DotSpatial.Positioning.NativeMethods2.BluetoothRadioInfo">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.BluetoothRadioInfo.ByteSize">
- <summary>
- Size, in bytes, of the structure. dwSize.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.BluetoothRadioInfo.Address">
- <summary>
- Address of the local Bluetooth radio.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.BluetoothRadioInfo.Name">
- <summary>
- Name of the local Bluetooth radio. szName.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.BluetoothRadioInfo.DeviceClass">
- <summary>
- Device class for the local Bluetooth radio. ClassofDevice.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.BluetoothRadioInfo.Subversion">
- <summary>
- This member contains data specific to individual Bluetooth device manufacturers. lmpSubversion.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.BluetoothRadioInfo.Manufacturer">
- <summary>
- Manufacturer of the Bluetooth radio, expressed as a BTH_MFG_Xxx value. For more
- information about the Bluetooth assigned numbers document and a current list of values,
- see the Bluetooth specification at www.bluetooth.com.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.NativeMethods2.BthQueryDevice">
- <summary>
- The BTH_QUERY_DEVICE structure is used when querying for the presence of a Bluetooth device.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.BthQueryDevice.LAP">
- <summary>
- Reserved. Must be set to zero.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.BthQueryDevice.Length">
- <summary>
- Requested length of the inquiry, in seconds.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.NativeMethods2.BthQueryDevice.#ctor">
- <summary>
- Initializes a new instance of the BthQueryDevice structure.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.NativeMethods2.SystemTime">
- <summary>
- Specifies a date and time, using individual members for the month, day, year, weekday, hour, minute, second,
- and millisecond. The time is either in coordinated universal time (UTC) or local time, depending on the
- function that is being called.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.SystemTime.Year">
- <summary>
- The year. The valid values for this member are 1601 through 30827. wYear.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.SystemTime.Month">
- <summary>
- The month. (January = 1).
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.SystemTime.DayOfWeek">
- <summary>
- The day of the week. (Sunday = 0)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.SystemTime.Day">
- <summary>
- The day of the month. The valid values for this member are 1 through 31.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.SystemTime.Hour">
- <summary>
- The hour. The valid values for this member are 0 through 23.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.SystemTime.Minute">
- <summary>
- The minute. The valid values for this member are 0 through 59.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.SystemTime.Second">
- <summary>
- The second. The valid values for this member are 0 through 59.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.SystemTime.Milliseconds">
- <summary>
- The millisecond. The valid values for this member are 0 through 999.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.NativeMethods2.SystemTime.ToDateTime">
- <summary>
- Creates a .Net DateTime structure from the SystemTime structure.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.NativeMethods2.SystemTime.FromDateTime(System.DateTime)">
- <summary>
- Creates a SystemTime structure based on the specified DateTime structure.
- </summary>
- <param name="value">The DateTime value to set.</param>
- <returns>The SystemTime equivalent to the specified value.</returns>
- </member>
- <member name="T:DotSpatial.Positioning.NativeMethods2.WsaData">
- <summary>
- The WSADATA structure contains information about the Windows Sockets implementation.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.WsaData.Version">
- <summary>
- The version of the Windows Sockets specification that the Ws2_32.dll expects the caller to use.
- The high-order byte specifies the minor version number; the low-order byte specifies the major version number.
- wVersion.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.WsaData.HighVersion">
- <summary>
- The highest version of the Windows Sockets specification that the Ws2_32.dll can support. The high-order byte
- specifies the minor version number; the low-order byte specifies the major version number.
- This is the same value as the wVersion member when the version requested in the wVersionRequested parameter
- passed to the WSAStartup function is the highest version of the Windows Sockets specification that the Ws2_32.dll
- can support. wHighVersion.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.WsaData.Description">
- <summary>
- A NULL-terminated ASCII string into which the Ws2_32.dll copies a description of the Windows Sockets implementation.
- The text (up to 256 characters in length) can contain any characters except control and formatting characters.
- The most likely use that an application would have for this member is to display it (possibly truncated) in a status
- message. szDescription.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.WsaData.SystemStatus">
- <summary>
- A NULL-terminated ASCII string into which the Ws2_32.dll copies relevant status or configuration information.
- The Ws2_32.dll should use this parameter only if the information might be useful to the user or support staff.
- This member should not be considered as an extension of the szDescription parameter. szSystemStatus.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.WsaData.MaxSockets">
- <summary>
- The maximum number of sockets that may be opened. This member should be ignored for Windows Sockets version 2 and later.
- The iMaxSockets member is retained for compatibility with Windows Sockets specification 1.1, but should not be used when
- developing new applications. No single value can be appropriate for all underlying service providers. The architecture
- of Windows Sockets changed in version 2 to support multiple providers, and the WSADATA structure no longer applies to
- a single vendor's stack. iMaxSockets.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.WsaData.MaximumMessageSize">
- <summary>
- The maximum datagram message size. This member is ignored for Windows Sockets version 2 and later. iMaxUdpDg.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.WsaData.VendorInfo">
- <summary>
- A pointer to vendor-specific information. This member should be ignored for Windows Sockets version 2 and later.
- lpVendorInfo
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.NativeMethods2.WasLookupControlOptions">
- <summary>
- WAS Lookup Control Options
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.WasLookupControlOptions.None">
- <summary>
- None of the return options are active.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.WasLookupControlOptions.Containers">
- <summary>
- Returns containers only. LUP_CONTAINERS.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.WasLookupControlOptions.ReturnName">
- <summary>
- Retrieves the name as lpszServiceInstanceName. LUP_RETURN_NAME.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.WasLookupControlOptions.ReturnType">
- <summary>
- Retrieves the type as lpServiceClassId. LUP_RETURN_TYPE.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.WasLookupControlOptions.ReturnVersion">
- <summary>
- Retrieves the version as lpVersion. LUP_RETURN_VERSION.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.WasLookupControlOptions.ReturnComment">
- <summary>
- Retrieves the comment as lpszComment. LUP_RETURN_COMMENT.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.WasLookupControlOptions.ReturnAddresses">
- <summary>
- Retrieves the addresses as lpcsaBuffer. LUP_RETURN_ADDR.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.WasLookupControlOptions.ReturnBlob">
- <summary>
- Retrieves the private data as lpBlob. LUP_RETURN_BLOB.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.WasLookupControlOptions.FlushCache">
- <summary>
- If the provider has been caching information, ignores the cache, and queries the namespace itself. LUP_FLUSHCACHE.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.WasLookupControlOptions.ResService">
- <summary>
- This indicates whether prime response is in the remote or local part of CSADDR_INFO structure.
- The other part needs to be usable in either case. LUP_RES_SERVICE.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.NativeMethods2.WsaQuerySet">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.WsaQuerySet.ByteSize">
- <summary>
- Must be set to sizeof(WSAQUERYSET) in bytes. This is a versioning mechanism. dwSize.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.WsaQuerySet.ServiceInstanceName">
- <summary>
- (Optional) Referenced string contains service name. The semantics for using wildcards
- within the string are not defined, but can be supported by certain name space providers.
- lpszServiceInstanceName.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.WsaQuerySet.ServiceClassId">
- <summary>
- (Required) The GUID corresponding to the service class.
- lpServiceClassId.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.WsaQuerySet.Version">
- <summary>
- (Optional) References desired version number and provides version comparison semantics
- (that is, version must match exactly, or version must be not less than the value supplied).
- lpVersion.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.WsaQuerySet.Comment">
- <summary>
- Ignored for queries. lpszComment.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.WsaQuerySet.NameSpace">
- <summary>
- Identifier of a single name space in which to constrain the search, or NS_ALL to include
- all name spaces. dwNameSpace.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.WsaQuerySet.ProviderId">
- <summary>
- (Optional) References the GUID of a specific name-space provider, and limits the query to
- this provider only. lpNSProviderId.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.WsaQuerySet.Context">
- <summary>
- (Optional) Specifies the starting point of the query in a hierarchical name space.
- lpszContext.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.WsaQuerySet.NumberOfProtocols">
- <summary>
- Size of the protocol constraint array, can be zero. dwNumberOfProtocols.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.WsaQuerySet.Protocols">
- <summary>
- (Optional) References an array of AFPROTOCOLS structure. Only services that utilize
- these protocols will be returned. lpafpProtocols.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.WsaQuerySet.QueryString">
- <summary>
- (Optional)Some name spaces (such as Whois++) support enriched SQL-like queries that are
- contained in a simple text string. This parameter is used to specify that string.
- lpszQueryString.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.WsaQuerySet.NumberOfCsAddrs">
- <summary>
- Ignored for queries. dwNumberOfCsAddrs
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.WsaQuerySet.Buffer">
- <summary>
- Ignored for queries. lpcsaBuffer.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.WsaQuerySet.OutputFlags">
- <summary>
- Ignored for queries. dwOutputFlags.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.WsaQuerySet.EntityBlob">
- <summary>
- (Optional)This is a pointer to a provider-specific entity. lbBlob.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.NativeMethods2.WsaQuerySet.#ctor">
- <summary>
- Instantiates a new instance of the Wsaqueryset Class.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.NativeMethods2.SpDevinfoData">
- <summary>
- An SP_DEVINFO_DATA structure defines a device instance that is a member of a device information set.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.SpDevinfoData.Size">
- <summary>
- The size, in bytes, of the SP_DEVINFO_DATA structure. For more information, see the
- following Remarks section. cbSize.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.SpDevinfoData.ClassGuid">
- <summary>
- The GUID of the device's setup class.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.SpDevinfoData.DeviceInstance">
- <summary>
- An opaque handle to the device instance (also known as a handle to the devnode).
- Some functions, such as SetupDiXxx functions, take the whole SP_DEVINFO_DATA structure
- as input to identify a device in a device information set. Other functions, such as
- CM_Xxx functions like CM_Get_DevNode_Status, take this DevInst handle as input.
- DevInst.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.SpDevinfoData.Reserved">
- <summary>
- Reserved. For internal use only.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.NativeMethods2.SpDeviceInterfaceData">
- <summary>
- An SP_DEVICE_INTERFACE_DATA structure defines a device interface in a device information set.
- </summary>
- <remarks>A SetupAPI function that takes an instance of the SP_DEVICE_INTERFACE_DATA structure as a parameter
- verifies whether the cbSize member of the supplied structure is equal to the size, in bytes, of the
- structure. If the cbSize member is not set correctly, the function will fail and set an error code
- of ERROR_INVALID_USER_BUFFER.</remarks>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.SpDeviceInterfaceData.Size">
- <summary>
- The size, in bytes, of the SP_DEVICE_INTERFACE_DATA structure. For more information,
- see the Remarks section. cbSize.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.SpDeviceInterfaceData.InterfaceClassGuid">
- <summary>
- The GUID for the class to which the device interface belongs.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.SpDeviceInterfaceData.Flags">
- <summary>
- Can be one or more of the following:
- SPINT_ACTIVE - The interface is active (enabled).
- SPINT_DEFAULT - The interface is the default interface for the device class.
- SPINT_REMOVED - The interface is removed.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.SpDeviceInterfaceData.Reserved">
- <summary>
- Reserved. Do not use.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.NativeMethods2.SpDeviceInterfaceDetailData">
- <summary>
- An SP_DEVICE_INTERFACE_DETAIL_DATA structure contains the path for a device interface.
- </summary>
- <remarks>An SP_DEVICE_INTERFACE_DETAIL_DATA structure identifies the path for a device interface in a
- device information set. SetupDiXxx functions that take an SP_DEVICE_INTERFACE_DETAIL_DATA
- structure as a parameter verify that the cbSize member of the supplied structure is equal
- to the size, in bytes, of the structure. If the cbSize member is not set correctly for an
- input parameter, the function will fail and set an error code of ERROR_INVALID_PARAMETER.
- If the cbSize member is not set correctly for an output parameter, the function will fail
- and set an error code of ERROR_INVALID_USER_BUFFER.</remarks>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.SpDeviceInterfaceDetailData.ByteSize">
- <summary>
- The size, in bytes, of the SP_DEVICE_INTERFACE_DETAIL_DATA structure.
- For more information, see the following Remarks section. cbSize.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NativeMethods2.SpDeviceInterfaceDetailData.DevicePath">
- <summary>
- A NULL-terminated string that contains the device interface path. This path can be passed to Win32 functions such as CreateFile.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.NmeaEmulator">
- <summary>
- Emultor for MNEA devices
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NmeaEmulator._gpggaLastSent">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NmeaEmulator._gpgsaLastSent">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NmeaEmulator._gpgllLastSent">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NmeaEmulator._gpgsvLastSent">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NmeaEmulator._gprmcLastSent">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NmeaEmulator._gpggaInterval">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NmeaEmulator._gpgsaInterval">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NmeaEmulator._gpgllInterval">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NmeaEmulator._gpgsvInterval">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NmeaEmulator._gprmcInterval">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NmeaEmulator._horizontalDOP">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NmeaEmulator._verticalDOP">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NmeaEmulator._meanDOP">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NmeaEmulator._fixMode">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NmeaEmulator._fixStatus">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NmeaEmulator._fixMethod">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NmeaEmulator._fixQuality">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NmeaEmulator._magneticVariation">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NmeaEmulator._minHdop">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NmeaEmulator._maxHdop">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NmeaEmulator._minVdop">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NmeaEmulator._maxVdop">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaEmulator.#ctor">
- <summary>
- Creates a generic NMEA-0183 Emulator
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaEmulator.#ctor(System.String)">
- <summary>
- Creates a generic NMEA-0183 Emulator from the specified string name
- </summary>
- <param name="name">The name.</param>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaEmulator.Randomize">
- <summary>
- Randomizes the emulation by changing speed and direction
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaEmulator.Randomize(DotSpatial.Positioning.DilutionOfPrecision,DotSpatial.Positioning.DilutionOfPrecision)">
- <summary>
- Randomize
- </summary>
- <param name="maxHDOP">The max HDOP.</param>
- <param name="maxVDOP">The max VDOP.</param>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaEmulator.Randomize(DotSpatial.Positioning.DilutionOfPrecision,DotSpatial.Positioning.DilutionOfPrecision,DotSpatial.Positioning.DilutionOfPrecision,DotSpatial.Positioning.DilutionOfPrecision)">
- <summary>
- Randomize
- </summary>
- <param name="minHDOP">The min HDOP.</param>
- <param name="maxHDOP">The max HDOP.</param>
- <param name="minVDOP">The min VDOP.</param>
- <param name="maxVDOP">The max VDOP.</param>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaEmulator.Randomize(System.Random,DotSpatial.Positioning.Speed,DotSpatial.Positioning.Speed,DotSpatial.Positioning.Azimuth,DotSpatial.Positioning.Azimuth,DotSpatial.Positioning.DilutionOfPrecision,DotSpatial.Positioning.DilutionOfPrecision,DotSpatial.Positioning.DilutionOfPrecision,DotSpatial.Positioning.DilutionOfPrecision)">
- <summary>
- Randomize
- </summary>
- <param name="seed">The seed.</param>
- <param name="speedLow">The speed low.</param>
- <param name="speedHigh">The speed high.</param>
- <param name="bearingStart">The bearing start.</param>
- <param name="bearingArc">The bearing arc.</param>
- <param name="minHDOP">The min HDOP.</param>
- <param name="maxHDOP">The max HDOP.</param>
- <param name="minVDOP">The min VDOP.</param>
- <param name="maxVDOP">The max VDOP.</param>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaEmulator.OnEmulation">
- <summary>
- Generates actual data to send to the client.
- </summary>
- <remarks>Data is sent according to the behavior of a typical GPS device: $GPGGA,
- $GPGSA, $GPRMC, $GPGSV sentences are sent every second, and a $GPGSV sentence
- is sent every five seconds.
- Developers who want to emulate a specific model of GPS device should override this
- method and generate the sentences specific to that device.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaEmulator.EmulatePositionError(DotSpatial.Positioning.Position)">
- <summary>
- Emulates the position error.
- </summary>
- <param name="truth">The truth.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaEmulator.EmulateError(DotSpatial.Positioning.DilutionOfPrecision)">
- <summary>
- Emulates the error.
- </summary>
- <param name="dop">The dop.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaEmulator.WriteSentenceToClient(DotSpatial.Positioning.NmeaSentence)">
- <summary>
- Writes the sentence to client.
- </summary>
- <param name="sentence">The sentence.</param>
- </member>
- <member name="P:DotSpatial.Positioning.NmeaEmulator.Interval">
- <summary>
- Sets the update intervals for the NMEA Emulator's sentence generation.
- </summary>
- <value>The interval.</value>
- </member>
- <member name="P:DotSpatial.Positioning.NmeaEmulator.HorizontalDilutiuonOfPrecision">
- <summary>
- Horizontal dilution of precision
- </summary>
- <value>The horizontal dilutiuon of precision.</value>
- </member>
- <member name="P:DotSpatial.Positioning.NmeaEmulator.VerticalDilutiuonOfPrecision">
- <summary>
- Vertical dilution of precision
- </summary>
- <value>The vertical dilutiuon of precision.</value>
- </member>
- <member name="P:DotSpatial.Positioning.NmeaEmulator.MeanDilutiuonOfPrecision">
- <summary>
- Mean Dilution of Precision
- </summary>
- <value>The mean dilutiuon of precision.</value>
- </member>
- <member name="P:DotSpatial.Positioning.NmeaEmulator.EmulatedFixMode">
- <summary>
- Emulated Fix Mode
- </summary>
- <value>The emulated fix mode.</value>
- </member>
- <member name="P:DotSpatial.Positioning.NmeaEmulator.EmulatedFixStatus">
- <summary>
- Emulated Fix Status
- </summary>
- <value>The emulated fix status.</value>
- </member>
- <member name="P:DotSpatial.Positioning.NmeaEmulator.EmulatedFixMethod">
- <summary>
- Emulated Fix Method
- </summary>
- <value>The emulated fix method.</value>
- </member>
- <member name="P:DotSpatial.Positioning.NmeaEmulator.EmulatedFixQuality">
- <summary>
- Emulated Fix Quality
- </summary>
- <value>The emulated fix quality.</value>
- </member>
- <member name="P:DotSpatial.Positioning.NmeaEmulator.MagneticVariation">
- <summary>
- Magnetic Variation
- </summary>
- <value>The magnetic variation.</value>
- </member>
- <member name="T:DotSpatial.Positioning.NmeaInterpreter">
- <summary>
- Represents an interpreter for GPS data from the National Marine Electronics Association (NMEA).
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NmeaInterpreter._stream">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NmeaInterpreter.DataChangeSyncRoot">
- <summary>
- Represents a synchronization object used to prevent changes to GPS data when reading multiple GPS values.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaInterpreter.#ctor">
- <summary>
- Creates an interpreter to read NMEA streams
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaInterpreter.OnSentenceRecorded(DotSpatial.Positioning.NmeaSentence)">
- <summary>
- Called when [sentence recorded].
- </summary>
- <param name="sentence">The sentence.</param>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaInterpreter.Parse(DotSpatial.Positioning.NmeaSentence)">
- <summary>
- Translates the NmeaSentence
- </summary>
- <param name="sentence">The NMeaSentence to parse</param>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaInterpreter.OnDeviceChanged">
- <summary>
- Occurs when the interpreter is using a different device for raw data.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaInterpreter.OnReadPacket">
- <summary>
- Occurs when new data should be read from the underlying device.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaInterpreter.OnStopped">
- <summary>
- Occurs immediately after the interpreter has been shut down.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.NmeaInterpreter.SentenceRecorded">
- <summary>
- Occurs when a packet of data has been recorded to the recording stream.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.NmeaReader">
- <summary>
- Represents a reader which deserializes raw data into NMEA sentences.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NmeaReader.IDEAL_NMEA_BUFFER_SIZE">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NmeaReader._stream">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NmeaReader._reader">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaReader.#ctor(System.IO.Stream)">
- <summary>
- Creates a new instance using the specified stream.
- </summary>
- <param name="stream">The stream.</param>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaReader.IsNmea(System.IO.Stream)">
- <summary>
- Returns whether the specified stream contains valid NMEA data.
- </summary>
- <param name="stream">An open <strong>Stream</strong> object which supports read operations.</param>
- <returns>A <strong>Boolean</strong> value, <strong>True</strong> if valid NMEA data has been read from the stream.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaReader.ReadSentence">
- <summary>
- Reads the next available sentence, valid or invalid, from the underlying stream.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaReader.ReadValidSentence">
- <summary>
- Reads a well-formed NMEA sentence (with a valid checksum) from the underlying stream.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaReader.ReadTypedSentence">
- <summary>
- Reads a single NMEA sentence then attempts to convert it into an object-oriented form.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaReader.ReadPosition">
- <summary>
- Reads the current latitude and longitude from the next available sentence.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaReader.ReadUtcDateTime">
- <summary>
- Reads the UTC date and time from the next available sentence.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaReader.ReadDateTime">
- <summary>
- Returns the current date and time from the next available sentence.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaReader.ReadSpeed">
- <summary>
- Returns the current rate of travel from the next available sentence.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaReader.ReadBearing">
- <summary>
- Reads the Bearing direction
- </summary>
- <returns>The direction as an azimuth angle</returns>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaReader.ReadHeading">
- <summary>
- Reads the Heading direction
- </summary>
- <returns>The direction as an azimuth angle</returns>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaReader.ReadFixQuality">
- <summary>
- Reads the current type of fix acquired from the next available sentence.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaReader.ReadAltitude">
- <summary>
- Reads the current distance above sea level from the next available sentence.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaReader.ReadHorizontalDilutionOfPrecision">
- <summary>
- Reads the current precision as it relates to latitude and longitude from the next available sentence.
- </summary>
- <returns></returns>
- </member>
- <member name="E:DotSpatial.Positioning.NmeaReader.ResolveSentence">
- <summary>
- Occurs when an unknown sentence type is encountered.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.NmeaSentenceResolverEventArgs">
- <summary>
- Represents information about an unknown NMEA sentence which has been encountered.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NmeaSentenceResolverEventArgs._sentence">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.NmeaSentenceResolverEventArgs._result">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaSentenceResolverEventArgs.#ctor(DotSpatial.Positioning.NmeaSentence)">
- <summary>
- Creates a new instance of the Nmea Sentence Resolver Event arguments class
- </summary>
- <param name="sentence">The sentence.</param>
- </member>
- <member name="P:DotSpatial.Positioning.NmeaSentenceResolverEventArgs.Sentence">
- <summary>
- Returns the NMEA sentence which needs to be resolved.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.NmeaSentenceResolverEventArgs.Result">
- <summary>
- Controls a more-strongly-typed NMEA sentence if resolution is successful.
- </summary>
- <value>The result.</value>
- </member>
- <member name="T:DotSpatial.Positioning.NmeaSentenceEventArgs">
- <summary>
- Represents information about raw data received from a GPS device.
- </summary>
- <remarks>This object is used primarily by the SentenceReceived
- and UnrecognizedSentenceReceived events of
- the Receiver class to provide notification when raw data has been received
- from the GPS device.</remarks>
- <example>This example demonstrates how to use this class when raising an event.
- <code lang="VB">
- ' Declare a new event
- Dim MySentenceEvent As SentenceEventHandler
- ' Create an NMEA $GPGLL sentence
- Dim MySentence As String = "$GPGLL, 4122, N, 14628, W, 104243.00, A, D*7E"
-
- Sub Main()
- ' Raise our custom event, also indicating that the sentence was completely recognized
- RaiseEvent MySentenceEvent(Me, New SentenceEventArgs(MySentence, SentenceType.Recognized))
- End Sub
- </code>
- <code lang="C#">
- // Declare a new event
- SentenceEventHandler MySentenceEvent;
- // Create an NMEA $GPGLL sentence
- string MySentence = "$GPGLL, 4122, N, 14628, W, 104243.00, A, D*7E"
-
- void Main()
- {
- // Raise our custom event, also indicating that the sentence was completely recognized
- MySentenceEvent(this, New SentenceEventArgs(MySentence, SentenceType.Recognized));
- }
- </code>
- </example>
- </member>
- <member name="M:DotSpatial.Positioning.NmeaSentenceEventArgs.#ctor(DotSpatial.Positioning.NmeaSentence)">
- <summary>
- Creates a new instance with the specified block of raw GPS data and a flag indicating if the sentence was fully parsed.
- </summary>
- <param name="sentence">A <strong>String</strong> containing raw GPS data.</param>
- <seealso cref="T:System.Type">Type Property</seealso>
- <seealso cref="P:DotSpatial.Positioning.NmeaSentenceEventArgs.Sentence">Sentence Property</seealso>
- </member>
- <member name="P:DotSpatial.Positioning.NmeaSentenceEventArgs.Sentence">
- <summary>
- Stores one line of raw GPS data.
- </summary>
- <value>A String containing one line of raw NMEA or Garmin® text data.</value>
- <remarks>When using the NMEA-0183 or Garmin® text protocols, this property stores text for one individual line. For the Garmin® binary protocol, a signature such as "(Garmin waypoint data)" is stored instead of actual binary data.</remarks>
- <seealso cref="T:System.Type">Type Property</seealso>
- </member>
- <member name="T:DotSpatial.Positioning.PgrmfSentence">
- <summary>
- Represents a Garmin $PGRMF sentence.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.PgrmfSentence.#ctor(System.String,System.String,System.String[],System.String)">
- <summary>
- Creates a Garmin $PGRMF sentence from the specified parameters
- </summary>
- <param name="sentence">The sentence.</param>
- <param name="commandWord">The command word.</param>
- <param name="words">The words.</param>
- <param name="validChecksum">The valid checksum.</param>
- </member>
- <member name="M:DotSpatial.Positioning.PgrmfSentence.#ctor(System.String)">
- <summary>
- Creates a Garmin $PGRMF sentence from the specified string
- </summary>
- <param name="sentence">The sentence.</param>
- </member>
- <member name="M:DotSpatial.Positioning.PgrmfSentence.SetPropertiesFromSentence">
- <summary>
- OnSentanceChanged event handler
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.PgrmfSentence.UtcDateTime">
- <summary>
- Represents an NMEA sentence which contains date and time in UTC.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.PgrmfSentence.Position">
- <summary>
- Represents an NMEA sentence which contains a position.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.PgrmfSentence.FixMode">
- <summary>
- Gets the fix mode
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.PgrmfSentence.FixMethod">
- <summary>
- The Fix Method.
- </summary>
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Positioning.PgrmfSentence.Speed">
- <summary>
- The Speed
- </summary>
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Positioning.PgrmfSentence.Bearing">
- <summary>
- the Bearing
- </summary>
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Positioning.PgrmfSentence.PositionDilutionOfPrecision">
- <summary>
- The Position Dilution of Precision (PDOP)
- </summary>
- <inheritdocs/>
- </member>
- <member name="T:DotSpatial.Positioning.PositionAverageFilter">
- <summary>
- Position averaging filter
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.PositionAverageFilter._samples">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.PositionAverageFilter._sampleTimes">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.PositionAverageFilter._filteredPositon">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.PositionAverageFilter._sampleCount">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.PositionAverageFilter.#ctor">
- <summary>
- Creates an uninitialized filter with a sample count of 4
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.PositionAverageFilter.#ctor(System.Int32)">
- <summary>
- Creates an uninitialized filter with a sample count.
- </summary>
- <param name="sampleCount">The sample count.</param>
- </member>
- <member name="M:DotSpatial.Positioning.PositionAverageFilter.#ctor(DotSpatial.Positioning.Position[])">
- <summary>
- Creates an initialized filter.
- </summary>
- <param name="positions">The positions.</param>
- <remarks>The sample count equals the number of positions passed in the positions argument.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.PositionAverageFilter.#ctor(System.Collections.Generic.IList{DotSpatial.Positioning.Position},System.Int32)">
- <summary>
- Creates an initialzed filter
- </summary>
- <param name="positions">The positions.</param>
- <param name="sampleCount">The sample count.</param>
- <remarks>If the number of positions supllied in the positions parameter and the sample
- count parameter are not equal, the filter is uninitialized.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.PositionAverageFilter.Filter">
- <summary>
- Filters this instance.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.PositionAverageFilter.Initialize(System.Collections.Generic.IList{DotSpatial.Positioning.Position})">
- <summary>
- Initializes the filter
- </summary>
- <param name="positions">The initial sample positions.</param>
- <remarks>This method updates the SampleCount property to the number of
- initialization positions providedand updates the FilteredLocation
- property.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.PositionAverageFilter.Initialize(System.Collections.Generic.IList{DotSpatial.Positioning.Position3D})">
- <summary>
- Initializes the filter
- </summary>
- <param name="positions">The initial sample positions.</param>
- <remarks>This method updates the SampleCount property to the number of
- initialization positions provided and updates the FilteredLocation
- property.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.PositionAverageFilter.Initialize(DotSpatial.Positioning.Position)">
- <summary>
- Adds an initialization position.
- </summary>
- <param name="gpsPosition">The initialization position to add.</param>
- <remarks>This method does not update the SampleCount or the FilteredLocation
- properties.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.PositionAverageFilter.Initialize(DotSpatial.Positioning.Position3D)">
- <summary>
- Adds an initialization position.
- </summary>
- <param name="gpsPosition">The initialization position to add.</param>
- <remarks>This method does not update the SampleCount or the FilteredLocation
- properties.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.PositionAverageFilter.Filter(DotSpatial.Positioning.Position)">
- <summary>
- Adds a new observation and applies the filter.
- </summary>
- <param name="gpsPosition">The new observation to add to the filter.</param>
- <returns>The filtered position.</returns>
- <remarks>This method updates the FilteredLocation property without consideration for SampleCount.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.PositionAverageFilter.Filter(DotSpatial.Positioning.Position,DotSpatial.Positioning.Distance,DotSpatial.Positioning.DilutionOfPrecision,DotSpatial.Positioning.DilutionOfPrecision,DotSpatial.Positioning.Azimuth,DotSpatial.Positioning.Speed)">
- <summary>
- Adds a new observation and applies the filter.
- </summary>
- <param name="gpsPosition">The new observation to add to the filter.</param>
- <param name="deviceError">A DeviceError, which does not currently affect position averaging.</param>
- <param name="horizontalDOP">A horizontal dilution of position, which does not currently affect position averaging.</param>
- <param name="verticalDOP">A vertical dilution of positoin which does not currently affect position averaging.</param>
- <param name="bearing">A directional bearing, which does not currently affect position averaging.</param>
- <param name="speed">A speed, which does not currently affect position averaging.</param>
- <returns></returns>
- <remarks>This method updates the FilteredLocation property without consideration for SampleCount.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.PositionAverageFilter.Filter(DotSpatial.Positioning.Position3D)">
- <summary>
- Adds a new observation and applies the filter.
- </summary>
- <param name="gpsPosition">The new observation to add to the filter.</param>
- <returns>The filtered position.</returns>
- <remarks>This method updates the FilteredLocation property without consideration for SampleCount.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.PositionAverageFilter.Filter(DotSpatial.Positioning.Position3D,DotSpatial.Positioning.Distance,DotSpatial.Positioning.DilutionOfPrecision,DotSpatial.Positioning.DilutionOfPrecision,DotSpatial.Positioning.Azimuth,DotSpatial.Positioning.Speed)">
- <summary>
- Adds a new observation and applies the filter.
- </summary>
- <param name="gpsPosition">The new observation to add to the filter.</param>
- <param name="deviceError">A DeviceError, which does not currently affect position averaging.</param>
- <param name="horizontalDOP">A horizontal dilution of position, which does not currently affect position averaging.</param>
- <param name="verticalDOP">A vertical dilution of positoin which does not currently affect position averaging.</param>
- <param name="bearing">A directional bearing, which does not currently affect position averaging.</param>
- <param name="speed">A speed, which does not currently affect position averaging.</param>
- <returns></returns>
- <remarks>This method updates the FilteredLocation property without consideration for SampleCount.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.PositionAverageFilter.SampleCount">
- <summary>
- Gets the number of samples required for a valid fintered value.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.PositionAverageFilter.ObservedLocations">
- <summary>
- Gets a list of the current observed locations
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.PositionAverageFilter.ObservedLocation">
- <summary>
- Not implemented in the PrositionAverage filter. Use ObservedLocations to get a list
- of observed locations.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.PositionAverageFilter.FilteredLocation">
- <summary>
- Gets the filtered location
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.PositionAverageFilter.IsInitialized">
- <summary>
- Gets a value indicating the state of the filter.
- </summary>
- <remarks>The filter is considered initialized and thus reporting valid filtered
- locations, when the SampleCount property equals the number of values returned
- by the ObservedLocations property.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.PositionAverageFilter.Delay">
- <summary>
- Gets the time elapsed from the oldest to the most resent position sample.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.PositioningStrings">
- <summary>
- A strongly-typed resource class, for looking up localized strings, etc.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.PositioningStrings.ResourceManager">
- <summary>
- Returns the cached ResourceManager instance used by this class.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.PositioningStrings.Culture">
- <summary>
- Overrides the current thread's CurrentUICulture property for all
- resource lookups using this strongly typed resource class.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.RouteFileEmulator">
- <summary>
- This emulator follows a custom route defined in a text file.
- </summary>
- <remarks><para>
- This emulator is similar to the <see cref="T:DotSpatial.Positioning.TextFileEmulator"/>, except that it does not require real
- GPS data. Instead, it expects a text file that contains a <see cref="T:DotSpatial.Positioning.Position"/> value on each line
- (e.g. HH°MM'SS.SSSS, HH°MM'SS.SSSS).
- </para>
- <para>
- The <see cref="T:DotSpatial.Positioning.RouteFileEmulator"/> will move one point further along its route at each
- <see cref="P:DotSpatial.Positioning.Emulator.Interval"/> period, so the <see cref="P:DotSpatial.Positioning.Emulator.Speed"/> will automatically adjust
- as needed to move the required distance each time.
- </para></remarks>
- </member>
- <member name="F:DotSpatial.Positioning.RouteFileEmulator._myInterval">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.RouteFileEmulator.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.RouteFileEmulator"/> class that reads
- its route from the specified file.
- </summary>
- <param name="filePath">The file path.</param>
- </member>
- <member name="M:DotSpatial.Positioning.RouteFileEmulator.#ctor(System.String,System.Boolean)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.RouteFileEmulator"/> class that reads
- its route from the specified file in the specified direction.
- </summary>
- <param name="filePath">The file path.</param>
- <param name="reverse">if set to <c>true</c> [reverse].</param>
- </member>
- <member name="M:DotSpatial.Positioning.RouteFileEmulator.#ctor(System.String,System.Boolean,System.TimeSpan)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.RouteFileEmulator"/> class that reads
- its route from the specified file in the specified direction at the specified interval.
- </summary>
- <param name="filePath">The file path.</param>
- <param name="reverse">if set to <c>true</c> [reverse].</param>
- <param name="interval">The interval.</param>
- </member>
- <member name="M:DotSpatial.Positioning.RouteFileEmulator.OnEmulation">
- <summary>
- Moves to the next point in the route, and calls the base <see cref="T:DotSpatial.Positioning.NmeaEmulator"/>
- implementation to generate the appropriate NMEA sentences.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.RouteFileEmulator.ReadRoute(System.String,System.Boolean)">
- <summary>
- Reads the route file and populates the <see cref="P:DotSpatial.Positioning.Emulator.Route"/> property.
- </summary>
- <param name="filePath">The absolute or relative path of the file containing the route.</param>
- <param name="reverse">If <see langword="true"/>, the route file will be read in reverse order. That is, the last
- <see cref="T:DotSpatial.Positioning.Position"/> in the file will be the starting point of the route.</param>
- </member>
- <member name="P:DotSpatial.Positioning.RouteFileEmulator.Interval">
- <summary>
- Returns the amount of time the emulator waits before processing new data.
- </summary>
- <value>The interval.</value>
- </member>
- <member name="T:DotSpatial.Positioning.Satellite">
- <summary>
- Represents information about a GPS satellite in orbit above Earth.
- </summary>
- <remarks><para>GPS devices are able to isolate information about GPS satellites in orbit. Each
- satellite's <see cref="P:DotSpatial.Positioning.Satellite.PseudorandomNumber">unique identifier</see>,
- <see cref="P:DotSpatial.Positioning.Satellite.SignalToNoiseRatio">radio signal strength</see>,
- <see cref="P:DotSpatial.Positioning.Satellite.Azimuth">azimuth</see> and
- <see cref="P:DotSpatial.Positioning.Satellite.Elevation">elevation</see> are available once its
- radio signal is detected.</para>
- <para>Properties in this class are updated automatically as new information is
- received from the GPS device.</para>
- <para><img src="Satellite.jpg"/></para></remarks>
- </member>
- <member name="F:DotSpatial.Positioning.Satellite._pseudorandomNumber">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Satellite._azimuth">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Satellite._elevation">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Satellite._signalToNoiseRatio">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Satellite._isFixed">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Satellite._lastSignalReceived">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Satellite.#ctor(System.Int32)">
- <summary>
- Creates a new instance using the specified unique identifier.
- </summary>
- <param name="pseudorandomNumber">The pseudorandom number.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Satellite.#ctor(System.Int32,DotSpatial.Positioning.Azimuth,DotSpatial.Positioning.Elevation)">
- <summary>
- Creates a new instance using the specified unique identifier, location around the horizon, and elevation up from the horizon.
- </summary>
- <param name="pseudorandomNumber">The pseudorandom number.</param>
- <param name="azimuth">The azimuth.</param>
- <param name="elevation">The elevation.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Satellite.#ctor(System.Int32,DotSpatial.Positioning.Azimuth,DotSpatial.Positioning.Elevation,DotSpatial.Positioning.SignalToNoiseRatio)">
- <summary>
- Creates a new instance using the specified unique identifier, location around the horizon, and elevation up from the horizon.
- </summary>
- <param name="pseudorandomNumber">The pseudorandom number.</param>
- <param name="azimuth">The azimuth.</param>
- <param name="elevation">The elevation.</param>
- <param name="signalToNoiseRatio">The signal to noise ratio.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Satellite.#ctor(System.Int32,DotSpatial.Positioning.Azimuth,DotSpatial.Positioning.Elevation,DotSpatial.Positioning.SignalToNoiseRatio,System.Boolean)">
- <summary>
- Creates a new instance using the specified unique identifier, location around the horizon, and elevation up from the horizon.
- </summary>
- <param name="pseudorandomNumber">The pseudorandom number.</param>
- <param name="azimuth">The azimuth.</param>
- <param name="elevation">The elevation.</param>
- <param name="signalToNoiseRatio">The signal to noise ratio.</param>
- <param name="isFixed">if set to <c>true</c> [is fixed].</param>
- </member>
- <member name="M:DotSpatial.Positioning.Satellite.ToString(System.String)">
- <summary>
- REturns the string equivalent of this object using ht ecurrent cul
- </summary>
- <param name="format">The format.</param>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Satellite.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
- </summary>
- <param name="obj">Another object to compare to.</param>
- <returns><c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Satellite.GetHashCode">
- <summary>
- Returns a hash code for this instance.
- </summary>
- <returns>A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Satellite.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Satellite.GetFixedSatellites(System.Collections.Generic.List{DotSpatial.Positioning.Satellite})">
- <summary>
- Returns the satellites in the specified in the list which are marked as fixed.
- </summary>
- <param name="satellites">The satellites.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Satellite.Equals(DotSpatial.Positioning.Satellite)">
- <summary>
- Indicates whether the current object is equal to another object of the same type.
- </summary>
- <param name="other">An object to compare with this object.</param>
- <returns>true if the current object is equal to the <paramref name="other"/> parameter; otherwise, false.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Satellite.ToString(System.String,System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format to use.-or- A null reference (Nothing in Visual Basic) to use the default format defined for the type of the <see cref="T:System.IFormattable"/> implementation.</param>
- <param name="formatProvider">The provider to use to format the value.-or- A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.</param>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Satellite.CompareTo(DotSpatial.Positioning.Satellite)">
- <summary>
- Compares the current object with another object of the same type.
- </summary>
- <param name="other">An object to compare with this object.</param>
- <returns>A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has the following meanings:
- Value
- Meaning
- Less than zero
- This object is less than the <paramref name="other"/> parameter.
- Zero
- This object is equal to <paramref name="other"/>.
- Greater than zero
- This object is greater than <paramref name="other"/>.</returns>
- </member>
- <member name="P:DotSpatial.Positioning.Satellite.PseudorandomNumber">
- <summary>
- Returns the unique identifier of the satellite.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Satellite.Azimuth">
- <summary>
- Returns the horizontal direction towards the satellite from the current location.
- </summary>
- <value>The azimuth.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Satellite.Elevation">
- <summary>
- Returns the vertical direction towards the satellite from the current
- location.
- </summary>
- <value>The elevation.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Satellite.SignalToNoiseRatio">
- <summary>
- Returns the strength of the satellite's radio signal as it is being
- received.
- </summary>
- <value>The signal to noise ratio.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Satellite.LastSignalReceived">
- <summary>
- Returns the date and time that the satellite's signal was detected.
- </summary>
- <value>The last signal received.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Satellite.IsFixed">
- <summary>
- Returns whether the satellite's signal is being used to calculate the current
- location.
- </summary>
- <value><c>true</c> if this instance is fixed; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Satellite.IsTracked">
- <summary>
- Returns whether the satellite's signal is currently being detected.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Satellite.SignalAge">
- <summary>
- Returns the amount of time elapsed since the signal was last received.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Satellite.IsActive">
- <summary>
- Returns whether the satellite's signal has recently been received.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Satellite.IsDifferentialGpsSatellite">
- <summary>
- Indicates whether the satellite is providing additional corrective
- signals to increase precision.
- </summary>
- <remarks>This property will return a value of <strong>True</strong>
- if the GPS satellite has been identified as a WAAS, EGNOS or MSAS satellite.
- These satellites are geostationary (unlike typical NAVSTAR GPS satellites)
- and re-broadcast correction signals from ground stations. When this property
- is true, the GPS device has improved precision.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Satellite.Class">
- <summary>
- Returns the government project responsible for launching the satellite.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Satellite.AtomicClockType">
- <summary>
- Returns the atomic clock currently in service.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Satellite.Block">
- <summary>
- Returns the launch block of the satellite.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Satellite.DateLaunched">
- <summary>
- Returns the date the satellite was placed into orbit.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Satellite.DateCommissioned">
- <summary>
- Returns the date the satellite was placed into service.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Satellite.DateDecommissioned">
- <summary>
- Returns the date the satellite was removed from service.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Satellite.Name">
- <summary>
- Returns the friendly name of the satellite.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.SatelliteEventArgs">
- <summary>
- Represents information about a satellite when a satellite-related event is raised.
- </summary>
- <example>This example demonstrates how to use this class when raising an event.
- <code lang="VB">
- ' Start a new receiver
- Dim MyReceiver As New Receiver()
- ' Declare a new event
- Dim MySatelliteEvent As EventHandler
- ' Get a handle on the first satellite in the receiver's collection
- Dim MySatellite As Satellite = MyReceiver.Satellites(0)
- Sub Main()
- ' Raise our custom event
- RaiseEvent MySatelliteEvent(Me, New SatelliteEventArgs(MySatellite))
- End Sub
- </code>
- <code lang="C#">
- // Start a new receiver
- Receiver MyReceiver = new Receiver();
- // Declare a new event
- EventHandler MySatelliteEvent;
- // Create an Satellite of 90°
- Satellite MySatellite = new Satellite(90);
- void Main()
- {
- // Raise our custom event
- MySatelliteEvent(this, New SatelliteEventArgs(MySatellite));
- }
- </code>
- </example>
-
- <seealso cref="P:DotSpatial.Positioning.SatelliteEventArgs.Satellite">SatelliteCollection Class</seealso>
-
- <seealso cref="T:DotSpatial.Positioning.Azimuth">Azimuth Property (Satellite Class)</seealso>
-
- <seealso cref="T:DotSpatial.Positioning.Elevation">Elevation Property (Satellite Class)</seealso>
-
- <seealso cref="T:DotSpatial.Positioning.SignalToNoiseRatio">SignalToNoiseRatio Property (Satellite Class)</seealso>
- <remarks>This object is used primarily by the <see cref="P:DotSpatial.Positioning.SatelliteEventArgs.Satellite">Satellite</see>
- class to provide notification when information such as <see cref="T:DotSpatial.Positioning.Azimuth">azimuth</see>,
- <see cref="T:DotSpatial.Positioning.Elevation">elevation</see>, or <see cref="T:DotSpatial.Positioning.SignalToNoiseRatio">radio signal strength</see>
- has changed.</remarks>
- </member>
- <member name="F:DotSpatial.Positioning.SatelliteEventArgs._satellite">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.SatelliteEventArgs.#ctor(DotSpatial.Positioning.Satellite)">
- <summary>
- Creates a new instance.
- </summary>
- <param name="satellite">The satellite.</param>
- </member>
- <member name="P:DotSpatial.Positioning.SatelliteEventArgs.Satellite">
- <summary>
- Indicates which satellite is the target of the event.
- </summary>
- <value>A <strong>Satellite</strong> object containing modified information.</value>
- </member>
- <member name="T:DotSpatial.Positioning.SatelliteListEventArgs">
- <summary>
- The event args for a list of satellites
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.SatelliteListEventArgs._satellites">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.SatelliteListEventArgs.#ctor(System.Collections.Generic.IList{DotSpatial.Positioning.Satellite})">
- <summary>
- Creates a new instance.
- </summary>
- <param name="satellites">The satellites.</param>
- </member>
- <member name="P:DotSpatial.Positioning.SatelliteListEventArgs.Satellites">
- <summary>
- Indicates which satellites are the target of the event.
- </summary>
- <value>A list of <strong>Satellite</strong> objects.</value>
- </member>
- <member name="T:DotSpatial.Positioning.SatelliteClass">
- <summary>
- Indicates the government project responsible for a GPS satellite.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.SatelliteClass.Unknown">
- <summary>The satellite could not be identified.</summary>
- </member>
- <member name="F:DotSpatial.Positioning.SatelliteClass.Navstar">
- <summary>The satellite is part of the NAVSTAR project.</summary>
- </member>
- <member name="F:DotSpatial.Positioning.SatelliteClass.Waas">
- <summary>The satellite is part of the Wide Area Augmentation System (WAAS).</summary>
- </member>
- <member name="F:DotSpatial.Positioning.SatelliteClass.Egnos">
- <summary>
- The satellite is part of the European Geostationary Navigation Overlay Service
- (EGNOS).
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.SatelliteClass.Msas">
- <summary>
- The satellite is pard of Japan's MTSAT Satellite Augmentation System
- (MSAS).
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.SatelliteBlock">
- <summary>
- Indicates the launch block of a group of NAVSTAR GPS satellites.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.SatelliteBlock.Unknown">
- <summary>The block is unknown.</summary>
- </member>
- <member name="F:DotSpatial.Positioning.SatelliteBlock.I">
- <summary>Represents Block I.</summary>
- </member>
- <member name="F:DotSpatial.Positioning.SatelliteBlock.II">
- <summary>Represents Block II.</summary>
- </member>
- <member name="F:DotSpatial.Positioning.SatelliteBlock.IIA">
- <summary>Represents Block IIA</summary>
- </member>
- <member name="F:DotSpatial.Positioning.SatelliteBlock.IIR">
- <summary>Represents Block IIR.</summary>
- </member>
- <member name="T:DotSpatial.Positioning.SatelliteAtomicClockType">
- <summary>
- Indicates the main atomic clock in service aboard a GPS satellite.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.SatelliteAtomicClockType.Unknown">
- <summary>The clock type is unknown.</summary>
- </member>
- <member name="F:DotSpatial.Positioning.SatelliteAtomicClockType.Cesium">
- <summary>The satellite's Cesium clock is currently in service.</summary>
- </member>
- <member name="F:DotSpatial.Positioning.SatelliteAtomicClockType.Rubidium">
- <summary>The satellite's Rubidium clock is currently in service.</summary>
- </member>
- <member name="T:DotSpatial.Positioning.SafeBluetoothRadioFindHandle">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.SafeBluetoothRadioFindHandle.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:System.Runtime.ConstrainedExecution.CriticalFinalizerObject"/> class.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.SafeBluetoothRadioFindHandle.ReleaseHandle">
- <summary>
- When overridden in a derived class, executes the code required to free the handle.
- </summary>
- <returns>true if the handle is released successfully; otherwise, in the event of a catastrophic failure, false. In this case, it generates a releaseHandleFailed MDA Managed Debugging Assistant.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.SafeBluetoothRadioFindHandle.BluetoothFindRadioClose(System.IntPtr)">
- <summary>
- Bluetoothes the find radio close.
- </summary>
- <param name="hFind">The h find.</param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Positioning.SerialDevice">
- <summary>
- Represents a serial (RS-232) device.
- </summary>
- <remarks><para>This class is used to connect to any device using the RS-232 protocol. Desktop computers will typically
- have at least one serial port, and in some cases a "virtual" serial port is created to make a device emulate RS-232. For
- example, since there is no USB standard for GPS devices, USB GPS device manufacturers typically provide a special "USB-to-serial"
- driver to make the device available for third-party applications.</para>
- <para>Each serial port on a computer has a unique name, typically beginning with "COM" followed by a number, then a colon
- (e.g. COM5:). In some special circumstances, such as the GPS Intermediate Driver on Windows Mobile devices, a different prefix
- is used. Each serial port includes other configuration settings, most importantly the baud rate, which controls the speed of
- communications. GPS device manufacturers must support 4800 baud in order to comply with the NMEA-0183 standard, but many newer devices
- use faster speeds. The baud rate of a connection must be specified precisely, otherwise all data from the device will be
- unrecognizable.</para>
- <para>Other settings for serial ports are the data bits, stop bits, and parity. In the context of GPS, a vast majority of GPS
- devices use eight data bits, one stop bit, and no parity. these settings are used if no settings are explicitly provided.</para></remarks>
- </member>
- <member name="F:DotSpatial.Positioning.SerialDevice.ROOT_KEY_NAME">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.SerialDevice._port">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.SerialDevice._lastSuccessfulBaudRate">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.SerialDevice._name">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.SerialDevice._maximumAllowedFailures">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.SerialDevice._detectionBaudRates">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.SerialDevice.#ctor">
- <summary>
- Creates a new instance.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.SerialDevice.#ctor(System.String)">
- <summary>
- Creates a new instance using the specified port.
- </summary>
- <param name="portName">Name of the port.</param>
- </member>
- <member name="M:DotSpatial.Positioning.SerialDevice.#ctor(System.String,System.Int32)">
- <summary>
- Creates a new instance using the specified port name and baud rate.
- </summary>
- <param name="portName">Name of the port.</param>
- <param name="baudRate">The baud rate.</param>
- </member>
- <member name="M:DotSpatial.Positioning.SerialDevice.Reset">
- <summary>
- Forces a device to a closed state without disposing the underlying stream.
- </summary>
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.SerialDevice.OpenStream(System.IO.FileAccess,System.IO.FileShare)">
- <summary>
- Creates a new Stream object for the device.
- </summary>
- <param name="access">The access.</param>
- <param name="sharing">The sharing.</param>
- <returns>A <strong>Stream</strong> object.</returns>
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.SerialDevice.OnDisconnecting">
- <summary>
- Occurs when an open connection is about to be closed.
- </summary>
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.SerialDevice.DetectProtocol">
- <summary>
- Performs a test on the device to confirm that it transmits GPS data.
- </summary>
- <returns>A <strong>Boolean</strong> value, <strong>True</strong> if the device is confirmed.</returns>
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Positioning.SerialDevice.CancelDetection">
- <summary>
- Stops any GPS protocol detection in progress.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.SerialDevice.Dispose(System.Boolean)">
- <summary>
- Disposes of any unmanaged (or optionally, managed) resources used by the device.
- </summary>
- <param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
- </member>
- <member name="M:DotSpatial.Positioning.SerialDevice.OnCacheWrite">
- <summary>
- Records information about this device to the registry.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.SerialDevice.OnCacheRemove">
- <summary>
- Removes previously cached information for this device from the registry.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.SerialDevice.OnCacheRead">
- <summary>
- Reads information about this device from the registry.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.SerialDevice.ClearCache">
- <summary>
- Clears the cache.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.SerialDevice.GetCache">
- <summary>
- Returns a list of known Bluetooth devices.
- </summary>
- <returns></returns>
- <remarks><para>To maximize performance, GPS.NET will record information about each device it encounters for the purposes of organizing
- and speeding up the GPS device detection process. This property returns a list of all known serial devices.</para>
- <para>Since this list is managed automatically, it should not be modified.</para></remarks>
- </member>
- <member name="M:DotSpatial.Positioning.SerialDevice.SetName(System.String)">
- <summary>
- Sets the name.
- </summary>
- <param name="name">The name.</param>
- </member>
- <member name="M:DotSpatial.Positioning.SerialDevice.LoadCachedDevices(System.Collections.Generic.IList{DotSpatial.Positioning.SerialDevice})">
- <summary>
- Loads the serial devices that have been cached by GPS.Net. This list contains previously-detected GPS devices,
- along with devices which were tested but found to NOT be GPS devices. By keeping these statistics,
- the detection system can become faster over time by first testing devices which have a better success rate.
- </summary>
- <param name="devices">The list to which the cached devices are added.</param>
- </member>
- <member name="M:DotSpatial.Positioning.SerialDevice.LoadVirtualDevices(System.Collections.Generic.IList{DotSpatial.Positioning.SerialDevice})">
- <summary>
- Loads any virtual serial devices that exist for other types of physical devices.
- This list includes non-GPS devices.
- </summary>
- <param name="devices">The list to which the cached devices are added.</param>
- </member>
- <member name="M:DotSpatial.Positioning.SerialDevice.LoadWindowsDevices(System.Collections.Generic.IList{DotSpatial.Positioning.SerialDevice})">
- <summary>
- Loads the serial devices that have already been detected by Windows. This list includes non-GPS devices.
- </summary>
- <param name="devices">The list to which the devices are added.</param>
- </member>
- <member name="M:DotSpatial.Positioning.SerialDevice.Equals(DotSpatial.Positioning.SerialDevice)">
- <summary>
- Indicates whether the current object is equal to another object of the same type.
- </summary>
- <param name="other">An object to compare with this object.</param>
- <returns>true if the current object is equal to the <paramref name="other"/> parameter; otherwise, false.</returns>
- </member>
- <member name="P:DotSpatial.Positioning.SerialDevice.Port">
- <summary>
- Returns the name of the port used to open a connection.
- </summary>
- <value>The port.</value>
- </member>
- <member name="P:DotSpatial.Positioning.SerialDevice.PortNumber">
- <summary>
- Returns the numeric portion of the port name.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.SerialDevice.BaudRate">
- <summary>
- Controls the speed of communications for this device.
- </summary>
- <value>The baud rate.</value>
- <remarks>This property controls the speed of read and write operations for the device. The baud rate specified must precisely
- match a rate supported by the device, otherwise data will be unrecognizable. GPS devices are required to support a minimum baud rate of 4800
- in order to comply with the NMEA-0183 standard (though not all devices do this). A higher rate is preferable.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.SerialDevice.Name">
- <summary>
- Returns a natural language name for the device.
- </summary>
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Positioning.SerialDevice.AllowConnections">
- <summary>
- Controls whether the device can be queried for GPS data.
- </summary>
- <value><c>true</c> if [allow connections]; otherwise, <c>false</c>.</value>
- <inheritdocs/>
- </member>
- <member name="P:DotSpatial.Positioning.SerialDevice.DetectionBaudRates">
- <summary>
- Controls the baud rates tested during GPS protocol detection.
- </summary>
- <remarks><para>A GPS device may support any number of baud rates. As a result, the GPS.NET device detection system
- needs to test multiple baud rates in order to find a match. This collection controls the list of baud rates
- tested during detection.</para>
- <para>Advanced GPS developers can improve performance by trimming this list down to baud rates which will actually
- be used.</para></remarks>
- </member>
- <member name="P:DotSpatial.Positioning.SerialDevice.MaximumAllowedFailures">
- <summary>
- Controls the maximum allowed detection failures before a device is excluded from detection.
- </summary>
- <value>The maximum allowed failures.</value>
- <remarks>Some devices involved with device detection are not GPS devices. For example, a serial device search
- could return a bar code scanner, an infrared port, or the neighbor's computer. This property controls how many times a device will be
- tested before it is no longer included for searches. If a device's failure count goes beyond this number, attempts
- will no longer be made to connect to the device.</remarks>
- </member>
- <member name="T:DotSpatial.Positioning.SerialPort">
- <summary>
- Wraps the .Net <see cref="T:System.IO.Ports.SerialPort"/> class and implements workarounds for some
- known bugs and limitations.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.SerialPort._reader">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.SerialPort.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:System.ComponentModel.Component"/> class.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.SerialPort.#ctor(System.String,System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.SerialPort"/> class.
- </summary>
- <param name="portName">Name of the port.</param>
- <param name="baudRate">The baud rate.</param>
- </member>
- <member name="M:DotSpatial.Positioning.SerialPort.#ctor(System.String,System.Int32,System.IO.Ports.Parity,System.Int32,System.IO.Ports.StopBits)">
- <summary>
- Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort"/> class using the specified port name, baud rate, parity bit, data bits, and stop bit.
- </summary>
- <param name="portName">The port to use (for example, COM1).</param>
- <param name="baudRate">The baud rate.</param>
- <param name="parity">One of the <see cref="P:System.IO.Ports.SerialPort.Parity"/> values.</param>
- <param name="dataBits">The data bits value.</param>
- <param name="stopBits">One of the <see cref="P:System.IO.Ports.SerialPort.StopBits"/> values.</param>
- <exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
- </member>
- <member name="M:DotSpatial.Positioning.SerialPort.Open">
- <summary>
- Opens a new serial port connection.
- </summary>
- <exception cref="T:System.InvalidOperationException">The specified port is open. </exception>
-
- <exception cref="T:System.ArgumentOutOfRangeException">One or more of the properties for this instance are invalid. For example, the <see cref="P:System.IO.Ports.SerialPort.Parity"/>, <see cref="P:System.IO.Ports.SerialPort.DataBits"/>, or <see cref="P:System.IO.Ports.SerialPort.Handshake"/> properties are not valid values; the <see cref="P:System.IO.Ports.SerialPort.BaudRate"/> is less than or equal to zero; the <see cref="P:System.IO.Ports.SerialPort.ReadTimeout"/> or <see cref="P:System.IO.Ports.SerialPort.WriteTimeout"/> property is less than zero and is not <see cref="F:System.IO.Ports.SerialPort.InfiniteTimeout"/>. </exception>
-
- <exception cref="T:System.ArgumentException">The port name does not begin with "COM". - or -The file type of the port is not supported.</exception>
-
- <exception cref="T:System.IO.IOException">The port is in an invalid state. - or - An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort"/> object were invalid.</exception>
-
- <exception cref="T:System.UnauthorizedAccessException">Access is denied to the port. </exception>
-
- <PermissionSet>
- <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode, ControlEvidence"/>
- </PermissionSet>
- </member>
- <member name="M:DotSpatial.Positioning.SerialPort.ReadLine">
- <summary>
- Reads up to the <see cref="P:System.IO.Ports.SerialPort.NewLine"/> value in the input buffer.
- </summary>
- <returns>The contents of the input buffer up to the first occurrence of a <see cref="P:System.IO.Ports.SerialPort.NewLine"/> value.</returns>
- <exception cref="T:System.InvalidOperationException">The specified port is not open. </exception>
-
- <exception cref="T:System.TimeoutException">The operation did not complete before the time-out period ended.- or -No bytes were read.</exception>
-
- <PermissionSet>
- <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode, ControlEvidence"/>
- </PermissionSet>
- </member>
- <member name="M:DotSpatial.Positioning.SerialPort.Dispose(System.Boolean)">
- <summary>
- Releases the unmanaged resources used by the <see cref="T:System.IO.Ports.SerialPort"/> and optionally releases the managed resources.
- </summary>
- <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
- <exception cref="T:System.IO.IOException">The port is in an invalid state. - or -An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort"/> object were invalid.</exception>
- </member>
- <member name="T:DotSpatial.Positioning.SignalToNoiseRatio">
- <summary>
- Represents a measurement of the strength of a received radio signal.
- </summary>
- <remarks>Signal-to-Noise Ratios (or SNR for short) measure the clarity of
- a received signal versus the level at which the signal is being obscured. For
- example, if a GPS device is operating in open sky on a clear day, no signals are
- obscured and the SNR will be high. Conversely, if a device is activated in a room
- with no view of the sky, signals may be obscured, resulting in a low SNR.
- This class is used frequently by the <see cref="T:DotSpatial.Positioning.Satellite">Satellite</see>
- class to report on the quality of GPS satellite signals. When three or more
- satellite SNR's are strong, the device is able to obtain a fix on the current location.</remarks>
- </member>
- <member name="F:DotSpatial.Positioning.SignalToNoiseRatio._value">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.SignalToNoiseRatio.NoSignal">
- <summary>
- Represents a value signifying a signal which is completely obscured.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.SignalToNoiseRatio.Empty">
- <summary>
- Represents a value of zero.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.SignalToNoiseRatio.HalfSignal">
- <summary>
- Represents a value signifying a signal which is partially obscured.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.SignalToNoiseRatio.FullSignal">
- <summary>
- Represents a value signifying a signal which is not being obscured.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.SignalToNoiseRatio.#ctor(System.Int32)">
- <summary>
- Creates a new instance.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:DotSpatial.Positioning.SignalToNoiseRatio.#ctor(System.String)">
- <summary>
- Creates a new instance by parsing the specified string.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:DotSpatial.Positioning.SignalToNoiseRatio.#ctor(System.String,System.Globalization.CultureInfo)">
- <summary>
- Creates a new instance by parsing the specified string using a specific culture.
- </summary>
- <param name="value">The value.</param>
- <param name="culture">The culture.</param>
- </member>
- <member name="M:DotSpatial.Positioning.SignalToNoiseRatio.ToString(System.String)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format.</param>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- <overloads>Outputs the current instance as a formatted string.</overloads>
- </member>
- <member name="M:DotSpatial.Positioning.SignalToNoiseRatio.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
- </summary>
- <param name="obj">Another object to compare to.</param>
- <returns><c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.SignalToNoiseRatio.GetHashCode">
- <summary>
- Returns a unique code for the current instance used in hash tables.
- </summary>
- <returns>A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.SignalToNoiseRatio.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.SignalToNoiseRatio.Random">
- <summary>
- Returns a <strong>SignalToNoiseRatio</strong> object containing a random
- value.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.SignalToNoiseRatio.Parse(System.String)">
- <summary>
- Parses the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.SignalToNoiseRatio.Parse(System.String,System.Globalization.CultureInfo)">
- <summary>
- Parses the specified value.
- </summary>
- <param name="value">The value.</param>
- <param name="culture">The culture.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.SignalToNoiseRatio.Equals(DotSpatial.Positioning.SignalToNoiseRatio)">
- <summary>
- Indicates whether the current object is equal to another object of the same type.
- </summary>
- <param name="other">An object to compare with this object.</param>
- <returns>true if the current object is equal to the <paramref name="other"/> parameter; otherwise, false.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.SignalToNoiseRatio.Equals(DotSpatial.Positioning.SignalToNoiseRatioRating)">
- <summary>
- Equalses the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.SignalToNoiseRatio.ToString(System.String,System.IFormatProvider)">
- <summary>
- Outputs the current instance as a string using the specified format and
- culture.
- </summary>
- <param name="format">The format to use.-or- A null reference (Nothing in Visual Basic) to use the default format defined for the type of the <see cref="T:System.IFormattable"/> implementation.</param>
- <param name="formatProvider">The provider to use to format the value.-or- A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.</param>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.SignalToNoiseRatio.CompareTo(DotSpatial.Positioning.SignalToNoiseRatio)">
- <summary>
- Compares the current object with another object of the same type.
- </summary>
- <param name="other">An object to compare with this object.</param>
- <returns>A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has the following meanings:
- Value
- Meaning
- Less than zero
- This object is less than the <paramref name="other"/> parameter.
- Zero
- This object is equal to <paramref name="other"/>.
- Greater than zero
- This object is greater than <paramref name="other"/>.</returns>
- </member>
- <member name="P:DotSpatial.Positioning.SignalToNoiseRatio.Value">
- <summary>
- Returns the numeric value of the signal strength.
- </summary>
- <value>An <strong>Integer</strong> value between 0 and 50, where 0 represents no signal and fifty represents a signal at full strength.</value>
- <remarks>This property indicates the strength of a received satellite signal. GPS
- satellites always transmit signals at the same strength, but the signal is often
- obscured by the atmosphere, buildings and other obstacles such as trees. A value
- must be at about 30 or greater for a satellite to be able to maintain a fix for long.
- In the <see cref="T:DotSpatial.Positioning.Satellite">Satellite</see> class, this property is updated automatically as new information is
- received from the GPS device.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.SignalToNoiseRatio.IsEmpty">
- <summary>
- Indicates if the value is zero.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.SignalToNoiseRatio.Rating">
- <summary>
- Returns a subjective rating of the signal strength.
- </summary>
- <value>A value from the <strong>SignalToNoiseRatioRating</strong> enumeration.</value>
- <seealso cref="T:DotSpatial.Positioning.SignalToNoiseRatioRating">SignalToNoiseRatioRating Enumeration</seealso>
- <remarks>This property is frequently used to present an SNR reading in a readable format to the user.
- This property is updated automatically as new information is received from the GPS device.</remarks>
- </member>
- <member name="T:DotSpatial.Positioning.SignalToNoiseRatioRating">
- <summary>
- Indicates an in-English description of the a satellite's radio signal strength
- </summary>
- <remarks>This enumeration is used by the <see cref="P:DotSpatial.Positioning.SignalToNoiseRatio.Rating">Rating</see> property of the
- <see cref="T:DotSpatial.Positioning.SignalToNoiseRatio">SignalToNoiseRatio</see> class to give an in-English interpretation
- of satellite radio signal strength.</remarks>
- </member>
- <member name="F:DotSpatial.Positioning.SignalToNoiseRatioRating.None">
- <summary>Represents a value of 0. The radio signal is completely obscured.</summary>
- </member>
- <member name="F:DotSpatial.Positioning.SignalToNoiseRatioRating.Poor">
- <summary>Represents a value between 1 and 15. The radio signal is mostly obscured, such as by a building or tree, but might briefly be part of a fix.</summary>
- </member>
- <member name="F:DotSpatial.Positioning.SignalToNoiseRatioRating.Moderate">
- <summary>Represents a value between 16 and 30. The radio signal is partially obscured, but could be part of a sustained fix.</summary>
- </member>
- <member name="F:DotSpatial.Positioning.SignalToNoiseRatioRating.Good">
- <summary>Represents a value between 31 and 40. The radio signal is being received with little interferance and could maintain a reliable fix.</summary>
- </member>
- <member name="F:DotSpatial.Positioning.SignalToNoiseRatioRating.Excellent">
- <summary>Represents a value of 41 or above. The satellite is in direct line of sight from the receiver and can sustain a fix.</summary>
- </member>
- <member name="T:DotSpatial.Positioning.SignalToNoiseRatioEventArgs">
- <summary>
- Signal to noise ratio event args
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.SignalToNoiseRatioEventArgs._signalToNoiseRatio">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.SignalToNoiseRatioEventArgs.#ctor(DotSpatial.Positioning.SignalToNoiseRatio)">
- <summary>
- Creates a new instance of the event args
- </summary>
- <param name="signalToNoiseRatio">The signal to noise ratio.</param>
- </member>
- <member name="P:DotSpatial.Positioning.SignalToNoiseRatioEventArgs.SignalToNoiseRatio">
- <summary>
- The signal to noise ratio
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.SquareMatrix3D">
- <summary>
- Represents a three-dimensional double-precision matrix.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.SquareMatrix3D._m11">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.SquareMatrix3D._m12">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.SquareMatrix3D._m13">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.SquareMatrix3D._m21">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.SquareMatrix3D._m22">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.SquareMatrix3D._m23">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.SquareMatrix3D._m31">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.SquareMatrix3D._m32">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.SquareMatrix3D._m33">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.SquareMatrix3D._elements">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.SquareMatrix3D.#ctor">
- <summary>
- Creates a matrix as an identity matrix
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.SquareMatrix3D.#ctor(System.Double,System.Double,System.Double,System.Double,System.Double,System.Double,System.Double,System.Double,System.Double)">
- <summary>
- Creates a matrix with the indicated elements
- </summary>
- <param name="m11">The M11.</param>
- <param name="m12">The M12.</param>
- <param name="m13">The M13.</param>
- <param name="m21">The M21.</param>
- <param name="m22">The M22.</param>
- <param name="m23">The M23.</param>
- <param name="m31">The M31.</param>
- <param name="m32">The M32.</param>
- <param name="m33">The M33.</param>
- </member>
- <member name="M:DotSpatial.Positioning.SquareMatrix3D.Elementary">
- <summary>
- Elementaries this instance.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.SquareMatrix3D.Clone">
- <summary>
- Ctreates an exact copy of this matrix.
- </summary>
- <returns>A cloned matrix.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.SquareMatrix3D.Multiply(DotSpatial.Positioning.SquareMatrix3D)">
- <summary>
- Multiplies this matrix with the supplied matrix, using a prepended matrix order
- </summary>
- <param name="matrix">The matrix to multiply with this matrix.</param>
- </member>
- <member name="M:DotSpatial.Positioning.SquareMatrix3D.Multiply(DotSpatial.Positioning.SquareMatrix3D,System.Drawing.Drawing2D.MatrixOrder)">
- <summary>
- Multiplies this matrix with the supplied matrix.
- </summary>
- <param name="matrix">The matrix to multiply with this matrix.</param>
- <param name="matrixOrder">The order in which to carry out the operation.</param>
- </member>
- <member name="M:DotSpatial.Positioning.SquareMatrix3D.TransformVector(DotSpatial.Positioning.CartesianPoint)">
- <summary>
- Transforms the vector
- </summary>
- <param name="vector">The vector.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.SquareMatrix3D.TransformVectors(DotSpatial.Positioning.CartesianPoint[])">
- <summary>
- Transform the array of vectors
- </summary>
- <param name="vectors">The vectors.</param>
- </member>
- <member name="M:DotSpatial.Positioning.SquareMatrix3D.Invert">
- <summary>
- Inverts this matrix if it is invertable.
- </summary>
- <remarks>If the matrix is not invertable, this method throws an exception.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.SquareMatrix3D.Determinant">
- <summary>
- Calculates the determinat of this matrix.
- </summary>
- <returns>The signed area of the parallelagram described by this matrix.</returns>
- <remarks>The determinant is a scalar value typically used to invert a matrix. As a signed area, it can also be used to
- identify "flipped" orientations, like mirroring. A negative determinant indicates that a matrix is "flipped".</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.SquareMatrix3D.Reset">
- <summary>
- Resests the matrix to the identity matrix.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.SquareMatrix3D.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.SquareMatrix3D.GetHashCode">
- <summary>
- Returns a hash code for this instance.
- </summary>
- <returns>A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.SquareMatrix3D.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
- </summary>
- <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
- <returns><c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.SquareMatrix3D.Transpose(DotSpatial.Positioning.SquareMatrix3D)">
- <summary>
- Creates the transpose matrix of a matrix
- </summary>
- <param name="a">A.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.SquareMatrix3D.Invert(DotSpatial.Positioning.SquareMatrix3D)">
- <summary>
- Square Matrix 3D Invert
- </summary>
- <param name="a">A.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.SquareMatrix3D.Default(System.Double)">
- <summary>
- Defaults the specified default value.
- </summary>
- <param name="defaultValue">The default value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.SquareMatrix3D.op_Multiply(DotSpatial.Positioning.SquareMatrix3D,DotSpatial.Positioning.CartesianPoint)">
- <summary>
- Implements the operator *.
- </summary>
- <param name="a">A.</param>
- <param name="v">The v.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.SquareMatrix3D.op_Multiply(DotSpatial.Positioning.SquareMatrix3D,DotSpatial.Positioning.SquareMatrix3D)">
- <summary>
- Implements the operator *.
- </summary>
- <param name="a">A.</param>
- <param name="b">The b.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.SquareMatrix3D.op_Addition(DotSpatial.Positioning.SquareMatrix3D,DotSpatial.Positioning.SquareMatrix3D)">
- <summary>
- Implements the operator +.
- </summary>
- <param name="a">A.</param>
- <param name="b">The b.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.SquareMatrix3D.op_Subtraction(DotSpatial.Positioning.SquareMatrix3D,DotSpatial.Positioning.SquareMatrix3D)">
- <summary>
- Implements the operator -.
- </summary>
- <param name="a">A.</param>
- <param name="b">The b.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.SquareMatrix3D.Multiply(DotSpatial.Positioning.SquareMatrix3D,DotSpatial.Positioning.SquareMatrix3D)">
- <summary>
- Multiplies the specified a.
- </summary>
- <param name="a">A.</param>
- <param name="b">The b.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.SquareMatrix3D.Add(DotSpatial.Positioning.SquareMatrix3D,DotSpatial.Positioning.SquareMatrix3D)">
- <summary>
- Adds the specified a.
- </summary>
- <param name="a">A.</param>
- <param name="b">The b.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.SquareMatrix3D.Subtract(DotSpatial.Positioning.SquareMatrix3D,DotSpatial.Positioning.SquareMatrix3D)">
- <summary>
- Subtracts the specified a.
- </summary>
- <param name="a">A.</param>
- <param name="b">The b.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.SquareMatrix3D.Equals(DotSpatial.Positioning.SquareMatrix3D)">
- <summary>
- Indicates whether the current object is equal to another object of the same type.
- </summary>
- <param name="other">An object to compare with this object.</param>
- <returns>true if the current object is equal to the <paramref name="other"/> parameter; otherwise, false.</returns>
- </member>
- <member name="P:DotSpatial.Positioning.SquareMatrix3D.Elements">
- <summary>
- Elements
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.SquareMatrix3D.IsIdentity">
- <summary>
- Indicates whether or not this is an identity matrix
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.SquareMatrix3D.IsInvertable">
- <summary>
- Indicates whether or not this matrix is invertable.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.SquareMatrix3D.Identity">
- <summary>
- Returns an identity matrix.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.TextFileEmulator">
- <summary>
- Emulator that sources it's data from a text file
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.TextFileEmulator._filePath">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.TextFileEmulator._reader">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.TextFileEmulator._readInterval">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.TextFileEmulator.#ctor(System.String)">
- <summary>
- Creates a Text File Emulator from the specified file path with a default read interval of 400 seconds
- </summary>
- <param name="filePath">The file path.</param>
- </member>
- <member name="M:DotSpatial.Positioning.TextFileEmulator.#ctor(System.String,System.TimeSpan)">
- <summary>
- Creates a Text File Emulator from the specified file path with the specified read interval
- </summary>
- <param name="filePath">The file path.</param>
- <param name="readInterval">The read interval.</param>
- </member>
- <member name="M:DotSpatial.Positioning.TextFileEmulator.OnEmulation">
- <summary>
- OnEmulation event handler
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.TextFileEmulator.ReadInterval">
- <summary>
- Gets or sets the ReadInterval for the Text File Emulator
- </summary>
- <value>The read interval.</value>
- </member>
- <member name="T:DotSpatial.Positioning.Velocity">
- <summary>
- Represents a measurement of an object's rate of travel in a particular direction.
- </summary>
- <remarks>Instances of this class are guaranteed to be thread-safe because the class is
- immutable (its properties can only be changed via constructors).</remarks>
- </member>
- <member name="F:DotSpatial.Positioning.Velocity._speed">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Velocity._bearing">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Velocity.Empty">
- <summary>
- Represents a velocity with no speed or direction.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Velocity.Invalid">
- <summary>
- Represents a velocity with an invalid or unspecified speed and direction.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Velocity.#ctor(DotSpatial.Positioning.Speed,DotSpatial.Positioning.Azimuth)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.Velocity"/> struct.
- </summary>
- <param name="speed">The speed.</param>
- <param name="bearing">The bearing.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Velocity.#ctor(DotSpatial.Positioning.Speed,System.Double)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.Velocity"/> struct.
- </summary>
- <param name="speed">The speed.</param>
- <param name="bearingDegrees">The bearing degrees.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Velocity.#ctor(System.Double,DotSpatial.Positioning.SpeedUnit,DotSpatial.Positioning.Azimuth)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.Velocity"/> struct.
- </summary>
- <param name="speed">The speed.</param>
- <param name="speedUnits">The speed units.</param>
- <param name="bearing">The bearing.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Velocity.#ctor(System.Double,DotSpatial.Positioning.SpeedUnit,System.Double)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.Velocity"/> struct.
- </summary>
- <param name="speed">The speed.</param>
- <param name="speedUnits">The speed units.</param>
- <param name="bearingDegrees">The bearing degrees.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Velocity.#ctor(System.String,System.String)">
- <summary>
- Creates a new instance by parsing speed and bearing from the specified strings.
- </summary>
- <param name="speed">The speed.</param>
- <param name="bearing">The bearing.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Velocity.#ctor(System.String,System.String,System.Globalization.CultureInfo)">
- <summary>
- Creates a new instance by converting the specified strings using the specific culture.
- </summary>
- <param name="speed">The speed.</param>
- <param name="bearing">The bearing.</param>
- <param name="culture">The culture.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Velocity.#ctor(System.Xml.XmlReader)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.Velocity"/> struct.
- </summary>
- <param name="reader">The reader.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Velocity.op_Equality(DotSpatial.Positioning.Velocity,DotSpatial.Positioning.Velocity)">
- <summary>
- Implements the operator ==.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Velocity.op_Inequality(DotSpatial.Positioning.Velocity,DotSpatial.Positioning.Velocity)">
- <summary>
- Implements the operator !=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Velocity.GetHashCode">
- <summary>
- Returns a hash code for this instance.
- </summary>
- <returns>A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Velocity.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
- </summary>
- <param name="obj">Another object to compare to.</param>
- <returns><c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Velocity.ToString">
- <summary>
- Outputs the current instance as a string using the default format.
- </summary>
- <returns>A <strong>String</strong> representing the current instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Velocity.Equals(DotSpatial.Positioning.Velocity)">
- <summary>
- Compares the current instance to the specified velocity.
- </summary>
- <param name="other">A <strong>Velocity</strong> object to compare with.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the values are identical.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Velocity.Equals(DotSpatial.Positioning.Velocity,System.Int32)">
- <summary>
- Compares the current instance to the specified velocity using the specified numeric precision.
- </summary>
- <param name="other">A <strong>Velocity</strong> object to compare with.</param>
- <param name="decimals">An <strong>Integer</strong> specifying the number of fractional digits to compare.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the values are identical.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Velocity.ToString(System.String,System.IFormatProvider)">
- <summary>
- Outputs the current instance as a string using the specified format and culture information.
- </summary>
- <param name="format">The format to use.-or- A null reference (Nothing in Visual Basic) to use the default format defined for the type of the <see cref="T:System.IFormattable"/> implementation.</param>
- <param name="formatProvider">The provider to use to format the value.-or- A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.</param>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Velocity.System#Xml#Serialization#IXmlSerializable#GetSchema">
- <summary>
- This method is reserved and should not be used. When implementing the IXmlSerializable interface, you should return null (Nothing in Visual Basic) from this method, and instead, if specifying a custom schema is required, apply the <see cref="T:System.Xml.Serialization.XmlSchemaProviderAttribute"/> to the class.
- </summary>
- <returns>An <see cref="T:System.Xml.Schema.XmlSchema"/> that describes the XML representation of the object that is produced by the <see cref="M:System.Xml.Serialization.IXmlSerializable.WriteXml(System.Xml.XmlWriter)"/> method and consumed by the <see cref="M:System.Xml.Serialization.IXmlSerializable.ReadXml(System.Xml.XmlReader)"/> method.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Velocity.WriteXml(System.Xml.XmlWriter)">
- <summary>
- Converts an object into its XML representation.
- </summary>
- <param name="writer">The <see cref="T:System.Xml.XmlWriter"/> stream to which the object is serialized.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Velocity.ReadXml(System.Xml.XmlReader)">
- <summary>
- Generates an object from its XML representation.
- </summary>
- <param name="reader">The <see cref="T:System.Xml.XmlReader"/> stream from which the object is deserialized.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Velocity.Clone">
- <summary>
- Clones this instance.
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Positioning.Velocity.Speed">
- <summary>
- Gets the objects rate of travel.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Velocity.Bearing">
- <summary>
- Gets the objects direction of travel.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Velocity.IsEmpty">
- <summary>
- Indicates whether the speed and bearing are both zero.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Velocity.IsInvalid">
- <summary>
- Indicates whether the speed or bearing is invalid or unspecified.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.GeographicRectangle">
- <summary>
- Represents a rectangular shape on Earth's surface.
- </summary>
- <remarks><para>This class is used to represent a square (or close to a square) shape on
- Earth's surface. This class is typically used during mapping applications to zoom
- into a particular area on Earth. This class looks nearly identical to the Rectangle
- class in the .NET framework, except that it's bounding points are defined as
- <strong>Position</strong> objects instead of <strong>Point</strong> objects.</para>
- <para>Instances of this class are guaranteed to be thread-safe because the class is
- immutable (it's properties can only be set via constructors).</para></remarks>
- </member>
- <member name="F:DotSpatial.Positioning.GeographicRectangle._top">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.GeographicRectangle._bottom">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.GeographicRectangle._left">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.GeographicRectangle._right">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.GeographicRectangle._center">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.GeographicRectangle.Empty">
- <summary>
- Represents a GeographicRectangle having no size.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.GeographicRectangle.Maximum">
- <summary>
- Represents a rectangle that encompasses all of Earth's surface.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.#ctor(DotSpatial.Positioning.Position,DotSpatial.Positioning.GeographicSize)">
- <summary>
- Creates a new instance using the specified location and size.
- </summary>
- <param name="location">The location.</param>
- <param name="size">The size.</param>
- <returns>
- A <strong>GeographicRectangle</strong> set to the specified location and
- size.
- </returns>
-
- <example>
- This example creates a new <strong>GeographicRectangle</strong> starting at 39°N
- 105°W which is 2° wide and 5° tall.
- <code lang="VB" title="[New Example]">
- Dim NorthwestCorner As New Position("39N 105W")
- Dim RectangleSize As New GeographicSize(2, 5)
- Dim Rectangle As New GeographicRectangle(NorthwestCorner, RectangleSize)
- </code>
- <code lang="CS" title="[New Example]">
- Position NorthwestCorner = new Position("39N, 105W");
- GeographicSize RectangleSize = new GeographicSize(2, 5);
- GeographicRectangle Rectangle = new GeographicRectangle(NorthwestCorner, RectangleSize);
- </code>
- </example>
- <remarks>This constructor defines a rectangle which expands east and south of the
- specified location.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.#ctor(DotSpatial.Positioning.Position,DotSpatial.Positioning.Distance,DotSpatial.Positioning.Distance)">
- <summary>
- Creates a new instance using the specified location, width, and height.
- </summary>
- <param name="location">The location.</param>
- <param name="width">The width.</param>
- <param name="height">The height.</param>
- <example>
- This example creates a new <strong>GeographicRectangle</strong> starting at 39°N
- 105°W which is 2° wide and 5° tall.
- <code lang="VB" title="[New Example]">
- Dim NorthwestCorner As New Position("39N 105W")
- Dim RectangleWidth As Distance = Distance.FromKilometers(1)
- Dim RectangleHeight As Distance = Distance.FromKilometers(1)
- Dim Rectangle As New GeographicRectangle(NorthwestCorner, RectangleWidth, RectangleHeight)
- </code>
- <code lang="CS" title="[New Example]">
- Position NorthwestCorner = new Position("39N 105W");
- Distance RectangleWidth = Distance.FromKilometers(1);
- Distance RectangleHeight = Distance.FromKilometers(1);
- GeographicRectangle Rectangle = new GeographicRectangle(NorthwestCorner, RectangleWidth, RectangleHeight);
- </code>
- </example>
-
- <returns>
- A <strong>GeographicRectangle</strong> set to the specified location and
- size.
- </returns>
- <remarks>This constructor defines a rectangle which expands east and south of the
- specified location.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.#ctor(DotSpatial.Positioning.Position,DotSpatial.Positioning.Position)">
- <summary>
- Creates a new instance using the specified northwest and southeast
- coordinates.
- </summary>
- <param name="northwest">The northwest.</param>
- <param name="southeast">The southeast.</param>
- <returns>A <strong>GeographicRectangle</strong> defined by the two endpoints.</returns>
-
- <example>
- This example creates a new <strong>GeographicRectangle</strong> starting at 39°N
- 105°W and ending at 37°N 100°W (2° wide and 5° tall).
- <code lang="VB" title="[New Example]">
- Dim NorthwestCorner As New Position("39N 105W")
- Dim SoutheastCorner As New Position("37N 100W")
- Dim Rectangle As New GeographicRectangle(NorthwestCorner, SoutheastCorner)
- </code>
- <code lang="CS" title="[New Example]">
- Position NorthwestCorner = new Position("39N 105W");
- Position SoutheastCorner = new Position("37N 100W");
- GeographicRectangle Rectangle = new GeographicRectangle(NorthwestCorner, SoutheastCorner);
- </code>
- </example>
- <remarks>This constructor takes the specified parameters and calculates the width and
- height of the rectangle. If the two points are backwards (meaning that the right-most
- point is west of the left-most point), they are automatically swapped before creating
- the rectangle.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.#ctor(System.String)">
- <summary>
- Creates a new instance by converting the specified string.
- </summary>
- <param name="value">The value.</param>
- <returns>
- A <strong>GeographicRectangle</strong> matching the specified string
- value.
- </returns>
-
- <example>
- This example creates a new rectangle at 39°N, 105° extending two degrees south and
- five degrees east to 37°N, 100°W.
- <code lang="VB" title="[New Example]">
- Dim Rectangle As New GeographicRectangle("39N, 105W, 37N, 100W")
- </code>
- <code lang="CS" title="[New Example]">
- GeographicRectangle Rectangle = new GeographicRectangle("39N, 105W, 37N, 100W");
- </code>
- </example>
- <remarks>This constructor attempts to parse the specified string into a rectangle. The
- current culture is used to interpret the string -- use the list separator of the
- current culture (which may not necessarily be a comma). This constructor can accept any
- output created via the <strong>ToString</strong> method.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.#ctor(System.String,System.Globalization.CultureInfo)">
- <summary>
- Creates a new instance by converting the specified string in the given
- culture.
- </summary>
- <param name="value">The value.</param>
- <param name="culture">The culture.</param>
- <returns>
- This constructor attempts to parse the specified string into a rectangle. The
- specified culture is used to interpret the string. This constructor can accept any
- output created via the <strong>ToString</strong> method.
- </returns>
-
- <example>
- This example creates a new rectangle at 39°N, 105° extending two degrees south and
- five degrees east to 37°N, 100°W.
- <code lang="VB" title="[New Example]">
- Dim Rectangle As New GeographicRectangle("39N, 105W, 37N, 100W", CultureInfo.CurrentCulture)
- </code>
- <code lang="CS" title="[New Example]">
- GeographicRectangle Rectangle = new GeographicRectangle("39N, 105W, 37N, 100W", CultureInfo.CurrentCulture);
- </code>
- </example>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.#ctor(DotSpatial.Positioning.Longitude,DotSpatial.Positioning.Latitude,DotSpatial.Positioning.Longitude,DotSpatial.Positioning.Latitude)">
- <summary>
- Creates a new instance using the specified latitudes and longitudes.
- </summary>
- <param name="left">The left.</param>
- <param name="top">The top.</param>
- <param name="right">The right.</param>
- <param name="bottom">The bottom.</param>
- <example>
- This example creates a new <strong>GeographicRectangle</strong> by specifying each
- side individually.
- <code lang="VB" title="[New Example]">
- Dim Left As New Longitude(-105)
- Dim Top As New Latitude(39)
- Dim Right As New Longitude(-100)
- Dim Top As New Latitude(37)
- Dim Rectangle As New GeographicRectangle(Left, Top, Right, Bottom)
- </code>
- <code lang="CS" title="[New Example]">
- Longitude Left = new Longitude(-105);
- Latitude Top = new Latitude(39);
- Longitude Right = new Longitude(-100);
- Latitude Top = new Latitude(37);
- GeographicRectangle Rectangle = new GeographicRectangle(Left, Top, Right, Bottom);
- </code>
- </example>
-
- <returns>A <strong>GeographicRectangle</strong> bound by the specified values.</returns>
- <remarks>If the left and right, or top and bottom values are backwards, they are
- automatically swapped before creating the rectangle.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.#ctor(DotSpatial.Positioning.Latitude,DotSpatial.Positioning.Longitude,DotSpatial.Positioning.Latitude,DotSpatial.Positioning.Longitude)">
- <summary>
- Creates a new instance using the specified latitudes and longitudes.
- </summary>
- <param name="top">The top.</param>
- <param name="left">The left.</param>
- <param name="bottom">The bottom.</param>
- <param name="right">The right.</param>
- <returns>A <strong>GeographicRectangle</strong> bound by the specified values.</returns>
-
- <example>
- <code lang="VB" title="[New Example]">
- Dim Left As New Longitude(-105)
- Dim Top As New Latitude(39)
- Dim Right As New Longitude(-100)
- Dim Top As New Latitude(37)
- Dim Rectangle As New GeographicRectangle(Left, Top, Right, Bottom)
- </code>
- <code lang="CS" title="[New Example]">
- Latitude Top = new Latitude(39);
- Longitude Left = new Longitude(-105);
- Latitude Bottom = new Latitude(37);
- Longitude Right = new Longitude(-100);
- GeographicRectangle Rectangle = new GeographicRectangle(Top, Left, Bottom, Right);
- </code>
- </example>
- <remarks>If the left and right, or top and bottom values are backwards, they are
- automatically swapped before creating the rectangle.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.#ctor(System.Double,System.Double,System.Double,System.Double)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.GeographicRectangle"/> struct.
- </summary>
- <param name="left">The left.</param>
- <param name="top">The top.</param>
- <param name="right">The right.</param>
- <param name="bottom">The bottom.</param>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.#ctor(System.Xml.XmlReader)">
- <summary>
- Creates a new instance from a block of Geography Markup Language (GML).
- </summary>
- <param name="reader">The reader.</param>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.TranslateTo(DotSpatial.Positioning.Azimuth,DotSpatial.Positioning.Distance)">
- <summary>
- Moves the rectangle in the specified direction by the specified distance.
- </summary>
- <param name="direction">The direction.</param>
- <param name="distance">The distance.</param>
- <returns>A new <strong>GeographicRectangle</strong> translated by the specified direction
- and distance.</returns>
- <example>
- This example defines a rectangle then shifts it Northeast by fifty kilometers.
- <code lang="VB" title="[New Example]">
- Dim Rectangle As New GeographicRectangle("30N, 105W, 1°, 5°")
- Rectangle = Rectangle.Translate(Azimuth.Northeast, New Distance(50, DistanceUnit.Kilometers))
- </code>
- <code lang="CS" title="[New Example]">
- GeographicRectangle Rectangle = new GeographicRectangle("30N, 105W, 1°, 5°");
- Rectangle = Rectangle.Translate(Azimuth.Northeast, New Distance(50, DistanceUnit.Kilometers));
- </code>
- </example>
- <remarks>This method is used to shift a rectangle to a new location while preserving its
- size.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.TranslateTo(DotSpatial.Positioning.Angle,DotSpatial.Positioning.Distance)">
- <summary>
- Moves the rectangle in the specified direction by the specified distance.
- </summary>
- <param name="direction">The direction.</param>
- <param name="distance">The distance.</param>
- <returns>A new <strong>GeographicRectangle</strong> translated by the specified direction
- and distance.</returns>
- <example>
- This example defines a rectangle then shifts it Northeast by fifty kilometers.
- <code lang="VB" title="[New Example]">
- Dim Rectangle As New GeographicRectangle("30N, 105W, 1°, 5°")
- Rectangle = Rectangle.Translate(new Angle(45), New Distance(50, DistanceUnit.Kilometers))
- </code>
- <code lang="CS" title="[New Example]">
- GeographicRectangle Rectangle = new GeographicRectangle("30N, 105W, 1°, 5°");
- Rectangle = Rectangle.Translate(new Angle(45), New Distance(50, DistanceUnit.Kilometers));
- </code>
- </example>
- <remarks>This method is used to shift a rectangle to a new location while preserving its
- size.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.TranslateTo(System.Double,DotSpatial.Positioning.Distance)">
- <summary>
- Moves the rectangle in the specified direction by the specified distance.
- </summary>
- <param name="direction">The direction.</param>
- <param name="distance">The distance.</param>
- <returns>A new <strong>GeographicRectangle</strong> translated by the specified direction
- and distance.</returns>
- <example>
- This example defines a rectangle then shifts it Northeast by fifty kilometers.
- <code lang="VB" title="[New Example]">
- Dim Rectangle As New GeographicRectangle("30N, 105W, 1°, 5°")
- Rectangle = Rectangle.Translate(45, New Distance(50, DistanceUnit.Kilometers))
- </code>
- <code lang="CS" title="[New Example]">
- GeographicRectangle Rectangle = new GeographicRectangle("30N, 105W, 1°, 5°");
- Rectangle = Rectangle.Translate(45, New Distance(50, DistanceUnit.Kilometers));
- </code>
- </example>
- <remarks>This method is used to shift a rectangle to a new location while preserving its
- size.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.ToArray">
- <summary>
- Returns the points which form the rectangle.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.IsDisjointedFrom(DotSpatial.Positioning.GeographicRectangle)">
- <summary>
- Indicates if the rectangle does not intersect the specified rectangle.
- </summary>
- <param name="rectangle">The rectangle.</param>
- <returns><c>true</c> if [is disjointed from] [the specified rectangle]; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.IsEnclosing(DotSpatial.Positioning.GeographicRectangle)">
- <summary>
- Indicates if the specified GeographicRectangle is entirely within the current GeographicRectangle.
- </summary>
- <param name="rectangle">The rectangle.</param>
- <returns><c>true</c> if the specified rectangle is enclosing; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.IsEnclosing(DotSpatial.Positioning.Position)">
- <summary>
- Determines whether the specified position is enclosing.
- </summary>
- <param name="position">The position.</param>
- <returns><c>true</c> if the specified position is enclosing; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.CenterOn(DotSpatial.Positioning.Position)">
- <summary>
- Moves the GeographicRectangle so that the specified position is at its center.
- </summary>
- <param name="position">The position.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.FromCenter(DotSpatial.Positioning.Position,DotSpatial.Positioning.GeographicSize)">
- <summary>
- Creates a new rectangle of the specified size, centered on the specified position.
- </summary>
- <param name="position">The position.</param>
- <param name="size">The size.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.UnionWith(DotSpatial.Positioning.Position)">
- <summary>
- Expands the edges of the GeographicRectangle to contain the specified position.
- </summary>
- <param name="position">A <strong>Position</strong> object to surround.</param>
- <returns>A <strong>GeographicRectangle</strong> which contains the specified position.</returns>
- <remarks>If the specified position is already enclosed, the current instance will be returned.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.Inflate(DotSpatial.Positioning.GeographicSize)">
- <summary>
- Increases the size of the rectangle while maintaining its center point.
- </summary>
- <param name="size">The size.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.Inflate(DotSpatial.Positioning.Longitude,DotSpatial.Positioning.Latitude)">
- <summary>
- Increases the width and height of the rectangle by the specified amount.
- </summary>
- <param name="width">The width.</param>
- <param name="height">The height.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.Inflate(DotSpatial.Positioning.Latitude,DotSpatial.Positioning.Longitude)">
- <summary>
- Increases the width and height of the rectangle by the specified amount.
- </summary>
- <param name="height">The latitudinal height.</param>
- <param name="width">The longitudinal width.</param>
- <returns>A geographic size rectangle for the height and width specified.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.IntersectionOf(DotSpatial.Positioning.GeographicRectangle)">
- <summary>
- Calculates the rectangle created by the intersection of this and another rectangle.
- </summary>
- <param name="rectangle">The rectangle.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.IsIntersectingWith(DotSpatial.Positioning.GeographicRectangle)">
- <summary>
- Indicates if the rectangle's border crosses or shares the border of the specified rectangle.
- </summary>
- <param name="rectangle">The rectangle.</param>
- <returns><c>true</c> if [is intersecting with] [the specified rectangle]; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.IsOverlapping(DotSpatial.Positioning.GeographicRectangle)">
- <summary>
- Indicates if the specified GeographicRectangle shares any of the same 2D space as the current instance.
- </summary>
- <param name="rectangle">The rectangle.</param>
- <returns><c>true</c> if the specified rectangle is overlapping; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.IsOverlapping(DotSpatial.Positioning.Position)">
- <summary>
- Indicates if the specified Position is within the current instance.
- </summary>
- <param name="position">A <strong>Position</strong> to test against the current instance.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the position is inside of the current rectangle.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.UnionWith(DotSpatial.Positioning.GeographicRectangle)">
- <summary>
- Returns the combination of the current instance with the specified rectangle.
- </summary>
- <param name="rectangle">A <strong>GeographicRectangle</strong> to merge with the current instance.</param>
- <returns>A <strong>GeographicRectangle</strong> enclosing both rectangles.</returns>
- <remarks>This method returns the smallest possible rectangle which encloses the current instance as well as the specified rectangle.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.ToString(System.String)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format.</param>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
- </summary>
- <param name="obj">Another object to compare to.</param>
- <returns><c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.GetHashCode">
- <summary>
- Returns a unique code of the rectangle for hash tables.
- </summary>
- <returns>A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.UnionWith(DotSpatial.Positioning.GeographicRectangle,DotSpatial.Positioning.GeographicRectangle)">
- <summary>
- Returns a rectangle which encloses the two specified rectangles.
- </summary>
- <param name="first">A <strong>GeographicRectangle</strong> to merge with the second rectangle.</param>
- <param name="second">A <strong>GeographicRectangle</strong> to merge with the first rectangle.</param>
- <returns>A <strong>GeographicRectangle</strong> as a result of merging the two
- rectangles.</returns>
- <remarks>This method is typically used to combine two individual shapes into a single
- shape.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.IntersectionOf(DotSpatial.Positioning.GeographicRectangle,DotSpatial.Positioning.GeographicRectangle)">
- <summary>
- Returns the GeographicRectangle formed by the intersection of the two specified GeographicRectangles.
- </summary>
- <param name="first">The first.</param>
- <param name="second">The second.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.FromArray(DotSpatial.Positioning.Position[])">
- <summary>
- Returns a rectangle which encloses the specified points.
- </summary>
- <param name="positions">An array of PointD objects to enclose.</param>
- <returns>A <strong>RectangleD</strong> object enclosing the specified points.</returns>
- <remarks>This method is typically used to calculate a rectangle surrounding
- points which have been rotated. For example, if a rectangle is rotated by 45°, the
- total width it occupies is greater than it's own width.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.Parse(System.String)">
- <summary>
- Parses a string into a GeographicRectangle object.
- </summary>
- <param name="value">A <string>String</string> specifying geographic coordinates defining a rectangle.</param>
- <returns>A <strong>GeographicRectangle</strong> object using the specified coordinates.</returns>
- <remarks>This powerful method will convert points defining a rectangle in the form of a string into
- a GeographicRectangle object. The string can be</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.Parse(System.String,System.Globalization.CultureInfo)">
- <summary>
- Parses the specified value.
- </summary>
- <param name="value">The value.</param>
- <param name="culture">The culture.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.op_Explicit(System.String)~DotSpatial.Positioning.GeographicRectangle">
- <summary>
- Performs an explicit conversion from <see cref="T:System.String"/> to <see cref="T:DotSpatial.Positioning.GeographicRectangle"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.op_Explicit(DotSpatial.Positioning.GeographicRectangle)~System.String">
- <summary>
- Performs an explicit conversion from <see cref="T:DotSpatial.Positioning.GeographicRectangle"/> to <see cref="T:System.String"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.Equals(DotSpatial.Positioning.GeographicRectangle)">
- <summary>
- Indicates whether the current object is equal to another object of the same type.
- </summary>
- <param name="other">An object to compare with this object.</param>
- <returns>true if the current object is equal to the <paramref name="other"/> parameter; otherwise, false.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.ToString(System.String,System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format to use.-or- A null reference (Nothing in Visual Basic) to use the default format defined for the type of the <see cref="T:System.IFormattable"/> implementation.</param>
- <param name="formatProvider">The provider to use to format the value.-or- A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.</param>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.System#Xml#Serialization#IXmlSerializable#GetSchema">
- <summary>
- This method is reserved and should not be used. When implementing the IXmlSerializable interface, you should return null (Nothing in Visual Basic) from this method, and instead, if specifying a custom schema is required, apply the <see cref="T:System.Xml.Serialization.XmlSchemaProviderAttribute"/> to the class.
- </summary>
- <returns>An <see cref="T:System.Xml.Schema.XmlSchema"/> that describes the XML representation of the object that is produced by the <see cref="M:System.Xml.Serialization.IXmlSerializable.WriteXml(System.Xml.XmlWriter)"/> method and consumed by the <see cref="M:System.Xml.Serialization.IXmlSerializable.ReadXml(System.Xml.XmlReader)"/> method.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.WriteXml(System.Xml.XmlWriter)">
- <summary>
- Converts an object into its XML representation.
- </summary>
- <param name="writer">The <see cref="T:System.Xml.XmlWriter"/> stream to which the object is serialized.</param>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicRectangle.ReadXml(System.Xml.XmlReader)">
- <summary>
- Generates an object from its XML representation.
- </summary>
- <param name="reader">The <see cref="T:System.Xml.XmlReader"/> stream from which the object is deserialized.</param>
- </member>
- <member name="P:DotSpatial.Positioning.GeographicRectangle.Top">
- <summary>
- Returns the southern-most side of the rectangle.
- </summary>
- <value>A <see cref="T:DotSpatial.Positioning.Latitude"></see> object marking the southern-most latitude.</value>
- </member>
- <member name="P:DotSpatial.Positioning.GeographicRectangle.Bottom">
- <summary>
- Returns the southern-most latitude of the rectangle.
- </summary>
- <value>A <see cref="T:DotSpatial.Positioning.Latitude"></see> object marking the southern-most latitude.</value>
- </member>
- <member name="P:DotSpatial.Positioning.GeographicRectangle.Left">
- <summary>
- Returns the western-most side of the rectangle.
- </summary>
- <value>A <strong>Longitude</strong> indicating the left side of the rectangle.</value>
- </member>
- <member name="P:DotSpatial.Positioning.GeographicRectangle.Right">
- <summary>
- Returns the eastern-most side of the rectangle.
- </summary>
- <value>A <strong>Longitude</strong> indicating the right side of the rectangle.</value>
- </member>
- <member name="P:DotSpatial.Positioning.GeographicRectangle.Center">
- <summary>
- Returns the geographic center of the rectangle.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GeographicRectangle.AspectRatio">
- <summary>
- Returns the aspect ratio of the rectangle.
- </summary>
- <remarks>This property returns the ratio of the GeographicRectangles width to its height (width / height). This
- property gives an indication of the GeographicRectangle's shape. An aspect ratio of one indicates
- a square, whereas an aspect ratio of two indicates a GeographicRectangle which is twice as wide as
- it is high.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.GeographicRectangle.IsEmpty">
- <summary>
- Indicates if the rectangle has any value.
- </summary>
- <value>A <strong>Boolean</strong>, <strong>True</strong> if a metor the size of Rhode
- Island is about to crash into the Pacific Ocean just off the coast of Nicaragua but
- there will be no casualties because everyone was warned plenty of time in
- advance.</value>
- </member>
- <member name="P:DotSpatial.Positioning.GeographicRectangle.Hypotenuse">
- <summary>
- Returns the rectangle's hypotenuse.
- </summary>
- <remarks>The hypotenuse of a rectangle is a line connecting its northwest corner with its southeast corner.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.GeographicRectangle.Width">
- <summary>
- Returns the distance from the left to the right at the rectangle's middle latitude.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GeographicRectangle.Height">
- <summary>
- Returns the distance from the top to the bottom at the rectangle's middle longitude.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GeographicRectangle.HeightDegrees">
- <summary>
- Gets the height degrees.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GeographicRectangle.WidthDegrees">
- <summary>
- Gets the width degrees.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GeographicRectangle.Size">
- <summary>
- Returns the width and height of the rectangle.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GeographicRectangle.Northwest">
- <summary>
- Returns the northwestern corner of the rectangle.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GeographicRectangle.NorthCenter">
- <summary>
- Returns a point on the northern side, centered horizontally.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GeographicRectangle.SouthCenter">
- <summary>
- Returns a point on the southern side, centered horizontally.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GeographicRectangle.WestCenter">
- <summary>
- Returns a point on the western side, centered vertically.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GeographicRectangle.EastCenter">
- <summary>
- Returns a point on the eastern side, centered vertically.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GeographicRectangle.Northeast">
- <summary>
- Returns the northeastern corner of the rectangle.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GeographicRectangle.Southwest">
- <summary>
- Returns the southwestern corner of the rectangle.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GeographicRectangle.Southeast">
- <summary>
- Returns the southeastern corner of the rectangle.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.PointD">
- <summary>
- Represents a highly-precise pixel coordinate.
- </summary>
- <remarks><para>This class behaves similar to the <strong>PointF</strong> structure in the
- <strong>System.Drawing</strong> namespace, except that it supports double-precision
- values and can be converted into a geographic coordinate. This structure is also
- supported on the Compact Framework version of the <strong>DotSpatial.Positioning</strong>,
- whereas <strong>PointF</strong> is not.</para>
- <para>Instances of this class are guaranteed to be thread-safe because the class is
- immutable (its properties can only be changed via constructors).</para></remarks>
- </member>
- <member name="F:DotSpatial.Positioning.PointD._x">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.PointD._y">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.PointD.Empty">
- <summary>
- Returns a point with no value.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.PointD.Invalid">
- <summary>
- Represents an invalid coordinate.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.PointD.#ctor(System.Double,System.Double)">
- <summary>
- Creates a new instance for the specified coordinates.
- </summary>
- <param name="x">The x.</param>
- <param name="y">The y.</param>
- </member>
- <member name="M:DotSpatial.Positioning.PointD.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.PointD"/> struct.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:DotSpatial.Positioning.PointD.#ctor(System.String,System.Globalization.CultureInfo)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.PointD"/> struct.
- </summary>
- <param name="value">The value.</param>
- <param name="culture">The culture.</param>
- </member>
- <member name="M:DotSpatial.Positioning.PointD.#ctor(System.Xml.XmlReader)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.PointD"/> struct.
- </summary>
- <param name="reader">The reader.</param>
- </member>
- <member name="M:DotSpatial.Positioning.PointD.DistanceTo(DotSpatial.Positioning.PointD)">
- <summary>
- Calculates the distance to another pixel.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.PointD.IsAbove(DotSpatial.Positioning.PointD)">
- <summary>
- Indicates if the current instance is closer to the top of the monitor than the
- specified value.
- </summary>
- <param name="value">The value.</param>
- <returns><c>true</c> if the specified value is above; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.PointD.IsBelow(DotSpatial.Positioning.PointD)">
- <summary>
- Indicates if the current instance is closer to the bottom of the monitor than the
- specified value.
- </summary>
- <param name="value">The value.</param>
- <returns><c>true</c> if the specified value is below; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.PointD.IsLeftOf(DotSpatial.Positioning.PointD)">
- <summary>
- Indicates if the current instance is closer to the left of the monitor than the
- specified value.
- </summary>
- <param name="value">The value.</param>
- <returns><c>true</c> if [is left of] [the specified value]; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.PointD.IsRightOf(DotSpatial.Positioning.PointD)">
- <summary>
- Indicates if the current instance is closer to the right of the monitor than the
- specified value.
- </summary>
- <param name="value">The value.</param>
- <returns><c>true</c> if [is right of] [the specified value]; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.PointD.Mirror">
- <summary>
- Returns the current instance with its signs switched.
- </summary>
- <returns></returns>
- <remarks>This method returns a new point where the signs of X and Y are flipped. For example, if
- a point, represents (20, 40), this function will return (-20, -40).</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.PointD.ToString(System.String)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format.</param>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.PointD.Rotate(DotSpatial.Positioning.Angle)">
- <summary>
- Returns the current instance rotated about (0, 0).
- </summary>
- <param name="angle">The angle.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.PointD.Rotate(System.Double)">
- <summary>
- Returns the current instance rotated about (0, 0).
- </summary>
- <param name="angle">The angle.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.PointD.RotateAt(DotSpatial.Positioning.Angle,DotSpatial.Positioning.PointD)">
- <summary>
- Returns the current instance rotated about the specified point.
- </summary>
- <param name="angle">The angle.</param>
- <param name="center">The center.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.PointD.RotateAt(System.Double,DotSpatial.Positioning.PointD)">
- <summary>
- Rotates at.
- </summary>
- <param name="angle">The angle.</param>
- <param name="center">The center.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.PointD.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
- </summary>
- <param name="obj">Another object to compare to.</param>
- <returns><c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.PointD.GetHashCode">
- <summary>
- Returns a unique code used for hash tables.
- </summary>
- <returns>A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.PointD.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.PointD.Parse(System.String)">
- <summary>
- Parses the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.PointD.Parse(System.String,System.Globalization.CultureInfo)">
- <summary>
- Parses the specified value.
- </summary>
- <param name="value">The value.</param>
- <param name="culture">The culture.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.PointD.op_Equality(DotSpatial.Positioning.PointD,DotSpatial.Positioning.PointD)">
- <summary>
- Implements the operator ==.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.PointD.op_Inequality(DotSpatial.Positioning.PointD,DotSpatial.Positioning.PointD)">
- <summary>
- Implements the operator !=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.PointD.op_Addition(DotSpatial.Positioning.PointD,DotSpatial.Positioning.PointD)">
- <summary>
- Implements the operator +.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.PointD.op_Subtraction(DotSpatial.Positioning.PointD,DotSpatial.Positioning.PointD)">
- <summary>
- Implements the operator -.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.PointD.op_Multiply(DotSpatial.Positioning.PointD,DotSpatial.Positioning.PointD)">
- <summary>
- Implements the operator *.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.PointD.op_Division(DotSpatial.Positioning.PointD,DotSpatial.Positioning.PointD)">
- <summary>
- Implements the operator /.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.PointD.Add(DotSpatial.Positioning.PointD)">
- <summary>
- Returns the sum of two points by adding X and Y values together.
- </summary>
- <param name="offset">The offset.</param>
- <returns></returns>
- <remarks>This method adds the X and Y coordinates and returns a new point at that location.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.PointD.Add(System.Double,System.Double)">
- <summary>
- Returns the sum of two points by adding X and Y values together.
- </summary>
- <param name="offsetX">The offset X.</param>
- <param name="offsetY">The offset Y.</param>
- <returns></returns>
- <remarks>This method adds the X and Y coordinates and returns a new point at that location.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.PointD.Subtract(DotSpatial.Positioning.PointD)">
- <summary>
- Returns the difference of two points by subtracting the specified X and Y values.
- </summary>
- <param name="offset">The offset.</param>
- <returns></returns>
- <remarks>This method subtracts the X and Y coordinates and returns a new point at that location.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.PointD.Subtract(System.Double,System.Double)">
- <summary>
- Returns the difference of two points by subtracting the specified X and Y values.
- </summary>
- <param name="offsetX">The offset X.</param>
- <param name="offsetY">The offset Y.</param>
- <returns></returns>
- <remarks>This method subtracts the X and Y coordinates and returns a new point at that location.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.PointD.Multiply(DotSpatial.Positioning.PointD)">
- <summary>
- Returns the product of two points by multiplying X and Y values together.
- </summary>
- <param name="offset">The offset.</param>
- <returns></returns>
- <remarks>This method multiplies the X and Y coordinates together and returns a new point at that location. This
- is typically used to scale a point from one coordinate system to another.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.PointD.Multiply(System.Double,System.Double)">
- <summary>
- Multiplies the specified offset X.
- </summary>
- <param name="offsetX">The offset X.</param>
- <param name="offsetY">The offset Y.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.PointD.Divide(DotSpatial.Positioning.PointD)">
- <summary>
- Divides the specified offset.
- </summary>
- <param name="offset">The offset.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.PointD.Divide(System.Double,System.Double)">
- <summary>
- Divides the specified offset X.
- </summary>
- <param name="offsetX">The offset X.</param>
- <param name="offsetY">The offset Y.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.PointD.op_Explicit(DotSpatial.Positioning.PointD)~System.String">
- <summary>
- Performs an explicit conversion from <see cref="T:DotSpatial.Positioning.PointD"/> to <see cref="T:System.String"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.PointD.Equals(DotSpatial.Positioning.PointD)">
- <summary>
- Equalses the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.PointD.Equals(DotSpatial.Positioning.PointD,System.Int32)">
- <summary>
- Equalses the specified value.
- </summary>
- <param name="value">The value.</param>
- <param name="precision">The precision.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.PointD.ToString(System.String,System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format to use.-or- A null reference (Nothing in Visual Basic) to use the default format defined for the type of the <see cref="T:System.IFormattable"/> implementation.</param>
- <param name="formatProvider">The provider to use to format the value.-or- A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.</param>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.PointD.System#Xml#Serialization#IXmlSerializable#GetSchema">
- <summary>
- This method is reserved and should not be used. When implementing the IXmlSerializable interface, you should return null (Nothing in Visual Basic) from this method, and instead, if specifying a custom schema is required, apply the <see cref="T:System.Xml.Serialization.XmlSchemaProviderAttribute"/> to the class.
- </summary>
- <returns>An <see cref="T:System.Xml.Schema.XmlSchema"/> that describes the XML representation of the object that is produced by the <see cref="M:System.Xml.Serialization.IXmlSerializable.WriteXml(System.Xml.XmlWriter)"/> method and consumed by the <see cref="M:System.Xml.Serialization.IXmlSerializable.ReadXml(System.Xml.XmlReader)"/> method.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.PointD.WriteXml(System.Xml.XmlWriter)">
- <summary>
- Converts an object into its XML representation.
- </summary>
- <param name="writer">The <see cref="T:System.Xml.XmlWriter"/> stream to which the object is serialized.</param>
- </member>
- <member name="M:DotSpatial.Positioning.PointD.ReadXml(System.Xml.XmlReader)">
- <summary>
- Generates an object from its XML representation.
- </summary>
- <param name="reader">The <see cref="T:System.Xml.XmlReader"/> stream from which the object is deserialized.</param>
- </member>
- <member name="P:DotSpatial.Positioning.PointD.X">
- <summary>
- Gets or sets the x-coordinate of this PointD.
- </summary>
- <value>The X.</value>
- </member>
- <member name="P:DotSpatial.Positioning.PointD.Lam">
- <summary>
- For projected coordinates, this is the factor Lamda or the longitude parameter.
- For readability only, the value is X.
- </summary>
- <value>The lam.</value>
- </member>
- <member name="P:DotSpatial.Positioning.PointD.Y">
- <summary>
- Gets or sets the x-coordinate of this PointD.
- </summary>
- <value>The Y.</value>
- </member>
- <member name="P:DotSpatial.Positioning.PointD.Phi">
- <summary>
- For projected coordinates, this is the factor Phi or the latitude parameter.
- For readability only, the value is Y.
- </summary>
- <value>The phi.</value>
- </member>
- <member name="P:DotSpatial.Positioning.PointD.IsEmpty">
- <summary>
- Returns whether the current instance has no value.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.PointD.IsInvalid">
- <summary>
- Returns whether the current instance has an invalid value.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.Properties.Resources">
- <summary>
- A strongly-typed resource class, for looking up localized strings, etc.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.ResourceManager">
- <summary>
- Returns the cached ResourceManager instance used by this class.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.Culture">
- <summary>
- Overrides the current thread's CurrentUICulture property for all
- resource lookups using this strongly typed resource class.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.Angle_ExtraCharactersWereEncountered">
- <summary>
- Looks up a localized string similar to Extra characters were encountered while parsing an angular measurement. Only hours, minutes, and seconds are allowed..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.Angle_InvalidFormat">
- <summary>
- Looks up a localized string similar to The specified format could not be fully recognized as an angular measurement..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.Angle_InvalidInterval">
- <summary>
- Looks up a localized string similar to The interval must be a value greater than zero, between 0 and 60..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.Angle_InvalidToStringFormat">
- <summary>
- Looks up a localized string similar to Invalid format for Angle.ToString() method..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.Angle_OnlyRightmostIsDecimal">
- <summary>
- Looks up a localized string similar to Only the right-most number of a sexagesimal measurement can be a fractional value..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.Angle_TypeMismatch">
- <summary>
- Looks up a localized string similar to An Angle can only be compared with Angle, Double, or String values..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.Area_InvalidFormat">
- <summary>
- Looks up a localized string similar to The specified format could not be fully recognized as an area measurement..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.Area_InvalidNumericPortion">
- <summary>
- Looks up a localized string similar to The numeric portion of the area measurement could not be recognized..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.Area_InvalidUnitPortion">
- <summary>
- Looks up a localized string similar to The unit portion of the area measurement could not be recognized..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.Azimuth_ConversionNotImplemented">
- <summary>
- Looks up a localized string similar to The azimuth cannot be converted to a because no conversion has been implemented internally. Please contact info@DotSpatial.Positioning.com with the source and destination unit types..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.Azimuth_InvalidComparisonType">
- <summary>
- Looks up a localized string similar to An Azimuth can only be compared with another Azimuth, or a Double..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.Common_Empty">
- <summary>
- Looks up a localized string similar to Empty.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.Common_Infinity">
- <summary>
- Looks up a localized string similar to Infinity.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.Distance_ConversionNotImplemented">
- <summary>
- Looks up a localized string similar to The distance cannot be converted because no conversion has been implemented internally. Please contact info@DotSpatial.Positioning.com with the source and destination unit types..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.Distance_InvalidComparisonType">
- <summary>
- Looks up a localized string similar to Distance objects can only be compared with other Distance objects..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.Distance_InvalidFormat">
- <summary>
- Looks up a localized string similar to The specified format could not be fully recognized as a distance measurement..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.Distance_InvalidNumericPortion">
- <summary>
- Looks up a localized string similar to The numeric portion of the distance measurement could not be recognized..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.Distance_InvalidUnitPortion">
- <summary>
- Looks up a localized string similar to The unit portion of the distance measurement could not be recognized..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.DotSpatial_PositioningLicense_InvalidLicenseKey">
- <summary>
- Looks up a localized string similar to The specified license key is invalid. Please contact DotSpatial.Positioning to look up license keys you have purchased: http://dotspatial.codeplex.com/Secured/LicenseKeys.aspx..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.DotSpatial_PositioningLicenseProvider_AskToGoOnline">
- <summary>
- Looks up a localized string similar to Would you like to go online now to activate your trial? An email address will not be required unless you're behind a proxy server..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.DotSpatial_PositioningLicenseProvider_ExecutionStoppedDialogTitle">
- <summary>
- Looks up a localized string similar to {0} Stopped Execution.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.DotSpatial_PositioningLicenseProvider_ExecutionStoppedNeedKeys">
- <summary>
- Looks up a localized string similar to Execution of the current application has been stopped by an exception, but this message will go away once trial license keys have been provided, or the reference the assembly has been removed..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.DotSpatial_PositioningLicenseProvider_ExecutionStoppedVisitWebSite">
- <summary>
- Looks up a localized string similar to Execution of the current application has been stopped by an exception, but this message will go away once trial license keys have been provided. Please visit http://dotspatial.codeplex.com/FreeTrialLicenseKeys.aspx to obtain free license keys for any of our products..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.DotSpatial_PositioningLicenseProvider_GoOnlineForTrialKeys">
- <summary>
- Looks up a localized string similar to Do you want to go online to activate free trial license keys?.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.DotSpatial_PositioningLicenseProvider_InvalidLicenseKey">
- <summary>
- Looks up a localized string similar to An invalid license key was encountered while attempting to grant a license to a DotSpatial.Positioning object. The invalid key is "{0}".
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.DotSpatial_PositioningLicenseProvider_InvalidMajorVersion">
- <summary>
- Looks up a localized string similar to The license key for {0} is valid for a different major version of the software. Please visit http://dotspatial.codeplex.com/Shop for pricing on products for this version. Updates to DotSpatial.Positioning software are always free for each minor version change (e.g. versions 2.0 through 2.999).
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.DotSpatial_PositioningLicenseProvider_InvalidPlatform">
- <summary>
- Looks up a localized string similar to The license key for {0} is not valid for the current .NET platform. Please contact support@DotSpatial.Positioning.com for assistance or visit http://dotspatial.codeplex.com/Shop for pricing on products for this platform..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.DotSpatial_PositioningLicenseProvider_LicenseKeyDialogTitle">
- <summary>
- Looks up a localized string similar to A DotSpatial.Positioning License Key Is Required.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.DotSpatial_PositioningLicenseProvider_LicenseKeyIsRequired">
- <summary>
- Looks up a localized string similar to A license key is required for this DotSpatial.Positioning assembly to function. You can activate a free thirty-day trial online at http://dotspatial.codeplex.com..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.DotSpatial_PositioningLicenseProvider_ValidOwnerLicense">
- <summary>
- Looks up a localized string similar to A valid owner license has been granted for {0}.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.DotSpatial_PositioningLicenseProvider_ValidTrialLicense">
- <summary>
- Looks up a localized string similar to A trial license has been granted for {0} until {1}.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.GeographicSize_InvalidFormat">
- <summary>
- Looks up a localized string similar to The specified value could not be parsed into a GeographicSize object because two delimited values are required (Width, Height)..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.Latitude_DecimalOrSexagesimalRequired">
- <summary>
- Looks up a localized string similar to The Parse method requires a decimal or sexagesimal measurement..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.Latitude_InvalidComparisonType">
- <summary>
- Looks up a localized string similar to A Latitude can only be compared with another Latitude, Double or String..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.Latitude_InvalidFormat">
- <summary>
- Looks up a localized string similar to The specified format could not be fully recognized as a latitude..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.Latitude_InvalidHemisphere">
- <summary>
- Looks up a localized string similar to The hemisphere specified for the ToHemisphere method cannot be 'None'. A value of 'North' or 'South' is required..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.Latitude_LatitudeHemisphereExpected">
- <summary>
- Looks up a localized string similar to The hemisphere specified indicates a longitude but a latitude is expected..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.Latitude_OnlyRightmostIsDecimal">
- <summary>
- Looks up a localized string similar to Only the right-most number can be a floating-point value..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.Longitude_DecimalOrSexagesimalRequired">
- <summary>
- Looks up a localized string similar to The Parse method requires a decimal or sexagesimal measurement..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.Longitude_InvalidComparisonType">
- <summary>
- Looks up a localized string similar to A Longitude can only be compared with another Longitude, Double or String..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.Longitude_InvalidFormat">
- <summary>
- Looks up a localized string similar to The specified format could not be fully recognized as a longitude..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.Longitude_InvalidHemisphere">
- <summary>
- Looks up a localized string similar to The hemisphere specified for the ToHemisphere method cannot be 'None'. A value of 'East' or 'West' is required..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.Longitude_LongitudeHemisphereExpected">
- <summary>
- Looks up a localized string similar to The hemisphere specified indicates a latitude but a longitude is expected..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.Longitude_OnlyRightmostIsDecimal">
- <summary>
- Looks up a localized string similar to Only the right-most number can be a floating-point value..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.Position_DistanceTo_Null_Ellipsoid">
- <summary>
- Looks up a localized string similar to The Position.DistanceTo method requires a non-null ellipsoid parameter..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.Position_DuplicateZoneInformation">
- <summary>
- Looks up a localized string similar to Duplicate UTM zone information was found when trying to parse a UTM coordinate..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.Position_InvalidFormat">
- <summary>
- Looks up a localized string similar to The specified format could not be fully recognized as a spherical or UTM coordinate..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.Position_InvalidUTMCoordinate">
- <summary>
- Looks up a localized string similar to The specified string could not be recognized as a valid UTM coordinate..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.Position_InvalidZoneLetter">
- <summary>
- Looks up a localized string similar to A UTM zone letter can only be one character long. Multiple characters were encountered..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.Position_InvalidZoneNumber">
- <summary>
- Looks up a localized string similar to A UTM zone number can only be one or two characters long. Multiple characters were encountered..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.Position_NoUTMZoneLetter">
- <summary>
- Looks up a localized string similar to No UTM zone letter could be located within the specified string..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.Position_NoUTMZoneNumber">
- <summary>
- Looks up a localized string similar to No UTM zone number could be located within the specified string..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.PositionCollection_AreaError">
- <summary>
- Looks up a localized string similar to The total area could not be calculated..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.PositionCollection_DistanceError">
- <summary>
- Looks up a localized string similar to The total distance could not be calculated..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.PositionCollection_RangeMustBeAboveZero">
- <summary>
- Looks up a localized string similar to The range must be a distance greater than or equal to zero..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.RectangleD_HeightMustBeAboveZero">
- <summary>
- Looks up a localized string similar to Height must be a number greater than zero..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.RectangleD_InvalidFormat">
- <summary>
- Looks up a localized string similar to The specified value could not be parsed into a RectangleD object because four delimited values are required (Top, Left, Bottom, Right)..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.RectangleD_WidthMustBeAboveZero">
- <summary>
- Looks up a localized string similar to Width must be a number greater than zero..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.SizeD_InvalidFormat">
- <summary>
- Looks up a localized string similar to Two values must be supplied to create a SizeD object from a string. Verify that the CultureInfo passed matches the delimiter used to separate the values..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.Speed_InvalidFormat">
- <summary>
- Looks up a localized string similar to The specified format could not be fully recognized as a speed measurement..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.Speed_InvalidNumericPortion">
- <summary>
- Looks up a localized string similar to The numeric portion of the speed measurement could not be recognized..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.Speed_InvalidUnitPortion">
- <summary>
- Looks up a localized string similar to The unit portion of the speed measurement could not be recognized..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.TrialLicense_ExpirationDate">
- <summary>
- Looks up a localized string similar to Trial License Expires {0} ({1} days remaining).
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.TrialLicense_ExtendTrial">
- <summary>
- Looks up a localized string similar to Would you like to go online to try and extend your free trial now?.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.TrialLicense_InvalidLicenseKey">
- <summary>
- Looks up a localized string similar to Purchased license keys cannot be used as trial license keys. Please use another key or contact DotSpatial.Positioning for further assistance..
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.TrialLicense_LicenseExpired">
- <summary>
- Looks up a localized string similar to Sorry, the trial key for the following DotSpatial.Positioning assembly expired on {0}. You can go online to try and extend your trial another month, or you can purchase a license key online.\r\n\r\n{1}.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Properties.Resources.TrialLicense_LicenseExpiredDialogTitle">
- <summary>
- Looks up a localized string similar to DotSpatial.Positioning Trial Has Expired.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.Percent">
- <summary>
- Represents a number as a fraction of one hundred.
- </summary>
- <example>
- These examples create <strong>Percent</strong> objects using different
- constructors.
- <code lang="CS" description="This example creates a percentage of 25% using the decimal value 0.25.">
- // Create a percentage of 25%
- Percent twentyFivePercent = new Percent(0.25f);
- </code>
- <code lang="VB" description="This example creates a percentage of 25% using the decimal value 0.25.">
- ' Create a percentage of 25%
- Dim TwentyFivePercent As New Percent(0.25)
- </code>
- <code lang="CS" description="This example creates a percentage of 25.4% using a string. Since not all cultures use a period (.) as a separator, a CultureInfo object is passed.">
- // Create a percentage of 25%
- Percent twentyFivePercent = New Percent("25.4%", CultureInfo.InvariantCulture);
- </code>
- <code lang="VB" description="This example creates a percentage of 25.4% using a string. Since not all cultures use a period (.) as a separator, a CultureInfo object is passed.">
- ' Create a percentage of 25%
- Dim TwentyFivePercent As New Percent("25.5%", CultureInfo.InvariantCulture)
- </code>
- </example>
- <remarks><para>This class is used to express one quantity relative to another quantity.
- Percentage values are presented in string form using the percent symbol of the
- local culture (usually the percent symbol "%"). When percentage values are
- expressed in decimal form the value is divided by one hundred. In other words, the
- value "25%" is equivalent to 0.25.</para>
- <para>This class is culture-sensitive, meaning that both the percent symbol and the
- numeric format is interpreted and presented differently depending on the local
- culture. As a result, the <strong>CultureInfo</strong> object should be used any
- time a value is parsed from a <strong>String</strong> or output as a String using
- the <strong>ToString</strong> method.</para></remarks>
- </member>
- <member name="F:DotSpatial.Positioning.Percent._value">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Percent.Zero">
- <summary>
- Represents a percentage value of zero.
- </summary>
- <value>
- A <strong>Percentage</strong> value, representing <strong>0%</strong> and
- <strong>0.0</strong>.
- </value>
- </member>
- <member name="F:DotSpatial.Positioning.Percent.OneHundredPercent">
- <summary>
- Represents a value of one hundred percent.
- </summary>
- <value>
- A <strong>Percentage</strong> value, meaning <strong>100%</strong> or
- <strong>1.0</strong>.
- </value>
- </member>
- <member name="F:DotSpatial.Positioning.Percent.FiftyPercent">
- <summary>
- Represents a percentage of fifty percent.
- </summary>
- <value>
- A <strong>Percentage</strong> value, representing <strong>50%</strong> or
- <strong>0.5</strong>.
- </value>
- </member>
- <member name="F:DotSpatial.Positioning.Percent.TenPercent">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Percent.TwentyPercent">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Percent.ThirtyPercent">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Percent.FortyPercent">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Percent.SixtyPercent">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Percent.SeventyPercent">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Percent.EightyPercent">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Percent.NinetyPercent">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Percent.TwentyFivePercent">
- <summary>
- Represents a value of twenty-five percent.
- </summary>
- <value>
- A <strong>Percentage</strong> value, representing <strong>25%</strong> or
- <strong>0.25</strong>.
- </value>
- </member>
- <member name="M:DotSpatial.Positioning.Percent.#ctor(System.Single)">
- <summary>
- Creates a new instance using the specified value.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Percent.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.Percent"/> struct.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Percent.#ctor(System.String,System.Globalization.CultureInfo)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.Percent"/> struct.
- </summary>
- <param name="value">The value.</param>
- <param name="culture">The culture.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Percent.PercentageOf(System.Double)">
- <summary>
- Returns the percentage of the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Percent.PercentageOf(System.Single)">
- <summary>
- Returns the percentage of the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Percent.PercentageOf(System.Int32)">
- <summary>
- Returns the percentage of the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Percent.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
- </summary>
- <param name="obj">Another object to compare to.</param>
- <returns><c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Percent.GetHashCode">
- <summary>
- Returns a hash code for this instance.
- </summary>
- <returns>A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Percent.ToString">
- <summary>
- Returns the percentage formatted as a <strong>String</strong>.
- </summary>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Percent.op_Equality(DotSpatial.Positioning.Percent,DotSpatial.Positioning.Percent)">
- <summary>
- Implements the operator ==.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Percent.op_Equality(DotSpatial.Positioning.Percent,System.Single)">
- <summary>
- Implements the operator ==.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Percent.op_Inequality(DotSpatial.Positioning.Percent,DotSpatial.Positioning.Percent)">
- <summary>
- Implements the operator !=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Percent.op_Inequality(DotSpatial.Positioning.Percent,System.Single)">
- <summary>
- Implements the operator !=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Percent.op_Multiply(DotSpatial.Positioning.Percent,System.Double)">
- <summary>
- Returns the percentage of the specified value.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Percent.op_Multiply(DotSpatial.Positioning.Percent,System.Single)">
- <summary>
- Returns the percentage of the specified value.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Percent.op_Multiply(DotSpatial.Positioning.Percent,System.Int32)">
- <summary>
- Returns the percentage of the specified value.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Percent.Multiply(System.Double)">
- <summary>
- Returns the percentage of the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Percent.Multiply(System.Single)">
- <summary>
- Returns the percentage of the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Percent.Multiply(System.Int32)">
- <summary>
- Returns the percentage of the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Percent.op_Explicit(System.Single)~DotSpatial.Positioning.Percent">
- <summary>
- Converts the specified value to a <strong>Percent</strong> object.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Percent.op_Explicit(System.Double)~DotSpatial.Positioning.Percent">
- <summary>
- Converts the specified value to a <strong>Percent</strong> object.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Percent.op_Explicit(System.Int32)~DotSpatial.Positioning.Percent">
- <summary>
- Converts the specified value to a <strong>Percent</strong> object.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Percent.op_Explicit(System.String)~DotSpatial.Positioning.Percent">
- <summary>
- Performs an explicit conversion from <see cref="T:System.String"/> to <see cref="T:DotSpatial.Positioning.Percent"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Percent.ToString(System.String,System.IFormatProvider)">
- <summary>
- Returns the percentage formatted as a <strong>String</strong>.
- </summary>
- <param name="format">The format to use.-or- A null reference (Nothing in Visual Basic) to use the default format defined for the type of the <see cref="T:System.IFormattable"/> implementation.</param>
- <param name="formatProvider">The provider to use to format the value.-or- A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.</param>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Percent.Equals(DotSpatial.Positioning.Percent)">
- <summary>
- Indicates whether the current object is equal to another object of the same type.
- </summary>
- <param name="other">An object to compare with this object.</param>
- <returns>true if the current object is equal to the <paramref name="other"/> parameter; otherwise, false.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Percent.CompareTo(DotSpatial.Positioning.Percent)">
- <summary>
- Compares the current object with another object of the same type.
- </summary>
- <param name="other">An object to compare with this object.</param>
- <returns>A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has the following meanings:
- Value
- Meaning
- Less than zero
- This object is less than the <paramref name="other"/> parameter.
- Zero
- This object is equal to <paramref name="other"/>.
- Greater than zero
- This object is greater than <paramref name="other"/>.</returns>
- </member>
- <member name="P:DotSpatial.Positioning.Percent.Value">
- <summary>
- Returns the decimal value of the percentage.
- </summary>
- <remarks>The value of a <strong>Percent</strong> object is 1/100th of the
- percentage. In other words, if the percentage is "15%" then the <strong>Value</strong>
- property will return <strong>0.15</strong>, and a percentage of "100%" means a
- <strong>Value</strong> of <strong>1.0</strong>.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Percent.IsEmpty">
- <summary>
- Returns whether the value equals zero.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.Datum">
- <summary>
- Represents a coordinate system based on interpretations of the Earth's shape and size.
- </summary>
- <seealso cref="P:DotSpatial.Positioning.Datum.Ellipsoid">Ellipsoid Class</seealso>
- <remarks><para>Over the course of history, advances in technology have given people the
- ability to more accurately measure the shape and size of the Earth. Since countries
- have built significant infrastructure based upon older coordinate systems, they
- cannot immediately abandon them in favor of new ones. As a result, there are now
- over fifty interpretations of Earth's shape and size in use all over the
- world.</para>
- <para>Some datums, such as World Geodetic System 1984 (or WGS84 for short) are
- becoming more widely used throughout the world, and this datum is used by nearly
- all GPS devices. However, while the world is slowly standardizing its datums, some
- datums will not be abandoned because they remain quite accurate for a specific,
- local area.</para>
- <para>A datum on its own is nothing more than a more granular interpretation of an
- ellipsoid. Typically, more specific coordinate transformation information is
- further associated with a datum to produce meaningful information. For example,
- Helmert and Molodensky coordinate conversion formulas use several local conversion
- parameters for each datum.</para>
- <para>Instances of this class are guaranteed to be thread-safe because the class is
- immutable (its properties can only be set via constructors).</para></remarks>
- </member>
- <member name="F:DotSpatial.Positioning.Datum._epsgNumber">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum._primeMeridian">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum._ellipsoid">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum._name">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum._datums">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum._epsgDatums">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.UnspecifiedAiry1830">
- <summary>
- Not specified (based on the Airy 1830 ellipsoid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.UnspecifiedAiryModified1849">
- <summary>
- Not specified (based on the Airy Modified 1849 ellipsoid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.UnspecifiedAustralianNationalSpheroid">
- <summary>
- Not specified (based on the Australian National Spheroid ellipsoid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.UnspecifiedBessel1841">
- <summary>
- Not specified (based on the Bessel 1841 ellipsoid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.UnspecifiedBesselModified">
- <summary>
- Not specified (based on the Bessel Modified ellipsoid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.UnspecifiedBesselNamibiaGlm">
- <summary>
- Not specified (based on the Bessel Namibia (GLM) ellipsoid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.UnspecifiedClarke1858">
- <summary>
- Not specified (based on the Clarke 1858 ellipsoid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.UnspecifiedClarke1866">
- <summary>
- Not specified (based on the Clarke 1866 ellipsoid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.UnspecifiedClarke1866Michigan">
- <summary>
- Not specified (based on the Clarke 1866 Michigan ellipsoid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.UnspecifiedClarke1880Benoit">
- <summary>
- Not specified (based on the Clarke 1880 (Benoit) ellipsoid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.UnspecifiedClarke1880IGN">
- <summary>
- Not specified (based on the Clarke 1880 (IGN) ellipsoid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.UnspecifiedClarke1880RGS">
- <summary>
- Not specified (based on the Clarke 1880 (RGS) ellipsoid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.UnspecifiedClarke1880Arc">
- <summary>
- Not specified (based on the Clarke 1880 (Arc) ellipsoid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.UnspecifiedClarke1880SGA1922">
- <summary>
- Not specified (based on the Clarke 1880 (SGA 1922) ellipsoid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.UnspecifiedEverest1937Adjustment">
- <summary>
- Not specified (based on the Everest 1830 (1937 Adjustment) ellipsoid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.UnspecifiedEverest1967Definition">
- <summary>
- Not specified (based on the Everest 1830 (1967 Definition) ellipsoid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.UnspecifiedEverest1830Modified">
- <summary>
- Not specified (based on the Everest 1830 Modified ellipsoid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.UnspecifiedGrs1980">
- <summary>
- Not specified (based on the GRS 1980 ellipsoid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.UnspecifiedHelmert1906">
- <summary>
- Not specified (based on the Helmert 1906 ellipsoid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.UnspecifiedIndonesianNationalSpheroid">
- <summary>
- Not specified (based on the Indonesian National Spheroid ellipsoid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.UnspecifiedInternational1924">
- <summary>
- Not specified (based on the International 1924 ellipsoid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.UnspecifiedKrassowsky1940">
- <summary>
- Not specified (based on the Krassowsky 1940 ellipsoid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.UnspecifiedNwl9D">
- <summary>
- Not specified (based on the NWL 9D ellipsoid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.UnspecifiedPlessis1817">
- <summary>
- Not specified (based on the Plessis 1817 ellipsoid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.UnspecifiedStruve1860">
- <summary>
- Not specified (based on the Struve 1860 ellipsoid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.UnspecifiedWarOffice">
- <summary>
- Not specified (based on the War Office ellipsoid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.UnspecifiedWGS84">
- <summary>
- Not specified (based on the WGS 84 ellipsoid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.UnspecifiedGem10C">
- <summary>
- Not specified (based on the GEM 10C ellipsoid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.UnspecifiedOsu86F">
- <summary>
- Not specified (based on the OSU86F ellipsoid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.UnspecifiedOsu91A">
- <summary>
- Not specified (based on the OSU91A ellipsoid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.UnspecifiedClarke1880">
- <summary>
- Not specified (based on the Clarke 1880 ellipsoid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.UnspecifiedSphere">
- <summary>
- Not specified (based on the Sphere ellipsoid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.UnspecifiedGrs1967">
- <summary>
- Not specified (based on the GRS 1967 ellipsoid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.UnspecifiedAverageTerrestrialSystem1977">
- <summary>
- Not specified (based on the Average Terrestrial System 1977 ellipsoid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.UnspecifiedEverest1830Definition">
- <summary>
- Not specified (based on the Everest (1830 Definition) ellipsoid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.UnspecifiedWGS72">
- <summary>
- Not specified (based on the WGS 72 ellipsoid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.UnspecifiedEverest18301962Definition">
- <summary>
- Not specified (based on the Everest 1830 (1962 Definition) ellipsoid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.UnspecifiedEverest1975Definition">
- <summary>
- Not specified (based on the Everest 1830 (1975 Definition) ellipsoid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.UnspecifiedGrs1980AuthalicSphere">
- <summary>
- Not specified (based on the GRS 1980 Authalic Sphere ellipsoid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.UnspecifiedClarke1866AuthalicSphere">
- <summary>
- Not specified (based on the Clarke 1866 Authalic Sphere ellipsoid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.UnspecifiedInternational1924AuthalicSphere">
- <summary>
- Not specified (based on the International 1924 Authalic Sphere ellipsoid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.UnspecifiedHughes1980">
- <summary>
- Not specified (based on the Hughes 1980 ellipsoid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Greek">
- <summary>
- Greek
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.GreekGeodeticReferenceSystem1987">
- <summary>
- Greek Geodetic Reference System 1987
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.AverageTerrestrialSystem1977">
- <summary>
- Average Terrestrial System 1977
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Kartastokoordinaattijarjestelma1966">
- <summary>
- Kartastokoordinaattijarjestelma (1966)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Riketskoordinatsystem1990">
- <summary>
- Rikets koordinatsystem 1990
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Samboja">
- <summary>
- Samboja
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Lithuania1994Etrs89">
- <summary>
- Lithuania 1994 (ETRS89)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Tete">
- <summary>
- Tete
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Madzansua">
- <summary>
- Madzansua
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Observatario">
- <summary>
- Observatario
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.MoznetItrf94">
- <summary>
- Moznet (ITRF94)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Indian1960">
- <summary>
- Indian 1960
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Indian">
- <summary>
- Represents the Indian datum.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.FinalDatum1958">
- <summary>
- Final Datum 1958
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Estonia1992">
- <summary>
- Estonia 1992
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.PdoSurveyDatum1993">
- <summary>
- PDO Survey Datum 1993
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.OldHawaiian">
- <summary>
- Old Hawaiian
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.StLawrenceIsland">
- <summary>
- St. Lawrence Island
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.StPaulIsland">
- <summary>
- St. Paul Island
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.StGeorgeIsland">
- <summary>
- St. George Island
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.PuertoRico">
- <summary>
- Puerto Rico
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Nad83CanadianSpatialReferenceSystem">
- <summary>
- NAD83 Canadian Spatial Reference System
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Israel">
- <summary>
- Israel
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Locodjo1965">
- <summary>
- Locodjo 1965
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Abidjan1987">
- <summary>
- Abidjan 1987
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Kalianpur1937">
- <summary>
- Kalianpur 1937
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Kalianpur1962">
- <summary>
- Kalianpur 1962
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Kalianpur1975">
- <summary>
- Kalianpur 1975
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Hanoi1972">
- <summary>
- Hanoi 1972
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Hartebeesthoek94">
- <summary>
- Hartebeesthoek94
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Ch1903">
- <summary>
- CH1903
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Ch1903Plus">
- <summary>
- CH1903+
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.SwissTerrestrialReferenceFrame1995">
- <summary>
- Swiss Terrestrial Reference Frame 1995
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Nad83HighAccuracyRegionalNetwork">
- <summary>
- NAD83 (High Accuracy Regional Network)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Rassadiran">
- <summary>
- Rassadiran
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.EuropeanDatum1977">
- <summary>
- European Datum 1950(1977)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Dabola1981">
- <summary>
- Dabola 1981
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.JednotneTrigonometrickeSiteKatastralni">
- <summary>
- Jednotne Trigonometricke Site Katastralni
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.MountDillon">
- <summary>
- Mount Dillon
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Naparima1955">
- <summary>
- Naparima 1955
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.EuropeanLibyanDatum1979">
- <summary>
- European Libyan Datum 1979
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.ChosMalal1914">
- <summary>
- Chos Malal 1914
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.PampadelCastillo">
- <summary>
- Pampa del Castillo
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.KoreanDatum1985">
- <summary>
- Korean Datum 1985
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.YemenNationalGeodeticNetwork1996">
- <summary>
- Yemen National Geodetic Network 1996
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.SouthYemen">
- <summary>
- South Yemen
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Bissau">
- <summary>
- Bissau
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.KoreanDatum1995">
- <summary>
- Korean Datum 1995
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.NewZealandGeodeticDatum2000">
- <summary>
- New Zealand Geodetic Datum 2000
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Accra">
- <summary>
- Accra
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.AmericanSamoa1962">
- <summary>
- American Samoa 1962
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.SistemadeReferenciaGeocentricoparaAmericadelSur1995">
- <summary>
- Sistema de Referencia Geocentrico para America del Sur 1995
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.ReseauGeodesiqueFrancais1993">
- <summary>
- Reseau Geodesique Francais 1993
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.PosicionesGeodesicasArgentinas">
- <summary>
- Posiciones Geodesicas Argentinas
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Irenet95">
- <summary>
- IRENET95
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.SierraLeoneColony1924">
- <summary>
- Sierra Leone Colony 1924
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.SierraLeone1968">
- <summary>
- Sierra Leone 1968
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.AustralianAntarcticDatum1998">
- <summary>
- Australian Antarctic Datum 1998
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Pulkovo1983">
- <summary>
- Pulkovo 1942/83
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Pulkovo1958">
- <summary>
- Pulkovo 1942/58
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Estonia1997">
- <summary>
- Estonia 1997
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Luxembourg1930">
- <summary>
- Luxembourg 1930
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.AzoresOccidentalIslands1939">
- <summary>
- Azores Occidental Islands 1939
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.ObservatorioMeteorologico1939">
- <summary>
- Represents the Observatorio Meteorologico datum of 1939.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.AzoresCentralIslands1948">
- <summary>
- Azores Central Islands 1948
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.GraciosaBaseSw1948">
- <summary>
- Represents the Graciosa Base SW datum of 1948.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.AzoresOrientalIslands1940">
- <summary>
- Azores Oriental Islands 1940
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Madeira1936">
- <summary>
- Madeira 1936
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Osni1952">
- <summary>
- OSNI 1952
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.RedGeodesicaVenezolana">
- <summary>
- Red Geodesica Venezolana
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.PosicionesGeodesicasArgentinas1998">
- <summary>
- Posiciones Geodesicas Argentinas 1998
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Albanian1987">
- <summary>
- Albanian 1987
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Douala1948">
- <summary>
- Douala 1948
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Manoca1962">
- <summary>
- Manoca 1962
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Qornoq1927">
- <summary>
- Qornoq 1927
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Scoresbysund1952">
- <summary>
- Scoresbysund 1952
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Ammassalik1958">
- <summary>
- Ammassalik 1958
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.GarouaRGS">
- <summary>
- Garoua
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Kousseri">
- <summary>
- Kousseri
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Egypt1930">
- <summary>
- Egypt 1930
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Pulkovo1995">
- <summary>
- Pulkovo 1995
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Adindan">
- <summary>
- Adindan
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.AustralianGeodeticDatum1966">
- <summary>
- Australian Geodetic Datum 1966
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.AustralianGeodeticDatum1984">
- <summary>
- Australian Geodetic Datum 1984
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.AinelAbd1970">
- <summary>
- Ain el Abd 1970
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Afgooye">
- <summary>
- Afgooye
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Agadez">
- <summary>
- Agadez
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Lisbon1937">
- <summary>
- Lisbon 1937
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Aratu">
- <summary>
- Aratu
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Arc1950">
- <summary>
- Arc 1950
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Arc1960">
- <summary>
- Arc 1960
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Batavia">
- <summary>
- Batavia
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Barbados1938">
- <summary>
- Barbados 1938
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Beduaram">
- <summary>
- Beduaram
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Beijing1954">
- <summary>
- Beijing 1954
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.ReseauNationalBelge1950">
- <summary>
- Reseau National Belge 1950
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Bermuda1957">
- <summary>
- Bermuda 1957
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Bogota1975">
- <summary>
- Bogota 1975
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.BukitRimpah">
- <summary>
- Bukit Rimpah
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Camacupa">
- <summary>
- Camacupa
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.CampoInchauspe">
- <summary>
- Campo Inchauspe
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Cape">
- <summary>
- Cape
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Carthage">
- <summary>
- Carthage
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Chua">
- <summary>
- Chua
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.CorregoAlegre">
- <summary>
- Corrego Alegre
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.CotedIvoire">
- <summary>
- Cote d'Ivoire
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.DeirezZor">
- <summary>
- Deir ez Zor
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Douala">
- <summary>
- Douala
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Egypt1907">
- <summary>
- Egypt 1907
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.EuropeanDatum1950">
- <summary>
- European Datum 1950
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.EuropeanDatum1987">
- <summary>
- European Datum 1987
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Fahud">
- <summary>
- Fahud
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Gandajika1970">
- <summary>
- Gandajika 1970
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.GarouaIGN">
- <summary>
- Garoua
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.GuyaneFrancaise">
- <summary>
- Guyane Francaise
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.HuTzuShan">
- <summary>
- Hu Tzu Shan
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.HungarianDatum1972">
- <summary>
- Hungarian Datum 1972
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.IndonesianDatum1974">
- <summary>
- Indonesian Datum 1974
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Indian1954">
- <summary>
- Indian 1954
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Indian1975">
- <summary>
- Indian 1975
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Jamaica1875">
- <summary>
- Jamaica 1875
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Jamaica1969">
- <summary>
- Jamaica 1969
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Kalianpur1880">
- <summary>
- Kalianpur 1880
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Kandawala">
- <summary>
- Kandawala
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Kertau1968">
- <summary>
- Kertau 1968
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.KuwaitOilCompany">
- <summary>
- Kuwait Oil Company
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.LaCanoa">
- <summary>
- La Canoa
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.ProvisionalSouthAmericanDatum1956">
- <summary>
- Provisional South American Datum 1956
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Lake">
- <summary>
- Lake
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Leigon">
- <summary>
- Leigon
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Liberia1964">
- <summary>
- Liberia 1964
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Lome">
- <summary>
- Lome
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Luzon1911">
- <summary>
- Luzon 1911
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.HitoXviii1963">
- <summary>
- Hito XVIII 1963
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.ProvisionalSouthChilean1963">
- <summary>
- Represents the Provisional South Chilean datum of 1963.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.HeratNorth">
- <summary>
- Herat North
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Mahe1971">
- <summary>
- Mahe 1971
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Makassar">
- <summary>
- Makassar
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.EuropeanTerrestrialReferenceSystem1989">
- <summary>
- European Terrestrial Reference System 1989
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Malongo1987">
- <summary>
- Malongo 1987
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Manoca">
- <summary>
- Manoca
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Merchich">
- <summary>
- Merchich
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Massawa">
- <summary>
- Massawa
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Minna">
- <summary>
- Minna
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Mhast">
- <summary>
- Mhast
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.MonteMario">
- <summary>
- Monte Mario
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Mporaloko">
- <summary>
- M'poraloko
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.NorthAmericanDatum1927">
- <summary>
- North American Datum 1927
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.NadMichigan">
- <summary>
- NAD Michigan
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.NorthAmericanDatum1983">
- <summary>
- North American Datum 1983
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Nahrwan1967">
- <summary>
- Nahrwan 1967
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Naparima1972">
- <summary>
- Naparima 1972
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.NewZealandGeodeticDatum1949">
- <summary>
- New Zealand Geodetic Datum 1949
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.GeodeticDatum1949">
- <summary>
- Represents the Geodetic Datum of 1949.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Ngo1948">
- <summary>
- NGO 1948
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Datum73">
- <summary>
- Datum 73
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.NouvelleTriangulationFrancaise">
- <summary>
- Nouvelle Triangulation Francaise
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Nswc9Z2">
- <summary>
- NSWC 9Z-2
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Osgb1936">
- <summary>
- OSGB 1936
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.OrdnanceSurveyGreatBritain1936">
- <summary>
- Represents the Ordnance Survey of Great Britain datum of 1936.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Osgb1970Sn">
- <summary>
- OSGB 1970 (SN)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.OsSn1980">
- <summary>
- OS (SN) 1980
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Padang1884">
- <summary>
- Padang 1884
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Palestine1923">
- <summary>
- Palestine 1923
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Congo1960PointeNoire">
- <summary>
- Congo 1960 Pointe Noire
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.GeocentricDatumofAustralia1994">
- <summary>
- Geocentric Datum of Australia 1994
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Pulkovo1942">
- <summary>
- Pulkovo 1942
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Qatar1974">
- <summary>
- Qatar 1974
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Qatar1948">
- <summary>
- Qatar 1948
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Qornoq">
- <summary>
- Qornoq
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.LomaQuintana">
- <summary>
- Loma Quintana
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Amersfoort">
- <summary>
- Amersfoort
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.SouthAmericanDatum1969">
- <summary>
- South American Datum 1969
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.SapperHill1943">
- <summary>
- Sapper Hill 1943
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Schwarzeck">
- <summary>
- Schwarzeck
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Segora">
- <summary>
- Segora
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Serindung">
- <summary>
- Serindung
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Sudan">
- <summary>
- Sudan
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Tananarive1925">
- <summary>
- Tananarive 1925
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Timbalai1948">
- <summary>
- Timbalai 1948
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Tm65">
- <summary>
- TM65
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Ireland1965">
- <summary>
- Represents the Ireland datum of 1965.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.GeodeticDatumof1965">
- <summary>
- Geodetic Datum of 1965
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Tokyo">
- <summary>
- Tokyo
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Trinidad1903">
- <summary>
- Trinidad 1903
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.TrucialCoast1948">
- <summary>
- Trucial Coast 1948
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Voirol1875">
- <summary>
- Voirol 1875
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Bern1938">
- <summary>
- Bern 1938
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.NordSahara1959">
- <summary>
- Nord Sahara 1959
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Stockholm1938">
- <summary>
- Stockholm 1938
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Yacare">
- <summary>
- Yacare
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Yoff">
- <summary>
- Yoff
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Zanderij">
- <summary>
- Zanderij
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.MilitarGeographischeInstitut">
- <summary>
- Militar-Geographische Institut
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.HermannskogelDatum">
- <summary>
- Represents the Hermannskogel datum.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.ReseauNationalBelge1972">
- <summary>
- Reseau National Belge 1972
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.DeutschesHauptdreiecksnetz">
- <summary>
- Deutsches Hauptdreiecksnetz
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Conakry1905">
- <summary>
- Conakry 1905
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.DealulPiscului1933">
- <summary>
- Dealul Piscului 1933
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.DealulPiscului1970">
- <summary>
- Dealul Piscului 1970
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.NationalGeodeticNetwork">
- <summary>
- National Geodetic Network
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.KuwaitUtility">
- <summary>
- Kuwait Utility
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.WorldGeodeticSystem1972">
- <summary>
- World Geodetic System 1972
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.WGS72TransitBroadcastEphemeris">
- <summary>
- WGS 72 Transit Broadcast Ephemeris
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.WorldGeodeticSystem1984">
- <summary>
- World Geodetic System 1984
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Anguilla1957">
- <summary>
- Anguilla 1957
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Antigua1943">
- <summary>
- Antigua 1943
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Dominica1945">
- <summary>
- Dominica 1945
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Grenada1953">
- <summary>
- Grenada 1953
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Montserrat1958">
- <summary>
- Montserrat 1958
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.StKitts1955">
- <summary>
- St. Kitts 1955
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.FortThomas1955">
- <summary>
- Represents the Fort Thomas datum of 1955.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.StLucia1955">
- <summary>
- St. Lucia 1955
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.StVincent1945">
- <summary>
- St. Vincent 1945
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.NorthAmericanDatum1976">
- <summary>
- North American Datum 1927 (1976)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.NorthAmericanDatum1927Cgq77">
- <summary>
- North American Datum 1927 (CGQ77)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Xian1980">
- <summary>
- Xian 1980
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.HongKong1980">
- <summary>
- Hong Kong 1980
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.JapaneseGeodeticDatum2000">
- <summary>
- Japanese Geodetic Datum 2000
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.GunungSegara">
- <summary>
- Gunung Segara
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.QatarNationalDatum1995">
- <summary>
- Qatar National Datum 1995
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.PortoSanto1936">
- <summary>
- Porto Santo 1936
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.SelvagemGrande">
- <summary>
- Selvagem Grande
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.SouthAmericanDatum1969Sad69">
- <summary>
- South American Datum 1969
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Sweref99">
- <summary>
- SWEREF99
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Point58">
- <summary>
- Point 58
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.FortMarigot">
- <summary>
- Fort Marigot
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Guadeloupe1948">
- <summary>
- Guadeloupe 1948
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.CentreSpatialGuyanais1967">
- <summary>
- Centre Spatial Guyanais 1967
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.ReseauGeodesiqueFrancaisGuyane1995">
- <summary>
- Reseau Geodesique Francais Guyane 1995
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Martinique1938">
- <summary>
- Martinique 1938
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Reunion1947">
- <summary>
- Reunion 1947
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.ReseauGeodesiquedelaReunion1992">
- <summary>
- Reseau Geodesique de la Reunion 1992
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Tahiti52">
- <summary>
- Tahiti 52
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Tahaa54">
- <summary>
- Tahaa 54
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.IGN72NukuHiva">
- <summary>
- IGN72 Nuku Hiva
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.K01949">
- <summary>
- K0 1949
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Combani1950">
- <summary>
- Combani 1950
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.IGN56Lifou">
- <summary>
- IGN56 Lifou
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.IGN72GrandeTerre">
- <summary>
- IGN72 Grande Terre
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.St87Ouvea1924">
- <summary>
- ST87 Ouvea
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Petrels1972">
- <summary>
- Petrels 1972
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.PointeGeologiePerroud1950">
- <summary>
- Pointe Geologie Perroud 1950
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.SaintPierreetMiquelon1950">
- <summary>
- Saint Pierre et Miquelon 1950
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Mop78">
- <summary>
- MOP78
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.ReseaudeReferencedesAntillesFrancaises1991">
- <summary>
- Reseau de Reference des Antilles Francaises 1991
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.IGN53Mare">
- <summary>
- IGN53 Mare
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.St84IledesPins">
- <summary>
- ST84 Ile des Pins
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.St71Belep">
- <summary>
- ST71 Belep
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Nea74Noumea">
- <summary>
- NEA74 Noumea
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.ReseauGeodesiqueNouvelleCaledonie1991">
- <summary>
- Reseau Geodesique Nouvelle Caledonie 1991
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.GrandComoros">
- <summary>
- Grand Comoros
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.InternationalTerrestrialReferenceFrame1988">
- <summary>
- International Terrestrial Reference Frame 1988
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.InternationalTerrestrialReferenceFrame1989">
- <summary>
- International Terrestrial Reference Frame 1989
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.InternationalTerrestrialReferenceFrame1990">
- <summary>
- International Terrestrial Reference Frame 1990
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.InternationalTerrestrialReferenceFrame1991">
- <summary>
- International Terrestrial Reference Frame 1991
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.InternationalTerrestrialReferenceFrame1992">
- <summary>
- International Terrestrial Reference Frame 1992
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.InternationalTerrestrialReferenceFrame1993">
- <summary>
- International Terrestrial Reference Frame 1993
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.InternationalTerrestrialReferenceFrame1994">
- <summary>
- International Terrestrial Reference Frame 1994
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.InternationalTerrestrialReferenceFrame1996">
- <summary>
- International Terrestrial Reference Frame 1996
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.InternationalTerrestrialReferenceFrame1997">
- <summary>
- International Terrestrial Reference Frame 1997
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.InternationalTerrestrialReferenceFrame2000">
- <summary>
- International Terrestrial Reference Frame 2000
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Reykjavik1900">
- <summary>
- Reykjavik 1900
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Hjorsey1955">
- <summary>
- Hjorsey 1955
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.IslandsNetwork1993">
- <summary>
- Islands Network 1993
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Helle1954">
- <summary>
- Helle 1954
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Latvia1992">
- <summary>
- Latvia 1992
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.PortoSanto1995">
- <summary>
- Porto Santo 1995
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.AzoresOrientalIslands1995">
- <summary>
- Azores Oriental Islands 1995
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.AzoresCentralIslands1995">
- <summary>
- Azores Central Islands 1995
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Lisbon1890">
- <summary>
- Lisbon 1890
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.IraqKuwaitBoundaryDatum1992">
- <summary>
- Iraq-Kuwait Boundary Datum 1992
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.EuropeanDatum1979">
- <summary>
- European Datum 1979
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.IstitutoGeograficoMilitaire1995">
- <summary>
- Istituto Geografico Militaire 1995
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Voirol1879">
- <summary>
- Voirol 1879
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.ChathamIslandsDatum1971">
- <summary>
- Chatham Islands Datum 1971
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.ChathamIslandsDatum1979">
- <summary>
- Chatham Islands Datum 1979
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.SistemadeReferenciaGeocentricoparaAmericadelSur2000">
- <summary>
- Sistema de Referencia Geocentrico para America del Sur 2000
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Guam1963">
- <summary>
- Guam 1963
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Vientiane1982">
- <summary>
- Vientiane 1982
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Lao1993">
- <summary>
- Lao 1993
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.LaoNationalDatum1997">
- <summary>
- Lao National Datum 1997
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Jouik1961">
- <summary>
- Jouik 1961
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Nouakchott1965">
- <summary>
- Nouakchott 1965
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Mauritania1999RGS">
- <summary>
- Mauritania 1999
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Gulshan303">
- <summary>
- Gulshan 303
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.PhilippineReferenceSystem1992">
- <summary>
- Philippine Reference System 1992
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Gan1970">
- <summary>
- Gan 1970
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Gandajika">
- <summary>
- Gandajika
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.MarcoGeocentricoNacionaldeReferencia">
- <summary>
- Marco Geocentrico Nacional de Referencia
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.ReseauGeodesiquedelaPolynesieFrancaise">
- <summary>
- Reseau Geodesique de la Polynesie Francaise
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.FatuIva72">
- <summary>
- Fatu Iva 72
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.IGN63HivaOa">
- <summary>
- IGN63 Hiva Oa
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Tahiti79">
- <summary>
- Tahiti 79
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Moorea87">
- <summary>
- Moorea 87
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Maupiti83">
- <summary>
- Maupiti 83
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.NakhlEGhanem">
- <summary>
- Nakhl-e Ghanem
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.PosicionesGeodesicasArgentinas1994">
- <summary>
- Posiciones Geodesicas Argentinas 1994
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Katanga1955">
- <summary>
- Katanga 1955
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Kasai1953">
- <summary>
- Kasai 1953
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Igc1962Arcofthe6ThParallelSouth">
- <summary>
- IGC 1962 Arc of the 6th Parallel South
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.IGN1962Kerguelen">
- <summary>
- IGN 1962 Kerguelen
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.LePouce1934">
- <summary>
- Le Pouce 1934
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.IGNAstro1960">
- <summary>
- IGN Astro 1960
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.InstitutGeographiqueduCongoBelge1955">
- <summary>
- Institut Geographique du Congo Belge 1955
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Mauritania1999">
- <summary>
- Mauritania 1999
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.MissaoHidrograficoAngolaySaoTome1951">
- <summary>
- Missao Hidrografico Angola y Sao Tome 1951
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.MhastOnshore">
- <summary>
- Mhast (onshore)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.MhastOffshore">
- <summary>
- Mhast (offshore)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.EgyptGulfofSuezS650Tl">
- <summary>
- Egypt Gulf of Suez S-650 TL
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.TernIsland1961">
- <summary>
- Tern Island 1961
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.CocosIslands1965">
- <summary>
- Cocos Islands 1965
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Anna1Astro1965">
- <summary>
- Represents the Anna 1 Astro datum of 1965.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.IwoJima1945">
- <summary>
- Iwo Jima 1945
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.AstroBeaconE1945">
- <summary>
- Represents the Astro Beacon "E" datum of 1945.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.StHelena1971">
- <summary>
- St. Helena 1971
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.AstroDos714">
- <summary>
- Represents the Astro DOS 71/4 datum.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.MarcusIsland1952">
- <summary>
- Marcus Island 1952
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.AstronomicalStation1952">
- <summary>
- Represents the Astronomical Station datum of 1952.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.AscensionIsland1958">
- <summary>
- Ascension Island 1958
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.AyabelleLighthouse">
- <summary>
- Ayabelle Lighthouse
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Bellevue">
- <summary>
- Bellevue
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.CampAreaAstro">
- <summary>
- Camp Area Astro
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.PhoenixIslands1966">
- <summary>
- Phoenix Islands 1966
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.CantonAstro1966">
- <summary>
- Represents the Canton Astro datum of 1966.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.CapeCanaveral">
- <summary>
- Cape Canaveral
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Solomon1968">
- <summary>
- Solomon 1968
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Dos1968">
- <summary>
- Represents the DOS datum of 1968.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Gux1Astro">
- <summary>
- Represents the GUX 1 Astro datum.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.EasterIsland1967">
- <summary>
- Easter Island 1967
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.FijiGeodeticDatum1986">
- <summary>
- Fiji Geodetic Datum 1986
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Fiji1956">
- <summary>
- Fiji 1956
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.SouthGeorgia1968">
- <summary>
- South Georgia 1968
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Ists061Astro1968">
- <summary>
- Represents the ISTS 061 Astro datum of 1968.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.GrandCayman1959">
- <summary>
- Grand Cayman 1959
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.DiegoGarcia1969">
- <summary>
- Diego Garcia 1969
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Ists073Astro1969">
- <summary>
- Represents the ISTS 073 Astro datum of 1969.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.JohnstonIsland1961">
- <summary>
- Johnston Island 1961
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.LittleCayman1961">
- <summary>
- Little Cayman 1961
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Lc5Astro1961">
- <summary>
- Represents the L. C. 5 Astro datum of 1961.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Midway1961">
- <summary>
- Midway 1961
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.PicodelaNieves">
- <summary>
- Pico de la Nieves
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Pitcairn1967">
- <summary>
- Pitcairn 1967
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Santo1965">
- <summary>
- Santo 1965
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.VitiLevu1916">
- <summary>
- Viti Levu 1916
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.MarshallIslands1960">
- <summary>
- Marshall Islands 1960
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.WakeIsland1952">
- <summary>
- Wake Island 1952
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Tristan1968">
- <summary>
- Tristan 1968
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Kusaie1951">
- <summary>
- Kusaie 1951
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.DeceptionIsland">
- <summary>
- Deception Island
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.GeocentricdatumofKorea">
- <summary>
- Geocentric datum of Korea
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.HongKong1963">
- <summary>
- Hong Kong 1963
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.HongKong1967">
- <summary>
- Hong Kong 1963(67)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.ParametropZemp1990">
- <summary>
- Parametrop Zemp 1990
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.FaroeDatum1954">
- <summary>
- Faroe Datum 1954
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.GeodeticDatumofMalaysia2000">
- <summary>
- Geodetic Datum of Malaysia 2000
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Karbala1979Polservice">
- <summary>
- Karbala 1979 (Polservice)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Nahrwan1934">
- <summary>
- Nahrwan 1934
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.RauenbergDatum83">
- <summary>
- Rauenberg Datum/83
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.PotsdamDatum83">
- <summary>
- Potsdam Datum/83
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Greenland1996">
- <summary>
- Greenland 1996
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.VanuaLevu1915">
- <summary>
- Vanua Levu 1915
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.ReseauGeodesiquedeNouvelleCaledonie93">
- <summary>
- Reseau Geodesique de Nouvelle Caledonie 91-93
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.St87Ouvea">
- <summary>
- ST87 Ouvea
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.KertauRso">
- <summary>
- Kertau (RSO)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Kertau1948">
- <summary>
- Represents the Kertau datum of 1948.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.VitiLevu1912">
- <summary>
- Viti Levu 1912
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Fk89">
- <summary>
- fk89
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.LibyanGeodeticDatum2006">
- <summary>
- Libyan Geodetic Datum 2006
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.DatumGeodesiNasional1995">
- <summary>
- Datum Geodesi Nasional 1995
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Vietnam2000">
- <summary>
- Vietnam 2000
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Svy21">
- <summary>
- SVY21
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Jamaica2001">
- <summary>
- Jamaica 2001
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Ch1903Bern">
- <summary>
- CH1903 (Bern)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Bogota1975Bogota">
- <summary>
- Bogota 1975 (Bogota)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Lisbon1937Lisbon">
- <summary>
- Lisbon 1937 (Lisbon)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.MakassarJakarta">
- <summary>
- Makassar (Jakarta)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.MilitarGeographischeInstitutFerro">
- <summary>
- Militar-Geographische Institut (Ferro)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.MonteMarioRome">
- <summary>
- Monte Mario (Rome)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.NouvelleTriangulationFrancaiseParis">
- <summary>
- Nouvelle Triangulation Francaise (Paris)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Padang1884Jakarta">
- <summary>
- Padang 1884 (Jakarta)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.ReseauNationalBelge1950Brussels">
- <summary>
- Reseau National Belge 1950 (Brussels)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Tananarive1925Paris">
- <summary>
- Tananarive 1925 (Paris)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Voirol1875Paris">
- <summary>
- Voirol 1875 (Paris)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.BataviaJakarta">
- <summary>
- Batavia (Jakarta)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Stockholm1938Stockholm">
- <summary>
- Stockholm 1938 (Stockholm)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.GreekAthens">
- <summary>
- Greek (Athens)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.CarthageParis">
- <summary>
- Carthage (Paris)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Ngo1948Oslo">
- <summary>
- NGO 1948 (Oslo)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.SJtskFerro">
- <summary>
- S-JTSK (Ferro)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.NordSahara1959Paris">
- <summary>
- Nord Sahara 1959 (Paris)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.GunungSegaraJakarta">
- <summary>
- Gunung Segara (Jakarta)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Voirol1879Paris">
- <summary>
- Voirol 1879 (Paris)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.InternationalTerrestrialReferenceFrame2005">
- <summary>
- International Terrestrial Reference Frame 2005
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.AncienneTriangulationFrancaiseParis">
- <summary>
- Ancienne Triangulation Francaise (Paris)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.NorddeGuerreParis">
- <summary>
- Nord de Guerre (Paris)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Madrid1870Madrid">
- <summary>
- Madrid 1870 (Madrid)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Lisbon1890Lisbon">
- <summary>
- Lisbon 1890 (Lisbon)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.EstoniaLocalDatum1937">
- <summary>
- Represents the Estonia Coordinate System datum of 1937.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.OldEgyptian1907">
- <summary>
- Represents the Old Egyptian datum of 1907.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Oman">
- <summary>
- Represents the Oman datum.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.PointeNoire1948">
- <summary>
- Represents the Pointe Noire datum.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Rome1940">
- <summary>
- Represents the Rome datum of 1940.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.SaoBraz">
- <summary>
- Represents the Sao Braz datum.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.SouthAsia">
- <summary>
- Represents the South Asia datum.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Voirol1960">
- <summary>
- Represents the Voirol datum of 1960.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.WakeEniwetok1960">
- <summary>
- Represents the Wake Eniwetok datum of 1960.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.WorldGeodeticSystem1960">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.WorldGeodeticSystem1966">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Datum.Default">
- <summary>
- Represents the default datum used by the DotSpatial.Positioning, WGS1984.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Datum.#ctor(System.String,DotSpatial.Positioning.Ellipsoid)">
- <summary>
- Creates a new instance using the specified name and reference ellipsoid.
- </summary>
- <param name="name">The name.</param>
- <param name="ellipsoid">The ellipsoid.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Datum.#ctor(System.Int32,DotSpatial.Positioning.Ellipsoid,System.String)">
- <summary>
- Internal constructor for static list generation
- </summary>
- <param name="epsgNumber">The epsg number.</param>
- <param name="ellipsoid">The ellipsoid.</param>
- <param name="name">The name.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Datum.#ctor(System.Int32,DotSpatial.Positioning.Ellipsoid,System.Double,System.String)">
- <summary>
- Internal constructor for static list generation
- </summary>
- <param name="epsgNumber">The epsg number.</param>
- <param name="ellipsoid">The ellipsoid.</param>
- <param name="meridian">The meridian.</param>
- <param name="name">The name.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Datum.SanityCheck">
- <summary>
- Validates the datum. Called in the constructor.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Datum.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Datum.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
- </summary>
- <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
- <returns><c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Datum.GetHashCode">
- <summary>
- Returns a hash code for this instance.
- </summary>
- <returns>A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Datum.FromName(System.String)">
- <summary>
- Returns a Datum object matching the specified name.
- </summary>
- <param name="name">A <strong>String</strong> describing the name of an existing datum.</param>
- <returns>A <strong>Datum</strong> object matching the specified string, or null if no datum was found.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Datum.FromEpsgNumber(System.Int32)">
- <summary>
- Returns the datum corresponding to the EPSG code
- </summary>
- <param name="epsgNumber">The epsg number.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Datum.Equals(DotSpatial.Positioning.Datum)">
- <summary>
- Compares the current instance to the specified datum object.
- </summary>
- <param name="other">An object to compare with this object.</param>
- <returns>true if the current object is equal to the <paramref name="other"/> parameter; otherwise, false.</returns>
- </member>
- <member name="P:DotSpatial.Positioning.Datum.Name">
- <summary>
- Returns the name of the datum.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Datum.EpsgNumber">
- <summary>
- European Petroleum Survey Group number for this datum. The ESPG standards are now maintained by OGP
- (International Association of Oil and Gas Producers).
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Datum.Ellipsoid">
- <summary>
- Returns the interpretation of Earth's shape associated with a datum.
- </summary>
- <value>Read only. An
- <see cref="P:DotSpatial.Positioning.Datum.Ellipsoid">Ellipsoid</see>
- object.</value>
- <example>
- This example gets information on the ellipsoid associated with the WGS84 datum.
- <code lang="VB">
- ' Get information about the NAD1983 datum
- Dim MyDatum As Datum = Geodesy.GetDatum(DatumType.NorthAmerican1983)
- ' Get the ellipsoid associated with this datum
- Dim MyEllipsoid As Ellipsoid = MyDatum.Ellipsoid
- ' Write the semi-major axis of the ellipsoid
- Debug.WriteLine(MyEllipsoid.SemiMajorAxis.ToString())
- </code>
- <code lang="CS">
- // Get information about the NAD1983 datum
- Datum MyDatum = Geodesy.GetDatum(DatumType.NorthAmerican1983);
- // Get the ellipsoid associated with this datum
- Ellipsoid MyEllipsoid = MyDatum.Ellipsoid;
- // Write the semi-major axis of the ellipsoid
- Debug.WriteLine(MyEllipsoid.SemiMajorAxis.ToString());
- </code>
- </example>
-
- <seealso cref="P:DotSpatial.Positioning.Datum.Ellipsoid">Ellipsoid Class</seealso>
- <remarks>Each datum is associated with an ellipsoid, which is an interpretation of Earth's shape and
- size.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Datum.PrimeMeridian">
- <summary>
- Returns the prime meridian assocated with this Datum.
- </summary>
- <remarks>Most datums use Greenwich as the prime meridian. However, several systems offset coordinates
- using a local meridian. This value reflects that usage.</remarks>
- </member>
- <member name="T:DotSpatial.Positioning.Distance">
- <summary>
- Represents the measurement of a straight line between between two points on
- Earth's surface.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.FEET_PER_METER">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.FEET_PER_CENTIMETER">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.FEET_PER_STATUTE_MILE">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.FEET_PER_KILOMETER">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.FEET_PER_INCH">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.FEET_PER_NAUTICAL_MILE">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.INCHES_PER_METER">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.INCHES_PER_CENTIMETER">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.INCHES_PER_STATUTE_MILE">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.INCHES_PER_KILOMETER">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.INCHES_PER_FOOT">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.INCHES_PER_NAUTICAL_MILE">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.STATUTE_MILES_PER_METER">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.STATUTE_MILES_PER_CENTIMETER">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.STATUTE_MILES_PER_KILOMETER">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.STATUTE_MILES_PER_INCH">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.STATUTE_MILES_PER_FOOT">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.STATUTE_MILES_PER_NAUTICAL_MILE">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.NAUTICAL_MILES_PER_METER">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.NAUTICAL_MILES_PER_CENTIMETER">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.NAUTICAL_MILES_PER_KILOMETER">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.NAUTICAL_MILES_PER_INCH">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.NAUTICAL_MILES_PER_FOOT">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.NAUTICAL_MILES_PER_STATUTE_MILE">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.CENTIMETERS_PER_STATUTE_MILE">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.CENTIMETERS_PER_KILOMETER">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.CENTIMETERS_PER_FOOT">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.CENTIMETERS_PER_INCH">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.CENTIMETERS_PER_METER">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.CENTIMETERS_PER_NAUTICAL_MILE">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.METERS_PER_STATUTE_MILE">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.METERS_PER_CENTIMETER">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.METERS_PER_KILOMETER">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.METERS_PER_FOOT">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.METERS_PER_INCH">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.METERS_PER_NAUTICAL_MILE">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.KILOMETERS_PER_METER">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.KILOMETERS_PER_CENTIMETER">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.KILOMETERS_PER_STATUTE_MILE">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.KILOMETERS_PER_FOOT">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.KILOMETERS_PER_INCH">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.KILOMETERS_PER_NAUTICAL_MILE">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance._value">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance._units">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.EarthsEquatorialRadiusWgs1984">
- <summary>
- Returns the distance from the center of the Earth to the equator according to the
- WGS1984 ellipsoid.
- </summary>
- <seealso cref="F:DotSpatial.Positioning.Distance.EarthsPolarRadiusWgs1984">EarthsPolarRadiusWgs1984
- Field</seealso>
-
- <seealso cref="F:DotSpatial.Positioning.Distance.EarthsAverageRadius">EarthsAverageRadius Field</seealso>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.Infinity">
- <summary>
- Represents an infinite distance.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.EarthsPolarRadiusWgs1984">
- <summary>
- Returns the distance from the center of the Earth to a pole according to the
- WGS1984 ellipsoid.
- </summary>
- <seealso cref="F:DotSpatial.Positioning.Distance.EarthsEquatorialRadiusWgs1984">EarthsEquatorialRadiusWgs1984 Field</seealso>
-
- <seealso cref="F:DotSpatial.Positioning.Distance.EarthsAverageRadius">EarthsAverageRadius Field</seealso>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.EarthsAverageRadius">
- <summary>
- Returns the average radius of the Earth.
- </summary>
- <seealso cref="F:DotSpatial.Positioning.Distance.EarthsEquatorialRadiusWgs1984">EarthsEquatorialRadiusWgs1984 Field</seealso>
-
- <seealso cref="F:DotSpatial.Positioning.Distance.EarthsPolarRadiusWgs1984">EarthsPolarRadiusWgs1984 Field</seealso>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.Empty">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.SeaLevel">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.Maximum">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.Minimum">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Distance.Invalid">
- <summary>
- Represents an invalid or unspecified value.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.#ctor(System.Double,DotSpatial.Positioning.DistanceUnit)">
- <summary>
- Creates a new instance using the specified value and unit type.
- </summary>
- <param name="value">The value.</param>
- <param name="units">The units.</param>
- <example>
- This example uses a constructor to create a new distance of 50km.
- <code lang="VB">
- Dim MyDistance As New Distance(50, DistanceUnit.Kilometers)
- </code>
- <code lang="C#">
- Distance MyDistance = new Distance(50, DistanceUnit.Kilometers);
- </code>
- </example>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.#ctor(System.String)">
- <summary>
- Creates a new instance from the the specified string.
- </summary>
- <param name="value">The value.</param>
- <exception cref="T:System.ArgumentNullException" caption="ArgumentNullException">Parse method requires a valid distance measurement.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">1. The numeric portion of the distance measurement was not recognized.<br/>
- 2. The distance unit type was not recognized or not specified.</exception>
-
- <example>
- This example demonstrates how the to use this constructor.
- <code lang="VB">
- Dim MyDistance As Distance
- ' Create a distance of 50 kilometers
- MyDistance = New Distance("50 km")
- ' Create a distance of 14, 387 miles, then convert it into inches
- MyDistance = New Distance("14, 387 statute miles").ToInches
- ' Parse an untrimmed measurement into 50 feet
- MyDistance = New Distance(" 50 ' ")
- </code>
- <code lang="C#">
- Distance MyDistance;
- // Create a distance of 50 kilometers
- MyDistance = new Distance("50 km");
- // Create a distance of 14, 387 miles, then convert it into inches
- MyDistance = new Distance("14, 387 statute miles").ToInches;
- // Parse an untrimmed measurement into 50 feet
- MyDistance = new Distance(" 50 ' ");
- </code>
- </example>
- <remarks>This powerful constructor is typically used to initialize an instance with a
- string-based distance measurement, such as one entered by a user or read from a file.
- This constructor can accept any output created via the
- <see cref="M:DotSpatial.Positioning.Distance.ToString">ToString</see> method.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.#ctor(System.String,System.Globalization.CultureInfo)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.Distance"/> struct.
- </summary>
- <param name="value">The value.</param>
- <param name="culture">The culture.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.#ctor(System.Xml.XmlReader)">
- <summary>
- Creates a new instance from the specified XML.
- </summary>
- <param name="reader">The reader.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.GetMinimumTravelTime(DotSpatial.Positioning.Speed)">
- <summary>
- Returns the time required to travel the entire distance at the specified speed.
- </summary>
- <param name="speed">A <strong>Speed</strong> object representing a travel speed.</param>
- <returns>A <strong>TimeSpan</strong> object representing the total time required to travel the entire distance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.GetMinimumTravelSpeed(System.TimeSpan)">
- <summary>
- Returns the speed required to travel the entire distance in the specified time.
- </summary>
- <param name="time">A <strong>TimeSpan</strong> object representing the time to travel the entire distance.</param>
- <returns>A <strong>Speed</strong> object representing the speed required to travel the distance in exactly the time specified.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.ToFeet">
- <summary>
- Converts the current measurement into feet.
- </summary>
- <returns>A new <strong>Distance</strong> object containing the converted
- value.</returns>
- <seealso cref="M:DotSpatial.Positioning.Distance.ToInches">ToInches Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Distance.ToKilometers">ToKilometers Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Distance.ToMeters">ToMeters Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Distance.ToNauticalMiles">ToNauticalMiles Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Distance.ToStatuteMiles">ToStatuteMiles Method</seealso>
-
- <example>
- This example converts various distances into feet. notice that the ToFeet method converts distances
- from any source type.
- <code lang="VB">
- ' Create distances of different unit types
- Dim Distance1 As New Distance(10, DistanceUnit.Inches)
- Dim Distance2 As New Distance(20, DistanceUnit.StatuteMiles)
- Dim Distance3 As New Distance(50, DistanceUnit.Kilometers)
- ' Convert the distance measurements to feet and output the result
- Debug.WriteLine(Distance1.ToFeet.ToString)
- Debug.WriteLine(Distance2.ToFeet.ToString)
- Debug.WriteLine(Distance3.ToFeet.ToString)
- </code>
- <code lang="C#">
- // Create distances of different unit types
- Distance Distance1 = new Distance(10, DistanceUnit.Inches);
- Distance Distance2 = new Distance(20, DistanceUnit.StatuteMiles);
- Distance Distance3 = new Distance(50, DistanceUnit.Kilometers);
- // Convert the distance measurements to feet and output the result
- Debug.WriteLine(Distance1.ToFeet().ToString());
- Debug.WriteLine(Distance2.ToFeet().ToString());
- Debug.WriteLine(Distance3.ToFeet().ToString());
- </code>
- </example>
- <remarks>This method will perform a conversion into feet regardless of the current unit
- type. You may convert from any unit type to any unit type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.ToInches">
- <summary>
- Converts the current measurement into inches.
- </summary>
- <returns>A new <strong>Distance</strong> object containing the converted
- value.</returns>
- <example>
- This example converts various distances into inches. notice that the ToInches method converts distances
- from any source type.
- <code lang="VB">
- ' Create distances of different unit types
- Dim Distance1 As New Distance(10, DistanceUnit.Feet)
- Dim Distance2 As New Distance(20, DistanceUnit.StatuteMiles)
- Dim Distance3 As New Distance(50, DistanceUnit.Kilometers)
- ' Convert the distance measurements to feet and output the result
- Debug.WriteLine(Distance1.ToInches.ToString)
- Debug.WriteLine(Distance2.ToInches.ToString)
- Debug.WriteLine(Distance3.ToInches.ToString)
- </code>
- <code lang="C#">
- // Create distances of different unit types
- Distance Distance1 = new Distance(10, DistanceUnit.Feet);
- Distance Distance2 = new Distance(20, DistanceUnit.StatuteMiles);
- Distance Distance3 = new Distance(50, DistanceUnit.Kilometers);
- // Convert the distance measurements to feet and output the result
- Debug.WriteLine(Distance1.ToInches().ToString());
- Debug.WriteLine(Distance2.ToInches().ToString());
- Debug.WriteLine(Distance3.ToInches().ToString());
- </code>
- </example>
-
- <seealso cref="M:DotSpatial.Positioning.Distance.ToFeet">ToFeet Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Distance.ToKilometers">ToKilometers Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Distance.ToMeters">ToMeters Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Distance.ToNauticalMiles">ToNauticalMiles Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Distance.ToStatuteMiles">ToStatuteMiles Method</seealso>
- <remarks>This method will perform a conversion into feet regardless of the current unit
- type. You may convert from any unit type to any unit type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.ToKilometers">
- <summary>
- Converts the current measurement into kilometers.
- </summary>
- <returns>A new <strong>Distance</strong> object containing the converted
- value.</returns>
- <example>
- This example converts various distances into kilometers. notice that the ToKilometers method converts
- distances from any source type.
- <code lang="VB">
- ' Create distances of different unit types
- Dim Distance1 As New Distance(10, DistanceUnit.Feet)
- Dim Distance2 As New Distance(20, DistanceUnit.StatuteMiles)
- Dim Distance3 As New Distance(50, DistanceUnit.Inches)
- ' Convert the distance measurements to feet and output the result
- Debug.WriteLine(Distance1.ToKilometers.ToString)
- Debug.WriteLine(Distance2.ToKilometers.ToString)
- Debug.WriteLine(Distance3.ToKilometers.ToString)
- </code>
- <code lang="C#">
- // Create distances of different unit types
- Distance Distance1 = new Distance(10, DistanceUnit.Feet);
- Distance Distance2 = new Distance(20, DistanceUnit.StatuteMiles);
- Distance Distance3 = new Distance(50, DistanceUnit.Inches);
- // Convert the distance measurements to feet and output the result
- Debug.WriteLine(Distance1.ToKilometers().ToString());
- Debug.WriteLine(Distance2.ToKilometers().ToString());
- Debug.WriteLine(Distance3.ToKilometers().ToString());
- </code>
- </example>
-
- <seealso cref="M:DotSpatial.Positioning.Distance.ToFeet">ToFeet Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Distance.ToInches">ToInches Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Distance.ToMeters">ToMeters Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Distance.ToNauticalMiles">ToNauticalMiles Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Distance.ToStatuteMiles">ToStatuteMiles Method</seealso>
- <remarks>This method will perform a conversion into feet regardless of the current unit
- type. You may convert from any unit type to any unit type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.ToMeters">
- <summary>
- Converts the current measurement into meters.
- </summary>
- <returns>A new <strong>Distance</strong> object containing the converted
- value.</returns>
- <example>
- This example converts various distances into meters. notice that the ToMeters method converts distances
- from any source type.
- <code lang="VB">
- ' Create distances of different unit types
- Dim Distance1 As New Distance(10, DistanceUnit.Feet)
- Dim Distance2 As New Distance(20, DistanceUnit.StatuteMiles)
- Dim Distance3 As New Distance(50, DistanceUnit.Inches)
- ' Convert the distance measurements to feet and output the result
- Debug.WriteLine(Distance1.ToMeters().ToString)
- Debug.WriteLine(Distance2.ToMeters().ToString)
- Debug.WriteLine(Distance3.ToMeters().ToString)
- </code>
- <code lang="C#">
- // Create distances of different unit types
- Distance Distance1 = new Distance(10, DistanceUnit.Feet);
- Distance Distance2 = new Distance(20, DistanceUnit.StatuteMiles);
- Distance Distance3 = new Distance(50, DistanceUnit.Inches);
- // Convert the distance measurements to feet and output the result
- Debug.WriteLine(Distance1.ToMeters().ToString());
- Debug.WriteLine(Distance2.ToMeters().ToString());
- Debug.WriteLine(Distance3.ToMeters().ToString());
- </code>
- </example>
-
- <seealso cref="M:DotSpatial.Positioning.Distance.ToFeet">ToFeet Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Distance.ToInches">ToInches Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Distance.ToKilometers">ToKilometers Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Distance.ToNauticalMiles">ToNauticalMiles Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Distance.ToStatuteMiles">ToStatuteMiles Method</seealso>
- <remarks>This method will perform a conversion into feet regardless of the current unit
- type. You may convert from any unit type to any unit type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.ToCentimeters">
- <summary>
- Converts the current measurement into meters.
- </summary>
- <returns>A new <strong>Distance</strong> object containing the converted
- value.</returns>
- <example>
- This example converts various distances into meters. notice that the ToMeters method converts distances
- from any source type.
- <code lang="VB">
- ' Create distances of different unit types
- Dim Distance1 As New Distance(10, DistanceUnit.Feet)
- Dim Distance2 As New Distance(20, DistanceUnit.StatuteMiles)
- Dim Distance3 As New Distance(50, DistanceUnit.Inches)
- ' Convert the distance measurements to feet and output the result
- Debug.WriteLine(Distance1.ToMeters().ToString)
- Debug.WriteLine(Distance2.ToMeters().ToString)
- Debug.WriteLine(Distance3.ToMeters().ToString)
- </code>
- <code lang="C#">
- // Create distances of different unit types
- Distance Distance1 = new Distance(10, DistanceUnit.Feet);
- Distance Distance2 = new Distance(20, DistanceUnit.StatuteMiles);
- Distance Distance3 = new Distance(50, DistanceUnit.Inches);
- // Convert the distance measurements to feet and output the result
- Debug.WriteLine(Distance1.ToMeters().ToString());
- Debug.WriteLine(Distance2.ToMeters().ToString());
- Debug.WriteLine(Distance3.ToMeters().ToString());
- </code>
- </example>
-
- <seealso cref="M:DotSpatial.Positioning.Distance.ToFeet">ToFeet Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Distance.ToInches">ToInches Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Distance.ToKilometers">ToKilometers Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Distance.ToNauticalMiles">ToNauticalMiles Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Distance.ToStatuteMiles">ToStatuteMiles Method</seealso>
- <remarks>This method will perform a conversion into feet regardless of the current unit
- type. You may convert from any unit type to any unit type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.ToNauticalMiles">
- <summary>
- Converts the current measurement into nautical miles.
- </summary>
- <returns>A new <strong>Distance</strong> object containing the converted
- value.</returns>
- <example>
- This example converts various distances into nautical miles. notice that the ToNauticalMiles method
- converts distances from any source type.
- <code lang="VB">
- ' Create distances of different unit types
- Dim Distance1 As New Distance(10, DistanceUnit.Feet)
- Dim Distance2 As New Distance(20, DistanceUnit.StatuteMiles)
- Dim Distance3 As New Distance(50, DistanceUnit.Inches)
- ' Convert the distance measurements to feet and output the result
- Debug.WriteLine(Distance1.ToNauticalMiles.ToString)
- Debug.WriteLine(Distance2.ToNauticalMiles.ToString)
- Debug.WriteLine(Distance3.ToNauticalMiles.ToString)
- </code>
- <code lang="C#">
- // Create distances of different unit types
- Distance Distance1 = new Distance(10, DistanceUnit.Feet);
- Distance Distance2 = new Distance(20, DistanceUnit.StatuteMiles);
- Distance Distance3 = new Distance(50, DistanceUnit.Inches);
- // Convert the distance measurements to feet and output the result
- Debug.WriteLine(Distance1.ToNauticalMiles().ToString());
- Debug.WriteLine(Distance2.ToNauticalMiles().ToString());
- Debug.WriteLine(Distance3.ToNauticalMiles().ToString());
- </code>
- </example>
-
- <seealso cref="M:DotSpatial.Positioning.Distance.ToFeet">ToFeet Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Distance.ToInches">ToInches Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Distance.ToKilometers">ToKilometers Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Distance.ToMeters">ToMeters Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Distance.ToStatuteMiles">ToStatuteMiles Method</seealso>
- <remarks>This method will perform a conversion into feet regardless of the current unit
- type. You may convert from any unit type to any unit type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.ToStatuteMiles">
- <summary>
- Converts the current measurement into miles.
- </summary>
- <returns>A new <strong>Distance</strong> object containing the converted
- value.</returns>
- <example>
- This example converts various distances into statute miles. notice that the ToStatuteMiles method
- converts distances from any source type.
- <code lang="VB">
- ' Create distances of different unit types
- Dim Distance1 As New Distance(10, DistanceUnit.Feet)
- Dim Distance2 As New Distance(20, DistanceUnit.StatuteMiles)
- Dim Distance3 As New Distance(50, DistanceUnit.Inches)
- ' Convert the distance measurements to feet and output the result
- Debug.WriteLine(Distance1.ToStatuteMiles.ToString)
- Debug.WriteLine(Distance2.ToStatuteMiles.ToString)
- Debug.WriteLine(Distance3.ToStatuteMiles.ToString)
- </code>
- <code lang="C#">
- // Create distances of different unit types
- Distance Distance1 = new Distance(10, DistanceUnit.Feet);
- Distance Distance2 = new Distance(20, DistanceUnit.StatuteMiles);
- Distance Distance3 = new Distance(50, DistanceUnit.Inches);
- // Convert the distance measurements to feet and output the result
- Debug.WriteLine(Distance1.ToStatuteMiles().ToString());
- Debug.WriteLine(Distance2.ToStatuteMiles().ToString());
- Debug.WriteLine(Distance3.ToStatuteMiles().ToString());
- </code>
- </example>
-
- <seealso cref="M:DotSpatial.Positioning.Distance.ToFeet">ToFeet Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Distance.ToInches">ToInches Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Distance.ToKilometers">ToKilometers Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Distance.ToMeters">ToMeters Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Distance.ToNauticalMiles">ToNauticalMiles Method</seealso>
- <remarks>This method will perform a conversion into feet regardless of the current unit
- type. You may convert from any unit type to any unit type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.ToUnitType(DotSpatial.Positioning.DistanceUnit)">
- <summary>
- Toes the type of the unit.
- </summary>
- <param name="newUnits">The new units.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.ToImperialUnitType">
- <summary>
- Attempts to adjust the unit type to keep the value above 1 and uses the local region measurement system.
- </summary>
- <returns>A <strong>Distance</strong> converted to the chosen unit type.</returns>
- <remarks>When a distance becomes smaller, it may make more sense to the
- user to be expressed in a smaller unit type. For example, a distance of
- 0.001 kilometers might be better expressed as 1 meter. This method will
- determine the smallest Imperial unit type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.ToMetricUnitType">
- <summary>
- Attempts to adjust the unit type to keep the value above 1 and uses the local region measurement system.
- </summary>
- <returns>A <strong>Distance</strong> converted to the chosen unit type.</returns>
- <remarks>When a distance becomes smaller, it may make more sense to the
- user to be expressed in a smaller unit type. For example, a distance of
- 0.001 kilometers might be better expressed as 1 meter. This method will
- determine the smallest metric unit type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.ToLocalUnitType">
- <summary>
- Attempts to adjust the unit type to keep the value above 1 and uses the local region measurement system.
- </summary>
- <returns>A <strong>Distance</strong> converted to the chosen unit type.</returns>
- <remarks>When a distance becomes smaller, it may make more sense to the
- user to be expressed in a smaller unit type. For example, a distance of
- 0.001 kilometers might be better expressed as 1 meter. This method will
- find the smallest unit type and convert the unit to the user's local
- numeric system (Imperial or Metric).</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.ToSpeed(System.TimeSpan)">
- <summary>
- Returns the distance traveled at the current speed for the specified time.
- </summary>
- <param name="time">A length of time to travel.</param>
- <returns>A <strong>Distance</strong> representing the distance travelled at
- the current speed for the specified length of time.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.Round(System.Int32)">
- <summary>
- Returns a new instance rounded to the specified number of digits.
- </summary>
- <param name="decimals">An <strong>Integer</strong> specifying the number of digits to round off to.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.ToString(System.String)">
- <summary>
- Outputs the current instance as a string using the specified format.
- </summary>
- <param name="format"><para>A combination of symbols, spaces, and any of the following case-insensitive
- letters: <strong>#</strong> or <strong>0</strong> for the value property, and <strong>U</strong> for
- distance units. Here are some examples:</para>
- <para>
- <table cellspacing="0" cols="3" cellpadding="2" width="100%">
- <tr>
- <td>##0.## uu</td>
- <td>## uuuu</td>
- <td># u</td>
- <td>###</td>
- </tr>
- </table>
- </para></param>
- <returns>A <strong>String</strong> containing the distance in the specified format.</returns>
- <example>
- This example uses the ToString method to populate a TextBox with a distance measurement using a custom format.
- <code lang="VB">
- ' Declare a distance of 75 miles
- Dim MyDistance As New Distance(75, DistanceUnit.StatuteMiles)
- ' Set the text box to the distance, formatted as a string
- MyTextBox.Text = MyDistance.ToString("## uuu")
- </code>
- <code lang="C#">
- // Declare a distance of 75 miles
- Distance MyDistance = new Distance(75, DistanceUnit.StatuteMiles);
- // Set the text box to the distance, formatted as a string
- MyTextBox.Text = MyDistance.ToString("## uuu");
- </code>
- </example>
- <remarks>This method allows a custom format to be applied to the ToString method. Numeric formats
- will be adjusted to the machine's local UI culture.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.Add(DotSpatial.Positioning.Distance)">
- <summary>
- Adds the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.Add(System.Double)">
- <summary>
- Adds the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.Subtract(DotSpatial.Positioning.Distance)">
- <summary>
- Subtracts the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.Subtract(System.Double)">
- <summary>
- Subtracts the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.Multiply(DotSpatial.Positioning.Distance)">
- <summary>
- Multiplies the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.Multiply(System.Double)">
- <summary>
- Multiplies the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.Divide(DotSpatial.Positioning.Distance)">
- <summary>
- Divides the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.Divide(System.Double)">
- <summary>
- Divides the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.Increment">
- <summary>
- Increments this instance.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.Decrement">
- <summary>
- Decrements this instance.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.IsLessThan(DotSpatial.Positioning.Distance)">
- <summary>
- Determines whether [is less than] [the specified value].
- </summary>
- <param name="value">The value.</param>
- <returns><c>true</c> if [is less than] [the specified value]; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.IsLessThanOrEqualTo(DotSpatial.Positioning.Distance)">
- <summary>
- Determines whether [is less than or equal to] [the specified value].
- </summary>
- <param name="value">The value.</param>
- <returns><c>true</c> if [is less than or equal to] [the specified value]; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.IsGreaterThan(DotSpatial.Positioning.Distance)">
- <summary>
- Determines whether [is greater than] [the specified value].
- </summary>
- <param name="value">The value.</param>
- <returns><c>true</c> if [is greater than] [the specified value]; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.IsGreaterThanOrEqualTo(DotSpatial.Positioning.Distance)">
- <summary>
- Determines whether [is greater than or equal to] [the specified value].
- </summary>
- <param name="value">The value.</param>
- <returns><c>true</c> if [is greater than or equal to] [the specified value]; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.Equals(System.Object)">
- <summary>
- Compares the current instance to the specified object.
- </summary>
- <param name="obj">An <strong>Object</strong> to compare with.</param>
- <returns>A <strong>Boolean</strong>, True if the values are equivalent.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.GetHashCode">
- <summary>
- Returns a hash code for this instance.
- </summary>
- <returns>A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.ToString">
- <summary>
- Outputs the current instance as a string using the default format.
- </summary>
- <returns>A <strong>String</strong> containing the current distance in the default format.</returns>
- <example>
- This example uses the ToString method to populate a TextBox with a distance measurement.
- <code lang="VB">
- ' Declare a distance of 75 miles
- Dim MyDistance As New Distance(75, DistanceUnit.StatuteMiles)
- ' Set the text box to the distance, formatted as a string
- MyTextBox.Text = MyDistance.ToString
- </code>
- <code lang="C#">
- // Declare a distance of 75 miles
- Distance MyDistance = new Distance(75, DistanceUnit.StatuteMiles);
- // Set the text box to the distance, formatted as a string
- MyTextBox.Text = MyDistance.ToString();
- </code>
- </example>
- <remarks>The default format used is "##0.## uu" where <strong>uu</strong> is the distance unit type.
- The numeric format may vary depending on the machine's local culture.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.Random">
- <summary>
- Returns a random distance between 0 and 1, 000 meters.
- </summary>
- <returns>A <strong>Distance</strong> containing a random value, converted to local units.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.Random(System.Random)">
- <summary>
- Returns a random distance between 0 and 1, 000 meters.
- </summary>
- <param name="generator">The generator.</param>
- <returns>A <strong>Distance</strong> containing a random value, converted to local units.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.Random(DotSpatial.Positioning.Distance)">
- <summary>
- Returns a random distance between zero and the specified maximum.
- </summary>
- <param name="maximum">The maximum.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.FromCentimeters(System.Double)">
- <summary>
- Froms the centimeters.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.FromFeet(System.Double)">
- <summary>
- Froms the feet.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.FromInches(System.Double)">
- <summary>
- Froms the inches.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.FromKilometers(System.Double)">
- <summary>
- Froms the kilometers.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.FromMeters(System.Double)">
- <summary>
- Froms the meters.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.FromNauticalMiles(System.Double)">
- <summary>
- Froms the nautical miles.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.FromStatuteMiles(System.Double)">
- <summary>
- Froms the statute miles.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.FromCentimeters(System.Int32)">
- <summary>
- Froms the centimeters.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.FromFeet(System.Int32)">
- <summary>
- Froms the feet.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.FromInches(System.Int32)">
- <summary>
- Froms the inches.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.FromKilometers(System.Int32)">
- <summary>
- Froms the kilometers.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.FromMeters(System.Int32)">
- <summary>
- Froms the meters.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.FromNauticalMiles(System.Int32)">
- <summary>
- Froms the nautical miles.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.FromStatuteMiles(System.Int32)">
- <summary>
- Froms the statute miles.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.ParseDistanceUnit(System.String)">
- <summary>
- Parses the distance unit.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.Parse(System.String)">
- <summary>
- Converts a string-based distance measurement into a Distance object.
- </summary>
- <param name="value"><para>A <strong>String</strong> describing a case-insensitive distance measurement,
- in any of the following formats, where <strong>N</strong> represents a numeric
- value:</para>
- <list type="bullet">
- <item>N m</item>
- <item>N meters</item>
- <item>N meter</item>
- <item>N metre</item>
- <item>N metres</item>
- <item>N km</item>
- <item>N kilometers</item>
- <item>N kilometer</item>
- <item>N kilometre</item>
- <item>N kilometres</item>
- <item>N ft</item>
- <item>N'</item>
- <item>N foot</item>
- <item>N feet</item>
- <item>N in</item>
- <item>N"</item>
- <item>N inch</item>
- <item>N inches</item>
- <item>N mi</item>
- <item>N mile</item>
- <item>N miles</item>
- <item>N nm</item>
- <item>N nautical mile</item>
- <item>N nautical miles</item>
- </list></param>
- <returns>A new Distance object containing the parsed <see cref="P:DotSpatial.Positioning.Distance.Value">value</see> and
- <see cref="P:DotSpatial.Positioning.Distance.Units">unit</see> type.</returns>
- <exception cref="T:System.ArgumentNullException" caption="ArgumentNullException">Parse method requires a valid distance measurement.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">1. The numeric portion of the distance measurement was not recognized.<br/>
- 2. The distance unit type was not recognized or not specified.</exception>
-
- <example>
- This example demonstrates how the Parse method can convert several string formats into a Distance object.
- <code lang="VB">
- Dim NewDistance As Distance
- ' Create a distance of 50 kilometers
- NewDistance = Distance.Parse("50 km")
- ' Create a distance of 14, 387 miles, then convert it into inches
- NewDistance = Distance.Parse("14, 387 statute miles").ToInches
- ' Parse an untrimmed measurement into 50 feet
- NewDistance = Distance.Parse(" 50 ' ")
- </code>
- <code lang="C#">
- Distance NewDistance;
- // Create a distance of 50 kilometers
- NewDistance = Distance.Parse("50 km");
- // Create a distance of 14, 387 miles, then convert it into inches
- NewDistance = Distance.Parse("14, 387 statute miles").ToInches;
- // Parse an untrimmed measurement into 50 feet
- NewDistance = Distance.Parse(" 50 ' ");
- </code>
- </example>
- <remarks>This powerful constructor is typically used to convert a string-based distance
- measurement, such as one entered by a user or read from a file, into a
- <strong>Distance</strong> object. This method will accept any output created via the
- <see cref="M:DotSpatial.Positioning.Distance.ToString">ToString</see> method.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.Parse(System.String,System.Globalization.CultureInfo)">
- <summary>
- Parses the specified value.
- </summary>
- <param name="value">The value.</param>
- <param name="culture">The culture.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.op_Addition(DotSpatial.Positioning.Distance,DotSpatial.Positioning.Distance)">
- <summary>
- Implements the operator +.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.op_Subtraction(DotSpatial.Positioning.Distance,DotSpatial.Positioning.Distance)">
- <summary>
- Implements the operator -.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.op_Multiply(DotSpatial.Positioning.Distance,DotSpatial.Positioning.Distance)">
- <summary>
- Implements the operator *.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.op_Division(DotSpatial.Positioning.Distance,DotSpatial.Positioning.Distance)">
- <summary>
- Implements the operator /.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.op_LessThan(DotSpatial.Positioning.Distance,DotSpatial.Positioning.Distance)">
- <summary>
- Implements the operator <.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.op_LessThanOrEqual(DotSpatial.Positioning.Distance,DotSpatial.Positioning.Distance)">
- <summary>
- Implements the operator <=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.op_Equality(DotSpatial.Positioning.Distance,DotSpatial.Positioning.Distance)">
- <summary>
- Implements the operator ==.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.op_Inequality(DotSpatial.Positioning.Distance,DotSpatial.Positioning.Distance)">
- <summary>
- Implements the operator !=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.op_GreaterThanOrEqual(DotSpatial.Positioning.Distance,DotSpatial.Positioning.Distance)">
- <summary>
- Implements the operator >=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.op_GreaterThan(DotSpatial.Positioning.Distance,DotSpatial.Positioning.Distance)">
- <summary>
- Implements the operator >.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.op_Explicit(System.String)~DotSpatial.Positioning.Distance">
- <summary>
- Performs an explicit conversion from <see cref="T:System.String"/> to <see cref="T:DotSpatial.Positioning.Distance"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.op_Explicit(DotSpatial.Positioning.Distance)~System.String">
- <summary>
- Performs an explicit conversion from <see cref="T:DotSpatial.Positioning.Distance"/> to <see cref="T:System.String"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.Equals(DotSpatial.Positioning.Distance)">
- <summary>
- Compares the current instance to the specified distance object.
- </summary>
- <param name="other">A <strong>Distance</strong> object to compare with.</param>
- <returns>A <strong>Boolean</strong>, True if the values are equivalent.</returns>
- <remarks>This method compares the current instance to the specified object up to four digits of precision.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.Equals(DotSpatial.Positioning.Distance,System.Int32)">
- <summary>
- Compares the current instance to the specified value, distance units, and precision.
- </summary>
- <param name="other">A <strong>Distance</strong> object to compare with.</param>
- <param name="decimals">An <strong>Integer</strong> specifying the number of digits to compare with.</param>
- <returns>A <strong>Boolean</strong>, True if the values are equivalent.</returns>
- <remarks>This method compares the current instance to the specified object at up to the specified number of digits of precision.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.ToString(System.String,System.IFormatProvider)">
- <summary>
- Outputs the current instance as a string using the specified format and local culture.
- </summary>
- <param name="format"><para>A combination of symbols, spaces, and any of the following case-insensitive
- letters: <strong>#</strong> or <strong>0</strong> for the value property, and <strong>U</strong> for
- distance units. Here are some examples:</para>
- <para>
- <table cellspacing="0" cols="3" cellpadding="2" width="100%">
- <tr>
- <td>##0.## uu</td>
- <td>## uuuu</td>
- <td># u</td>
- <td>###</td>
- </tr>
- </table>
- </para></param>
- <param name="formatProvider">Information about the culture to apply to the numeric format.</param>
- <returns>A <strong>String</strong> containing the distance in the specified format.</returns>
- <example>
- This example uses the ToString method to populate a TextBox with a distance measurement using a custom format and culture information.
- <code lang="VB">
- ' Declare a distance of 75 miles
- Dim MyDistance As New Distance(75, DistanceUnit.StatuteMiles)
- ' Set the text box to the distance, formatted as a string
- MyTextBox.Text = MyDistance.ToString("## uuu", CultureInfo.CurrentUICulture)
- </code>
- <code lang="C#">
- // Declare a distance of 75 miles
- Distance MyDistance = new Distance(75, DistanceUnit.StatuteMiles);
- // Set the text box to the distance, formatted as a string
- MyTextBox.Text = MyDistance.ToString("## uuu", CultureInfo.CurrentUICulture);
- </code>
- </example>
- <remarks>This method allows a custom format to be applied to the ToString method. Numeric formats
- will be adjusted to the machine's local UI culture.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.CompareTo(DotSpatial.Positioning.Distance)">
- <summary>
- Compares the current object with another object of the same type.
- </summary>
- <param name="other">An object to compare with this object.</param>
- <returns>A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has the following meanings:
- Value
- Meaning
- Less than zero
- This object is less than the <paramref name="other"/> parameter.
- Zero
- This object is equal to <paramref name="other"/>.
- Greater than zero
- This object is greater than <paramref name="other"/>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.System#Xml#Serialization#IXmlSerializable#GetSchema">
- <summary>
- This method is reserved and should not be used. When implementing the IXmlSerializable interface, you should return null (Nothing in Visual Basic) from this method, and instead, if specifying a custom schema is required, apply the <see cref="T:System.Xml.Serialization.XmlSchemaProviderAttribute"/> to the class.
- </summary>
- <returns>An <see cref="T:System.Xml.Schema.XmlSchema"/> that describes the XML representation of the object that is produced by the <see cref="M:System.Xml.Serialization.IXmlSerializable.WriteXml(System.Xml.XmlWriter)"/> method and consumed by the <see cref="M:System.Xml.Serialization.IXmlSerializable.ReadXml(System.Xml.XmlReader)"/> method.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.WriteXml(System.Xml.XmlWriter)">
- <summary>
- Converts an object into its XML representation.
- </summary>
- <param name="writer">The <see cref="T:System.Xml.XmlWriter"/> stream to which the object is serialized.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Distance.ReadXml(System.Xml.XmlReader)">
- <summary>
- Generates an object from its XML representation.
- </summary>
- <param name="reader">The <see cref="T:System.Xml.XmlReader"/> stream from which the object is deserialized.</param>
- </member>
- <member name="P:DotSpatial.Positioning.Distance.Value">
- <summary>
- Returns the numeric portion of a distance measurement.
- </summary>
- <value>A <strong>Double</strong> value.</value>
- <example>
- This example demonstrates how to use the Value property to modify a distance object. The object
- is then converted to kilometers.
- <code lang="VB">
- ' Declare a distance of 0 mi.
- Dim MyDistance As New Distance(0, DistanceUnit.StatuteMiles)
- ' Change the distance to 100 mi.
- MyDistance.Value = 100
- ' Change the distance to 12.3456 mi.
- MyDistance.Value = 12.3456
- ' Convert the measurement into kilometers
- MyDistance = MyDistance.ToKilometers
- </code>
- <code lang="C#">
- // Declare a distance of 0 mi.
- Distance MyDistance = new Distance(0, DistanceUnit.StatuteMiles);
- // Change the distance to 100 mi.
- MyDistance.Value = 100;
- // Change the distance to 12.3456 mi.
- MyDistance.Value = 12.3456;
- // Convert the measurement into kilometers
- MyDistance = MyDistance.ToKilometers;
- </code>
- </example>
-
- <seealso cref="P:DotSpatial.Positioning.Distance.Units">Units Property</seealso>
- <remarks>This property is paired with the <see cref="P:DotSpatial.Positioning.Distance.Units">Units</see> property to form a complete distance
- measurement.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Distance.Units">
- <summary>
- Describes the unit portion of a distance measurement.
- </summary>
- <value>A value from the <see cref="T:DotSpatial.Positioning.DistanceUnit">DistanceUnit</see> enumeration. Default
- is <strong>DistanceUnit.Meters</strong>.</value>
- <seealso cref="P:DotSpatial.Positioning.Distance.Value">Value Property</seealso>
- <remarks><para>Each distance measurement is comprised of a numeric <see cref="P:DotSpatial.Positioning.Distance.Value">value</see>
- and a unit type. This property describes the numeric value so that it may be
- explicitly identified. An instance of the <strong>Distance</strong> class may have a value
- of zero, but it is impossible to have an unspecified unit type.</para>
- <para><img src="BestPractice.jpg"/></para><para><strong>Use conversion methods instead of setting the
- Units property</strong></para>
- <para>When the Units property is changed, no conversion is performed on the
- Value property. This could lead to mathematical errors which are difficult to debug. Use
- conversion methods such as ToFeet or ToMeters instead.</para>
- <para>
- This example demonstrates poor programming when trying to add 100 feet to 100 meters
- by changing the Units property of the Distance2 object.
- <code lang="VB">
- ' Declare two distances
- Dim Distance1 As New Distance(50, DistanceUnit.Meters)
- Dim Distance2 As New Distance(100, DistanceUnit.Feet)
- ' Store their sum in another variable
- Dim Distance3 As New Distance(0, DistanceUnit.Meters)
- ' INCORRECT: Changing Units property does not convert Distance2!
- Distance2.Units = DistanceUnit.Meters
- Distance3.Value = Distance1.Value + Distance2.Value
- </code>
- <code lang="C#">
- // Declare two distances
- Distance Distance1 = new Distance(50, DistanceUnit.Meters);
- Distance Distance2 = new Distance(100, DistanceUnit.Feet);
- // Store their sum in another variable
- Distance Distance3 = new Distance(0, DistanceUnit.Meters);
- // INCORRECT: Changing Units property does not convert Distance2!
- Distance2.Units = DistanceUnit.Meters;
- Distance3.Value = Distance1.Value + Distance2.Value;
- </code>
- The correct technique is to use a conversion method to change the unit type instead
- of modifying the Units property.
- <code lang="VB">
- ' Declare two distances
- Dim Distance1 As New Distance(50, DistanceUnit.Meters)
- Dim Distance2 As New Distance(100, DistanceUnit.Feet)
- ' Store their sum in another variable
- Dim Distance3 As New Distance(0, DistanceUnit.Meters)
- ' CORRECT: The ToMeters method is used to standardize unit types
- Distance3.Value = Distance1.ToMeters().Value + Distance2.ToMeters().Value
- </code>
- <code lang="C#">
- // Declare two distances
- Distance Distance1 = new Distance(50, DistanceUnit.Meters);
- Distance Distance2 = new Distance(100, DistanceUnit.Feet);
- // Store their sum in another variable
- Distance Distance3 = new Distance(0, DistanceUnit.Meters);
- // CORRECT: The ToMeters method is used to standardize unit types
- Distance3.Value = Distance1.ToMeters().Value + Distance2.ToMeters().Value;
- </code>
- </para></remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Distance.IsInvalid">
- <summary>
- Returns whether the value is invalid or unspecified.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Distance.IsEmpty">
- <summary>
- Returns whether the value is zero.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Distance.IsMetric">
- <summary>
- Returns whether the unit of measurement is metric.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Distance.IsInfinity">
- <summary>
- Returns whether the value is infinite.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.DistanceUnit">
- <summary>
- Indicates the unit of measure for distance measurements.
- </summary>
- <seealso cref="P:DotSpatial.Positioning.Distance.Value">Value Property (Distance Class)</seealso>
-
- <seealso cref="P:DotSpatial.Positioning.Distance.Units">Units Property (Distance Class)</seealso>
- <remarks>This enumeration is most frequently used by the
- <see cref="P:DotSpatial.Positioning.Distance.Units">Units</see> property of the
- <see cref="T:DotSpatial.Positioning.Distance">Distance</see>
- class in conjunction with the <see cref="P:DotSpatial.Positioning.Distance.Value">Value</see>
- property to describe a straight-line distance.</remarks>
- </member>
- <member name="F:DotSpatial.Positioning.DistanceUnit.Kilometers">
- <summary>Metric System. Kilometers (thousands of meters).</summary>
- </member>
- <member name="F:DotSpatial.Positioning.DistanceUnit.Meters">
- <summary>Metric System. 1/1000th of a kilometer.</summary>
- </member>
- <member name="F:DotSpatial.Positioning.DistanceUnit.Centimeters">
- <summary>Metric System. 1/100th of a meter.</summary>
- </member>
- <member name="F:DotSpatial.Positioning.DistanceUnit.NauticalMiles">
- <summary>Nautical miles, also known as "sea miles".</summary>
- </member>
- <member name="F:DotSpatial.Positioning.DistanceUnit.StatuteMiles">
- <summary>Imperial System. A statute mile, most often referred to just as "mile."</summary>
- </member>
- <member name="F:DotSpatial.Positioning.DistanceUnit.Feet">
- <summary>Imperial System. Feet.</summary>
- </member>
- <member name="F:DotSpatial.Positioning.DistanceUnit.Inches">
- <summary>Imperial System. Inches.</summary>
- </member>
- <member name="T:DotSpatial.Positioning.Elevation">
- <summary>
- Represents a vertical angular measurement between -90° and 90°.
- </summary>
- <example>
- These examples create new instances of <strong>Elevation</strong> objects.
- </example>
-
- <seealso cref="T:DotSpatial.Positioning.Angle">Angle Class</seealso>
-
- <seealso cref="T:DotSpatial.Positioning.Azimuth">Azimuth Class</seealso>
-
- <seealso cref="T:DotSpatial.Positioning.Latitude">Latitude Class</seealso>
-
- <seealso cref="T:DotSpatial.Positioning.Longitude">Longitude Class</seealso>
-
- <example>
- These examples create new instances of Elevation objects.
- <code lang="VB" description="Create an angle of 90°">
- Dim MyElevation As New Elevation(90)
- </code>
- <code lang="CS" description="Create an angle of 90°">
- Elevation MyElevation = new Elevation(90);
- </code>
- <code lang="C++" description="Create an angle of 90°">
- Elevation MyElevation = new Elevation(90);
- </code>
- <code lang="VB" description="Create an angle of 105°30'21.4">
- Dim MyElevation1 As New Elevation(105, 30, 21.4)
- </code>
- <code lang="CS" description="Create an angle of 105°30'21.4">
- Elevation MyElevation = new Elevation(105, 30, 21.4);
- </code>
- <code lang="C++" description="Create an angle of 105°30'21.4">
- Elevation MyElevation = new Elevation(105, 30, 21.4);
- </code>
- </example>
- <remarks>This class is used to indicate a vertical angle where 90° represents a point
- directly overhead, 0° represents the horizon (striaght ahead), and -90° represents a
- point straight down. This class is typically combined with an <strong>Elevation</strong>
- object (which measures a horizontal angle) to form a three-dimensional direction to an
- object in space, such as a GPS satellite.</remarks>
- </member>
- <member name="F:DotSpatial.Positioning.Elevation.MAXIMUM_PRECISION_DIGITS">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Elevation._decimalDegrees">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Elevation.Minimum">
- <summary>
- Represents the minimum value of an angle in one turn of a circle.
- </summary>
- <example>
- This example creates an angle representing the minimum allowed value.
- <code lang="VB">
- Dim MyElevation As Elevation = Elevation.Minimum
- </code>
- <code lang="CS">
- Elevation MyElevation = Elevation.Minimum;
- </code>
- <code lang="C++">
- Elevation MyElevation = Elevation.Minimum;
- </code>
- </example>
-
- <value>An Elevation with a value of -359.999999°.</value>
- </member>
- <member name="F:DotSpatial.Positioning.Elevation.Empty">
- <summary>
- Represents an angle with no value.
- </summary>
- <value>An Elevation containing a value of zero (0°).</value>
-
- <seealso cref="P:DotSpatial.Positioning.Elevation.IsEmpty">IsEmpty Property</seealso>
- </member>
- <member name="F:DotSpatial.Positioning.Elevation.Infinity">
- <summary>
- Represents an angle with infinite value.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Elevation.Invalid">
- <summary>
- Represents an invalid or unspecified value.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Elevation.Maximum">
- <summary>
- Represents the maximum value of an angle in one turn of a circle.
- </summary>
- <example>
- This example creates an angle representing the maximum allowed value of 359.9999°.
- <code lang="VB">
- Dim MyElevation As Elevation = Elevation.Maximum
- </code>
- <code lang="CS">
- Elevation MyElevation = Elevation.Maximum;
- </code>
- </example>
- </member>
- <member name="F:DotSpatial.Positioning.Elevation.Zenith">
- <summary>
- Represents the point directly overhead.
- </summary>
- <value>An <strong>Elevation</strong> object.</value>
- </member>
- <member name="F:DotSpatial.Positioning.Elevation.HalfwayAboveHorizon">
- <summary>
- Represents a vertical direction halfway up from the horizon.
- </summary>
- <value>An <strong>Elevation</strong> object.</value>
- </member>
- <member name="F:DotSpatial.Positioning.Elevation.HalfwayBelowHorizon">
- <summary>
- Represents a vertical direction halfway below the horizon.
- </summary>
- <value>An <strong>Elevation</strong> object.</value>
- </member>
- <member name="F:DotSpatial.Positioning.Elevation.Horizon">
- <summary>
-
- </summary>
- <value>An <strong>Elevation</strong> object.</value>
- </member>
- <member name="F:DotSpatial.Positioning.Elevation.Nadir">
- <summary>
- Represents the point directly below one's feet.
- </summary>
- <value>An <strong>Elevation</strong> object.</value>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.#ctor(System.Double)">
- <summary>
- Creates a new instance with the specified decimal degrees.
- </summary>
- <param name="decimalDegrees">The decimal degrees.</param>
- <example>
- This example demonstrates how to create an angle with a measurement of 90°.
- <code lang="VB">
- Dim MyElevation As New Elevation(90)
- </code>
- <code lang="CS">
- Elevation MyElevation = new Elevation(90);
- </code>
- </example>
-
- <returns>An <strong>Elevation</strong> containing the specified value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.#ctor(System.Int32)">
- <summary>
- Creates a new instance with the specified degrees.
- </summary>
- <param name="hours">The hours.</param>
- <returns>An <strong>Elevation</strong> containing the specified value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.#ctor(System.Int32,System.Double)">
- <summary>
- Creates a new instance with the specified hours and decimal minutes.
- </summary>
- <param name="hours">The hours.</param>
- <param name="decimalMinutes">The decimal minutes.</param>
- <example>
- This example demonstrates how an angle can be created when only the hours and
- minutes (in decimal form) are known. This creates a value of 12°42.345'.
- <code lang="VB">
- Dim MyElevation As New Elevation(12, 42.345)
- </code>
- <code lang="VB">
- Elevation MyElevation = new Elevation(12, 42.345);
- </code>
- </example>
- <remarks>An <strong>Elevation</strong> containing the specified value.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.#ctor(System.Int32,System.Int32,System.Double)">
- <summary>
- Creates a new instance with the specified hours, minutes and
- seconds.
- </summary>
- <param name="hours">The hours.</param>
- <param name="minutes">The minutes.</param>
- <param name="seconds">The seconds.</param>
- <example>
- This example demonstrates how to create an angular measurement of 34°12'29.2 in
- hours, minutes and seconds.
- <code lang="VB">
- Dim MyElevation As New Elevation(34, 12, 29.2)
- </code>
- <code lang="CS">
- Elevation MyElevation = new Elevation(34, 12, 29.2);
- </code>
- </example>
-
- <returns>An <strong>Elevation</strong> containing the specified value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.#ctor(System.String)">
- <summary>
- Creates a new instance by converting the specified string.
- </summary>
- <param name="value">The value.</param>
- <seealso cref="M:DotSpatial.Positioning.Elevation.Parse(System.String,System.Globalization.CultureInfo)">Parse Method</seealso>
-
- <example>
- This example creates a new instance by parsing a string. (notice The double-quote is
- doubled up to represent a single double-quote in the string.)
- <code lang="VB">
- Dim MyElevation As New Elevation("123°45'67.8""")
- </code>
- <code lang="CS">
- Elevation MyElevation = new Elevation("123°45'67.8\"");
- </code>
- </example>
-
- <returns>An <strong>Elevation</strong> containing the specified value.</returns>
-
- <exception cref="T:System.ArgumentNullException" caption="ArgumentNullException">The Parse method requires a decimal or sexagesimal measurement.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">Only the right-most portion of a sexagesimal measurement can be a fractional value.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">Extra characters were encountered while parsing an angular measurement. Only hours, minutes, and seconds are allowed.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">The specified text was not fully understood as an angular measurement.</exception>
- <remarks>This constructor parses the specified string into an <strong>Elevation</strong>
- object using the current culture. This constructor can parse any strings created via
- the <strong>ToString</strong> method.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.#ctor(System.String,System.Globalization.CultureInfo)">
- <summary>
- Creates a new instance by converting the specified string using the specified
- culture.
- </summary>
- <param name="value">The value.</param>
- <param name="culture">The culture.</param>
- <exception cref="T:System.ArgumentNullException" caption="ArgumentNullException">The Parse method requires a decimal or sexagesimal measurement.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">Only the right-most portion of a sexagesimal measurement can be a fractional value.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">Extra characters were encountered while parsing an angular measurement. Only hours, minutes, and seconds are allowed.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">The specified text was not fully understood as an angular measurement.</exception>
- <remarks>This constructor parses the specified string into an <strong>Elevation</strong>
- object using a specific culture. This constructor can parse any strings created via the
- <strong>ToString</strong> method.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.#ctor(System.Xml.XmlReader)">
- <summary>
- Creates a new instance by deserializing the specified XML.
- </summary>
- <param name="reader">The reader.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.Normalize">
- <summary>
- Normalizes this instance.
- </summary>
- <returns></returns>
- <overloads>Converts a measurement to its equivalent value between -90 and
- 90 degrees.</overloads>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.Ceiling">
- <summary>
- Returns the smallest integer greater than the specified value.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.Floor">
- <summary>
- Returns the largest integer which is smaller than the specified value.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.Round(System.Int32)">
- <summary>
- Returns a new instance whose value is rounded the specified number of decimals.
- </summary>
- <param name="decimals">An <strong>Integer</strong> specifying the number of decimals to round off to.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.RoundSeconds">
- <summary>
- Returns a new instance whose Seconds property is evenly divisible by 15.
- </summary>
- <returns>An <strong>Elevation</strong> containing the rounded value.</returns>
- <remarks>This method is used to align or "snap" an angle to a regular interval. For
- example, a grid might be easier to read if it were drawn at 30-second intervals instead
- of 24.198-second intervals.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.RoundSeconds(System.Double)">
- <summary>
- Returns a new angle whose Seconds property is evenly divisible by the specified amount.
- </summary>
- <param name="interval">A <strong>Double</strong> between 0 and 60 indicating the interval to round
- to.</param>
- <returns>An <strong>Elevation</strong> containing the rounded value.</returns>
- <remarks>This method is used to align or "snap" an angle to a regular interval. For
- example, a grid might be easier to read if it were drawn at 30-second intervals instead
- of 24.198-second intervals.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.LesserOf(DotSpatial.Positioning.Elevation)">
- <summary>
- Returns the object with the smallest value.
- </summary>
- <param name="value">An <strong>Elevation</strong> object to compare to the current instance.</param>
- <returns>The <strong>Elevation</strong> containing the smallest value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.GreaterOf(DotSpatial.Positioning.Elevation)">
- <summary>
- Returns the object with the largest value.
- </summary>
- <param name="value">An <strong>Elevation</strong> object to compare to the current instance.</param>
- <returns>An <strong>Elevation</strong> containing the largest value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.Mirror">
- <summary>
- Returns an angle opposite of the current instance.
- </summary>
- <returns>An <strong>Elevation</strong> representing the mirrored value.</returns>
- <example>
- This example creates a new <strong>Elevation</strong> of 45° then calculates its mirror
- of 225°. (45 + 180)
- <code lang="VB" title="[New Example]">
- Dim Elevation1 As New Elevation(45)
- Dim Elevation2 As Elevation = Elevation1.Mirror()
- Debug.WriteLine(Elevation2.ToString())
- ' Output: 225
- </code>
- <code lang="CS" title="[New Example]">
- Elevation Elevation1 = new Elevation(45);
- Elevation Elevation2 = Elevation1.Mirror();
- Console.WriteLine(Elevation2.ToString());
- // Output: 225
- </code>
- </example>
- <remarks>This method returns the "opposite" of the current instance. The opposite is
- defined as the point on the other side of an imaginary circle. For example, if an angle
- is 0°, at the top of a circle, this method returns 180°, at the bottom of the
- circle.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.ToRadians">
- <summary>
- Converts the current instance into radians.
- </summary>
- <returns>A <see cref="T:DotSpatial.Positioning.Radian">Radian</see> object.</returns>
- <seealso cref="T:DotSpatial.Positioning.Radian">Radian Class</seealso>
-
- <overloads>Converts an angular measurement into radians before further processing.</overloads>
-
- <example>
- This example converts a measurement of 90° into radians.
- <code lang="VB">
- Dim MyElevation As New Elevation(90)
- Dim MyRadians As Radian = MyElevation.ToRadians()
- </code>
- <code lang="CS">
- Elevation MyElevation = new Elevation(90);
- Radian MyRadians = MyElevation.ToRadians();
- </code>
- </example>
- <remarks>This function is typically used to convert an angular measurement into
- radians before performing a trigonometric function.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.ToString(System.String)">
- <summary>
- Outputs the angle as a string using the specified format.
- </summary>
- <param name="format">The format.</param>
- <returns>A <strong>String</strong> in the specified format.</returns>
- <seealso cref="M:DotSpatial.Positioning.Elevation.ToString(System.String,System.IFormatProvider)">ToString Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Elevation.Parse(System.String)">Parse Method</seealso>
-
- <example>
- This example uses the <strong>ToString</strong> method to output an angle in a
- custom format. The " <strong>h°</strong> " code represents hours along with a
- degree symbol (Alt+0176 on the keypad), and " <strong>m.mm</strong> " represents
- the minutes out to two decimals. Mmm.
- <code lang="VB">
- Dim MyElevation As New Elevation(45, 16.772)
- Debug.WriteLine(MyElevation.ToString("h°m.mm"))
- ' Output: 45°16.78
- </code>
- <code lang="CS">
- Dim MyElevation As New Elevation(45, 16.772);
- Debug.WriteLine(MyElevation.ToString("h°m.mm"));
- // Output: 45°16.78
- </code>
- </example>
- <remarks>This method returns the current instance output in a specific format. If no
- value for the format is specified, a default format of "d.dddd°" is used. Any
- string output by this method can be converted back into an Elevation object using the
- <strong>Parse</strong> method or <strong>Elevation(string)</strong> constructor.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.Equals(System.Object)">
- <summary>
- Compares the current value to another Elevation object's value.
- </summary>
- <param name="obj">An <strong>Elevation</strong>, <strong>Double</strong>, or <strong>Integer</strong>
- to compare with.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the object's DecimalDegrees
- properties match.</returns>
- <remarks>This</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.GetHashCode">
- <summary>
- Returns a unique code for this instance.
- </summary>
- <returns>An <strong>Integer</strong> representing a unique code for the current
- instance.</returns>
- <remarks>Since the <strong>Elevation</strong> class is immutable, this property may be used
- safely with hash tables.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.ToString">
- <summary>
- Outputs the angle as a string using the default format.
- </summary>
- <returns>A <strong>String</strong> created using the default format.</returns>
- <seealso cref="M:DotSpatial.Positioning.Elevation.Parse(System.String)">Parse Method</seealso>
-
- <example>
- This example outputs a value of 90 degrees in the default format of ###.#°.
- <code lang="VB">
- Dim MyElevation As New Elevation(90)
- Debug.WriteLine(MyElevation.ToString)
- ' Output: "90°"
- </code>
- <code lang="CS">
- Elevation MyElevation = new Elevation(90);
- Debug.WriteLine(MyElevation.ToString());
- // Output: "90°"
- </code>
- </example>
- <remarks>This method formats the current instance using the default format of
- "d.dddd°." Any string output by this method can be converted back into an Elevation
- object using the <strong>Parse</strong> method or <strong>Elevation(string)</strong>
- constructor.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.Normalize(System.Double)">
- <summary>
- Normalizes the specified decimal degrees.
- </summary>
- <param name="decimalDegrees">The decimal degrees.</param>
- <returns></returns>
- <overloads>Converts a measurement to its equivalent value between -90 and
- 90 degrees.</overloads>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.ToDecimalDegrees(System.Int32,System.Int32,System.Double)">
- <summary>
- Converts arbitrary hour, minute and seconds into decimal degrees.
- </summary>
- <param name="hours">The hours.</param>
- <param name="minutes">The minutes.</param>
- <param name="seconds">The seconds.</param>
- <returns>A <strong>Double</strong> containing the decimal degree version of the specified
- values.</returns>
- <seealso cref="P:DotSpatial.Positioning.Latitude.DecimalDegrees">DecimalDegrees Property</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Latitude.Normalize">Normalize Method</seealso>
-
- <example>
- This example converts a value of 10°30'0" into decimal degrees (10.5).
- <code lang="VB" title="ToDecimalDegrees Example (VB)">
- Dim MyValue As Double = Latitude.ToDecimalDegrees(10, 30, 0)
- </code>
- <code lang="CS" title="ToDecimalDegrees Example (C#)">
- double MyValue = Latitude.ToDecimalDegrees(10, 30, 0);
- </code>
- </example>
- <remarks>This function is used to convert three-part measurements into a single value. The
- result of this method is typically assigned to the
- <see cref="P:DotSpatial.Positioning.Latitude.DecimalDegrees">
- DecimalDegrees</see> property. Values are rounded to thirteen decimal
- places, the maximum precision allowed by this type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.ToDecimalDegrees(System.Int32,System.Double)">
- <summary>
- Converts arbitrary hour and decimal minutes into decimal degrees.
- </summary>
- <param name="hours">The hours.</param>
- <param name="decimalMinutes">The decimal minutes.</param>
- <returns>A <strong>Double</strong> containing the decimal degree version of the specified
- values.</returns>
- <remarks>This function is used to convert three-part measurements into a single value. The
- result of this method is typically assigned to the
- <see cref="P:DotSpatial.Positioning.Latitude.DecimalDegrees">
- DecimalDegrees</see> property. Values are rounded to thirteen decimal
- places, the maximum precision allowed by this type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.ToDecimalDegrees(System.Int32)">
- <summary>
- Converts an hour value into decimal degrees.
- </summary>
- <param name="hours">The hours.</param>
- <returns>A <strong>Double</strong> containing the decimal degree version of the specified
- values.</returns>
- <remarks>The specified value will be converted to a double value.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.Random">
- <summary>
- Returns a random angle between 0° and 360°.
- </summary>
- <returns>An <strong>Elevation</strong> containing a random value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.Random(System.Random)">
- <summary>
- Returns a random Elevation between 0° and 360° using the specified random number
- seed.
- </summary>
- <param name="generator">A <strong>Random</strong> object used to ogenerate random values.</param>
- <returns>An <strong>Elevation</strong> containing a random value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.LesserOf(DotSpatial.Positioning.Elevation,DotSpatial.Positioning.Elevation)">
- <summary>
- Returns the object with the smallest value.
- </summary>
- <param name="value1">A <strong>Elevation</strong> object to compare to value2.</param>
- <param name="value2">A <strong>Elevation</strong> object to compare to value1.</param>
- <returns>The <strong>Elevation</strong> containing the smallest value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.GreaterOf(DotSpatial.Positioning.Elevation,DotSpatial.Positioning.Elevation)">
- <summary>
- Returns the object with the largest value.
- </summary>
- <param name="value1">A <strong>Elevation</strong> object to compare to value2.</param>
- <param name="value2">A <strong>Elevation</strong> object to compare to value1.</param>
- <returns>A <strong>Elevation</strong> containing the largest value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.ToRadians(DotSpatial.Positioning.Elevation)">
- <summary>
- Converts an angular measurement into radians.
- </summary>
- <param name="value">The value.</param>
- <returns>A <see cref="T:DotSpatial.Positioning.Radian"><strong>Radian</strong></see> object.</returns>
- <example>
- This example shows a quick way to convert an angle of 90° into radians.
- <code lang="VB">
- Dim MyRadian As Radian = Elevation.ToRadians(90)
- </code>
- <code lang="CS">
- Radian MyRadian = Elevation.ToRadians(90);
- </code>
- </example>
- <remarks>This function is typically used to convert an angular measurement into
- radians before performing a trigonometric function.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.FromRadians(DotSpatial.Positioning.Radian)">
- <summary>
- Converts a value in radians into an angular measurement.
- </summary>
- <param name="radians">The radians.</param>
- <returns></returns>
- <seealso cref="M:DotSpatial.Positioning.Elevation.ToRadians(DotSpatial.Positioning.Elevation)">ToRadians</seealso>
-
- <seealso cref="T:DotSpatial.Positioning.Radian">Radian Class</seealso>
-
- <example>
- This example uses the <strong>FromRadians</strong> method to convert a value of one
- radian into an <strong>Elevation</strong> of 57°.
- <code lang="VB">
- ' Create a new angle equal to one radian
- Dim MyRadians As New Radian(1)
- Dim MyElevation As Elevation = Elevation.FromRadians(MyRadians)
- Debug.WriteLine(MyElevation.ToString())
- ' Output: 57°
- </code>
- <code lang="CS">
- // Create a new angle equal to one radian
- Radian MyRadians = new Radian(1);
- Elevation MyElevation = Elevation.FromRadians(MyRadians);
- Console.WriteLine(MyElevation.ToString());
- // Output: 57°
- </code>
- </example>
- <remarks>This function is typically used in conjunction with the
- <see cref="M:DotSpatial.Positioning.Elevation.ToRadians">ToRadians</see>
- method after a trigonometric function has completed. The converted value is stored in
- the <see cref="P:DotSpatial.Positioning.Elevation.DecimalDegrees">DecimalDegrees</see> property.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.FromRadians(System.Double)">
- <summary>
- Froms the radians.
- </summary>
- <param name="radians">The radians.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.Parse(System.String)">
- <summary>
- Converts the specified string into an Elevation object.
- </summary>
- <param name="value">The value.</param>
- <returns>A new <strong>Elevation</strong> object populated with the specified
- values.</returns>
- <seealso cref="M:DotSpatial.Positioning.Elevation.ToString">ToString Method</seealso>
-
- <example>
- This example creates a new angular measurement using the <strong>Parse</strong>
- method.
- <code lang="VB">
- Dim NewElevation As Elevation = Elevation.Parse("123.45°")
- </code>
- <code lang="CS">
- Elevation NewElevation = Elevation.Parse("123.45°");
- </code>
- </example>
-
- <exception cref="T:System.ArgumentNullException" caption="ArgumentNullException">The Parse method requires a decimal or sexagesimal measurement.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">Only the right-most portion of a sexagesimal measurement can be a fractional value.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">Extra characters were encountered while parsing an angular measurement. Only hours, minutes, and seconds are allowed.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">The specified text was not fully understood as an angular measurement.</exception>
- <remarks>This method parses the specified string into an <strong>Elevation</strong> object
- using the current culture. This constructor can parse any strings created via the
- <strong>ToString</strong> method.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.Parse(System.String,System.Globalization.CultureInfo)">
- <summary>
- Converts the specified string into an <strong>Elevation</strong> object using the
- specified culture.
- </summary>
- <param name="value">A <strong>String</strong> describing an angle in the form of decimal degrees or a
- sexagesimal.</param>
- <param name="culture">A <strong>CultureInfo</strong> object describing the numeric format to use during
- conversion.</param>
- <returns>A new <strong>Elevation</strong> object equivalent to the specified string.</returns>
- <remarks>This powerful method is typically used to process data from a data store or a
- value input by the user in any culture. This function can accept any format which
- can be output by the ToString method.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.op_Addition(DotSpatial.Positioning.Elevation,DotSpatial.Positioning.Elevation)">
- <summary>
- Implements the operator +.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.op_Addition(DotSpatial.Positioning.Elevation,System.Double)">
- <summary>
- Implements the operator +.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.op_Subtraction(DotSpatial.Positioning.Elevation,DotSpatial.Positioning.Elevation)">
- <summary>
- Implements the operator -.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.op_Subtraction(DotSpatial.Positioning.Elevation,System.Double)">
- <summary>
- Implements the operator -.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.op_Multiply(DotSpatial.Positioning.Elevation,DotSpatial.Positioning.Elevation)">
- <summary>
- Implements the operator *.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.op_Multiply(DotSpatial.Positioning.Elevation,System.Double)">
- <summary>
- Implements the operator *.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.op_Division(DotSpatial.Positioning.Elevation,DotSpatial.Positioning.Elevation)">
- <summary>
- Implements the operator /.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.op_Division(DotSpatial.Positioning.Elevation,System.Double)">
- <summary>
- Implements the operator /.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.op_Equality(DotSpatial.Positioning.Elevation,DotSpatial.Positioning.Elevation)">
- <summary>
- Implements the operator ==.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.op_Equality(DotSpatial.Positioning.Elevation,System.Double)">
- <summary>
- Implements the operator ==.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.op_Inequality(DotSpatial.Positioning.Elevation,DotSpatial.Positioning.Elevation)">
- <summary>
- Implements the operator !=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.op_Inequality(DotSpatial.Positioning.Elevation,System.Double)">
- <summary>
- Implements the operator !=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.op_GreaterThan(DotSpatial.Positioning.Elevation,DotSpatial.Positioning.Elevation)">
- <summary>
- Implements the operator >.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.op_GreaterThan(DotSpatial.Positioning.Elevation,System.Double)">
- <summary>
- Implements the operator >.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.op_GreaterThanOrEqual(DotSpatial.Positioning.Elevation,DotSpatial.Positioning.Elevation)">
- <summary>
- Implements the operator >=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.op_GreaterThanOrEqual(DotSpatial.Positioning.Elevation,System.Double)">
- <summary>
- Implements the operator >=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.op_LessThan(DotSpatial.Positioning.Elevation,DotSpatial.Positioning.Elevation)">
- <summary>
- Implements the operator <.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.op_LessThan(DotSpatial.Positioning.Elevation,System.Double)">
- <summary>
- Implements the operator <.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.op_LessThanOrEqual(DotSpatial.Positioning.Elevation,DotSpatial.Positioning.Elevation)">
- <summary>
- Implements the operator <=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.op_LessThanOrEqual(DotSpatial.Positioning.Elevation,System.Double)">
- <summary>
- Implements the operator <=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.Increment">
- <summary>
- Returns the current instance increased by one.
- </summary>
- <returns>An <strong>Elevation</strong> object.</returns>
- <example>
- This example uses the <strong>Increment</strong> method to increase an Elevation's
- value. It also demonstrates the subtle error which can be caused if
- <strong>Increment</strong> is called while ignoring the return value.
- <code lang="VB" title="[New Example]">
- ' Correct use of Increment
- Dim Elevation1 As New Elevation(89)
- Elevation1 = Elevation1.Increment()
- ' Incorrect use of Increment
- Dim Elevation1 = New Elevation(89)
- Elevation1.Increment()
- 'notice Elevation1 will still be 89°!
- </code>
- <code lang="CS" title="[New Example]">
- // Correct use of Increment
- Elevation Elevation1 = new Elevation(89);
- Elevation1 = Elevation1.Increment();
- // Incorrect use of Increment
- Elevation Elevation1 = new Elevation(89);
- Elevation1.Increment();
- //notice Elevation1 will still be 89°!
- </code>
- </example>
- <remarks><para>This method increases the <strong>DecimalDegrees</strong> property by 1.0,
- returned as a new instance.</para>
- <para><font color="red">Since the <strong>Elevation</strong> class is immutable, this
- method cannot be used to modify an existing instance.</font></para></remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.Add(System.Double)">
- <summary>
- Increases the current instance by the specified value.
- </summary>
- <param name="value">A <strong>Double</strong> to add to the current instance.</param>
- <returns>A new <strong>Elevation</strong> containing the summed values.</returns>
- <example>
- This example adds 45° to the current instance of 45°, returning 90°.
- <code lang="VB" title="[New Example]">
- Dim Elevation1 As New Elevation(45)
- Elevation1 = Elevation1.Add(45)
- </code>
- <code lang="CS" title="[New Example]">
- Elevation Elevation1 = new Elevation(45);
- Elevation1 = Elevation1.Add(45);
- </code>
- </example>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.Add(DotSpatial.Positioning.Elevation)">
- <summary>
- Adds the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.Decrement">
- <summary>
- Returns the current instance decreased by one.
- </summary>
- <returns>An <strong>Elevation</strong> object.</returns>
- <example>
- This example uses the <strong>Decrement</strong> method to decrease an Elevation's
- value. It also demonstrates the subtle error which can be caused if
- <strong>Decrement</strong> is called while ignoring the return value.
- <code lang="VB" title="[New Example]">
- ' Correct use of Decrement
- Dim Elevation1 As New Elevation(91)
- Elevation1 = Elevation1.Decrement()
- ' Incorrect use of Decrement
- Dim Elevation1 = New Elevation(91)
- Elevation1.Increment()
- ' notice Elevation1 will still be 91°!
- </code>
- <code lang="CS" title="[New Example]">
- // Correct use of Decrement
- Elevation Elevation1 = new Elevation(91);
- Elevation1 = Elevation1.Decrement();
- // Incorrect use of Decrement
- Elevation Elevation1 = new Elevation(91);
- Elevation1.Decrement();
- // notice Elevation1 will still be 91°!
- </code>
- </example>
- <remarks><para>This method decreases the <strong>DecimalDegrees</strong> property by 1.0,
- returned as a new instance.</para>
- <para><font color="red">Since the <strong>Elevation</strong> class is immutable, this
- method cannot be used to modify an existing instance.</font></para></remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.Subtract(System.Double)">
- <summary>
- Decreases the current instance by the specified value.
- </summary>
- <param name="value">A <strong>Double</strong> to subtract from the current instance.</param>
- <returns>A new <strong>Elevation</strong> containing the new value.</returns>
- <example>
- This example subtracts 30° from the current instance of 90°, returning 60°.
- <code lang="VB" title="[New Example]">
- Dim Elevation1 As New Elevation(90)
- Elevation1 = Elevation1.Subtract(30)
- </code>
- <code lang="CS" title="[New Example]">
- Elevation Elevation1 = new Elevation(90);
- Elevation1 = Elevation1.Subtract(30);
- </code>
- </example>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.Subtract(DotSpatial.Positioning.Elevation)">
- <summary>
- Subtracts the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.Multiply(System.Double)">
- <summary>
- Multiplies the current instance by the specified value.
- </summary>
- <param name="value">A <strong>Double</strong> to multiply with the current instance.</param>
- <returns>A new <strong>Elevation</strong> containing the product of the two numbers.</returns>
- <example>
- This example multiplies 30° with three, returning 90°.
- <code lang="VB" title="[New Example]">
- Dim Elevation1 As New Elevation(30)
- Elevation1 = Elevation1.Multiply(3)
- </code>
- <code lang="CS" title="[New Example]">
- Elevation Elevation1 = new Elevation(30);
- Elevation1 = Elevation1.Multiply(3);
- </code>
- </example>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.Multiply(DotSpatial.Positioning.Elevation)">
- <summary>
- Multiplies the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.Divide(System.Double)">
- <summary>
- Divides the current instance by the specified value.
- </summary>
- <param name="value">A <strong>Double</strong> representing a denominator to divide by.</param>
- <returns>An <strong>Elevation</strong> containing the new value.</returns>
- <example>
- This example divides 90° by three, returning 30°.
- <code lang="VB" title="[New Example]">
- Dim Elevation1 As New Elevation(90)
- Elevation1 = Elevation1.Divide(3)
- </code>
- <code lang="CS" title="[New Example]">
- Elevation Elevation1 = new Elevation(90);
- Elevation1 = Elevation1.Divide(3);
- </code>
- </example>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.Divide(DotSpatial.Positioning.Elevation)">
- <summary>
- Divides the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.IsLessThan(DotSpatial.Positioning.Elevation)">
- <summary>
- Indicates if the current instance is smaller than the specified value.
- </summary>
- <param name="value">An <strong>Elevation</strong> to compare with the current instance.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the current instance is
- smaller than the specified value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.IsLessThan(System.Double)">
- <summary>
- Determines whether [is less than] [the specified value].
- </summary>
- <param name="value">The value.</param>
- <returns><c>true</c> if [is less than] [the specified value]; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.IsLessThanOrEqualTo(DotSpatial.Positioning.Elevation)">
- <summary>
- Indicates if the current instance is smaller than or equal to the specified
- value.
- </summary>
- <param name="value">An <strong>Elevation</strong> to compare with the current instance.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the current instance is
- smaller than or equal to the specified value.</returns>
- <remarks>This method compares the <strong>DecimalDegrees</strong> property with the
- specified value. This method is the same as the "<=" operator.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.IsLessThanOrEqualTo(System.Double)">
- <summary>
- Determines whether [is less than or equal to] [the specified value].
- </summary>
- <param name="value">The value.</param>
- <returns><c>true</c> if [is less than or equal to] [the specified value]; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.IsGreaterThan(DotSpatial.Positioning.Elevation)">
- <summary>
- Indicates if the current instance is larger than the specified value.
- </summary>
- <param name="value">An <strong>Elevation</strong> to compare with the current instance.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the current instance is
- greater than the specified value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.IsGreaterThan(System.Double)">
- <summary>
- Determines whether [is greater than] [the specified value].
- </summary>
- <param name="value">The value.</param>
- <returns><c>true</c> if [is greater than] [the specified value]; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.IsGreaterThanOrEqualTo(DotSpatial.Positioning.Elevation)">
- <summary>
- Indicates if the current instance is larger than or equal to the specified
- value.
- </summary>
- <param name="value">An <strong>Elevation</strong> to compare with the current instance.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the current instance is
- greater than or equal to the specified value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.IsGreaterThanOrEqualTo(System.Double)">
- <summary>
- Determines whether [is greater than or equal to] [the specified value].
- </summary>
- <param name="value">The value.</param>
- <returns><c>true</c> if [is greater than or equal to] [the specified value]; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.op_Explicit(DotSpatial.Positioning.Radian)~DotSpatial.Positioning.Elevation">
- <summary>
- Converts a measurement in Radians into an Elevation.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.op_Explicit(System.Double)~DotSpatial.Positioning.Elevation">
- <summary>
- Converts a decimal degree measurement as a Double into an Elevation.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.op_Explicit(System.Single)~DotSpatial.Positioning.Elevation">
- <summary>
- Converts a decimal degree measurement as a Double into an Elevation.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.op_Explicit(DotSpatial.Positioning.Elevation)~System.Double">
- <summary>
- Converts a decimal degree measurement as a Double into an Elevation.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.op_Explicit(DotSpatial.Positioning.Elevation)~System.Single">
- <summary>
- Converts a decimal degree measurement as a Double into an Elevation.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.op_Explicit(System.Int32)~DotSpatial.Positioning.Elevation">
- <summary>
- Converts a measurement in degrees as an Integer into an Elevation.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.op_Explicit(DotSpatial.Positioning.Angle)~DotSpatial.Positioning.Elevation">
- <summary>
- Performs an explicit conversion from <see cref="T:DotSpatial.Positioning.Angle"/> to <see cref="T:DotSpatial.Positioning.Elevation"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.op_Explicit(DotSpatial.Positioning.Azimuth)~DotSpatial.Positioning.Elevation">
- <summary>
- Performs an explicit conversion from <see cref="T:DotSpatial.Positioning.Azimuth"/> to <see cref="T:DotSpatial.Positioning.Elevation"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.op_Explicit(DotSpatial.Positioning.Latitude)~DotSpatial.Positioning.Elevation">
- <summary>
- Performs an explicit conversion from <see cref="T:DotSpatial.Positioning.Latitude"/> to <see cref="T:DotSpatial.Positioning.Elevation"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.op_Explicit(DotSpatial.Positioning.Longitude)~DotSpatial.Positioning.Elevation">
- <summary>
- Performs an explicit conversion from <see cref="T:DotSpatial.Positioning.Longitude"/> to <see cref="T:DotSpatial.Positioning.Elevation"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.op_Explicit(System.String)~DotSpatial.Positioning.Elevation">
- <summary>
- Converts a measurement in the form of a formatted String into an Elevation.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.op_Explicit(DotSpatial.Positioning.Elevation)~System.String">
- <summary>
- Converts an Elevation into a String.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- <remarks>This operator calls the ToString() method using the current culture.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.Clone">
- <summary>
- Creates a copy of the current instance.
- </summary>
- <returns>An <strong>Elevation</strong> of the same value as the current instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.ToString(System.String,System.IFormatProvider)">
- <summary>
- Outputs the angle as a string using the specified format.
- </summary>
- <param name="format">The format to use.-or- A null reference (Nothing in Visual Basic) to use the default format defined for the type of the <see cref="T:System.IFormattable"/> implementation.</param>
- <param name="formatProvider">The provider to use to format the value.-or- A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.</param>
- <returns>A <strong>String</strong> in the specified format.</returns>
- <seealso cref="M:DotSpatial.Positioning.Elevation.ToString">ToString Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Elevation.Parse(System.String)">Parse Method</seealso>
-
- <example>
- This example uses the <strong>ToString</strong> method to output an angle in a
- custom format. The " <strong>h°</strong> " code represents hours along with a
- degree symbol (Alt+0176 on the keypad), and " <strong>m.mm</strong> " represents
- the minutes out to two decimals. Mmm.
- <code lang="VB">
- Dim MyElevation As New Elevation(45, 16.772)
- Debug.WriteLine(MyElevation.ToString("h°m.mm", CultureInfo.CurrentCulture))
- ' Output: 45°16.78
- </code>
- <code lang="CS">
- Dim MyElevation As New Elevation(45, 16.772);
- Debug.WriteLine(MyElevation.ToString("h°m.mm", CultureInfo.CurrentCulture));
- // Output: 45°16.78
- </code>
- </example>
- <remarks>This method returns the current instance output in a specific format. If no
- value for the format is specified, a default format of "d.dddd" is used. Any string
- output by this method can be converted back into an Elevation object using the
- <strong>Parse</strong> method or <strong>Elevation(string)</strong> constructor.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.Equals(DotSpatial.Positioning.Elevation,System.Int32)">
- <summary>
- Compares the current instance to another instance using the specified
- precision.
- </summary>
- <param name="value">The value.</param>
- <param name="decimals">The decimals.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the
- <strong>DecimalDegrees</strong> property of the current instance matches the
- specified instance's <strong>DecimalDegrees</strong> property.</returns>
- <seealso cref="M:DotSpatial.Positioning.Elevation.Equals(DotSpatial.Positioning.Elevation)">Equals Method</seealso>
-
- <example>
- These examples compare two fractional values using specific numbers of digits for
- comparison.
- <code lang="VB" title="[New Example]">
- ' Equals will return False
- Dim Elevation1 As New Elevation(90.15);
- Dim Elevation2 As New Elevation(90.12);
- If Elevation1.Equals(Elevation2, 2) Then
- Debug.WriteLine("The values are the same to two digits of precision.");
- ' Equals will return True
- Dim Elevation1 As New Elevation(90.15);
- Dim Elevation2 As New Elevation(90.12);
- If Elevation1.Equals(Elevation2, 1) Then
- Debug.WriteLine("The values are the same to one digit of precision.");
- </code>
- <code lang="CS" title="[New Example]">
- // Equals will return False
- Elevation Elevation1 = new Elevation(90.15);
- Elevation Elevation2 = new Elevation(90.12);
- if (Elevation1.Equals(Elevation2, 2))
- Console.WriteLine("The values are the same to two digits of precision.");
- // Equals will return True
- Elevation Elevation1 = new Elevation(90.15);
- Elevation Elevation2 = new Elevation(90.12);
- if (Elevation1.Equals(Elevation2, 1))
- Console.WriteLine("The values are the same to one digits of precision.");
- </code>
- </example>
- <remarks><para>This is typically used in cases where precision is only significant for a few
- digits and exact comparison is not necessary.</para>
- <para><em>notice This method compares objects by value, not by
- reference.</em></para></remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.Equals(DotSpatial.Positioning.Elevation)">
- <summary>
- Equalses the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns>Whether the two elevations are equivalent.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.CompareTo(DotSpatial.Positioning.Elevation)">
- <summary>
- Returns a value indicating the relative order of two objects.
- </summary>
- <param name="other">An <strong>Elevation</strong> object to compare with.</param>
- <returns>A value of -1, 0, or 1 as documented by the IComparable interface.</returns>
- <remarks>This method allows collections of <strong>Azimuth</strong> objects to be sorted.
- The <see cref="P:DotSpatial.Positioning.Elevation.DecimalDegrees">DecimalDegrees</see> property of each instance is compared.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.System#Xml#Serialization#IXmlSerializable#GetSchema">
- <summary>
- This method is reserved and should not be used. When implementing the IXmlSerializable interface, you should return null (Nothing in Visual Basic) from this method, and instead, if specifying a custom schema is required, apply the <see cref="T:System.Xml.Serialization.XmlSchemaProviderAttribute"/> to the class.
- </summary>
- <returns>An <see cref="T:System.Xml.Schema.XmlSchema"/> that describes the XML representation of the object that is produced by the <see cref="M:System.Xml.Serialization.IXmlSerializable.WriteXml(System.Xml.XmlWriter)"/> method and consumed by the <see cref="M:System.Xml.Serialization.IXmlSerializable.ReadXml(System.Xml.XmlReader)"/> method.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.WriteXml(System.Xml.XmlWriter)">
- <summary>
- Converts an object into its XML representation.
- </summary>
- <param name="writer">The <see cref="T:System.Xml.XmlWriter"/> stream to which the object is serialized.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Elevation.ReadXml(System.Xml.XmlReader)">
- <summary>
- Generates an object from its XML representation.
- </summary>
- <param name="reader">The <see cref="T:System.Xml.XmlReader"/> stream from which the object is deserialized.</param>
- </member>
- <member name="P:DotSpatial.Positioning.Elevation.DecimalDegrees">
- <summary>
- Returns the value of the angle as decimal degrees.
- </summary>
- <value>A <strong>Double</strong> value.</value>
- <seealso cref="P:DotSpatial.Positioning.Elevation.Hours">Hours Property</seealso>
-
- <seealso cref="P:DotSpatial.Positioning.Elevation.Minutes">Minutes Property</seealso>
-
- <seealso cref="P:DotSpatial.Positioning.Elevation.Seconds">Seconds Property</seealso>
-
- <example>
- This example demonstrates how the
- <see cref="P:DotSpatial.Positioning.Elevation.DecimalDegrees"><strong>DecimalDegrees</strong></see> property is
- calculated automatically when creating an angle using hours, minutes and seconds.
- <code lang="VB">
- ' Create an angle of 20°30'
- Dim MyElevation As New Elevation(20, 30)
- ' Setting the DecimalMinutes recalculated other properties
- Debug.WriteLine(MyElevation.DecimalDegrees)
- ' Output: "20.5" the same as 20°30'
- </code>
- <code lang="CS">
- // Create an angle of 20°30'
- Elevation MyElevation = New Elevation(20, 30);
- // Setting the DecimalMinutes recalculated other properties
- Console.WriteLine(MyElevation.DecimalDegrees)
- // Output: "20.5" the same as 20°30'
- </code>
- </example>
- <remarks>This property returns the value of the angle as a single number.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Elevation.DecimalMinutes">
- <summary>
- Returns the minutes and seconds as a single numeric value.
- </summary>
- <value>A <strong>Double</strong> value.</value>
- <seealso cref="P:DotSpatial.Positioning.Elevation.Minutes">Minutes Property</seealso>
-
- <seealso cref="P:DotSpatial.Positioning.Elevation.DecimalDegrees">DecimalDegrees Property</seealso>
-
- <example>
- This example demonstrates how the <strong>DecimalMinutes</strong> property is
- automatically calculated when creating a new angle.
- <code lang="VB">
- ' Create an angle of 20°10'30"
- Dim MyElevation As New Elevation(20, 10, 30)
- ' The DecimalMinutes property is automatically calculated
- Debug.WriteLine(MyElevation.DecimalMinutes)
- ' Output: "10.5"
- </code>
- <code lang="CS">
- // Create an angle of 20°10'30"
- Elevation MyElevation = new Elevation(20, 10, 30);
- // The DecimalMinutes property is automatically calculated
- Console.WriteLine(MyElevation.DecimalMinutes)
- // Output: "10.5"
- </code>
- </example>
- <remarks>This property is used when minutes and seconds are represented as a single
- decimal value.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Elevation.Hours">
- <summary>
- Returns the integer hours (degrees) portion of an angular
- measurement.
- </summary>
- <value>An <strong>Integer</strong> value.</value>
- <seealso cref="P:DotSpatial.Positioning.Elevation.Minutes">Minutes Property</seealso>
-
- <seealso cref="P:DotSpatial.Positioning.Elevation.Seconds">Seconds Property</seealso>
-
- <example>
- This example creates an angle of 60.5° then outputs the value of the
- <strong>Hours</strong> property, 60.
- <code lang="VB">
- Dim MyElevation As New Elevation(60.5)
- Debug.WriteLine(MyElevation.Hours)
- ' Output: 60
- </code>
- <code lang="CS">
- Elevation MyElevation = new Elevation(60.5);
- Console.WriteLine(MyElevation.Hours);
- // Output: 60
- </code>
- </example>
- <remarks>This property is used in conjunction with the <see cref="P:DotSpatial.Positioning.Elevation.Minutes">Minutes</see>
- and <see cref="P:DotSpatial.Positioning.Elevation.Seconds">Seconds</see> properties to create a full angular measurement.
- This property is the same as <strong>DecimalDegrees</strong> without any fractional
- value.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Elevation.Minutes">
- <summary>
- Returns the integer minutes portion of an angular measurement.
- </summary>
- <value>An <strong>Integer</strong>.</value>
- <seealso cref="P:DotSpatial.Positioning.Elevation.Hours">Hours Property</seealso>
-
- <seealso cref="P:DotSpatial.Positioning.Elevation.Seconds">Seconds Property</seealso>
-
- <example>
- This example creates an angle of 45.5° then outputs the value of the
- <strong>Minutes</strong> property, 30.
- <code lang="VB">
- Dim MyElevation As New Elevation(45.5)
- Debug.WriteLine(MyElevation.Minutes)
- ' Output: 30
- </code>
- <code lang="CS">
- Elevation MyElevation = new Elevation(45.5);
- Console.WriteLine(MyElevation.Minutes);
- // Output: 30
- </code>
- </example>
- <remarks>This property is used in conjunction with the <see cref="P:DotSpatial.Positioning.Elevation.Hours">Hours</see> and
- <see cref="P:DotSpatial.Positioning.Elevation.Seconds">Seconds</see> properties to create a sexagesimal
- measurement.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Elevation.Seconds">
- <summary>
- Returns the seconds minutes portion of an angular measurement.
- </summary>
- <value>A <strong>Double</strong> value.</value>
- <seealso cref="P:DotSpatial.Positioning.Elevation.Hours">Hours Property</seealso>
-
- <seealso cref="P:DotSpatial.Positioning.Elevation.Minutes">Minutes Property</seealso>
-
- <example>
- This example creates an angle of 45°10.5' then outputs the value of the
- <strong>Seconds</strong> property, 30.
- <code lang="VB">
- Dim MyElevation As New Elevation(45, 10.5)
- Debug.WriteLine(MyElevation.Seconds)
- ' Output: 30
- </code>
- <code lang="CS">
- Dim MyElevation As New Elevation(45, 10.5);
- Console.WriteLine(MyElevation.Seconds);
- // Output: 30
- </code>
- </example>
- <remarks>This property is used in conjunction with the <see cref="P:DotSpatial.Positioning.Elevation.Hours">Hours</see> and
- <see cref="P:DotSpatial.Positioning.Elevation.Minutes">Minutes</see> properties to create a sexagesimal
- measurement.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Elevation.IsEmpty">
- <summary>
- Indicates if the current instance has a non-zero value.
- </summary>
- <value>A <strong>Boolean</strong>, <strong>True</strong> if the
- <strong>DecimalDegrees</strong> property is zero.</value>
- <seealso cref="F:DotSpatial.Positioning.Elevation.Empty">Empty Field</seealso>
- </member>
- <member name="P:DotSpatial.Positioning.Elevation.IsInfinity">
- <summary>
- Indicates if the current instance represents an infinite value.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Elevation.IsInvalid">
- <summary>
- Indicates if the current instance is invalid or unspecified.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Elevation.IsNormalized">
- <summary>
- Indicates whether the current instance has been normalized and is within the
- allowed bounds of -90° and 90°.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.Ellipsoid">
- <summary>
- Represents a flattened sphere which approximates Earth's size and shape.
- </summary>
- <remarks><para>Mathematics involving points on Earth's surface are difficult to perform with
- precision because the Earth's surface is rugged. In order to maximize precision,
- scientists developed "ellipsoids," smooth ellipsoidal shapes (known as "oblate
- spheriods" or flattened spheres) which attempt to approximate Earth's exact shape.
- Like datums, ellipsoids have been subject to frequent revisions thanks to advances
- in technology, yet countries cannot quickly abandon outdated ellipsoids because so
- much infrastructure is built upon them. As a result, multiple ellipsoids are
- tracked and utilized when converting coordinates from one locale to another. Today,
- there are approximately thirty known ellipsoids upon which an estimated 120
- individual coordinate systems are built.</para>
- <para>This class is typically used during coordinate conversion to convert from one
- interpretation of Earth's shape to another. All known worldwide ellipsoids such as
- WGS84 and Clarke 1880 are provided as static (Shared in Visual Basic) fields. Most
- developers will not have to use this class until coordinates must be plotted on a
- map. For most purposes, using the default ellipsoid of WGS84 is sufficient.</para>
- <para>Instances of this class are guaranteed to be thread-safe because the class is
- immutable (its properties can only be set via constructors).</para></remarks>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid._epsgNumber">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid._equatorialRadius">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid._equatorialRadiusMeters">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid._polarRadius">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid._polarRadiusMeters">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid._name">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid._flattening">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid._inverseFlattening">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid._eccentricity">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid._eccentricitySquared">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid._ellipsoids">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid._epsgEllipsoids">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Airy1830">
- <summary>
- Represents the Airy ellipsoid of 1830.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.AiryModified1949">
- <summary>
- Represents the Modified Airy ellipsoid.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.AustralianNational1965">
- <summary>
- Represents the Australian National ellipsoid of 1965.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Bessel1841">
- <summary>
- Represents the Bessel ellipsoid of 1841.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Bessel1841Mod">
- <summary>
- Represents the Bessel Modified ellipsoid of 1841.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Bessel1841Namibia">
- <summary>
- Represents the Bessel (Namibia) ellipsoid of 1841.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Clarke1858">
- <summary>
- Represents the Clarke ellipsoid of 1858.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Clarke1866">
- <summary>
- Represents the Clarke ellipsoid of 1866.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Clarke1866Michigan">
- <summary>
- Represents the Clarke (Michigan) ellipsoid of 1866.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Clarke1880Benoit">
- <summary>
- Represents the Clarke (Benoit) ellipsoid of 1880.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Clarke1880IGN">
- <summary>
- Represents the Clarke (IGN) ellipsoid of 1880.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Clarke1880RGS">
- <summary>
- Represents the Clarke (RGS) ellipsoid of 1880.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Clarke1880Arc">
- <summary>
- Represents the Clarke (Arc) ellipsoid of 1880.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Clarke1880SGA">
- <summary>
- Represents the Clarke (SGA 1822) ellipsoid of 1880.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Everest1937">
- <summary>
- Represents the Everest (1937 Adjustment) ellipsoid of 1830.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Everest1967">
- <summary>
- Represents the Everest (1967 Definition) ellipsoid of 1830.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Everest1830Modified">
- <summary>
- Represents the Everest (Modified 1948) ellipsoid of 1880.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Grs80">
- <summary>
- Represents the Geodetic Reference System ellipsoid of 1980.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Helmert1906">
- <summary>
- Represents the Helmert ellipsoid of 1906.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Indonesian1974">
- <summary>
- Represents the Indonesian ellipsoid of 1974.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.International1909">
- <summary>
- Represents the International ellipsoid of 1909 (1924 alias).
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.International1924">
- <summary>
- Represents the International ellipsoid of 1924.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Krassovsky1940">
- <summary>
- Represents the Krassovsky ellipsoid of 1940.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Nwl9D">
- <summary>
- Represents the Naval Weapons Lab ellipsoid of 1965.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Plessis1817">
- <summary>
- Represents the Plessis ellipsoid of 1817.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Struve1860">
- <summary>
- Represents the Struve ellipsoid of 1860.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.WarOffice">
- <summary>
- Represents the War Office ellipsoid.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Wgs1984">
- <summary>
- Represents the World Geodetic System ellipsoid of 1984.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Gem10C">
- <summary>
- Represents the GEM 10C Gravity Potential Model ellipsoid.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Osu86F">
- <summary>
- Represents the OSU86 gravity potential (geoidal) model ellipsoid.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Osu91A">
- <summary>
- Represents the OSU91 gravity potential (geoidal) model ellipsoid.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Clarke1880">
- <summary>
- Represents the Clarke ellipsoid of 1880.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.AuthalicSphere">
- <summary>
- Represents the Authalic Sphere (r=6371000).
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Grs67">
- <summary>
- Represents the Geodetic Reference System ellipsoid of 1967.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Ats1977">
- <summary>
- Represents the Average Terrestrial System ellipsoid of 1977.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Everest1830">
- <summary>
- Represents the Everest (1830 Definition) ellipsoid.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Wgs1972">
- <summary>
- Represents the World Geodetic System ellipsoid of 1972.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Everest1962">
- <summary>
- Represents the Everest (1962 Definition) ellipsoid of 1830.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Everest1975">
- <summary>
- Represents the Everest (1975 Definition) ellipsoid of 1830.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Bessel1841Japan">
- <summary>
- Represents the Bessel (Japan) ellipsoid of 1841.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Grs1980AuthalicSphere">
- <summary>
- Represents the GRS 1980 Authalic Sphere (r=6371007).
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Xian1980">
- <summary>
- Represents the Xian ellipsoid of 1980.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Iau76">
- <summary>
- Represents the IAU ellipsoid of 1976.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Grs67Sad69">
- <summary>
- Represents the Geodetic Reference System (SAD69) ellipsoid of 1967.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Danish1876">
- <summary>
- Represents the Danish ellipsoid of 1876.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Andrae">
- <summary>
- Represents the Andrae (Danish 1876 alternate) ellipsoid of 1876.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.NormalSphere">
- <summary>
- Represents the Common Sphere (Clarke 1866 Authalic Sphere alias).
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Clarke1866AuthalicSphere">
- <summary>
- Represents the Clarke 1866 Authalic Sphere (r=6370997).
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Hough1960">
- <summary>
- Represents the Hough ellipsoid of 1960.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Pz1990">
- <summary>
- Represents the PZ90 ellipsoid.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Clarke1880InternationalFoot">
- <summary>
- Represents the Clarke (international foot) ellipsoid of 1880.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Everest1880Rso">
- <summary>
- Represents the Everest (RSO 1969) ellipsoid of 1880.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.International1924AuthalicSphere">
- <summary>
- Represents the International 1924 Authalic Sphere.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Hughes1980">
- <summary>
- Represents the Hughes ellipsoid of 1980.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Apl49">
- <summary>
- Represents the Applied Physics ellipsoid of 1965.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Cpm">
- <summary>
- Represents the Comm. des Poids et Mesures ellipsoid of 1799.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Delmabre">
- <summary>
- Represents the Delambre (Belgium) ellipsoid of 1810.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Engelis">
- <summary>
- Represents the Engelis ellipsoid of 1985.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Fischer1960">
- <summary>
- Represents the Fisher ellipsoid of 1960.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.ModifiedFischer1960">
- <summary>
- Represents the Modified Fisher ellipsoid of 1960.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Fischer1968">
- <summary>
- Represents the Fisher ellipsoid of 1968.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.NewInternational1967">
- <summary>
- Represents the New International ellipsoid of 1967.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Kaula">
- <summary>
- Represents the Kaula ellipsoid of 1961.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Lerch">
- <summary>
- Represents the Lerch ellipsoid of 1979.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Merit">
- <summary>
- Represents the MERIT ellipsoid of 1983.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Maupertius">
- <summary>
- Represents the Maupertius ellipsoid of 1738.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.SoutheastAsia">
- <summary>
- Represents the Southeast Asia (Modified Fisher ellipsoid of 1960) ellipsoid.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Sgs1985">
- <summary>
- Represents the SGS ellipsoid of 1985.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.SouthAmerican1969">
- <summary>
- Represents the South American ellipsoid of 1969.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Walbeck">
- <summary>
- Represents the Walbeck ellipsoid.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Wgs1960">
- <summary>
- Represents the World Geodetic System ellipsoid of 1960.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Wgs1966">
- <summary>
- Represents the World Geodetic System ellipsoid of 1966.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Ellipsoid.Default">
- <summary>
- Represents the default ellipsoid, WGS1984.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Ellipsoid.#ctor(System.String,DotSpatial.Positioning.Distance,DotSpatial.Positioning.Distance)">
- <summary>
- Creates a new instance with the specified type, name, equatorial raduis and polar radius.
- </summary>
- <param name="name">The name.</param>
- <param name="equatorialRadius">The equatorial radius.</param>
- <param name="polarRadius">The polar radius.</param>
- <remarks>This constructor allows user-defined ellipsoids to be created for specialized applications.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Ellipsoid.#ctor(System.String,DotSpatial.Positioning.Distance,System.Double)">
- <summary>
- Internal contructor for static list generation
- </summary>
- <param name="name">The name.</param>
- <param name="equatorialRadius">The equatorial radius.</param>
- <param name="inverseFlattening">The inverse flattening.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Ellipsoid.#ctor(System.Int32,System.Double,System.Double,System.Double,System.String)">
- <summary>
- Internal contructor for static list generation
- </summary>
- <param name="epsgNumber">The epsg number.</param>
- <param name="a">A.</param>
- <param name="invf">The invf.</param>
- <param name="b">The b.</param>
- <param name="name">The name.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Ellipsoid.#ctor(System.Xml.XmlReader)">
- <summary>
- Creates a new instance from the specified XML.
- </summary>
- <param name="reader">The reader.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Ellipsoid.SanityCheck">
- <summary>
- Validates the ellipsoid. Called in the constructor.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Ellipsoid.Calculate">
- <summary>
- Calculates the common ellipsoid properties. Called from the constructor
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Ellipsoid.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
- </summary>
- <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
- <returns><c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Ellipsoid.GetHashCode">
- <summary>
- Returns a hash code for this instance.
- </summary>
- <returns>A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Ellipsoid.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Ellipsoid.FromName(System.String)">
- <summary>
- Returns a Ellipsoid object matching the specified name.
- </summary>
- <param name="name">A <strong>String</strong> describing the name of an existing Ellipsoid.</param>
- <returns>A <strong>Ellipsoid</strong> object matching the specified string, or null if no Ellipsoid was found.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Ellipsoid.FromEpsgNumber(System.Int32)">
- <summary>
- Returns the datum corresponding to the EPSG code
- </summary>
- <param name="epsgNumber">The epsg number.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Ellipsoid.Equals(DotSpatial.Positioning.Ellipsoid)">
- <summary>
- Returns whether the current ellipsoid has the same value as the specified ellipsoid.
- </summary>
- <param name="other">An <strong>Ellipsoid</strong> object to compare against.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the equatorial radius and polar radius
- of both ellipsoids are equal. When both radii are equal, all other calculated properties will also
- be equal. The name of the ellipsoid is not compared.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Ellipsoid.Equals(DotSpatial.Positioning.Ellipsoid,System.Int32)">
- <summary>
- Returns whether the current ellipsoid has the same value as the specified ellipsoid.
- </summary>
- <param name="other">An <strong>Ellipsoid</strong> object to compare against.</param>
- <param name="decimals">An <strong>integer</strong> specifies the precision for the comparison.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the equatorial radius and polar radius
- of both ellipsoids are equal. When both radii are equal, all other calculated properties will also
- be equal. The name of the ellipsoid is not compared.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Ellipsoid.System#Xml#Serialization#IXmlSerializable#GetSchema">
- <summary>
- This method is reserved and should not be used. When implementing the IXmlSerializable interface, you should return null (Nothing in Visual Basic) from this method, and instead, if specifying a custom schema is required, apply the <see cref="T:System.Xml.Serialization.XmlSchemaProviderAttribute"/> to the class.
- </summary>
- <returns>An <see cref="T:System.Xml.Schema.XmlSchema"/> that describes the XML representation of the object that is produced by the <see cref="M:System.Xml.Serialization.IXmlSerializable.WriteXml(System.Xml.XmlWriter)"/> method and consumed by the <see cref="M:System.Xml.Serialization.IXmlSerializable.ReadXml(System.Xml.XmlReader)"/> method.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Ellipsoid.WriteXml(System.Xml.XmlWriter)">
- <summary>
- Converts an object into its XML representation.
- </summary>
- <param name="writer">The <see cref="T:System.Xml.XmlWriter"/> stream to which the object is serialized.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Ellipsoid.ReadXml(System.Xml.XmlReader)">
- <summary>
- Generates an object from its XML representation.
- </summary>
- <param name="reader">The <see cref="T:System.Xml.XmlReader"/> stream from which the object is deserialized.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Ellipsoid.OnReadXml(System.Xml.XmlReader)">
- <summary>
- Called when [read XML].
- </summary>
- <param name="reader">The reader.</param>
- </member>
- <member name="P:DotSpatial.Positioning.Ellipsoid.EpsgNumber">
- <summary>
- European Petroleum Survey Group number for this ellipsoid. The ESPG standards are now maintained by OGP
- (International Association of Oil and Gas Producers).
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Ellipsoid.Name">
- <summary>
- Indicates the descriptive name of the ellipsoid.
- </summary>
- <value>A <strong>String</strong> containing the name of the ellipsoid.</value>
- <remarks>This property is typically used to display ellipsoid information on a user interface.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Ellipsoid.EquatorialRadius">
- <summary>
- Represents the distance from Earth's center to the equator.
- </summary>
- <value>A <strong>Distance</strong> object.</value>
- <seealso cref="P:DotSpatial.Positioning.Ellipsoid.PolarRadius">PolarRadius Property</seealso>
- <remarks>This property defines the radius of the Earth from its center to the equator.
- This property is used in conjunction with the <strong>PolarRadius</strong> property
- to define an ellipsoidal shape. This property returns the same value as the
- <strong>SemiMajorAxis</strong> property.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Ellipsoid.PolarRadius">
- <summary>
- Represents the distance from Earth's center to the North or South pole.
- </summary>
- <value>A <strong>Distance</strong> object.</value>
- <seealso cref="P:DotSpatial.Positioning.Ellipsoid.EquatorialRadius">EquatorialRadius Property</seealso>
- <remarks>This property defines the radius of the Earth from its center to the equator.
- This property is used in conjunction with the <strong>EquatorialRadius</strong>
- property to define an ellipsoidal shape. This property returns the same value as
- the <strong>SemiMinorAxis</strong> property.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Ellipsoid.SemiMajorAxis">
- <summary>
- Represents the distance from Earth's center to the equator.
- </summary>
- <value>A <strong>Distance</strong> containing Earth's equatorial radius.</value>
- <seealso cref="P:DotSpatial.Positioning.Ellipsoid.EquatorialRadius">EquatorialRadius Property</seealso>
- <remarks>This property defines the radius of the Earth from its center to the equator.
- This property is used in conjunction with the <strong>SemiMinorAxis</strong>
- property to define an ellipsoidal shape. This property returns the same value as
- the <strong>EquatorialRadius</strong> property.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Ellipsoid.SemiMinorAxis">
- <summary>
- Represents the distance from Earth's center to the North or South pole.
- </summary>
- <value>A <strong>Distance</strong> containing Earth's polar radius.</value>
- <seealso cref="P:DotSpatial.Positioning.Ellipsoid.EquatorialRadius">EquatorialRadius Property</seealso>
- <remarks>This property defines the radius of the Earth from its center to the equator.
- This property is used in conjunction with the <strong>SemiMajorAxis</strong>
- property to define an ellipsoidal shape. This property returns the same value as
- the <strong>PolarRadius</strong> property.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Ellipsoid.IsSpherical">
- <summary>
- Indicates if the ellipsoid is describing a perfect sphere.
- </summary>
- <remarks>Mathematical formulas such as map projection and coordinate conversion can be
- optimized if the ellipsoid they are working with is spherical. For more precise
- results, however, spherical ellipsoids should not be used. This property, when used
- correctly, can improve performance for mathematics when coordinate precision is less of
- a concern, such as viewing a map from a high altitude.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Ellipsoid.InverseFlattening">
- <summary>
- Indicates the inverse of the shape of an ellipsoid relative to a sphere.
- </summary>
- <value>A <strong>Double</strong> containing the ellipsoid's flattening.</value>
- <seealso cref="P:DotSpatial.Positioning.Ellipsoid.EquatorialRadius">EquatorialRadius Property</seealso>
- <remarks>This property is used frequently in equations. Inverse flattening is defined as
- one divided by the <strong>Flattening</strong> property.:</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Ellipsoid.Flattening">
- <summary>
- Indicates the shape of the ellipsoid relative to a sphere.
- </summary>
- <value>A <strong>Double</strong> containing the ellipsoid's flattening.</value>
- <seealso cref="P:DotSpatial.Positioning.Ellipsoid.EquatorialRadius">EquatorialRadius Property</seealso>
- <remarks>This property compares the equatorial radius with the polar radius to measure the
- amount that the ellipsoid is "squished" vertically.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Ellipsoid.Eccentricity">
- <summary>
- Returns the rate of flattening of the ellipsoid.
- </summary>
- <value>A <strong>Double</strong> measuring how elongated the ellipsoid is.</value>
- <remarks>The eccentricity is a positive number less than 1, or 0 in the case of a circle.
- The greater the eccentricity is, the larger the ratio of the equatorial radius to the
- polar radius is, and therefore the more elongated the ellipse is.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Ellipsoid.EccentricitySquared">
- <summary>
- Returns the square of the eccentricity.
- </summary>
- <remarks>This property returns the value of the <strong>Eccentricity</strong> property,
- squared. It is used frequently during coordinate conversion formulas.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Ellipsoid.PolarRadiusMeters">
- <summary>
- Gets the polar radius meters.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Ellipsoid.EquatorialRadiusMeters">
- <summary>
- Gets the equatorial radius meters.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Ellipsoid.SemiMajorAxisMeters">
- <summary>
- Gets the semi major axis meters.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Ellipsoid.SemiMinorMeters">
- <summary>
- Gets the semi minor meters.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.AngleEventArgs">
- <summary>
- Represents information about an angle when an angle-related event is raised.
- </summary>
- <example>
- This example demonstrates how to use <strong>AngleEventArgs</strong> when raising
- an event.
- <code lang="VB">
- ' Declare a new event
- Dim MyAngleEvent As AngleEventHandler
- Sub Main()
- ' Create an angle of 90°
- Dim MyAngle As New Angle(90);
- ' Raise our custom Event
- RaiseEvent MyAngleEvent(Me, New AngleEventArgs(MyAngle));
- End Sub
- </code>
- <code lang="CS">
- // Declare a new event
- AngleEventHandler MyAngleEvent;
- void Main()
- {
- // Create an angle of 90°
- Angle MyAngle = new Angle(90);
- // Raise our custom event
- if (MyAngleEvent != null)
- MyAngleEvent(this, new AngleEventArgs(MyAngle));
- }
- </code>
- </example>
-
- <seealso cref="P:DotSpatial.Positioning.AngleEventArgs.Angle">Angle Class</seealso>
- <remarks>This class is used for events which use an <strong>Angle</strong> as a
- parameter.</remarks>
- </member>
- <member name="F:DotSpatial.Positioning.AngleEventArgs._angle">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.AngleEventArgs.#ctor(DotSpatial.Positioning.Angle)">
- <summary>
- Creates a new instance containing the specified Angle object.
- </summary>
- <param name="angle">The angle.</param>
- </member>
- <member name="P:DotSpatial.Positioning.AngleEventArgs.Angle">
- <summary>
- Represents information about an angular measurement when an angle-related event is raised.
- </summary>
- <value>An <strong>Angle</strong> object containing a property which has changed.</value>
- <seealso cref="P:DotSpatial.Positioning.AngleEventArgs.Angle">Angle Class</seealso>
- <remarks>This class is used by the <see cref="P:DotSpatial.Positioning.AngleEventArgs.Angle">Angle</see> class to provide notification when hours, minutes, or seconds properties have changed.</remarks>
- </member>
- <member name="T:DotSpatial.Positioning.AreaEventArgs">
- <summary>
- Represents information about a area when an area-related event is raised.
- </summary>
- <example>
- This example demonstrates how to use the <strong>AreaEventArgs</strong> class when
- raising an event.
- <code lang="VB">
- ' Declare a new event
- Dim MyAreaEvent As AreaEventHandler
- Sub Main()
- ' Create a Area of 125 kilometers
- Dim MyArea As New Area(125, AreaUnit.SquareKilometers)
- ' Raise our custom event
- RaiseEvent MyAreaEvent(Me, New AreaEventArgs(MyArea))
- End Sub
- </code>
- <code lang="CS">
- // Declare a new event
- AreaEventHandler MyAreaEvent;
- void Main()
- {
- // Create a Area of 125 kilometers
- Area MyArea = new Area(125, AreaUnit.SquareKilometers);
- // Raise our custom event
- if (MyAreaEvent != null)
- MyAreaEvent(this, New AreaEventArgs(MyArea));
- }
- </code>
- </example>
-
- <seealso cref="P:DotSpatial.Positioning.AreaEventArgs.Area">Area Class</seealso>
- </member>
- <member name="F:DotSpatial.Positioning.AreaEventArgs._area">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.AreaEventArgs.#ctor(DotSpatial.Positioning.Area)">
- <summary>
- Creates a new instance containing the specified Area object.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="P:DotSpatial.Positioning.AreaEventArgs.Area">
- <summary>
- Represents information about a Area measurement when an Area-related event is raised.
- </summary>
- <value>A <strong>Area</strong> object containing a property which has changed.</value>
- <seealso cref="P:DotSpatial.Positioning.AreaEventArgs.Area">Area Class</seealso>
- <remarks>This class is used by the <see cref="P:DotSpatial.Positioning.AreaEventArgs.Area">Area</see> class to provide notification
- when hours, minutes, or seconds properties have changed.</remarks>
- </member>
- <member name="T:DotSpatial.Positioning.AzimuthEventArgs">
- <summary>
- Represents information about an angle when an angle-related event is raised.
- </summary>
- <example>
- This example demonstrates how to use <strong>AzimuthEventArgs</strong> when raising
- an event.
- <code lang="VB">
- ' Declare a new event
- Dim MyAzimuthEvent As AzimuthEventHandler
- Sub Main()
- ' Create an angle of 90°
- Dim MyAzimuth As New Azimuth(90);
- ' Raise our custom Event
- RaiseEvent MyAzimuthEvent(Me, New AzimuthEventArgs(MyAzimuth));
- End Sub
- </code>
- <code lang="CS">
- // Declare a new event
- AzimuthEventHandler MyAzimuthEvent;
- void Main()
- {
- // Create an angle of 90°
- Azimuth MyAzimuth = new Azimuth(90);
- // Raise our custom event
- if (MyAzimuthEvent != null)
- MyAzimuthEvent(this, new AzimuthEventArgs(MyAzimuth));
- }
- </code>
- </example>
-
- <seealso cref="P:DotSpatial.Positioning.AzimuthEventArgs.Azimuth">Azimuth Class</seealso>
- <remarks>This class is used for events which use an <strong>Azimuth</strong> as a
- parameter.</remarks>
- </member>
- <member name="F:DotSpatial.Positioning.AzimuthEventArgs._azimuth">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.AzimuthEventArgs.#ctor(DotSpatial.Positioning.Azimuth)">
- <summary>
- Creates a new instance containing the specified Azimuth object.
- </summary>
- <param name="angle">The angle.</param>
- </member>
- <member name="P:DotSpatial.Positioning.AzimuthEventArgs.Azimuth">
- <summary>
- Represents information about an angular measurement when an angle-related event is raised.
- </summary>
- <value>An <strong>Azimuth</strong> object containing a property which has changed.</value>
- <seealso cref="P:DotSpatial.Positioning.AzimuthEventArgs.Azimuth">Azimuth Class</seealso>
- <remarks>This class is used by the <see cref="P:DotSpatial.Positioning.AzimuthEventArgs.Azimuth">Azimuth</see> class to provide notification when hours, minutes, or seconds properties have changed.</remarks>
- </member>
- <member name="T:DotSpatial.Positioning.CancelableEventArgs">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.CancelableEventArgs._canceled">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.CancelableEventArgs.#ctor(System.Boolean)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.CancelableEventArgs"/> class.
- </summary>
- <param name="isCanceled">if set to <c>true</c> [is canceled].</param>
- </member>
- <member name="P:DotSpatial.Positioning.CancelableEventArgs.Canceled">
- <summary>
- Controls whether an operation is to be aborted.
- </summary>
- <value><c>true</c> if canceled; otherwise, <c>false</c>.</value>
- <remarks>This property, when set to True will signal that a pending operation should not execute. For example,
- an event which is raised immediately before connecting would check this property to determine whether to
- continue connecting, or exit.</remarks>
- </member>
- <member name="T:DotSpatial.Positioning.DistanceEventArgs">
- <summary>
- Represents information about a distance when an distance-related event is raised.
- </summary>
- <example>This example demonstrates how to use this class when raising an event.
- <code lang="VB">
- ' Declare a new event
- Dim MyDistanceEvent As DistanceEventHandler
- ' Create a distance of 125 kilometers
- Dim MyDistance As New Distance(125, DistanceUnit.Kilometers)
- Sub Main()
- ' Raise our custom event
- RaiseEvent MyDistanceEvent(Me, New DistanceEventArgs(MyDistance))
- End Sub
- </code>
- <code lang="C#">
- // Declare a new event
- DistanceEventHandler MyDistanceEvent;
- // Create a distance of 125 kilometers
- Distance MyDistance = new Distance(125, DistanceUnit.Kilometers);
- void Main()
- {
- // Raise our custom event
- MyDistanceEvent(this, New DistanceEventArgs(MyDistance));
- }
- </code>
- </example>
-
- <seealso cref="P:DotSpatial.Positioning.DistanceEventArgs.Distance">Distance Class</seealso>
- <remarks>This class is typically used for events in the <see cref="P:DotSpatial.Positioning.DistanceEventArgs.Distance">Distance</see> class to
- provide notification when hours, minutes, decimal minutes or seconds properties have changed.</remarks>
- </member>
- <member name="F:DotSpatial.Positioning.DistanceEventArgs._distance">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.DistanceEventArgs.#ctor(DotSpatial.Positioning.Distance)">
- <summary>
- Creates a new instance containing the specified Distance object.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="P:DotSpatial.Positioning.DistanceEventArgs.Distance">
- <summary>
- Represents information about a distance measurement when an distance-related event is raised.
- </summary>
- <value>A <strong>Distance</strong> object containing a property which has changed.</value>
- <seealso cref="P:DotSpatial.Positioning.DistanceEventArgs.Distance">Distance Class</seealso>
- <remarks>This class is used by the <see cref="P:DotSpatial.Positioning.DistanceEventArgs.Distance">Distance</see> class to provide notification
- when hours, minutes, or seconds properties have changed.</remarks>
- </member>
- <member name="T:DotSpatial.Positioning.ElevationEventArgs">
- <summary>
- Represents information about an angle when an angle-related event is raised.
- </summary>
- <example>
- This example demonstrates how to use <strong>ElevationEventArgs</strong> when raising
- an event.
- <code lang="VB">
- ' Declare a new event
- Dim MyElevationEvent As ElevationEventHandler
- Sub Main()
- ' Create an angle of 90°
- Dim MyElevation As New Elevation(90);
- ' Raise our custom Event
- RaiseEvent MyElevationEvent(Me, New ElevationEventArgs(MyElevation));
- End Sub
- </code>
- <code lang="CS">
- // Declare a new event
- ElevationEventHandler MyElevationEvent;
- void Main()
- {
- // Create an angle of 90°
- Elevation MyElevation = new Elevation(90);
- // Raise our custom event
- if (MyElevationEvent != null)
- MyElevationEvent(this, new ElevationEventArgs(MyElevation));
- }
- </code>
- </example>
-
- <seealso cref="P:DotSpatial.Positioning.ElevationEventArgs.Elevation">Elevation Class</seealso>
- <remarks>This class is used for events which use an <strong>Elevation</strong> as a
- parameter.</remarks>
- </member>
- <member name="F:DotSpatial.Positioning.ElevationEventArgs._elevation">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.ElevationEventArgs.#ctor(DotSpatial.Positioning.Elevation)">
- <summary>
- Creates a new instance containing the specified Elevation object.
- </summary>
- <param name="angle">The angle.</param>
- </member>
- <member name="P:DotSpatial.Positioning.ElevationEventArgs.Elevation">
- <summary>
- Represents information about an angular measurement when an angle-related event is raised.
- </summary>
- <value>An <strong>Elevation</strong> object containing a property which has changed.</value>
- <seealso cref="P:DotSpatial.Positioning.ElevationEventArgs.Elevation">Elevation Class</seealso>
- <remarks>This class is used by the <see cref="P:DotSpatial.Positioning.ElevationEventArgs.Elevation">Elevation</see> class to provide notification when hours, minutes, or seconds properties have changed.</remarks>
- </member>
- <member name="T:DotSpatial.Positioning.LatitudeEventArgs">
- <summary>
- Represents information about an angle when an angle-related event is raised.
- </summary>
- <example>
- This example demonstrates how to use <strong>LatitudeEventArgs</strong> when raising
- an event.
- <code lang="VB">
- ' Declare a new event
- Dim MyLatitudeEvent As LatitudeEventHandler
- Sub Main()
- ' Create an angle of 90°
- Dim MyLatitude As New Latitude(90);
- ' Raise our custom Event
- RaiseEvent MyLatitudeEvent(Me, New LatitudeEventArgs(MyLatitude));
- End Sub
- </code>
- <code lang="CS">
- // Declare a new event
- LatitudeEventHandler MyLatitudeEvent;
- void Main()
- {
- // Create an angle of 90°
- Latitude MyLatitude = new Latitude(90);
- // Raise our custom event
- if (MyLatitudeEvent != null)
- MyLatitudeEvent(this, new LatitudeEventArgs(MyLatitude));
- }
- </code>
- </example>
-
- <seealso cref="P:DotSpatial.Positioning.LatitudeEventArgs.Latitude">Latitude Class</seealso>
- <remarks>This class is used for events which use an <strong>Latitude</strong> as a
- parameter.</remarks>
- </member>
- <member name="F:DotSpatial.Positioning.LatitudeEventArgs._latitude">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.LatitudeEventArgs.#ctor(DotSpatial.Positioning.Latitude)">
- <summary>
- Creates a new instance containing the specified Latitude object.
- </summary>
- <param name="angle">The angle.</param>
- </member>
- <member name="P:DotSpatial.Positioning.LatitudeEventArgs.Latitude">
- <summary>
- Represents information about an angular measurement when an angle-related event is raised.
- </summary>
- <value>An <strong>Latitude</strong> object containing a property which has changed.</value>
- <seealso cref="P:DotSpatial.Positioning.LatitudeEventArgs.Latitude">Latitude Class</seealso>
- <remarks>This class is used by the <see cref="P:DotSpatial.Positioning.LatitudeEventArgs.Latitude">Latitude</see> class to provide notification when hours, minutes, or seconds properties have changed.</remarks>
- </member>
- <member name="T:DotSpatial.Positioning.LongitudeEventArgs">
- <summary>
- Represents information about an angle when an angle-related event is raised.
- </summary>
- <example>
- This example demonstrates how to use <strong>LongitudeEventArgs</strong> when raising
- an event.
- <code lang="VB">
- ' Declare a new event
- Dim MyLongitudeEvent As LongitudeEventHandler
- Sub Main()
- ' Create an angle of 90°
- Dim MyLongitude As New Longitude(90);
- ' Raise our custom Event
- RaiseEvent MyLongitudeEvent(Me, New LongitudeEventArgs(MyLongitude));
- End Sub
- </code>
- <code lang="CS">
- // Declare a new event
- LongitudeEventHandler MyLongitudeEvent;
- void Main()
- {
- // Create an angle of 90°
- Longitude MyLongitude = new Longitude(90);
- // Raise our custom event
- if (MyLongitudeEvent != null)
- MyLongitudeEvent(this, new LongitudeEventArgs(MyLongitude));
- }
- </code>
- </example>
-
- <seealso cref="P:DotSpatial.Positioning.LongitudeEventArgs.Longitude">Longitude Class</seealso>
- <remarks>This class is used for events which use an <strong>Longitude</strong> as a
- parameter.</remarks>
- </member>
- <member name="F:DotSpatial.Positioning.LongitudeEventArgs._longitude">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.LongitudeEventArgs.#ctor(DotSpatial.Positioning.Longitude)">
- <summary>
- Creates a new instance containing the specified Longitude object.
- </summary>
- <param name="longitude">The longitude.</param>
- </member>
- <member name="P:DotSpatial.Positioning.LongitudeEventArgs.Longitude">
- <summary>
- Represents information about an angular measurement when an angle-related event is raised.
- </summary>
- <value>An <strong>Longitude</strong> object containing a property which has changed.</value>
- <seealso cref="P:DotSpatial.Positioning.LongitudeEventArgs.Longitude">Longitude Class</seealso>
- <remarks>This class is used by the <see cref="P:DotSpatial.Positioning.LongitudeEventArgs.Longitude">Longitude</see> class to provide notification when hours, minutes, or seconds properties have changed.</remarks>
- </member>
- <member name="T:DotSpatial.Positioning.PositionEventArgs">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.PositionEventArgs._position">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.PositionEventArgs.#ctor(DotSpatial.Positioning.Position)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.PositionEventArgs"/> class.
- </summary>
- <param name="position">The position.</param>
- </member>
- <member name="P:DotSpatial.Positioning.PositionEventArgs.Position">
- <summary>
- Gets the position.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.RadianEventArgs">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.RadianEventArgs._radians">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.RadianEventArgs.#ctor(DotSpatial.Positioning.Radian)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.RadianEventArgs"/> class.
- </summary>
- <param name="radian">The radian.</param>
- </member>
- <member name="P:DotSpatial.Positioning.RadianEventArgs.Radians">
- <summary>
- Gets the radians.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.SpeedEventArgs">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.SpeedEventArgs._speed">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.SpeedEventArgs.#ctor(DotSpatial.Positioning.Speed)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.SpeedEventArgs"/> class.
- </summary>
- <param name="speed">The speed.</param>
- </member>
- <member name="P:DotSpatial.Positioning.SpeedEventArgs.Speed">
- <summary>
- Gets the speed.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.TimeSpanEventArgs">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.TimeSpanEventArgs._timeSpan">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.TimeSpanEventArgs.#ctor(System.TimeSpan)">
- <summary>
- Creates a new instance containing the specified TimeSpan object.
- </summary>
- <param name="timeSpan">The time span.</param>
- <seealso cref="P:DotSpatial.Positioning.TimeSpanEventArgs.TimeSpan">TimeSpan Property</seealso>
-
- <seealso cref="T:System.TimeSpan">TimeSpan Structure</seealso>
- </member>
- <member name="P:DotSpatial.Positioning.TimeSpanEventArgs.TimeSpan">
- <summary>
- Indicates a length of time which is the target of the event.
- </summary>
- <value>A <strong>TimeSpan</strong> object describing a length of time.</value>
- <seealso cref="T:System.TimeSpan">TimeSpan Structure</seealso>
- </member>
- <member name="T:DotSpatial.Positioning.DateTimeEventArgs">
- <summary>
- Represents information about the date and time reported by the GPS device.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DateTimeEventArgs._dateTime">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DateTimeEventArgs._systemClockUpdated">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.DateTimeEventArgs.#ctor(System.DateTime)">
- <summary>
- Creates a new instance.
- </summary>
- <param name="dateTime">The date time.</param>
- </member>
- <member name="M:DotSpatial.Positioning.DateTimeEventArgs.#ctor(System.DateTime,System.Boolean)">
- <summary>
- Creates a new instance.
- </summary>
- <param name="dateTime">The date time.</param>
- <param name="systemClockUpdated">if set to <c>true</c> [system clock updated].</param>
- </member>
- <member name="P:DotSpatial.Positioning.DateTimeEventArgs.DateTime">
- <summary>
- A date and time value in UTC time (not adjusted for the local time zone).
- </summary>
- <value>A DateTime object containing a date and time reported by the GPS device.</value>
- <seealso cref="T:System.DateTime">DateTime Class</seealso>
-
- <seealso cref="M:System.DateTime.ToLocalTime">ToLocalTime Method (DateTime Class)</seealso>
- <remarks>This date and time value is not adjusted to the local time zone. Use the
- <see cref="M:System.DateTime.ToLocalTime">ToLocalTime</see> method to adjust to local time.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.DateTimeEventArgs.SystemClockUpdated">
- <summary>
- Indicates whether the system clock updated to match the <see cref="P:DotSpatial.Positioning.DateTimeEventArgs.DateTime"/>.
- </summary>
- <value><see langword="true">True</see> if the system clock was updated; otherwise, <see langword="false"/>.
- The default is <see langword="false"/>.</value>
- </member>
- <member name="T:DotSpatial.Positioning.ExceptionEventArgs">
- <summary>
- Represents information about an exception when an error-related event is raised.
- </summary>
- <example>This example demonstrates how to use this class when raising an event.
- <code lang="VB">
- ' Create a new exception
- Dim MyException As New ApplicationException("The error was successfully created.")
- ' Declare a new event
- Dim MyErrorEvent As ExceptionEventHandler
- Sub Main()
- ' Raise our custom event
- RaiseEvent MyErrorEvent(Me, New ExceptionEventArgs(MyException))
- End Sub
- </code>
- <code lang="C#">
- // Create a new exception
- ApplicationException MyException = new ApplicationException("The error was successfully created.")
- // Declare a new event
- ExceptionEventHandler MyErrorEvent;
- void Main()
- {
- // Raise our custom event
- MySatelliteEvent(this, New ExceptionEventArgs(MyException));
- }
- </code>
- </example>
- <remarks>This object is used throughout the GPS.NET framework to provide notification when
- either of two situations occur:
- <list>
- <item>An exception is thrown which cannot be trapped via a Try..Catch block (such as from a separate thread)</item>
- <item>An exception is thrown which can be recovered from and should not halt the current operation.</item>
- </list>
- Most frequently, this class is used when a parsing exception occurs via the Parse method or during automatic
- data collection.</remarks>
- </member>
- <member name="F:DotSpatial.Positioning.ExceptionEventArgs._exception">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.ExceptionEventArgs.#ctor(System.Exception)">
- <summary>
- Creates a new instance containing the specified exception object.
- </summary>
- <param name="exception">The exception.</param>
- </member>
- <member name="P:DotSpatial.Positioning.ExceptionEventArgs.Exception">
- <summary>
- Indicates information about the error and its location within a module.
- </summary>
- <value>An <strong>ApplicationException</strong> object or derivitive describing the error.</value>
- </member>
- <member name="T:DotSpatial.Positioning.ProgressEventArgs">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.ProgressEventArgs._current">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.ProgressEventArgs._total">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.ProgressEventArgs.Empty">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.ProgressEventArgs.#ctor(System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.ProgressEventArgs"/> class.
- </summary>
- <param name="total">The total.</param>
- </member>
- <member name="M:DotSpatial.Positioning.ProgressEventArgs.#ctor(System.Int32,System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.ProgressEventArgs"/> class.
- </summary>
- <param name="current">The current.</param>
- <param name="total">The total.</param>
- </member>
- <member name="P:DotSpatial.Positioning.ProgressEventArgs.Total">
- <summary>
- Gets the total.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.ProgressEventArgs.Current">
- <summary>
- Gets the current.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.GeographicSize">
- <summary>
- Represents a two-dimensional rectangular area.
- </summary>
- <remarks>Instances of this class are guaranteed to be thread-safe because the class is
- immutable (it's properties can only be set via constructors).</remarks>
- </member>
- <member name="F:DotSpatial.Positioning.GeographicSize._width">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.GeographicSize._height">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.GeographicSize.Empty">
- <summary>
- Represents a size with no value.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.GeographicSize.Minimum">
- <summary>
- Represents a size with no value.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.GeographicSize.Maximum">
- <summary>
- Represents the largest possible size on Earth's surface.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.GeographicSize.Invalid">
- <summary>
- Represents an invalid geographic size.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicSize.#ctor(DotSpatial.Positioning.Distance,DotSpatial.Positioning.Distance)">
- <summary>
- Creates a new instance.
- </summary>
- <param name="width">The width.</param>
- <param name="height">The height.</param>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicSize.#ctor(System.String)">
- <summary>
- Creates a new instance from the specified string.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicSize.#ctor(System.String,System.Globalization.CultureInfo)">
- <summary>
- Creates a new instance from the specified string in the specified culture.
- </summary>
- <param name="value">The value.</param>
- <param name="culture">The culture.</param>
- <remarks>This method will attempt to split the specified string into two values, then parse each value
- as an Distance object. The string must contain two numbers separated by a comma (or other character depending
- on the culture).</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicSize.ToAspectRatio(DotSpatial.Positioning.Distance,DotSpatial.Positioning.Distance)">
- <summary>
- Toes the aspect ratio.
- </summary>
- <param name="width">The width.</param>
- <param name="height">The height.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicSize.ToAspectRatio(System.Single)">
- <summary>
- Toes the aspect ratio.
- </summary>
- <param name="aspectRatio">The aspect ratio.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicSize.Add(DotSpatial.Positioning.GeographicSize)">
- <summary>
- Adds the specified size to the current instance.
- </summary>
- <param name="size">The size.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicSize.Subtract(DotSpatial.Positioning.GeographicSize)">
- <summary>
- Subtracts the specified size from the current instance.
- </summary>
- <param name="size">The size.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicSize.Multiply(DotSpatial.Positioning.GeographicSize)">
- <summary>
- Multiplies the width and height by the specified size.
- </summary>
- <param name="size">A <strong>GeographicSize</strong> specifying how to much to multiply the width and height.</param>
- <returns>A <strong>GeographicSize</strong> representing the product of the current instance with the specified size.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicSize.Divide(DotSpatial.Positioning.GeographicSize)">
- <summary>
- Divides the width and height by the specified size.
- </summary>
- <param name="size">The size.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicSize.ToString(System.String)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format.</param>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicSize.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
- </summary>
- <param name="obj">Another object to compare to.</param>
- <returns><c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicSize.GetHashCode">
- <summary>
- Returns a unique code based on the object's value.
- </summary>
- <returns>A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicSize.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicSize.Parse(System.String)">
- <summary>
- Returns a GeographicSize whose value matches the specified string.
- </summary>
- <param name="value">A <strong>String</strong> describing a width, followed by a height.</param>
- <returns>A <strong>GeographicSize</strong> whose Width and Height properties match the specified string.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicSize.Parse(System.String,System.Globalization.CultureInfo)">
- <summary>
- Returns a GeographicSize whose value matches the specified string.
- </summary>
- <param name="value">A <strong>String</strong> describing a width, followed by a height.</param>
- <param name="culture">A <strong>CultureInfo</strong> object describing how to parse the specified string.</param>
- <returns>A <strong>GeographicSize</strong> whose Width and Height properties match the specified string.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicSize.op_Explicit(System.String)~DotSpatial.Positioning.GeographicSize">
- <summary>
- Performs an explicit conversion from <see cref="T:System.String"/> to <see cref="T:DotSpatial.Positioning.GeographicSize"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicSize.op_Explicit(DotSpatial.Positioning.GeographicSize)~System.String">
- <summary>
- Performs an explicit conversion from <see cref="T:DotSpatial.Positioning.GeographicSize"/> to <see cref="T:System.String"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicSize.Equals(DotSpatial.Positioning.GeographicSize)">
- <summary>
- Compares the value of the current instance to the specified GeographicSize.
- </summary>
- <param name="value">A <strong>GeographicSize</strong> object to compare against.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the values of both objects are precisely the same.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicSize.Equals(DotSpatial.Positioning.GeographicSize,System.Int32)">
- <summary>
- Compares the value of the current instance to the specified GeographicSize, to the specified number of decimals.
- </summary>
- <param name="value">A <strong>GeographicSize</strong> object to compare against.</param>
- <param name="decimals">An <strong>Integer</strong> describing how many decimals the values are rounded to before comparison.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the values of both objects are the same out to the number of decimals specified.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.GeographicSize.ToString(System.String,System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format to use.-or- A null reference (Nothing in Visual Basic) to use the default format defined for the type of the <see cref="T:System.IFormattable"/> implementation.</param>
- <param name="formatProvider">The provider to use to format the value.-or- A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.</param>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="P:DotSpatial.Positioning.GeographicSize.AspectRatio">
- <summary>
- Returns the ratio of the size's width to its height.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GeographicSize.Width">
- <summary>
- Returns the left-to-right size.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GeographicSize.Height">
- <summary>
- Returns the top-to-bottom size.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GeographicSize.IsEmpty">
- <summary>
- Indicates if the size has zero values.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.GeographicSize.IsInvalid">
- <summary>
- Returns whether the current instance has invalid values.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.InterpolationMethod">
- <summary>
- Represents a collection of interpolated values using realistic acceleration and deceleration.
- </summary>
- <remarks>This enumeration is used by several DotSpatial.Positioning controls to smoothly transition from
- one value to another. For example, the GPS SatelliteViewer uses acceleration to smoothly
- transition from one bearing to another, giving the appearance of a realistic compass. This
- enumeration, when combined with the <see cref="T:DotSpatial.Positioning.Interpolator"></see> class lets you add smooth
- transitions to your own controls as well.</remarks>
- </member>
- <member name="F:DotSpatial.Positioning.InterpolationMethod.Linear">
- <summary>
- The transition occurs at a steady rate.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.InterpolationMethod.Snap">
- <summary>
- The transition is immediate; no interpolation takes place.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.InterpolationMethod.QuadraticEaseIn">
- <summary>
- The transition starts at zero and accelerates to the end using a quadratic formula.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.InterpolationMethod.QuadraticEaseOut">
- <summary>
- The transition starts at high speed and decelerates to zero.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.InterpolationMethod.QuadraticEaseInAndOut">
- <summary>
- The transition accelerates to the halfway point, then decelerates to zero.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.InterpolationMethod.CubicEaseIn">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.InterpolationMethod.CubicEaseOut">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.InterpolationMethod.CubicEaseInOut">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.InterpolationMethod.QuarticEaseIn">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.InterpolationMethod.ExponentialEaseIn">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.InterpolationMethod.ExponentialEaseOut">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.Interpolator">
- <summary>
- Calculates intermediate values between two bounding values.
- </summary>
- <remarks>This powerful class provides the ability to interpolate values based on varying
- interpolation techniques. This class is used primarily to simulate realistic motion by
- accelerating and decelerating. This class is also used to calculate intermediate values
- for features such as image georeferencing and estimating precision errors.</remarks>
- </member>
- <member name="F:DotSpatial.Positioning.Interpolator._count">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpolator._minimum">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpolator._maximum">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpolator._interpolationMethod">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpolator._values">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpolator._syncRoot">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Interpolator.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:System.Object"/> class.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Interpolator.#ctor(System.Int32,DotSpatial.Positioning.InterpolationMethod)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.Interpolator"/> class.
- </summary>
- <param name="count">The count.</param>
- <param name="mode">The mode.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Interpolator.#ctor(System.Double,System.Double,System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.Interpolator"/> class.
- </summary>
- <param name="minimum">The minimum.</param>
- <param name="maximum">The maximum.</param>
- <param name="count">The count.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Interpolator.#ctor(System.Double,System.Double,System.Int32,DotSpatial.Positioning.InterpolationMethod)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.Interpolator"/> class.
- </summary>
- <param name="minimum">The minimum.</param>
- <param name="maximum">The maximum.</param>
- <param name="count">The count.</param>
- <param name="mode">The mode.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Interpolator.Swap">
- <summary>
- Reverses the interpolated sequence.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Interpolator.Recalculate">
- <summary>
- Recalculates this instance.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Interpolator.CalculateValue(System.Double)">
- <summary>
- Calculates the value.
- </summary>
- <param name="index">The index.</param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Positioning.Interpolator.Minimum">
- <summary>
- Controls the smallest number in the sequence.
- </summary>
- <value>The minimum.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Interpolator.Maximum">
- <summary>
- Controls the largest number in the sequence.
- </summary>
- <value>The maximum.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Interpolator.InterpolationMethod">
- <summary>
- Controls the acceleration and/or deceleration technique used.
- </summary>
- <value>The interpolation method.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Interpolator.Count">
- <summary>
- Controls the number of interpolated values.
- </summary>
- <value>The count.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Interpolator.Item(System.Int32)">
- <summary>
- Returns a number from the interpolated sequence.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.Interpolator2D">
- <summary>
- Represents a collection of interpolated coordinates using realistic acceleration and deceleration.
- </summary>
- <remarks><para>This class is used by several controls in the DotSpatial.Positioning namespace to give
- them a more realistic behavior. This class will interpolate coordinates between a
- given start and end point according to an interpolation technique, and return them
- as an array. Then, controls and other elements can be moved smoothly by applying
- the calculated values.</para>
- <para>Instances of this class are likely to be thread safe because the class uses
- thread synchronization when recalculating interpolated values.</para></remarks>
- </member>
- <member name="F:DotSpatial.Positioning.Interpolator2D._minimum">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpolator2D._maximum">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpolator2D._count">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpolator2D._interpolationMethod">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpolator2D._values">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpolator2D._xValues">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Interpolator2D._yValues">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Interpolator2D.#ctor">
- <summary>
- Creates a new instance.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Interpolator2D.#ctor(DotSpatial.Positioning.Position,DotSpatial.Positioning.Position,System.Int32)">
- <summary>
- Creates a new instance using the specified start and end points.
- </summary>
- <param name="minimum">The minimum.</param>
- <param name="maximum">The maximum.</param>
- <param name="count">The count.</param>
- <remarks>This constructor provides a way to define the bounds of the interpolator,
- as well as its number of points. A higher level of points yield a smoother
- result but take longer to iterate through.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Interpolator2D.#ctor(System.Int32,DotSpatial.Positioning.InterpolationMethod)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.Interpolator2D"/> class.
- </summary>
- <param name="count">The count.</param>
- <param name="mode">The mode.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Interpolator2D.#ctor(DotSpatial.Positioning.Position,DotSpatial.Positioning.Position,System.Int32,DotSpatial.Positioning.InterpolationMethod)">
- <summary>
- Creates a new instance using the specified end points, count, and interpolation technique.
- </summary>
- <param name="minimum">The minimum.</param>
- <param name="maximum">The maximum.</param>
- <param name="count">The count.</param>
- <param name="mode">The mode.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Interpolator2D.Recalculate">
- <summary>
- Recalculates this instance.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Interpolator2D.Swap">
- <summary>
- Swaps this instance.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Interpolator2D.Minimum">
- <summary>
- Returns the starting point of the series.
- </summary>
- <value>The minimum.</value>
- <remarks>Interpolated values are calculated between this point and the end point
- stored in the <see cref="P:DotSpatial.Positioning.Interpolator2D.Maximum"></see> property. Changing this property causes
- the series to be recalculated.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Interpolator2D.Maximum">
- <summary>
- Returns the ending point of the series.
- </summary>
- <value>The maximum.</value>
- <remarks>Interpolated values are calculated between this point and the start point
- stored in the <see cref="P:DotSpatial.Positioning.Interpolator2D.Minimum"></see> property. Changing this property causes
- the series to be recalculated.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Interpolator2D.Item(System.Int32)">
- <summary>
- Returns a Position object from the interpolated series.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Interpolator2D.Count">
- <summary>
- Returns the number of calculated positions in the series.
- </summary>
- <value>The count.</value>
- </member>
- <member name="P:DotSpatial.Positioning.Interpolator2D.InterpolationMethod">
- <summary>
- Indicates the interpolation technique used to calculate intermediate points.
- </summary>
- <value>The interpolation method.</value>
- <remarks>This property controls the acceleration and deceleration techniques
- used when calculating intermediate points. Changing this property causes the
- series to be recalculated.</remarks>
- </member>
- <member name="T:DotSpatial.Positioning.Latitude">
- <summary>
- Represents a line of constant distance north or south of the equator.
- </summary>
- <seealso cref="T:DotSpatial.Positioning.Longitude">Longitude Class</seealso>
-
- <seealso cref="T:DotSpatial.Positioning.Position">Position Class</seealso>
-
- <seealso cref="T:DotSpatial.Positioning.Azimuth">Azimuth Class</seealso>
-
- <seealso cref="T:DotSpatial.Positioning.Elevation">Elevation Class</seealso>
-
- <seealso cref="T:DotSpatial.Positioning.Angle">Angle Class</seealso>
-
- <example>
- These examples create new instances of Latitude objects.
- <code lang="VB" description="Create an angle of 90°">
- Dim MyLatitude As New Latitude(90)
- </code>
- <code lang="CS" description="Create an angle of 90°">
- Latitude MyLatitude = new Latitude(90);
- </code>
- <code lang="C++" description="Create an angle of 90°">
- Latitude MyLatitude = new Latitude(90);
- </code>
- <code lang="VB" description="Create an angle of 105°30'21.4">
- Dim MyLatitude1 As New Latitude(105, 30, 21.4)
- </code>
- <code lang="CS" description="Create an angle of 105°30'21.4">
- Latitude MyLatitude = new Latitude(105, 30, 21.4);
- </code>
- <code lang="C++" description="Create an angle of 105°30'21.4">
- Latitude MyLatitude = new Latitude(105, 30, 21.4);
- </code>
- </example>
- <remarks><para>Latitudes measure a distance North or South away from the equator. Latitudes
- can range from -90° (at the South pole) to 90° (the North pole), with 0°
- representing the equator. Latitudes are commonly paired with Longitudes to mark a
- specific location on Earth's surface.</para>
- <para>Latitudes are expressed in either of two major formats. The first format uses
- only positive numbers and the letter "N" or "S" to indicate the hemisphere (i.e.
- "45°N" or "60°S"). The second format allows negative numbers an omits the single
- character (i.e. 45 or -60).</para>
- <para>Instances of this class are guaranteed to be thread-safe because the class is
- immutable (its properties can only be changed via constructors).</para></remarks>
- </member>
- <member name="F:DotSpatial.Positioning.Latitude.MAXIMUM_PRECISION_DIGITS">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Latitude._decimalDegrees">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Latitude.Equator">
- <summary>
- Represents a latitude of 0°.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Latitude.Empty">
- <summary>
- Represents a latitude of 0°.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Latitude.TropicOfCapricorn">
- <summary>
- Represents a latitude of 23.5°S.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Latitude.TropicOfCancer">
- <summary>
- Represents a latitude of 23.5°N.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Latitude.NorthPole">
- <summary>
- Represents a latitude of 90°N.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Latitude.SouthPole">
- <summary>
- Represents a latitude of 90°S.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Latitude.Minimum">
- <summary>
- Represents the minimum possible latitude -90°.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Latitude.Maximum">
- <summary>
- Represents the maximum possible latitude of 90°.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Latitude.Invalid">
- <summary>
- Represents an invalid or unspecified value.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.#ctor(System.Double)">
- <summary>
- Creates a new instance with the specified decimal degrees.
- </summary>
- <param name="decimalDegrees">The decimal degrees.</param>
- <example>
- This example demonstrates how to create an angle with a measurement of 90°.
- <code lang="VB">
- Dim MyLatitude As New Latitude(90)
- </code>
- <code lang="CS">
- Latitude MyLatitude = new Latitude(90);
- </code>
- </example>
-
- <returns>An <strong>Latitude</strong> containing the specified value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.#ctor(System.Double,DotSpatial.Positioning.LatitudeHemisphere)">
- <summary>
- Creates a new instance with the specified decimal degrees and hemisphere.
- </summary>
- <param name="decimalDegrees">The decimal degrees.</param>
- <param name="hemisphere">The hemisphere.</param>
- <example>
- This example creates a new latitude of 39°30' north.
- <code lang="VB">
- Dim MyLatitude As New Latitude(39.5, LatitudeHemisphere.North)
- </code>
- <code lang="C#">
- Latitude MyLatitude = new Latitude(39.5, LatitudeHemisphere.North);
- </code>
- This example creates a new latitude of 39°30 south.
- <code lang="VB">
- Dim MyLatitude As New Latitude(39.5, LatitudeHemisphere.South)
- </code>
- <code lang="C#">
- Latitude MyLatitude = new Latitude(39.5, LatitudeHemisphere.South);
- </code>
- </example>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.#ctor(System.Int32)">
- <summary>
- Creates a new instance with the specified degrees.
- </summary>
- <param name="hours">The hours.</param>
- <returns>An <strong>Latitude</strong> containing the specified value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.#ctor(System.Int32,System.Int32,System.Double)">
- <summary>
- Creates a new instance with the specified hours, minutes and
- seconds.
- </summary>
- <param name="hours">The hours.</param>
- <param name="minutes">The minutes.</param>
- <param name="seconds">The seconds.</param>
- <example>
- This example demonstrates how to create an angular measurement of 34°12'29.2 in
- hours, minutes and seconds.
- <code lang="VB">
- Dim MyLatitude As New Latitude(34, 12, 29.2)
- </code>
- <code lang="CS">
- Latitude MyLatitude = new Latitude(34, 12, 29.2);
- </code>
- </example>
-
- <returns>An <strong>Latitude</strong> containing the specified value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.#ctor(System.Int32,System.Int32,System.Double,DotSpatial.Positioning.LatitudeHemisphere)">
- <summary>
- Creates a new longitude with the specified hours, minutes, seconds, and hemisphere.
- </summary>
- <param name="hours">The hours.</param>
- <param name="minutes">The minutes.</param>
- <param name="seconds">The seconds.</param>
- <param name="hemisphere">The hemisphere.</param>
- <example>
- This example creates a new latitude of 39°12'10" north.
- <code lang="VB">
- Dim MyLatitude As New Latitude(39, 12, 10, LatitudeHemisphere.North)
- </code>
- <code lang="C#">
- Latitude MyLatitude = new Latitude(39, 12, 10, LatitudeHemisphere.North);
- </code>
- This example creates a new latitude of 39°12'10" south.
- <code lang="VB">
- Dim MyLatitude As New Latitude(39, 12, 10, LatitudeHemisphere.South)
- </code>
- <code lang="C#">
- Latitude MyLatitude = new Latitude(39, 12, 10, LatitudeHemisphere.South);
- </code>
- </example>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.#ctor(System.Int32,System.Double)">
- <summary>
- Creates a new instance with the specified hours and decimal minutes.
- </summary>
- <param name="hours">The hours.</param>
- <param name="decimalMinutes">The decimal minutes.</param>
- <example>
- This example demonstrates how an angle can be created when only the hours and
- minutes (in decimal form) are known. This creates a value of 12°42.345'.
- <code lang="VB">
- Dim MyLatitude As New Latitude(12, 42.345)
- </code>
- <code lang="VB">
- Latitude MyLatitude = new Latitude(12, 42.345);
- </code>
- </example>
- <remarks>An <strong>Latitude</strong> containing the specified value.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.#ctor(System.Int32,System.Double,DotSpatial.Positioning.LatitudeHemisphere)">
- <summary>
- Creates a new instance with the specified hours, decimal minutes, and hemisphere.
- </summary>
- <param name="hours">The hours.</param>
- <param name="decimalMinutes">The decimal minutes.</param>
- <param name="hemisphere">The hemisphere.</param>
- <example>
- This example creates a new latitude of 39°12.34' north.
- <code lang="VB">
- Dim MyLatitude As New Latitude(39, 12.34, LatitudeHemisphere.North)
- </code>
- <code lang="C#">
- Latitude MyLatitude = new Latitude(39, 12.34, LatitudeHemisphere.North);
- </code>
- This example creates a new latitude of 39°12.34 south.
- <code lang="VB">
- Dim MyLatitude As New Latitude(39, 12.34, LatitudeHemisphere.South)
- </code>
- <code lang="C#">
- Latitude MyLatitude = new Latitude(39, 12.34, LatitudeHemisphere.South);
- </code>
- </example>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.#ctor(System.String)">
- <summary>
- Creates a new instance by parsing the specified string value.
- </summary>
- <param name="value">The value.</param>
- <example>
- This example creates a new instance by parsing a string. (notice The double-quote is
- doubled up to represent a single double-quote in the string.)
- <code lang="VB">
- Dim MyLatitude As New Latitude("23°45'67.8""N")
- </code>
- <code lang="CS">
- Latitude MyLatitude = new Latitude("23°45'67.8\"N");
- </code>
- </example>
-
- <returns>An <strong>Latitude</strong> containing the specified value.</returns>
-
- <exception cref="T:System.ArgumentNullException" caption="ArgumentNullException">The Parse method requires a decimal or sexagesimal measurement.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">Only the right-most portion of a sexagesimal measurement can be a fractional value.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">Extra characters were encountered while parsing an angular measurement. Only hours, minutes, and seconds are allowed.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">The specified text was not fully understood as an angular measurement.</exception>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.#ctor(System.String,System.Globalization.CultureInfo)">
- <summary>
- Creates a new instance by parsing the specified string value.
- </summary>
- <param name="value">The value.</param>
- <param name="culture">The culture.</param>
- <para>A <strong>String</strong> in any of the following formats (or variation
- depending on the local culture):</para>
-
- <seealso cref="M:DotSpatial.Positioning.Latitude.Parse(System.String)">Parse</seealso>
-
- <example>
- This example creates a new instance by parsing a string. (notice: The double-quote is
- doubled up to represent a single double-quote in the string.)
- <code lang="VB">
- Dim MyLatitude As New Latitude("23°45'67.8""N")
- </code>
- <code lang="CS">
- Latitude MyLatitude = new Latitude("23°45'67.8\"N");
- </code>
- </example>
-
- <returns>An <strong>Latitude</strong> containing the specified value.</returns>
-
- <exception cref="T:System.ArgumentNullException" caption="ArgumentNullException">The Parse method requires a decimal or sexagesimal measurement.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">Only the right-most portion of a sexagesimal measurement can be a fractional value.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">Extra characters were encountered while parsing an angular measurement. Only hours, minutes, and seconds are allowed.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">The specified text was not fully understood as an angular measurement.</exception>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.#ctor(System.Xml.XmlReader)">
- <summary>
- Creates a new instance by deserializing the specified XML.
- </summary>
- <param name="reader">The reader.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.LesserOf(DotSpatial.Positioning.Latitude)">
- <summary>
- Returns the object with the smallest value.
- </summary>
- <param name="value">A <strong>Latitude</strong> object to compare to the current instance.</param>
- <returns>The <strong>Latitude</strong> containing the smallest value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.GreaterOf(DotSpatial.Positioning.Latitude)">
- <summary>
- Returns the object with the largest value.
- </summary>
- <param name="value">A <strong>Latitude</strong> object to compare to the current instance.</param>
- <returns>A <strong>Latitude</strong> containing the largest value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.Round(System.Int32)">
- <summary>
- Returns a new instance whose value is rounded the specified number of decimals.
- </summary>
- <param name="decimals">An <strong>Integer</strong> specifying the number of decimals to round off to.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.Mirror">
- <summary>
- Returns an angle opposite of the current instance.
- </summary>
- <returns>An <strong>Latitude</strong> representing the mirrored value.</returns>
- <example>
- This example creates a new <strong>Latitude</strong> of 45° then calculates its mirror
- of 225°. (45 + 180)
- <code lang="VB" title="[New Example]">
- Dim Latitude1 As New Latitude(45)
- Dim Latitude2 As Latitude = Latitude1.Mirror()
- Debug.WriteLine(Latitude2.ToString())
- ' Output: 225
- </code>
- <code lang="CS" title="[New Example]">
- Latitude Latitude1 = new Latitude(45);
- Latitude Latitude2 = Latitude1.Mirror();
- Console.WriteLine(Latitude2.ToString());
- // Output: 225
- </code>
- </example>
- <remarks>This method returns the "opposite" of the current instance. The opposite is
- defined as the point on the other side of an imaginary circle. For example, if an angle
- is 0°, at the top of a circle, this method returns 180°, at the bottom of the
- circle.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.ToRadians">
- <summary>
- Converts the current instance into radians.
- </summary>
- <returns>A <see cref="T:DotSpatial.Positioning.Radian">Radian</see> object.</returns>
- <seealso cref="T:DotSpatial.Positioning.Radian">Radian Class</seealso>
-
- <overloads>Converts an angular measurement into radians before further processing.</overloads>
-
- <example>
- This example converts a measurement of 90° into radians.
- <code lang="VB">
- Dim MyLatitude As New Latitude(90)
- Dim MyRadians As Radian = MyLatitude.ToRadians()
- </code>
- <code lang="CS">
- Latitude MyLatitude = new Latitude(90);
- Radian MyRadians = MyLatitude.ToRadians();
- </code>
- </example>
- <remarks>This function is typically used to convert an angular measurement into
- radians before performing a trigonometric function.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.Normalize">
- <summary>
- Causes the value to be adjusted to between -90 and +90.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.IsNorthOf(DotSpatial.Positioning.Latitude)">
- <summary>
- Indicates if the current instance is North of the specified latitude.
- </summary>
- <param name="latitude">A <strong>Latitude</strong> object to examine.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the current instance is more North than the specified instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.IsSouthOf(DotSpatial.Positioning.Latitude)">
- <summary>
- Indicates if the current instance is South of the specified latitude.
- </summary>
- <param name="latitude">A <strong>Latitude</strong> object to examine.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the current instance is more South than the specified instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.ToHemisphere(DotSpatial.Positioning.LatitudeHemisphere)">
- <summary>
- Converts the current instance to the northern or southern hemisphere.
- </summary>
- <param name="hemisphere">The hemisphere.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.ToString(System.String)">
- <summary>
- Outputs the angle as a string using the specified format.
- </summary>
- <param name="format">The format.</param>
- <returns>A <strong>String</strong> in the specified format.</returns>
- <example>
- This example uses the <strong>ToString</strong> method to output an angle in a
- custom format. The " <strong>h°</strong> " code represents hours along with a
- degree symbol (Alt+0176 on the keypad), and " <strong>m.mm</strong> " represents
- the minutes out to two decimals. Mmm.
- <code lang="VB">
- Dim MyLatitude As New Latitude(45, 16.772)
- Debug.WriteLine(MyLatitude.ToString("h°m.mm"))
- ' Output: 45°16.78
- </code>
- <code lang="CS">
- Dim MyLatitude As New Latitude(45, 16.772);
- Debug.WriteLine(MyLatitude.ToString("h°m.mm"));
- // Output: 45°16.78
- </code>
- </example>
- <remarks>This method returns the current instance output in a specific format. If no
- value for the format is specified, a default format of "d.dddd°" is used. Any
- string output by this method can be converted back into an Latitude object using the
- <strong>Parse</strong> method or <strong>Latitude(string)</strong> constructor.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.Ceiling">
- <summary>
- Returns the smallest integer greater than the specified value.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.Floor">
- <summary>
- Returns the largest integer which is smaller than the specified value.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.RoundSeconds">
- <summary>
- Returns a new instance whose Seconds property is evenly divisible by 15.
- </summary>
- <returns>An <strong>Latitude</strong> containing the rounded value.</returns>
- <remarks>This method is used to align or "snap" an angle to a regular interval. For
- example, a grid might be easier to read if it were drawn at 30-second intervals instead
- of 24.198-second intervals.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.RoundSeconds(System.Double)">
- <summary>
- Returns a new angle whose Seconds property is evenly divisible by the specified amount.
- </summary>
- <param name="interval">A <strong>Double</strong> between 0 and 60 indicating the interval to round
- to.</param>
- <returns>An <strong>Latitude</strong> containing the rounded value.</returns>
- <remarks>This method is used to align or "snap" an angle to a regular interval. For
- example, a grid might be easier to read if it were drawn at 30-second intervals instead
- of 24.198-second intervals.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.Equals(System.Object)">
- <summary>
- Compares the current value to another Latitude object's value.
- </summary>
- <param name="obj">An <strong>Latitude</strong>, <strong>Double</strong>, or <strong>Integer</strong>
- to compare with.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the object's DecimalDegrees
- properties match.</returns>
- <remarks>This</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.GetHashCode">
- <summary>
- Returns a unique code for this instance.
- </summary>
- <returns>An <strong>Integer</strong> representing a unique code for the current
- instance.</returns>
- <remarks>Since the <strong>Latitude</strong> class is immutable, this property may be used
- safely with hash tables.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.ToString">
- <summary>
- Outputs the angle as a string using the default format.
- </summary>
- <returns>A <strong>String</strong> created using the default format.</returns>
- <example>
- This example outputs a value of 90 degrees in the default format of ###.#°.
- <code lang="VB">
- Dim MyLatitude As New Latitude(90)
- Debug.WriteLine(MyLatitude.ToString)
- ' Output: "90°"
- </code>
- <code lang="CS">
- Latitude MyLatitude = new Latitude(90);
- Debug.WriteLine(MyLatitude.ToString());
- // Output: "90°"
- </code>
- </example>
- <remarks>This method formats the current instance using the default format of
- "d.dddd°." Any string output by this method can be converted back into an Latitude
- object using the <strong>Parse</strong> method or <strong>Latitude(string)</strong>
- constructor.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.Normalize(System.Double)">
- <summary>
- Normalizes the specified decimal degrees.
- </summary>
- <param name="decimalDegrees">The decimal degrees.</param>
- <returns></returns>
- <overloads>Converts a measurement to its equivalent value between -90 and
- 90 degrees.</overloads>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.Random">
- <summary>
- Returns a random latitude.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.Random(System.Random)">
- <summary>
- Returns a random latitude based on the specified seed.
- </summary>
- <param name="generator">The generator.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.Random(DotSpatial.Positioning.Latitude,DotSpatial.Positioning.Latitude)">
- <summary>
- Returns a random latitude using the specified northern and southern boundaries.
- </summary>
- <param name="northernmost">The northernmost.</param>
- <param name="southernmost">The southernmost.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.Random(System.Random,DotSpatial.Positioning.Latitude,DotSpatial.Positioning.Latitude)">
- <summary>
- Returns a random latitude between the specified minimum and maximum.
- </summary>
- <param name="generator">a <strong>Random</strong> object used to generate random values.</param>
- <param name="northernmost">A <strong>Latitude</strong> specifying the northern-most allowed latitude.</param>
- <param name="southernmost">A <strong>Latitude</strong> specifying the southern-most allowed latitude.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.ToDecimalDegrees(System.Int32,System.Int32,System.Double)">
- <summary>
- Converts arbitrary hour, minute and seconds into decimal degrees.
- </summary>
- <param name="hours">The hours.</param>
- <param name="minutes">The minutes.</param>
- <param name="seconds">The seconds.</param>
- <returns>A <strong>Double</strong> containing the decimal degree version of the specified
- values.</returns>
- <seealso cref="P:DotSpatial.Positioning.Latitude.DecimalDegrees">DecimalDegrees Property</seealso>
-
- <example>
- This example converts a value of 10°30'0" into decimal degrees (10.5).
- <code lang="VB" title="ToDecimalDegrees Example (VB)">
- Dim MyValue As Double = Latitude.ToDecimalDegrees(10, 30, 0)
- </code>
- <code lang="CS" title="ToDecimalDegrees Example (C#)">
- double MyValue = Latitude.ToDecimalDegrees(10, 30, 0);
- </code>
- </example>
- <remarks>This function is used to convert three-part measurements into a single value. The
- result of this method is typically assigned to the
- <see cref="P:DotSpatial.Positioning.Latitude.DecimalDegrees">
- DecimalDegrees</see> property. Values are rounded to thirteen decimal
- places, the maximum precision allowed by this type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.ToDecimalDegrees(System.Int32,System.Double)">
- <summary>
- Converts arbitrary hour and decimal minutes into decimal degrees.
- </summary>
- <param name="hours">The hours.</param>
- <param name="decimalMinutes">The decimal minutes.</param>
- <returns>A <strong>Double</strong> containing the decimal degree version of the specified
- values.</returns>
- <remarks>This function is used to convert three-part measurements into a single value. The
- result of this method is typically assigned to the
- <see cref="P:DotSpatial.Positioning.Latitude.DecimalDegrees">
- DecimalDegrees</see> property. Values are rounded to thirteen decimal
- places, the maximum precision allowed by this type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.ToDecimalDegrees(System.Int32)">
- <summary>
- Converts an hour value into decimal degrees.
- </summary>
- <param name="hours">The hours.</param>
- <returns>A <strong>Double</strong> containing the decimal degree version of the specified
- values.</returns>
- <remarks>The specified value will be converted to a double value.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.ToDecimalDegrees(System.Int32,System.Double,DotSpatial.Positioning.LatitudeHemisphere)">
- <summary>
- Converts arbitrary hour and decimal minutes into decimal degrees.
- </summary>
- <param name="hours">The hours.</param>
- <param name="decimalMinutes">The decimal minutes.</param>
- <param name="hemisphere">The hemisphere.</param>
- <returns>A <strong>Double</strong> containing the decimal degree version of the specified
- values.</returns>
- <remarks>The specified value will be converted to decimal degrees, then rounded to thirteen digits, the maximum precision allowed by this type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.ToDecimalDegrees(System.Double,DotSpatial.Positioning.LatitudeHemisphere)">
- <summary>
- Converts arbitrary decrees into well-formed decimal degrees.
- </summary>
- <param name="decimalDegrees">The decimal degrees.</param>
- <param name="hemisphere">The hemisphere.</param>
- <returns>A <strong>Double</strong> containing the decimal degree version of the specified
- values.</returns>
- <remarks>The specified value will be rounded to thirteen digits, the maximum precision allowed by this type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.ToDecimalDegrees(System.Int32,System.Int32,System.Double,DotSpatial.Positioning.LatitudeHemisphere)">
- <summary>
- Converts arbitrary hour, minute and seconds into decimal degrees.
- </summary>
- <param name="hours">The hours.</param>
- <param name="minutes">The minutes.</param>
- <param name="seconds">The seconds.</param>
- <param name="hemisphere">The hemisphere.</param>
- <returns>A <strong>Double</strong> containing the decimal degree version of the specified
- values.</returns>
- <remarks>This function is used to convert three-part measurements into a single value. The
- result of this method is typically assigned to the
- <see cref="P:DotSpatial.Positioning.Latitude.DecimalDegrees">
- DecimalDegrees</see> property. Values are rounded to thirteen decimal
- places, the maximum precision allowed by this type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.LesserOf(DotSpatial.Positioning.Latitude,DotSpatial.Positioning.Latitude)">
- <summary>
- Returns the object with the smallest value.
- </summary>
- <param name="value1">The first <strong>Latitude</strong> object.</param>
- <param name="value2">The second <strong>Latitude</strong> object.</param>
- <returns>The <strong>Latitude</strong> containing the smallest value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.GreaterOf(DotSpatial.Positioning.Latitude,DotSpatial.Positioning.Latitude)">
- <summary>
- Returns the object with the largest value.
- </summary>
- <param name="value1">The first <strong>Latitude</strong> object.</param>
- <param name="value2">The second <strong>Latitude</strong> object.</param>
- <returns>A <strong>Latitude</strong> containing the largest value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.ToRadians(DotSpatial.Positioning.Latitude)">
- <summary>
- Converts an angular measurement into radians.
- </summary>
- <param name="value">The value.</param>
- <returns>A <see cref="T:DotSpatial.Positioning.Radian"><strong>Radian</strong></see> object.</returns>
- <example>
- This example shows a quick way to convert an angle of 90° into radians.
- <code lang="VB">
- Dim MyRadian As Radian = Latitude.ToRadians(90)
- </code>
- <code lang="CS">
- Radian MyRadian = Latitude.ToRadians(90);
- </code>
- </example>
- <remarks>This function is typically used to convert an angular measurement into
- radians before performing a trigonometric function.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.FromRadians(DotSpatial.Positioning.Radian)">
- <summary>
- Converts a value in radians into an angular measurement.
- </summary>
- <param name="radians">The radians.</param>
- <returns></returns>
- <seealso cref="M:DotSpatial.Positioning.Latitude.ToRadians">ToRadians</seealso>
-
- <seealso cref="T:DotSpatial.Positioning.Radian">Radian Class</seealso>
-
- <example>
- This example uses the <strong>FromRadians</strong> method to convert a value of one
- radian into an <strong>Latitude</strong> of 57°.
- <code lang="VB">
- ' Create a new angle equal to one radian
- Dim MyRadians As New Radian(1)
- Dim MyLatitude As Latitude = Latitude.FromRadians(MyRadians)
- Debug.WriteLine(MyLatitude.ToString())
- ' Output: 57°
- </code>
- <code lang="CS">
- // Create a new angle equal to one radian
- Radian MyRadians = new Radian(1);
- Latitude MyLatitude = Latitude.FromRadians(MyRadians);
- Console.WriteLine(MyLatitude.ToString());
- // Output: 57°
- </code>
- </example>
- <remarks>This function is typically used in conjunction with the
- <see cref="M:DotSpatial.Positioning.Latitude.ToRadians">ToRadians</see>
- method after a trigonometric function has completed. The converted value is stored in
- the <see cref="P:DotSpatial.Positioning.Latitude.DecimalDegrees">DecimalDegrees</see> property.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.FromRadians(System.Double)">
- <summary>
- Froms the radians.
- </summary>
- <param name="radians">The radians.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.Parse(System.String)">
- <summary>
- Converts the specified string into an Latitude object.
- </summary>
- <param name="value">The value.</param>
- <returns>A new <strong>Latitude</strong> object populated with the specified
- values.</returns>
- <example>
- This example creates a new angular measurement using the <strong>Parse</strong>
- method.
- <code lang="VB">
- Dim NewLatitude As Latitude = Latitude.Parse("123.45°")
- </code>
- <code lang="CS">
- Latitude NewLatitude = Latitude.Parse("123.45°");
- </code>
- </example>
-
- <exception cref="T:System.ArgumentNullException" caption="ArgumentNullException">The Parse method requires a decimal or sexagesimal measurement.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">Only the right-most portion of a sexagesimal measurement can be a fractional value.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">Extra characters were encountered while parsing an angular measurement. Only hours, minutes, and seconds are allowed.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">The specified text was not fully understood as an angular measurement.</exception>
- <remarks>This method parses the specified string into an <strong>Latitude</strong> object
- using the current culture. This constructor can parse any strings created via the
- <strong>ToString</strong> method.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.Parse(System.String,System.Globalization.CultureInfo)">
- <summary>
- Converts the specified string into an <strong>Latitude</strong> object using the
- specified culture.
- </summary>
- <param name="value">A <strong>String</strong> describing an angle in the form of decimal degrees or a
- sexagesimal.</param>
- <param name="culture">A <strong>CultureInfo</strong> object describing the numeric format to use during
- conversion.</param>
- <returns>A new <strong>Latitude</strong> object equivalent to the specified string.</returns>
- <remarks>This powerful method is typically used to process data from a data store or a
- value input by the user in any culture. This function can accept any format which
- can be output by the ToString method.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.op_Addition(DotSpatial.Positioning.Latitude,DotSpatial.Positioning.Latitude)">
- <summary>
- Implements the operator +.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.op_Addition(DotSpatial.Positioning.Latitude,System.Double)">
- <summary>
- Implements the operator +.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.op_Subtraction(DotSpatial.Positioning.Latitude,DotSpatial.Positioning.Latitude)">
- <summary>
- Implements the operator -.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.op_Subtraction(DotSpatial.Positioning.Latitude,System.Double)">
- <summary>
- Implements the operator -.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.op_Multiply(DotSpatial.Positioning.Latitude,DotSpatial.Positioning.Latitude)">
- <summary>
- Implements the operator *.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.op_Multiply(DotSpatial.Positioning.Latitude,System.Double)">
- <summary>
- Implements the operator *.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.op_Division(DotSpatial.Positioning.Latitude,DotSpatial.Positioning.Latitude)">
- <summary>
- Implements the operator /.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.op_Division(DotSpatial.Positioning.Latitude,System.Double)">
- <summary>
- Implements the operator /.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.op_Equality(DotSpatial.Positioning.Latitude,DotSpatial.Positioning.Latitude)">
- <summary>
- Implements the operator ==.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.op_Equality(DotSpatial.Positioning.Latitude,System.Double)">
- <summary>
- Implements the operator ==.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.op_Inequality(DotSpatial.Positioning.Latitude,DotSpatial.Positioning.Latitude)">
- <summary>
- Implements the operator !=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.op_Inequality(DotSpatial.Positioning.Latitude,System.Double)">
- <summary>
- Implements the operator !=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.op_GreaterThan(DotSpatial.Positioning.Latitude,DotSpatial.Positioning.Latitude)">
- <summary>
- Implements the operator >.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.op_GreaterThan(DotSpatial.Positioning.Latitude,System.Double)">
- <summary>
- Implements the operator >.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.op_GreaterThanOrEqual(DotSpatial.Positioning.Latitude,DotSpatial.Positioning.Latitude)">
- <summary>
- Implements the operator >=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.op_GreaterThanOrEqual(DotSpatial.Positioning.Latitude,System.Double)">
- <summary>
- Implements the operator >=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.op_LessThan(DotSpatial.Positioning.Latitude,DotSpatial.Positioning.Latitude)">
- <summary>
- Implements the operator <.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.op_LessThan(DotSpatial.Positioning.Latitude,System.Double)">
- <summary>
- Implements the operator <.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.op_LessThanOrEqual(DotSpatial.Positioning.Latitude,DotSpatial.Positioning.Latitude)">
- <summary>
- Implements the operator <=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.op_LessThanOrEqual(DotSpatial.Positioning.Latitude,System.Double)">
- <summary>
- Implements the operator <=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.Increment">
- <summary>
- Returns the current instance increased by one.
- </summary>
- <returns>An <strong>Latitude</strong> object.</returns>
- <example>
- This example uses the <strong>Increment</strong> method to increase an Latitude's
- value. It also demonstrates the subtle error which can be caused if
- <strong>Increment</strong> is called while ignoring the return value.
- <code lang="VB" title="[New Example]">
- ' Correct use of Increment
- Dim Latitude1 As New Latitude(89)
- Latitude1 = Latitude1.Increment()
- ' Incorrect use of Increment
- Dim Latitude1 = New Latitude(89)
- Latitude1.Increment()
- ' notice: Latitude1 will still be 89°!
- </code>
- <code lang="CS" title="[New Example]">
- // Correct use of Increment
- Latitude Latitude1 = new Latitude(89);
- Latitude1 = Latitude1.Increment();
- // Incorrect use of Increment
- Latitude Latitude1 = new Latitude(89);
- Latitude1.Increment();
- // notice: Latitude1 will still be 89°!
- </code>
- </example>
- <remarks><para>This method increases the <strong>DecimalDegrees</strong> property by 1.0,
- returned as a new instance.</para>
- <para><font color="red">Since the <strong>Latitude</strong> class is immutable, this
- method cannot be used to modify an existing instance.</font></para></remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.Add(System.Double)">
- <summary>
- Increases the current instance by the specified value.
- </summary>
- <param name="value">A <strong>Double</strong> to add to the current instance.</param>
- <returns>A new <strong>Latitude</strong> containing the summed values.</returns>
- <example>
- This example adds 45° to the current instance of 45°, returning 90°.
- <code lang="VB" title="[New Example]">
- Dim Latitude1 As New Latitude(45)
- Latitude1 = Latitude1.Add(45)
- </code>
- <code lang="CS" title="[New Example]">
- Latitude Latitude1 = new Latitude(45);
- Latitude1 = Latitude1.Add(45);
- </code>
- </example>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.Add(DotSpatial.Positioning.Latitude)">
- <summary>
- Adds the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.Decrement">
- <summary>
- Returns the current instance decreased by one.
- </summary>
- <returns>An <strong>Latitude</strong> object.</returns>
- <example>
- This example uses the <strong>Decrement</strong> method to decrease an Latitude's
- value. It also demonstrates the subtle error which can be caused if
- <strong>Decrement</strong> is called while ignoring the return value.
- <code lang="VB" title="[New Example]">
- ' Correct use of Decrement
- Dim Latitude1 As New Latitude(91)
- Latitude1 = Latitude1.Decrement()
- ' Incorrect use of Decrement
- Dim Latitude1 = New Latitude(91)
- Latitude1.Increment()
- ' notice Latitude1 will still be 91°!
- </code>
- <code lang="CS" title="[New Example]">
- // Correct use of Decrement
- Latitude Latitude1 = new Latitude(91);
- Latitude1 = Latitude1.Decrement();
- // Incorrect use of Decrement
- Latitude Latitude1 = new Latitude(91);
- Latitude1.Decrement();
- // notice Latitude1 will still be 91°!
- </code>
- </example>
- <remarks><para>This method decreases the <strong>DecimalDegrees</strong> property by 1.0,
- returned as a new instance.</para>
- <para><font color="red">Since the <strong>Latitude</strong> class is immutable, this
- method cannot be used to modify an existing instance.</font></para></remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.Subtract(System.Double)">
- <summary>
- Decreases the current instance by the specified value.
- </summary>
- <param name="value">A <strong>Double</strong> to subtract from the current instance.</param>
- <returns>A new <strong>Latitude</strong> containing the new value.</returns>
- <example>
- This example subtracts 30° from the current instance of 90°, returning 60°.
- <code lang="VB" title="[New Example]">
- Dim Latitude1 As New Latitude(90)
- Latitude1 = Latitude1.Subtract(30)
- </code>
- <code lang="CS" title="[New Example]">
- Latitude Latitude1 = new Latitude(90);
- Latitude1 = Latitude1.Subtract(30);
- </code>
- </example>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.Subtract(DotSpatial.Positioning.Latitude)">
- <summary>
- Subtracts the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.Multiply(System.Double)">
- <summary>
- Multiplies the current instance by the specified value.
- </summary>
- <param name="value">A <strong>Double</strong> to multiply with the current instance.</param>
- <returns>A new <strong>Latitude</strong> containing the product of the two numbers.</returns>
- <example>
- This example multiplies 30° with three, returning 90°.
- <code lang="VB" title="[New Example]">
- Dim Latitude1 As New Latitude(30)
- Latitude1 = Latitude1.Multiply(3)
- </code>
- <code lang="CS" title="[New Example]">
- Latitude Latitude1 = new Latitude(30);
- Latitude1 = Latitude1.Multiply(3);
- </code>
- </example>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.Multiply(DotSpatial.Positioning.Latitude)">
- <summary>
- Multiplies the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.Divide(System.Double)">
- <summary>
- Divides the current instance by the specified value.
- </summary>
- <param name="value">A <strong>Double</strong> representing a denominator to divide by.</param>
- <returns>An <strong>Latitude</strong> containing the new value.</returns>
- <example>
- This example divides 90° by three, returning 30°.
- <code lang="VB" title="[New Example]">
- Dim Latitude1 As New Latitude(90)
- Latitude1 = Latitude1.Divide(3)
- </code>
- <code lang="CS" title="[New Example]">
- Latitude Latitude1 = new Latitude(90);
- Latitude1 = Latitude1.Divide(3);
- </code>
- </example>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.Divide(DotSpatial.Positioning.Latitude)">
- <summary>
- Divides the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.IsLessThan(DotSpatial.Positioning.Latitude)">
- <summary>
- Indicates if the current instance is smaller than the specified value.
- </summary>
- <param name="value">An <strong>Latitude</strong> to compare with the current instance.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the current instance is
- smaller than the specified value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.IsLessThan(System.Double)">
- <summary>
- Determines whether [is less than] [the specified value].
- </summary>
- <param name="value">The value.</param>
- <returns><c>true</c> if [is less than] [the specified value]; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.IsLessThanOrEqualTo(DotSpatial.Positioning.Latitude)">
- <summary>
- Indicates if the current instance is smaller than or equal to the specified
- value.
- </summary>
- <param name="value">An <strong>Latitude</strong> to compare with the current instance.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the current instance is
- smaller than or equal to the specified value.</returns>
- <remarks>This method compares the <strong>DecimalDegrees</strong> property with the
- specified value. This method is the same as the "<=" operator.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.IsLessThanOrEqualTo(System.Double)">
- <summary>
- Determines whether [is less than or equal to] [the specified value].
- </summary>
- <param name="value">The value.</param>
- <returns><c>true</c> if [is less than or equal to] [the specified value]; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.IsGreaterThan(DotSpatial.Positioning.Latitude)">
- <summary>
- Indicates if the current instance is larger than the specified value.
- </summary>
- <param name="value">An <strong>Latitude</strong> to compare with the current instance.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the current instance is
- greater than the specified value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.IsGreaterThan(System.Double)">
- <summary>
- Determines whether [is greater than] [the specified value].
- </summary>
- <param name="value">The value.</param>
- <returns><c>true</c> if [is greater than] [the specified value]; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.IsGreaterThanOrEqualTo(DotSpatial.Positioning.Latitude)">
- <summary>
- Indicates if the current instance is larger than or equal to the specified
- value.
- </summary>
- <param name="value">An <strong>Latitude</strong> to compare with the current instance.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the current instance is
- greater than or equal to the specified value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.IsGreaterThanOrEqualTo(System.Double)">
- <summary>
- Determines whether [is greater than or equal to] [the specified value].
- </summary>
- <param name="value">The value.</param>
- <returns><c>true</c> if [is greater than or equal to] [the specified value]; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.op_Explicit(DotSpatial.Positioning.Radian)~DotSpatial.Positioning.Latitude">
- <summary>
- Converts a measurement in Radians into an Latitude.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.op_Explicit(System.Double)~DotSpatial.Positioning.Latitude">
- <summary>
- Converts a decimal degree measurement as a Double into an Latitude.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.op_Explicit(System.Single)~DotSpatial.Positioning.Latitude">
- <summary>
- Converts a decimal degree measurement as a Double into an Latitude.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.op_Explicit(DotSpatial.Positioning.Latitude)~System.Double">
- <summary>
- Converts a decimal degree measurement as a Double into an Latitude.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.op_Explicit(DotSpatial.Positioning.Latitude)~System.Single">
- <summary>
- Converts a decimal degree measurement as a Double into an Latitude.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.op_Explicit(System.Int32)~DotSpatial.Positioning.Latitude">
- <summary>
- Converts a measurement in degrees as an Integer into an Latitude.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.op_Explicit(DotSpatial.Positioning.Angle)~DotSpatial.Positioning.Latitude">
- <summary>
- Performs an explicit conversion from <see cref="T:DotSpatial.Positioning.Angle"/> to <see cref="T:DotSpatial.Positioning.Latitude"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.op_Explicit(DotSpatial.Positioning.Azimuth)~DotSpatial.Positioning.Latitude">
- <summary>
- Performs an explicit conversion from <see cref="T:DotSpatial.Positioning.Azimuth"/> to <see cref="T:DotSpatial.Positioning.Latitude"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.op_Explicit(DotSpatial.Positioning.Elevation)~DotSpatial.Positioning.Latitude">
- <summary>
- Performs an explicit conversion from <see cref="T:DotSpatial.Positioning.Elevation"/> to <see cref="T:DotSpatial.Positioning.Latitude"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.op_Explicit(DotSpatial.Positioning.Longitude)~DotSpatial.Positioning.Latitude">
- <summary>
- Performs an explicit conversion from <see cref="T:DotSpatial.Positioning.Longitude"/> to <see cref="T:DotSpatial.Positioning.Latitude"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.op_Explicit(System.String)~DotSpatial.Positioning.Latitude">
- <summary>
- Converts a measurement in the form of a formatted String into an Latitude.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.op_Explicit(DotSpatial.Positioning.Latitude)~System.String">
- <summary>
- Converts an Latitude into a String.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- <remarks>This operator calls the ToString() method using the current culture.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.Clone">
- <summary>
- Creates a copy of the current instance.
- </summary>
- <returns>An <strong>Latitude</strong> of the same value as the current instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.Equals(DotSpatial.Positioning.Latitude,System.Int32)">
- <summary>
- Compares the current instance to another instance using the specified
- precision.
- </summary>
- <param name="value">The value.</param>
- <param name="decimals">The decimals.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the
- <strong>DecimalDegrees</strong> property of the current instance matches the
- specified instance's <strong>DecimalDegrees</strong> property.</returns>
- <example>
- These examples compare two fractional values using specific numbers of digits for
- comparison.
- <code lang="VB" title="[New Example]">
- ' Equals will return False
- Dim Latitude1 As New Latitude(90.15);
- Dim Latitude2 As New Latitude(90.12);
- If Latitude1.Equals(Latitude2, 2) Then
- Debug.WriteLine("The values are the same to two digits of precision.");
- ' Equals will return True
- Dim Latitude1 As New Latitude(90.15);
- Dim Latitude2 As New Latitude(90.12);
- If Latitude1.Equals(Latitude2, 1) Then
- Debug.WriteLine("The values are the same to one digit of precision.");
- </code>
- <code lang="CS" title="[New Example]">
- // Equals will return False
- Latitude Latitude1 = new Latitude(90.15);
- Latitude Latitude2 = new Latitude(90.12);
- if (Latitude1.Equals(Latitude2, 2))
- Console.WriteLine("The values are the same to two digits of precision.");
- // Equals will return True
- Latitude Latitude1 = new Latitude(90.15);
- Latitude Latitude2 = new Latitude(90.12);
- if (Latitude1.Equals(Latitude2, 1))
- Console.WriteLine("The values are the same to one digits of precision.");
- </code>
- </example>
- <remarks><para>This is typically used in cases where precision is only significant for a few
- digits and exact comparison is not necessary.</para>
- <para><em>notice This method compares objects by value, not by
- reference.</em></para></remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.Equals(DotSpatial.Positioning.Latitude)">
- <summary>
- Equalses the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.CompareTo(DotSpatial.Positioning.Latitude)">
- <summary>
- Compares to.
- </summary>
- <param name="obj">The obj.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.ToString(System.String,System.IFormatProvider)">
- <summary>
- Outputs the angle as a string using the specified format.
- </summary>
- <param name="format">The format to use.-or- A null reference (Nothing in Visual Basic) to use the default format defined for the type of the <see cref="T:System.IFormattable"/> implementation.</param>
- <param name="formatProvider">The provider to use to format the value.-or- A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.</param>
- <returns>A <strong>String</strong> in the specified format.</returns>
- <example>
- This example uses the <strong>ToString</strong> method to output an angle in a
- custom format. The " <strong>h°</strong> " code represents hours along with a
- degree symbol (Alt+0176 on the keypad), and " <strong>m.mm</strong> " represents
- the minutes out to two decimals. Mmm.
- <code lang="VB">
- Dim MyLatitude As New Latitude(45, 16.772)
- Debug.WriteLine(MyLatitude.ToString("h°m.mm", CultureInfo.CurrentCulture))
- ' Output: 45°16.78
- </code>
- <code lang="CS">
- Dim MyLatitude As New Latitude(45, 16.772);
- Debug.WriteLine(MyLatitude.ToString("h°m.mm", CultureInfo.CurrentCulture));
- // Output: 45°16.78
- </code>
- </example>
- <remarks>This method returns the current instance output in a specific format. If no
- value for the format is specified, a default format of "d.dddd" is used. Any string
- output by this method can be converted back into an Latitude object using the
- <strong>Parse</strong> method or <strong>Latitude(string)</strong> constructor.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.System#Xml#Serialization#IXmlSerializable#GetSchema">
- <summary>
- This method is reserved and should not be used. When implementing the IXmlSerializable interface, you should return null (Nothing in Visual Basic) from this method, and instead, if specifying a custom schema is required, apply the <see cref="T:System.Xml.Serialization.XmlSchemaProviderAttribute"/> to the class.
- </summary>
- <returns>An <see cref="T:System.Xml.Schema.XmlSchema"/> that describes the XML representation of the object that is produced by the <see cref="M:System.Xml.Serialization.IXmlSerializable.WriteXml(System.Xml.XmlWriter)"/> method and consumed by the <see cref="M:System.Xml.Serialization.IXmlSerializable.ReadXml(System.Xml.XmlReader)"/> method.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.WriteXml(System.Xml.XmlWriter)">
- <summary>
- Converts an object into its XML representation.
- </summary>
- <param name="writer">The <see cref="T:System.Xml.XmlWriter"/> stream to which the object is serialized.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Latitude.ReadXml(System.Xml.XmlReader)">
- <summary>
- Generates an object from its XML representation.
- </summary>
- <param name="reader">The <see cref="T:System.Xml.XmlReader"/> stream from which the object is deserialized.</param>
- </member>
- <member name="P:DotSpatial.Positioning.Latitude.DecimalDegrees">
- <summary>
- Returns the value of the angle as decimal degrees.
- </summary>
- <value>A <strong>Double</strong> value.</value>
- <seealso cref="P:DotSpatial.Positioning.Latitude.Hours">Hours Property</seealso>
-
- <seealso cref="P:DotSpatial.Positioning.Latitude.Minutes">Minutes Property</seealso>
-
- <seealso cref="P:DotSpatial.Positioning.Latitude.Seconds">Seconds Property</seealso>
-
- <example>
- This example demonstrates how the
- <see cref="P:DotSpatial.Positioning.Latitude.DecimalDegrees"><strong>DecimalDegrees</strong></see> property is
- calculated automatically when creating an angle using hours, minutes and seconds.
- <code lang="VB">
- ' Create an angle of 20°30'
- Dim MyLatitude As New Latitude(20, 30)
- ' Setting the DecimalMinutes recalculated other properties
- Debug.WriteLine(MyLatitude.DecimalDegrees)
- ' Output: "20.5" the same as 20°30'
- </code>
- <code lang="CS">
- // Create an angle of 20°30'
- Latitude MyLatitude = New Latitude(20, 30);
- // Setting the DecimalMinutes recalculated other properties
- Console.WriteLine(MyLatitude.DecimalDegrees)
- // Output: "20.5" the same as 20°30'
- </code>
- </example>
- <remarks>This property returns the value of the angle as a single number.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Latitude.DecimalMinutes">
- <summary>
- Returns the minutes and seconds as a single numeric value.
- </summary>
- <value>A <strong>Double</strong> value.</value>
- <seealso cref="P:DotSpatial.Positioning.Latitude.Minutes">Minutes Property</seealso>
-
- <seealso cref="P:DotSpatial.Positioning.Latitude.DecimalDegrees">DecimalDegrees Property</seealso>
-
- <example>
- This example demonstrates how the <strong>DecimalMinutes</strong> property is
- automatically calculated when creating a new angle.
- <code lang="VB">
- ' Create an angle of 20°10'30"
- Dim MyLatitude As New Latitude(20, 10, 30)
- ' The DecimalMinutes property is automatically calculated
- Debug.WriteLine(MyLatitude.DecimalMinutes)
- ' Output: "10.5"
- </code>
- <code lang="CS">
- // Create an angle of 20°10'30"
- Latitude MyLatitude = new Latitude(20, 10, 30);
- // The DecimalMinutes property is automatically calculated
- Console.WriteLine(MyLatitude.DecimalMinutes)
- // Output: "10.5"
- </code>
- </example>
- <remarks>This property is used when minutes and seconds are represented as a single
- decimal value.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Latitude.Hours">
- <summary>
- Returns the integer hours (degrees) portion of an angular
- measurement.
- </summary>
- <value>An <strong>Integer</strong> value.</value>
- <seealso cref="P:DotSpatial.Positioning.Latitude.Minutes">Minutes Property</seealso>
-
- <seealso cref="P:DotSpatial.Positioning.Latitude.Seconds">Seconds Property</seealso>
-
- <example>
- This example creates an angle of 60.5° then outputs the value of the
- <strong>Hours</strong> property, 60.
- <code lang="VB">
- Dim MyLatitude As New Latitude(60.5)
- Debug.WriteLine(MyLatitude.Hours)
- ' Output: 60
- </code>
- <code lang="CS">
- Latitude MyLatitude = new Latitude(60.5);
- Console.WriteLine(MyLatitude.Hours);
- // Output: 60
- </code>
- </example>
- <remarks>This property is used in conjunction with the <see cref="P:DotSpatial.Positioning.Latitude.Minutes">Minutes</see>
- and <see cref="P:DotSpatial.Positioning.Latitude.Seconds">Seconds</see> properties to create a full angular measurement.
- This property is the same as <strong>DecimalDegrees</strong> without any fractional
- value.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Latitude.Minutes">
- <summary>
- Returns the integer minutes portion of an angular measurement.
- </summary>
- <value>An <strong>Integer</strong>.</value>
- <seealso cref="P:DotSpatial.Positioning.Latitude.Hours">Hours Property</seealso>
-
- <seealso cref="P:DotSpatial.Positioning.Latitude.Seconds">Seconds Property</seealso>
-
- <example>
- This example creates an angle of 45.5° then outputs the value of the
- <strong>Minutes</strong> property, 30.
- <code lang="VB">
- Dim MyLatitude As New Latitude(45.5)
- Debug.WriteLine(MyLatitude.Minutes)
- ' Output: 30
- </code>
- <code lang="CS">
- Latitude MyLatitude = new Latitude(45.5);
- Console.WriteLine(MyLatitude.Minutes);
- // Output: 30
- </code>
- </example>
- <remarks>This property is used in conjunction with the <see cref="P:DotSpatial.Positioning.Latitude.Hours">Hours</see> and
- <see cref="P:DotSpatial.Positioning.Latitude.Seconds">Seconds</see> properties to create a sexagesimal
- measurement.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Latitude.Seconds">
- <summary>
- Returns the seconds minutes portion of an angular measurement.
- </summary>
- <value>A <strong>Double</strong> value.</value>
- <seealso cref="P:DotSpatial.Positioning.Latitude.Hours">Hours Property</seealso>
-
- <seealso cref="P:DotSpatial.Positioning.Latitude.Minutes">Minutes Property</seealso>
-
- <example>
- This example creates an angle of 45°10.5' then outputs the value of the
- <strong>Seconds</strong> property, 30.
- <code lang="VB">
- Dim MyLatitude As New Latitude(45, 10.5)
- Debug.WriteLine(MyLatitude.Seconds)
- ' Output: 30
- </code>
- <code lang="CS">
- Dim MyLatitude As New Latitude(45, 10.5);
- Console.WriteLine(MyLatitude.Seconds);
- // Output: 30
- </code>
- </example>
- <remarks>This property is used in conjunction with the <see cref="P:DotSpatial.Positioning.Latitude.Hours">Hours</see> and
- <see cref="P:DotSpatial.Positioning.Latitude.Minutes">Minutes</see> properties to create a sexagesimal
- measurement.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Latitude.Hemisphere">
- <summary>
- Indicates if the latitude is north or south of the equator.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Latitude.IsEmpty">
- <summary>
- Indicates if the current instance has a non-zero value.
- </summary>
- <value>A <strong>Boolean</strong>, <strong>True</strong> if the
- <strong>DecimalDegrees</strong> property is zero.</value>
- <seealso cref="F:DotSpatial.Positioning.Latitude.Empty">Empty Field</seealso>
- </member>
- <member name="P:DotSpatial.Positioning.Latitude.IsInfinity">
- <summary>
- Indicates if the current instance represents an infinite value.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Latitude.IsInvalid">
- <summary>
- Indicates whether the value is invalid or unspecified.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Latitude.IsNormalized">
- <summary>
- Indicates whether the value has been normalized and is within the
- allowed bounds of -90° and 90°.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.LatitudeHemisphere">
- <summary>
- Indicates the position of a latitude measurement relative to the equator.
- </summary>
- <seealso cref="P:DotSpatial.Positioning.Longitude.Hemisphere">Hemisphere Property (Longitude Class)</seealso>
-
- <seealso cref="T:DotSpatial.Positioning.LongitudeHemisphere">LongitudeHemisphere Enumeration</seealso>
- <remarks><para>This enumeration is used by the <see cref="P:DotSpatial.Positioning.Latitude.Hemisphere">Hemisphere</see>
- property of the <see cref="T:DotSpatial.Positioning.Latitude">Latitude</see> class. If a latitude is south of the
- equator, it's value is displayed as a negative number, or with a single letter (but not
- both). For example, 39 degrees south of the equator can be expressed in either of these
- ways:</para>
- <list type="bullet">
- <item>39°S</item>
- <item>-39°</item>
- </list></remarks>
- </member>
- <member name="F:DotSpatial.Positioning.LatitudeHemisphere.None">
- <summary>Missing latitude information.</summary>
- </member>
- <member name="F:DotSpatial.Positioning.LatitudeHemisphere.North">
- <summary>The latitude is north of the equator.</summary>
- </member>
- <member name="F:DotSpatial.Positioning.LatitudeHemisphere.South">
- <summary>The latitude is south of the equator.</summary>
- </member>
- <member name="T:DotSpatial.Positioning.Longitude">
- <summary>
- Represents a line of constant distance east or west from the Prime Meridian.
- </summary>
- <seealso cref="T:DotSpatial.Positioning.Azimuth">Azimuth Class</seealso>
-
- <seealso cref="T:DotSpatial.Positioning.Elevation">Elevation Class</seealso>
-
- <seealso cref="T:DotSpatial.Positioning.Latitude">Latitude Class</seealso>
-
- <seealso cref="T:DotSpatial.Positioning.Longitude">Longitude Class</seealso>
-
- <example>
- These examples create new instances of Longitude objects.
- <code lang="VB" description="Create an angle of 90°">
- Dim MyLongitude As New Longitude(90)
- </code>
- <code lang="CS" description="Create an angle of 90°">
- Longitude MyLongitude = new Longitude(90);
- </code>
- <code lang="C++" description="Create an angle of 90°">
- Longitude MyLongitude = new Longitude(90);
- </code>
- <code lang="VB" description="Create an angle of 105°30'21.4">
- Dim MyLongitude1 As New Longitude(105, 30, 21.4)
- </code>
- <code lang="CS" description="Create an angle of 105°30'21.4">
- Longitude MyLongitude = new Longitude(105, 30, 21.4);
- </code>
- <code lang="C++" description="Create an angle of 105°30'21.4">
- Longitude MyLongitude = new Longitude(105, 30, 21.4);
- </code>
- </example>
- <remarks><para>Longitudes measure a distance either East or West from the Prime Meridian, an
- imaginary line which passes from the North Pole, through the
- <see href="http://www.nmm.ac.uk/">Royal Observatory in Greenwich, England, and on
- to the South Pole</see>. Longitudes can range from -180 to 180°, with the Prime
- Meridian at 0°. Latitudes are commonly paired with Longitudes to mark a specific
- location on Earth's surface.</para>
- <para>Latitudes are expressed in either of two major formats. The first format uses
- only positive numbers and the letter "E" or "W" to indicate the hemisphere (i.e.
- "94°E" or "32°W"). The second format allows negative numbers an omits the single
- character (i.e. 94 or -32).</para>
- <para>Instances of this class are guaranteed to be thread-safe because the class is
- immutable (its properties can only be changed via constructors).</para></remarks>
- </member>
- <member name="F:DotSpatial.Positioning.Longitude.MAXIMUM_PRECISION_DIGITS">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Longitude._decimalDegrees">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Longitude.PrimeMeridian">
- <summary>
- Represents a longitude of 0°.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Longitude.InternationalDateline">
- <summary>
- Represents a longitude 180°.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Longitude.Empty">
- <summary>
- Represents a longitude of 0°.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Longitude.Minimum">
- <summary>
- Represents the minimum possible longitude of -180°.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Longitude.Maximum">
- <summary>
- Represents the maximum possible longitude of 180°.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Longitude.Invalid">
- <summary>
- Represents an invalid or unspecified value.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.#ctor(System.Double)">
- <summary>
- Creates a new instance with the specified decimal degrees.
- </summary>
- <param name="decimalDegrees">The decimal degrees.</param>
- <example>
- This example demonstrates how to create an angle with a measurement of 90°.
- <code lang="VB">
- Dim MyLongitude As New Longitude(90)
- </code>
- <code lang="CS">
- Longitude MyLongitude = new Longitude(90);
- </code>
- </example>
-
- <returns>An <strong>Longitude</strong> containing the specified value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.#ctor(System.Double,DotSpatial.Positioning.LongitudeHemisphere)">
- <summary>
- Creates a new instance with the specified decimal degrees and hemisphere.
- </summary>
- <param name="decimalDegrees">The decimal degrees.</param>
- <param name="hemisphere">The hemisphere.</param>
- <example>
- This example creates a new Longitude of 39°30' north.
- <code lang="VB">
- Dim MyLongitude As New Longitude(39.5, LongitudeHemisphere.North)
- </code>
- <code lang="C#">
- Longitude MyLongitude = new Longitude(39.5, LongitudeHemisphere.North);
- </code>
- This example creates a new Longitude of 39°30 south.
- <code lang="VB">
- Dim MyLongitude As New Longitude(39.5, LongitudeHemisphere.South)
- </code>
- <code lang="C#">
- Longitude MyLongitude = new Longitude(39.5, LongitudeHemisphere.South);
- </code>
- </example>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.#ctor(System.Int32)">
- <summary>
- Creates a new instance with the specified degrees.
- </summary>
- <param name="hours">The hours.</param>
- <returns>An <strong>Longitude</strong> containing the specified value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.#ctor(System.Int32,System.Int32,System.Double)">
- <summary>
- Creates a new instance with the specified hours, minutes and
- seconds.
- </summary>
- <param name="hours">The hours.</param>
- <param name="minutes">The minutes.</param>
- <param name="seconds">The seconds.</param>
- <example>
- This example demonstrates how to create an angular measurement of 34°12'29.2 in
- hours, minutes and seconds.
- <code lang="VB">
- Dim MyLongitude As New Longitude(34, 12, 29.2)
- </code>
- <code lang="CS">
- Longitude MyLongitude = new Longitude(34, 12, 29.2);
- </code>
- </example>
-
- <returns>An <strong>Longitude</strong> containing the specified value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.#ctor(System.Int32,System.Int32,System.Double,DotSpatial.Positioning.LongitudeHemisphere)">
- <summary>
- Creates a new instance using the specified decimal degrees and
- hemisphere.
- </summary>
- <param name="hours">The hours.</param>
- <param name="minutes">The minutes.</param>
- <param name="seconds">The seconds.</param>
- <param name="hemisphere">The hemisphere.</param>
- <remarks><para>This constructor is typically used to create a longitude when decimal degrees
- are always expressed as a positive number. Since the hemisphere property is set
- <em>after</em> the DecimalDegrees property is set, the DecimalDegrees is adjusted
- automatically to be positive for the eastern hemisphere and negative for the
- western hemisphere.</para>
- <para>If the parameters conflict with each other, the <strong>Hemisphere</strong>
- parameter takes precedence. Therefore, a value of "-19°E" will become "19°E"
- (without the negative sign) with no exception being thrown.</para></remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.#ctor(System.Int32,System.Double)">
- <summary>
- Creates a new instance with the specified hours and decimal minutes.
- </summary>
- <param name="hours">The hours.</param>
- <param name="decimalMinutes">The decimal minutes.</param>
- <example>
- This example demonstrates how an angle can be created when only the hours and
- minutes (in decimal form) are known. This creates a value of 12°42.345'.
- <code lang="VB">
- Dim MyLongitude As New Longitude(12, 42.345)
- </code>
- <code lang="VB">
- Longitude MyLongitude = new Longitude(12, 42.345);
- </code>
- </example>
- <remarks>An <strong>Longitude</strong> containing the specified value.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.#ctor(System.Int32,System.Double,DotSpatial.Positioning.LongitudeHemisphere)">
- <summary>
- Creates a new instance with the specified hours, decimal minutes, and hemisphere.
- </summary>
- <param name="hours">The hours.</param>
- <param name="decimalMinutes">The decimal minutes.</param>
- <param name="hemisphere">The hemisphere.</param>
- <example>
- This example creates a new Longitude of 39°12.34' north.
- <code lang="VB">
- Dim MyLongitude As New Longitude(39, 12.34, LongitudeHemisphere.North)
- </code>
- <code lang="C#">
- Longitude MyLongitude = new Longitude(39, 12.34, LongitudeHemisphere.North);
- </code>
- This example creates a new Longitude of 39°12.34 south.
- <code lang="VB">
- Dim MyLongitude As New Longitude(39, 12.34, LongitudeHemisphere.South)
- </code>
- <code lang="C#">
- Longitude MyLongitude = new Longitude(39, 12.34, LongitudeHemisphere.South);
- </code>
- </example>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.#ctor(System.String)">
- <summary>
- Creates a new instance using the specified string-based measurement.
- </summary>
- <param name="value">The value.</param>
- <seealso cref="M:DotSpatial.Positioning.Longitude.Parse(System.String)">Parse Method</seealso>
-
- <example>
- This example creates a new instance by parsing a string. notice: The double-quote is
- doubled up to represent a single double-quote in the string.)
- <code lang="VB">
- Dim MyLongitude As New Longitude("123°45'67.8""")
- </code>
- <code lang="CS">
- Longitude MyLongitude = new Longitude("123°45'67.8\"");
- </code>
- </example>
-
- <returns>An <strong>Longitude</strong> containing the specified value.</returns>
-
- <exception cref="T:System.ArgumentNullException" caption="ArgumentNullException">The Parse method requires a decimal or sexagesimal measurement.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">Only the right-most portion of a sexagesimal measurement can be a fractional value.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">Extra characters were encountered while parsing an angular measurement. Only hours, minutes, and seconds are allowed.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">The specified text was not fully understood as an angular measurement.</exception>
- <remarks><para>A <strong>String</strong> in any of the following formats (or variation
- depending on the local culture):</para>
- <para>
- <table cellspacing="0" cols="4" cellpadding="2" width="100%">
- <tbody>
- <tr>
- <td>hh</td>
- <td>hh.h</td>
- <td>hh mm</td>
- <td>hh mm.mm</td>
- </tr>
- <tr>
- <td>hh mm ss</td>
- <td>hh mm ss.sss</td>
- <td>hhi</td>
- <td>hh.hi</td>
- </tr>
- <tr>
- <td>hh mmi</td>
- <td>hh mm i</td>
- <td>hh mm.mi</td>
- <td>hh mm.m i</td>
- </tr>
- <tr>
- <td>hh mm ssi</td>
- <td>hh mm ss i</td>
- <td>hh mm ss.si</td>
- <td>hh mm ss.s i</td>
- </tr>
- <tr>
- <td>hhhmmssi</td>
- <td></td>
- <td></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- </para>
- <para>Where <strong>h</strong> represents hours, <strong>m</strong> represents
- minutes, <strong>s</strong> represents seconds, and <strong>i</strong> represents a
- one-letter hemisphere indicator of "E" or "W." Any non-numeric character between
- numbers is considered a delimiter. Thus, a value of <strong>12°34'56.78"</strong>
- or even <strong>12A34B56.78C</strong> is treated the same as <strong>12 34
- 56.78</strong>.</para></remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.#ctor(System.String,System.Globalization.CultureInfo)">
- <summary>
- Creates a new instance using the specified string-based measurement.
- </summary>
- <param name="value">The value.</param>
- <param name="culture">The culture.</param>
- <exception cref="T:System.ArgumentNullException" caption="ArgumentNullException">The Parse method requires a decimal or sexagesimal measurement.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">Only the right-most portion of a sexagesimal measurement can be a fractional value.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">Extra characters were encountered while parsing an angular measurement. Only hours, minutes, and seconds are allowed.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">The specified text was not fully understood as an angular measurement.</exception>
- <remarks><para>A <strong>String</strong> in any of the following formats (or variation
- depending on the local culture):</para>
- <para>
- <table cellspacing="0" cols="4" cellpadding="2" width="100%">
- <tbody>
- <tr>
- <td>hh</td>
- <td>hh.h</td>
- <td>hh mm</td>
- <td>hh mm.mm</td>
- </tr>
- <tr>
- <td>hh mm ss</td>
- <td>hh mm ss.sss</td>
- <td>hhi</td>
- <td>hh.hi</td>
- </tr>
- <tr>
- <td>hh mmi</td>
- <td>hh mm i</td>
- <td>hh mm.mi</td>
- <td>hh mm.m i</td>
- </tr>
- <tr>
- <td>hh mm ssi</td>
- <td>hh mm ss i</td>
- <td>hh mm ss.si</td>
- <td>hh mm ss.s i</td>
- </tr>
- <tr>
- <td>hhhmmssi</td>
- <td></td>
- <td></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- </para>
- <para>Where <strong>h</strong> represents hours, <strong>m</strong> represents
- minutes, <strong>s</strong> represents seconds, and <strong>i</strong> represents a
- one-letter hemisphere indicator of "E" or "W." Any non-numeric character between
- numbers is considered a delimiter. Thus, a value of <strong>12°34'56.78"</strong>
- or even <strong>12A34B56.78C</strong> is treated the same as <strong>12 34
- 56.78</strong>.</para></remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.#ctor(System.Xml.XmlReader)">
- <summary>
- Creates a new instance by deserializing the specified XML.
- </summary>
- <param name="reader">The reader.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.LesserOf(DotSpatial.Positioning.Longitude)">
- <summary>
- Returns the object with the smallest value.
- </summary>
- <param name="value">An <strong>Longitude</strong> object to compare to the current instance.</param>
- <returns>The <strong>Longitude</strong> containing the smallest value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.GreaterOf(DotSpatial.Positioning.Longitude)">
- <summary>
- Returns the object with the largest value.
- </summary>
- <param name="value">An <strong>Longitude</strong> object to compare to the current instance.</param>
- <returns>An <strong>Longitude</strong> containing the largest value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.Compare(System.Double)">
- <summary>
- Returns a value indicating the relative order of two objects.
- </summary>
- <param name="value">An <strong>Longitude</strong> object to compare with.</param>
- <returns>A value of -1, 0, or 1 as documented by the IComparable interface.</returns>
- <remarks>This method allows collections of <strong>Longitude</strong> objects to be sorted.
- The <see cref="P:DotSpatial.Positioning.Longitude.DecimalDegrees">DecimalDegrees</see> property of each instance is compared.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.Mirror">
- <summary>
- Returns an angle opposite of the current instance.
- </summary>
- <returns>An <strong>Longitude</strong> representing the mirrored value.</returns>
- <example>
- This example creates a new <strong>Longitude</strong> of 45° then calculates its mirror
- of 225°. (45 + 180)
- <code lang="VB" title="[New Example]">
- Dim Longitude1 As New Longitude(45)
- Dim Longitude2 As Longitude = Longitude1.Mirror()
- Debug.WriteLine(Longitude2.ToString())
- ' Output: 225
- </code>
- <code lang="CS" title="[New Example]">
- Longitude Longitude1 = new Longitude(45);
- Longitude Longitude2 = Longitude1.Mirror();
- Console.WriteLine(Longitude2.ToString());
- // Output: 225
- </code>
- </example>
- <remarks>This method returns the "opposite" of the current instance. The opposite is
- defined as the point on the other side of an imaginary circle. For example, if an angle
- is 0°, at the top of a circle, this method returns 180°, at the bottom of the
- circle.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.ToRadians">
- <summary>
- Converts the current instance into radians.
- </summary>
- <returns>A <see cref="T:DotSpatial.Positioning.Radian">Radian</see> object.</returns>
- <seealso cref="T:DotSpatial.Positioning.Radian">Radian Class</seealso>
-
- <overloads>Converts an angular measurement into radians before further processing.</overloads>
-
- <example>
- This example converts a measurement of 90° into radians.
- <code lang="VB">
- Dim MyLongitude As New Longitude(90)
- Dim MyRadians As Radian = MyLongitude.ToRadians()
- </code>
- <code lang="CS">
- Longitude MyLongitude = new Longitude(90);
- Radian MyRadians = MyLongitude.ToRadians();
- </code>
- </example>
- <remarks>This function is typically used to convert an angular measurement into
- radians before performing a trigonometric function.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.IsEastOf(DotSpatial.Positioning.Longitude)">
- <summary>
- Indicates if the current instance is East of the specified longitude.
- </summary>
- <param name="longitude">A <strong>Longitude</strong> object to examine.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the current instance is more East than the specified instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.IsWestOf(DotSpatial.Positioning.Longitude)">
- <summary>
- Indicates if the current instance is West of the specified longitude.
- </summary>
- <param name="longitude">A <strong>Longitude</strong> object to examine.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the current instance is more West than the specified instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.ToString(System.String)">
- <summary>
- Outputs the current instance as a string using the specified format.
- </summary>
- <param name="format"><para>A combination of symbols, spaces, and any of the following case-insensitive
- letters: <strong>D</strong> or <strong>H</strong> for hours, <strong>M</strong> for
- minutes, <strong>S</strong> for seconds, and <strong>I</strong> to indicate the
- hemisphere. Here are some examples:</para>
- <para>
- <table cellspacing="0" cols="3" cellpadding="2" width="100%">
- <tbody>
- <tr>
- <td>HH°MM'SS.SS"</td>
- <td>HHH.H°</td>
- <td>HH MM.MM</td>
- <td>HHHMMSS</td>
- </tr>
- <tr>
- <td>HH°MM'SS.SS"I</td>
- <td>HHH.H°I</td>
- <td>HH MM.MMI</td>
- <td>HHHMMSSI</td>
- </tr>
- </tbody>
- </table>
- </para></param>
- <returns>A <strong>String</strong> matching the specified format.</returns>
- <seealso cref="M:DotSpatial.Positioning.Longitude.ToString">ToString Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Longitude.Parse(System.String)">Parse Method</seealso>
-
- <example>
- This example uses the <strong>ToString</strong> method to output an angle in a
- custom format. The " <strong>h°</strong> " code represents hours along with a
- degree symbol (Alt+0176 on the keypad), and " <strong>m.mm</strong> " represents
- the minutes out to two decimals. Mmm.
- <code lang="VB">
- Dim MyLongitude As New Longitude(45, 16.772)
- Debug.WriteLine(MyLongitude.ToString("h°m.mm"))
- ' Output: 45°16.78
- </code>
- <code lang="CS">
- Dim MyLongitude As New Longitude(45, 16.772);
- Debug.WriteLine(MyLongitude.ToString("h°m.mm"));
- // Output: 45°16.78
- </code>
- </example>
- <remarks>This powerful method returns the current angular measurement in a specific
- format. If no value for the format is specified, a format of
- <strong>hhh°mm'SS.SS"I</strong> (adjusted to the current culture) will be used. The
- resulting <strong>String</strong> can be converted back into an
- <strong>Longitude</strong> via the
- <see href="Angle.Parse">Parse</see> method so long as a delimiter separates each individual
- value.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.Ceiling">
- <summary>
- Returns the smallest integer greater than the specified value.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.Floor">
- <summary>
- Returns the largest integer which is smaller than the specified value.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.Round(System.Int32)">
- <summary>
- Returns a new instance whose value is rounded the specified number of decimals.
- </summary>
- <param name="decimals">An <strong>Integer</strong> specifying the number of decimals to round off to.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.RoundSeconds">
- <summary>
- Returns a new instance whose Seconds property is evenly divisible by 15.
- </summary>
- <returns>An <strong>Longitude</strong> containing the rounded value.</returns>
- <remarks>This method is used to align or "snap" an angle to a regular interval. For
- example, a grid might be easier to read if it were drawn at 30-second intervals instead
- of 24.198-second intervals.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.RoundSeconds(System.Double)">
- <summary>
- Returns a new angle whose Seconds property is evenly divisible by the specified amount.
- </summary>
- <param name="interval">A <strong>Double</strong> between 0 and 60 indicating the interval to round
- to.</param>
- <returns>An <strong>Longitude</strong> containing the rounded value.</returns>
- <remarks>This method is used to align or "snap" an angle to a regular interval. For
- example, a grid might be easier to read if it were drawn at 30-second intervals instead
- of 24.198-second intervals.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.Normalize">
- <summary>
- Normalizes this instance.
- </summary>
- <returns>A <strong>Longitude</strong> containing the normalized value.</returns>
- <remarks>This function is used to ensure that an angular measurement is within the
- allowed bounds of 0° and 180°. If a value of 360° or 720° is passed, a value of 0°
- is returned since traveling around the Earth 360° or 720° brings you to the same
- place you started.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.Equals(System.Object)">
- <summary>
- Compares the current value to another Longitude object's value.
- </summary>
- <param name="obj">An <strong>Longitude</strong>, <strong>Double</strong>, or <strong>Integer</strong>
- to compare with.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the object's DecimalDegrees
- properties match.</returns>
- <remarks>This</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.GetHashCode">
- <summary>
- Returns a unique code for this instance.
- </summary>
- <returns>An <strong>Integer</strong> representing a unique code for the current
- instance.</returns>
- <remarks>Since the <strong>Longitude</strong> class is immutable, this property may be used
- safely with hash tables.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.ToString">
- <summary>
- Outputs the current instance as a string using the specified format.
- </summary>
- <returns>A <strong>String</strong> matching the specified format.</returns>
- <seealso cref="M:DotSpatial.Positioning.Longitude.Parse(System.String)">Parse Method</seealso>
-
- <example>
- This example outputs a value of 90 degrees in the default format of ###.#°.
- <code lang="VB">
- Dim MyLongitude As New Longitude(90)
- Debug.WriteLine(MyLongitude.ToString)
- ' Output: "90°"
- </code>
- <code lang="CS">
- Longitude MyLongitude = new Longitude(90);
- Debug.WriteLine(MyLongitude.ToString());
- // Output: "90°"
- </code>
- </example>
- <remarks>This powerful method returns the current angular measurement in a specific
- format. If no value for the format is specified, a format of
- <strong>hhh°mm'SS.SS"I</strong> (adjusted to the current culture) will be used. The
- resulting <strong>String</strong> can be converted back into an
- <strong>Longitude</strong> via the
- <see href="Angle.Parse">Parse</see> method so long as a delimiter separates each individual
- value.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.Normalize(System.Double)">
- <summary>
- Normalizes the specified decimal degrees.
- </summary>
- <param name="decimalDegrees">The decimal degrees.</param>
- <returns></returns>
- <remarks>This function is used to ensure that an angular measurement is within the
- allowed bounds of -180° and 180°. If a value of 360° or 720° is passed, a value of 0°
- is returned since traveling around the Earth 360° or 720° brings you to the same
- place you started.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.LesserOf(DotSpatial.Positioning.Longitude,DotSpatial.Positioning.Longitude)">
- <summary>
- Returns the object with the smallest value.
- </summary>
- <param name="value1">A <strong>Longitude</strong> object to compare to value2.</param>
- <param name="value2">A <strong>Longitude</strong> object to compare to value1.</param>
- <returns>The <strong>Longitude</strong> containing the smallest value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.GreaterOf(DotSpatial.Positioning.Longitude,DotSpatial.Positioning.Longitude)">
- <summary>
- Returns the object with the largest value.
- </summary>
- <param name="value1">A <strong>Longitude</strong> object to compare to value2.</param>
- <param name="value2">A <strong>Longitude</strong> object to compare to value1.</param>
- <returns>A <strong>Longitude</strong> containing the largest value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.ToRadians(DotSpatial.Positioning.Longitude)">
- <summary>
- Converts an angular measurement into radians.
- </summary>
- <param name="value">The value.</param>
- <returns>A <see cref="T:DotSpatial.Positioning.Radian"><strong>Radian</strong></see> object.</returns>
- <example>
- This example shows a quick way to convert an angle of 90° into radians.
- <code lang="VB">
- Dim MyRadian As Radian = Longitude.ToRadians(90)
- </code>
- <code lang="CS">
- Radian MyRadian = Longitude.ToRadians(90);
- </code>
- </example>
- <remarks>This function is typically used to convert an angular measurement into
- radians before performing a trigonometric function.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.FromRadians(DotSpatial.Positioning.Radian)">
- <summary>
- Converts a value in radians into an angular measurement.
- </summary>
- <param name="radians">The radians.</param>
- <returns></returns>
- <seealso cref="M:DotSpatial.Positioning.Longitude.ToRadians">ToRadians</seealso>
-
- <seealso cref="T:DotSpatial.Positioning.Radian">Radian Class</seealso>
-
- <example>
- This example uses the <strong>FromRadians</strong> method to convert a value of one
- radian into an <strong>Longitude</strong> of 57°.
- <code lang="VB">
- ' Create a new angle equal to one radian
- Dim MyRadians As New Radian(1)
- Dim MyLongitude As Longitude = Longitude.FromRadians(MyRadians)
- Debug.WriteLine(MyLongitude.ToString())
- ' Output: 57°
- </code>
- <code lang="CS">
- // Create a new angle equal to one radian
- Radian MyRadians = new Radian(1);
- Longitude MyLongitude = Longitude.FromRadians(MyRadians);
- Console.WriteLine(MyLongitude.ToString());
- // Output: 57°
- </code>
- </example>
- <remarks>This function is typically used in conjunction with the
- <see cref="M:DotSpatial.Positioning.Longitude.ToRadians">ToRadians</see>
- method after a trigonometric function has completed. The converted value is stored in
- the <see cref="P:DotSpatial.Positioning.Longitude.DecimalDegrees">DecimalDegrees</see> property.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.FromRadians(System.Double)">
- <summary>
- Froms the radians.
- </summary>
- <param name="radians">The radians.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.Random">
- <summary>
- Returns a random longitude.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.Random(System.Random)">
- <summary>
- Returns a random longitude based on the specified seed.
- </summary>
- <param name="generator">The generator.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.Random(DotSpatial.Positioning.Longitude,DotSpatial.Positioning.Longitude)">
- <summary>
- Returns a random longitude using the specified eastern and western boundaries.
- </summary>
- <param name="easternmost">A <strong>Longitude</strong> specifying the eastern-most allowed longitude.</param>
- <param name="westernmost">A <strong>Longitude</strong> specifying the western-most allowed longitude.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.Random(System.Random,DotSpatial.Positioning.Longitude,DotSpatial.Positioning.Longitude)">
- <summary>
- Returns a random longitude between the specified minimum and maximum.
- </summary>
- <param name="generator">A <strong>Random</strong> object used to generate random values.</param>
- <param name="easternmost">A <strong>Longitude</strong> specifying the eastern-most allowed longitude.</param>
- <param name="westernmost">A <strong>Longitude</strong> specifying the western-most allowed longitude.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.ToDecimalDegrees(System.Int32,System.Int32,System.Double)">
- <summary>
- Converts arbitrary hour, minute and seconds into decimal degrees.
- </summary>
- <param name="hours">The hours.</param>
- <param name="minutes">The minutes.</param>
- <param name="seconds">The seconds.</param>
- <returns>A <strong>Double</strong> containing the decimal degree version of the specified
- values.</returns>
- <seealso cref="P:DotSpatial.Positioning.Latitude.DecimalDegrees">DecimalDegrees Property</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Latitude.Normalize">Normalize Method</seealso>
-
- <example>
- This example converts a value of 10°30'0" into decimal degrees (10.5).
- <code lang="VB" title="ToDecimalDegrees Example (VB)">
- Dim MyValue As Double = Latitude.ToDecimalDegrees(10, 30, 0)
- </code>
- <code lang="CS" title="ToDecimalDegrees Example (C#)">
- double MyValue = Latitude.ToDecimalDegrees(10, 30, 0);
- </code>
- </example>
- <remarks>This function is used to convert three-part measurements into a single value. The
- result of this method is typically assigned to the
- <see cref="P:DotSpatial.Positioning.Latitude.DecimalDegrees">
- DecimalDegrees</see> property. Values are rounded to thirteen decimal
- places, the maximum precision allowed by this type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.ToDecimalDegrees(System.Int32,System.Double)">
- <summary>
- Converts arbitrary hour and decimal minutes into decimal degrees.
- </summary>
- <param name="hours">The hours.</param>
- <param name="decimalMinutes">The decimal minutes.</param>
- <returns>A <strong>Double</strong> containing the decimal degree version of the specified
- values.</returns>
- <remarks>This function is used to convert three-part measurements into a single value. The
- result of this method is typically assigned to the
- <see cref="P:DotSpatial.Positioning.Latitude.DecimalDegrees">
- DecimalDegrees</see> property. Values are rounded to thirteen decimal
- places, the maximum precision allowed by this type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.ToDecimalDegrees(System.Int32)">
- <summary>
- Converts an hour value into decimal degrees.
- </summary>
- <param name="hours">The hours.</param>
- <returns>A <strong>Double</strong> containing the decimal degree version of the specified
- values.</returns>
- <remarks>The specified value will be converted to a double value.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.ToDecimalDegrees(System.Int32,System.Double,DotSpatial.Positioning.LongitudeHemisphere)">
- <summary>
- Converts arbitrary hour and decimal minutes into decimal degrees.
- </summary>
- <param name="hours">The hours.</param>
- <param name="decimalMinutes">The decimal minutes.</param>
- <param name="hemisphere">The hemisphere.</param>
- <returns>A <strong>Double</strong> containing the decimal degree version of the specified
- values.</returns>
- <remarks>The specified value will be converted to decimal degrees, then rounded to thirteen digits, the maximum precision allowed by this type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.ToDecimalDegrees(System.Double,DotSpatial.Positioning.LongitudeHemisphere)">
- <summary>
- Converts arbitrary decrees into well-formed decimal degrees.
- </summary>
- <param name="decimalDegrees">The decimal degrees.</param>
- <param name="hemisphere">The hemisphere.</param>
- <returns>A <strong>Double</strong> containing the decimal degree version of the specified
- values.</returns>
- <remarks>The specified value will be rounded to thirteen digits, the maximum precision allowed by this type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.ToDecimalDegrees(System.Int32,System.Int32,System.Double,DotSpatial.Positioning.LongitudeHemisphere)">
- <summary>
- Converts arbitrary hour, minute and seconds into decimal degrees.
- </summary>
- <param name="hours">The hours.</param>
- <param name="minutes">The minutes.</param>
- <param name="seconds">The seconds.</param>
- <param name="hemisphere">The hemisphere.</param>
- <returns>A <strong>Double</strong> containing the decimal degree version of the specified
- values.</returns>
- <remarks>This function is used to convert three-part measurements into a single value. The
- result of this method is typically assigned to the
- <see cref="P:DotSpatial.Positioning.Latitude.DecimalDegrees">
- DecimalDegrees</see> property. Values are rounded to thirteen decimal
- places, the maximum precision allowed by this type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.Parse(System.String)">
- <summary>
- Converts the specified string into an Longitude object.
- </summary>
- <param name="value">The value.</param>
- <returns>A new <strong>Longitude</strong> object populated with the specified
- values.</returns>
- <seealso cref="M:DotSpatial.Positioning.Longitude.ToString">ToString Method</seealso>
-
- <example>
- This example creates a new angular measurement using the <strong>Parse</strong>
- method.
- <code lang="VB">
- Dim NewLongitude As Longitude = Longitude.Parse("123.45°")
- </code>
- <code lang="CS">
- Longitude NewLongitude = Longitude.Parse("123.45°");
- </code>
- </example>
-
- <exception cref="T:System.ArgumentNullException" caption="ArgumentNullException">The Parse method requires a decimal or sexagesimal measurement.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">Only the right-most portion of a sexagesimal measurement can be a fractional value.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">Extra characters were encountered while parsing an angular measurement. Only hours, minutes, and seconds are allowed.</exception>
-
- <exception cref="T:System.FormatException" caption="FormatException">The specified text was not fully understood as an angular measurement.</exception>
- <remarks>This method parses the specified string into an <strong>Longitude</strong> object
- using the current culture. This constructor can parse any strings created via the
- <strong>ToString</strong> method.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.Parse(System.String,System.Globalization.CultureInfo)">
- <summary>
- Converts the specified string into an <strong>Longitude</strong> object using the
- specified culture.
- </summary>
- <param name="value">A <strong>String</strong> describing an angle in the form of decimal degrees or a
- sexagesimal.</param>
- <param name="culture">A <strong>CultureInfo</strong> object describing the numeric format to use during
- conversion.</param>
- <returns>A new <strong>Longitude</strong> object equivalent to the specified string.</returns>
- <remarks>This powerful method is typically used to process data from a data store or a
- value input by the user in any culture. This function can accept any format which
- can be output by the ToString method.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.op_Addition(DotSpatial.Positioning.Longitude,DotSpatial.Positioning.Longitude)">
- <summary>
- Implements the operator +.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.op_Addition(DotSpatial.Positioning.Longitude,System.Double)">
- <summary>
- Implements the operator +.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.op_Subtraction(DotSpatial.Positioning.Longitude,DotSpatial.Positioning.Longitude)">
- <summary>
- Implements the operator -.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.op_Subtraction(DotSpatial.Positioning.Longitude,System.Double)">
- <summary>
- Implements the operator -.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.op_Multiply(DotSpatial.Positioning.Longitude,DotSpatial.Positioning.Longitude)">
- <summary>
- Implements the operator *.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.op_Multiply(DotSpatial.Positioning.Longitude,System.Double)">
- <summary>
- Implements the operator *.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.op_Division(DotSpatial.Positioning.Longitude,DotSpatial.Positioning.Longitude)">
- <summary>
- Implements the operator /.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.op_Division(DotSpatial.Positioning.Longitude,System.Double)">
- <summary>
- Implements the operator /.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.op_Equality(DotSpatial.Positioning.Longitude,DotSpatial.Positioning.Longitude)">
- <summary>
- Implements the operator ==.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.op_Equality(DotSpatial.Positioning.Longitude,System.Double)">
- <summary>
- Implements the operator ==.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.op_Inequality(DotSpatial.Positioning.Longitude,DotSpatial.Positioning.Longitude)">
- <summary>
- Implements the operator !=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.op_Inequality(DotSpatial.Positioning.Longitude,System.Double)">
- <summary>
- Implements the operator !=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.op_GreaterThan(DotSpatial.Positioning.Longitude,DotSpatial.Positioning.Longitude)">
- <summary>
- Implements the operator >.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.op_GreaterThan(DotSpatial.Positioning.Longitude,System.Double)">
- <summary>
- Implements the operator >.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.op_GreaterThanOrEqual(DotSpatial.Positioning.Longitude,DotSpatial.Positioning.Longitude)">
- <summary>
- Implements the operator >=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.op_GreaterThanOrEqual(DotSpatial.Positioning.Longitude,System.Double)">
- <summary>
- Implements the operator >=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.op_LessThan(DotSpatial.Positioning.Longitude,DotSpatial.Positioning.Longitude)">
- <summary>
- Implements the operator <.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.op_LessThan(DotSpatial.Positioning.Longitude,System.Double)">
- <summary>
- Implements the operator <.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.op_LessThanOrEqual(DotSpatial.Positioning.Longitude,DotSpatial.Positioning.Longitude)">
- <summary>
- Implements the operator <=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.op_LessThanOrEqual(DotSpatial.Positioning.Longitude,System.Double)">
- <summary>
- Implements the operator <=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.Increment">
- <summary>
- Returns the current instance increased by one.
- </summary>
- <returns>An <strong>Longitude</strong> object.</returns>
- <example>
- This example uses the <strong>Increment</strong> method to increase an Longitude's
- value. It also demonstrates the subtle error which can be caused if
- <strong>Increment</strong> is called while ignoring the return value.
- <code lang="VB" title="[New Example]">
- ' Correct use of Increment
- Dim Longitude1 As New Longitude(89)
- Longitude1 = Longitude1.Increment()
- ' Incorrect use of Increment
- Dim Longitude1 = New Longitude(89)
- Longitude1.Increment()
- ' notice: Longitude1 will still be 89°!
- </code>
- <code lang="CS" title="[New Example]">
- // Correct use of Increment
- Longitude Longitude1 = new Longitude(89);
- Longitude1 = Longitude1.Increment();
- // Incorrect use of Increment
- Longitude Longitude1 = new Longitude(89);
- Longitude1.Increment();
- // notice: Longitude1 will still be 89°!
- </code>
- </example>
- <remarks><para>This method increases the <strong>DecimalDegrees</strong> property by 1.0,
- returned as a new instance.</para>
- <para><font color="red">Since the <strong>Longitude</strong> class is immutable, this
- method cannot be used to modify an existing instance.</font></para></remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.Add(System.Double)">
- <summary>
- Increases the current instance by the specified value.
- </summary>
- <param name="value">A <strong>Double</strong> to add to the current instance.</param>
- <returns>A new <strong>Longitude</strong> containing the summed values.</returns>
- <example>
- This example adds 45° to the current instance of 45°, returning 90°.
- <code lang="VB" title="[New Example]">
- Dim Longitude1 As New Longitude(45)
- Longitude1 = Longitude1.Add(45)
- </code>
- <code lang="CS" title="[New Example]">
- Longitude Longitude1 = new Longitude(45);
- Longitude1 = Longitude1.Add(45);
- </code>
- </example>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.Add(DotSpatial.Positioning.Longitude)">
- <summary>
- Adds the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.Decrement">
- <summary>
- Returns the current instance decreased by one.
- </summary>
- <returns>An <strong>Longitude</strong> object.</returns>
- <example>
- This example uses the <strong>Decrement</strong> method to decrease an Longitude's
- value. It also demonstrates the subtle error which can be caused if
- <strong>Decrement</strong> is called while ignoring the return value.
- <code lang="VB" title="[New Example]">
- ' Correct use of Decrement
- Dim Longitude1 As New Longitude(91)
- Longitude1 = Longitude1.Decrement()
- ' Incorrect use of Decrement
- Dim Longitude1 = New Longitude(91)
- Longitude1.Increment()
- ' notice Longitude1 will still be 91°!
- </code>
- <code lang="CS" title="[New Example]">
- // Correct use of Decrement
- Longitude Longitude1 = new Longitude(91);
- Longitude1 = Longitude1.Decrement();
- // Incorrect use of Decrement
- Longitude Longitude1 = new Longitude(91);
- Longitude1.Decrement();
- // notice: Longitude1 will still be 91°!
- </code>
- </example>
- <remarks><para>This method decreases the <strong>DecimalDegrees</strong> property by 1.0,
- returned as a new instance.</para>
- <para><font color="red">Since the <strong>Longitude</strong> class is immutable, this
- method cannot be used to modify an existing instance.</font></para></remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.Subtract(System.Double)">
- <summary>
- Decreases the current instance by the specified value.
- </summary>
- <param name="value">A <strong>Double</strong> to subtract from the current instance.</param>
- <returns>A new <strong>Longitude</strong> containing the new value.</returns>
- <example>
- This example subtracts 30° from the current instance of 90°, returning 60°.
- <code lang="VB" title="[New Example]">
- Dim Longitude1 As New Longitude(90)
- Longitude1 = Longitude1.Subtract(30)
- </code>
- <code lang="CS" title="[New Example]">
- Longitude Longitude1 = new Longitude(90);
- Longitude1 = Longitude1.Subtract(30);
- </code>
- </example>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.Subtract(DotSpatial.Positioning.Longitude)">
- <summary>
- Subtracts the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.Multiply(System.Double)">
- <summary>
- Multiplies the current instance by the specified value.
- </summary>
- <param name="value">A <strong>Double</strong> to multiply with the current instance.</param>
- <returns>A new <strong>Longitude</strong> containing the product of the two numbers.</returns>
- <example>
- This example multiplies 30° with three, returning 90°.
- <code lang="VB" title="[New Example]">
- Dim Longitude1 As New Longitude(30)
- Longitude1 = Longitude1.Multiply(3)
- </code>
- <code lang="CS" title="[New Example]">
- Longitude Longitude1 = new Longitude(30);
- Longitude1 = Longitude1.Multiply(3);
- </code>
- </example>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.Multiply(DotSpatial.Positioning.Longitude)">
- <summary>
- Multiplies the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.Divide(System.Double)">
- <summary>
- Divides the current instance by the specified value.
- </summary>
- <param name="value">A <strong>Double</strong> representing a denominator to divide by.</param>
- <returns>An <strong>Longitude</strong> containing the new value.</returns>
- <example>
- This example divides 90° by three, returning 30°.
- <code lang="VB" title="[New Example]">
- Dim Longitude1 As New Longitude(90)
- Longitude1 = Longitude1.Divide(3)
- </code>
- <code lang="CS" title="[New Example]">
- Longitude Longitude1 = new Longitude(90);
- Longitude1 = Longitude1.Divide(3);
- </code>
- </example>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.Divide(DotSpatial.Positioning.Longitude)">
- <summary>
- Divides the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.IsLessThan(DotSpatial.Positioning.Longitude)">
- <summary>
- Indicates if the current instance is smaller than the specified value.
- </summary>
- <param name="value">An <strong>Longitude</strong> to compare with the current instance.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the current instance is
- smaller than the specified value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.IsLessThan(System.Double)">
- <summary>
- Determines whether [is less than] [the specified value].
- </summary>
- <param name="value">The value.</param>
- <returns><c>true</c> if [is less than] [the specified value]; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.IsLessThanOrEqualTo(DotSpatial.Positioning.Longitude)">
- <summary>
- Indicates if the current instance is smaller than or equal to the specified
- value.
- </summary>
- <param name="value">An <strong>Longitude</strong> to compare with the current instance.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the current instance is
- smaller than or equal to the specified value.</returns>
- <remarks>This method compares the <strong>DecimalDegrees</strong> property with the
- specified value. This method is the same as the "<=" operator.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.IsLessThanOrEqualTo(System.Double)">
- <summary>
- Determines whether [is less than or equal to] [the specified value].
- </summary>
- <param name="value">The value.</param>
- <returns><c>true</c> if [is less than or equal to] [the specified value]; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.IsGreaterThan(DotSpatial.Positioning.Longitude)">
- <summary>
- Indicates if the current instance is larger than the specified value.
- </summary>
- <param name="value">An <strong>Longitude</strong> to compare with the current instance.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the current instance is
- greater than the specified value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.IsGreaterThan(System.Double)">
- <summary>
- Determines whether [is greater than] [the specified value].
- </summary>
- <param name="value">The value.</param>
- <returns><c>true</c> if [is greater than] [the specified value]; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.IsGreaterThanOrEqualTo(DotSpatial.Positioning.Longitude)">
- <summary>
- Indicates if the current instance is larger than or equal to the specified
- value.
- </summary>
- <param name="value">An <strong>Longitude</strong> to compare with the current instance.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the current instance is
- greater than or equal to the specified value.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.IsGreaterThanOrEqualTo(System.Double)">
- <summary>
- Determines whether [is greater than or equal to] [the specified value].
- </summary>
- <param name="value">The value.</param>
- <returns><c>true</c> if [is greater than or equal to] [the specified value]; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.op_Explicit(DotSpatial.Positioning.Radian)~DotSpatial.Positioning.Longitude">
- <summary>
- Converts a measurement in Radians into an Longitude.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.op_Explicit(System.Double)~DotSpatial.Positioning.Longitude">
- <summary>
- Converts a decimal degree measurement as a Double into an Longitude.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.op_Explicit(System.Single)~DotSpatial.Positioning.Longitude">
- <summary>
- Converts a decimal degree measurement as a Double into an Longitude.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.op_Explicit(DotSpatial.Positioning.Longitude)~System.Double">
- <summary>
- Converts a decimal degree measurement as a Double into an Longitude.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.op_Explicit(DotSpatial.Positioning.Longitude)~System.Single">
- <summary>
- Converts a decimal degree measurement as a Double into an Longitude.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.op_Explicit(System.Int32)~DotSpatial.Positioning.Longitude">
- <summary>
- Converts a measurement in degrees as an Integer into an Longitude.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.op_Explicit(DotSpatial.Positioning.Angle)~DotSpatial.Positioning.Longitude">
- <summary>
- Performs an explicit conversion from <see cref="T:DotSpatial.Positioning.Angle"/> to <see cref="T:DotSpatial.Positioning.Longitude"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.op_Explicit(DotSpatial.Positioning.Azimuth)~DotSpatial.Positioning.Longitude">
- <summary>
- Performs an explicit conversion from <see cref="T:DotSpatial.Positioning.Azimuth"/> to <see cref="T:DotSpatial.Positioning.Longitude"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.op_Explicit(DotSpatial.Positioning.Elevation)~DotSpatial.Positioning.Longitude">
- <summary>
- Performs an explicit conversion from <see cref="T:DotSpatial.Positioning.Elevation"/> to <see cref="T:DotSpatial.Positioning.Longitude"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.op_Explicit(DotSpatial.Positioning.Latitude)~DotSpatial.Positioning.Longitude">
- <summary>
- Performs an explicit conversion from <see cref="T:DotSpatial.Positioning.Latitude"/> to <see cref="T:DotSpatial.Positioning.Longitude"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.op_Explicit(System.String)~DotSpatial.Positioning.Longitude">
- <summary>
- Converts a measurement in the form of a formatted String into an Longitude.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.op_Explicit(DotSpatial.Positioning.Longitude)~System.String">
- <summary>
- Converts an Longitude into a String.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- <remarks>This operator calls the ToString() method using the current culture.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.Clone">
- <summary>
- Creates a copy of the current instance.
- </summary>
- <returns>An <strong>Longitude</strong> of the same value as the current instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.Equals(DotSpatial.Positioning.Longitude,System.Int32)">
- <summary>
- Compares the current instance to another instance using the specified
- precision.
- </summary>
- <param name="other">The other.</param>
- <param name="decimals">The decimals.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the
- <strong>DecimalDegrees</strong> property of the current instance matches the
- specified instance's <strong>DecimalDegrees</strong> property.</returns>
- <seealso cref="M:DotSpatial.Positioning.Longitude.Equals(DotSpatial.Positioning.Longitude)">Equals Method</seealso>
-
- <example>
- These examples compare two fractional values using specific numbers of digits for
- comparison.
- <code lang="VB" title="[New Example]">
- ' Equals will return False
- Dim Longitude1 As New Longitude(90.15);
- Dim Longitude2 As New Longitude(90.12);
- If Longitude1.Equals(Longitude2, 2) Then
- Debug.WriteLine("The values are the same to two digits of precision.");
- ' Equals will return True
- Dim Longitude1 As New Longitude(90.15);
- Dim Longitude2 As New Longitude(90.12);
- If Longitude1.Equals(Longitude2, 1) Then
- Debug.WriteLine("The values are the same to one digit of precision.");
- </code>
- <code lang="CS" title="[New Example]">
- // Equals will return False
- Longitude Longitude1 = new Longitude(90.15);
- Longitude Longitude2 = new Longitude(90.12);
- if (Longitude1.Equals(Longitude2, 2))
- Console.WriteLine("The values are the same to two digits of precision.");
- // Equals will return True
- Longitude Longitude1 = new Longitude(90.15);
- Longitude Longitude2 = new Longitude(90.12);
- if (Longitude1.Equals(Longitude2, 1))
- Console.WriteLine("The values are the same to one digits of precision.");
- </code>
- </example>
- <remarks><para>This is typically used in cases where precision is only significant for a few
- digits and exact comparison is not necessary.</para>
- <para><em>notice: This method compares objects by value, not by
- reference.</em></para></remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.Equals(DotSpatial.Positioning.Longitude)">
- <summary>
- Indicates whether the current object is equal to another object of the same type.
- </summary>
- <param name="other">An object to compare with this object.</param>
- <returns>true if the current object is equal to the <paramref name="other"/> parameter; otherwise, false.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.CompareTo(DotSpatial.Positioning.Longitude)">
- <summary>
- Compares the current object with another object of the same type.
- </summary>
- <param name="other">An object to compare with this object.</param>
- <returns>A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has the following meanings:
- Value
- Meaning
- Less than zero
- This object is less than the <paramref name="other"/> parameter.
- Zero
- This object is equal to <paramref name="other"/>.
- Greater than zero
- This object is greater than <paramref name="other"/>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.ToString(System.String,System.IFormatProvider)">
- <summary>
- Outputs the current instance as a string using the specified format.
- </summary>
- <param name="format"><para>A combination of symbols, spaces, and any of the following case-insensitive
- letters: <strong>D</strong> or <strong>H</strong> for hours, <strong>M</strong> for
- minutes, <strong>S</strong> for seconds, and <strong>I</strong> to indicate the
- hemisphere. Here are some examples:</para>
- <para>
- <table cellspacing="0" cols="3" cellpadding="2" width="100%">
- <tbody>
- <tr>
- <td>HH°MM'SS.SS"</td>
- <td>HHH.H°</td>
- <td>HH MM.MM</td>
- <td>HHHMMSS</td>
- </tr>
- <tr>
- <td>HH°MM'SS.SS"I</td>
- <td>HHH.H°I</td>
- <td>HH MM.MMI</td>
- <td>HHHMMSSI</td>
- </tr>
- </tbody>
- </table>
- </para></param>
- <param name="formatProvider">A <strong>CultureInfo</strong> object used to properly format the string information.</param>
- <returns>A <strong>String</strong> matching the specified format.</returns>
- <seealso cref="M:DotSpatial.Positioning.Longitude.ToString">ToString Method</seealso>
-
- <seealso cref="M:DotSpatial.Positioning.Longitude.Parse(System.String)">Parse Method</seealso>
-
- <example>
- This example uses the <strong>ToString</strong> method to output an angle in a
- custom format. The " <strong>h°</strong> " code represents hours along with a
- degree symbol (Alt+0176 on the keypad), and " <strong>m.mm</strong> " represents
- the minutes out to two decimals. Mmm.
- <code lang="VB">
- Dim MyLongitude As New Longitude(45, 16.772)
- Debug.WriteLine(MyLongitude.ToString("h°m.mm", CultureInfo.CurrentCulture))
- ' Output: 45°16.78
- </code>
- <code lang="CS">
- Dim MyLongitude As New Longitude(45, 16.772);
- Debug.WriteLine(MyLongitude.ToString("h°m.mm", CultureInfo.CurrentCulture));
- // Output: 45°16.78
- </code>
- </example>
- <remarks>This powerful method returns the current angular measurement in a specific
- format. If no value for the format is specified, a format of
- <strong>hhh°mm'SS.SS"I</strong> (adjusted to the current culture) will be used. The
- resulting <strong>String</strong> can be converted back into an
- <strong>Longitude</strong> via the
- <see href="Angle.Parse">Parse</see> method so long as a delimiter separates each individual
- value.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.System#Xml#Serialization#IXmlSerializable#GetSchema">
- <summary>
- This method is reserved and should not be used. When implementing the IXmlSerializable interface, you should return null (Nothing in Visual Basic) from this method, and instead, if specifying a custom schema is required, apply the <see cref="T:System.Xml.Serialization.XmlSchemaProviderAttribute"/> to the class.
- </summary>
- <returns>An <see cref="T:System.Xml.Schema.XmlSchema"/> that describes the XML representation of the object that is produced by the <see cref="M:System.Xml.Serialization.IXmlSerializable.WriteXml(System.Xml.XmlWriter)"/> method and consumed by the <see cref="M:System.Xml.Serialization.IXmlSerializable.ReadXml(System.Xml.XmlReader)"/> method.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.WriteXml(System.Xml.XmlWriter)">
- <summary>
- Converts an object into its XML representation.
- </summary>
- <param name="writer">The <see cref="T:System.Xml.XmlWriter"/> stream to which the object is serialized.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Longitude.ReadXml(System.Xml.XmlReader)">
- <summary>
- Generates an object from its XML representation.
- </summary>
- <param name="reader">The <see cref="T:System.Xml.XmlReader"/> stream from which the object is deserialized.</param>
- </member>
- <member name="P:DotSpatial.Positioning.Longitude.DecimalDegrees">
- <summary>
- Returns the value of the angle as decimal degrees.
- </summary>
- <value>A <strong>Double</strong> value.</value>
- <seealso cref="P:DotSpatial.Positioning.Longitude.Hours">Hours Property</seealso>
-
- <seealso cref="P:DotSpatial.Positioning.Longitude.Minutes">Minutes Property</seealso>
-
- <seealso cref="P:DotSpatial.Positioning.Longitude.Seconds">Seconds Property</seealso>
-
- <example>
- This example demonstrates how the
- <see cref="P:DotSpatial.Positioning.Longitude.DecimalDegrees"><strong>DecimalDegrees</strong></see> property is
- calculated automatically when creating an angle using hours, minutes and seconds.
- <code lang="VB">
- ' Create an angle of 20°30'
- Dim MyLongitude As New Longitude(20, 30)
- ' Setting the DecimalMinutes recalculated other properties
- Debug.WriteLine(MyLongitude.DecimalDegrees)
- ' Output: "20.5" the same as 20°30'
- </code>
- <code lang="CS">
- // Create an angle of 20°30'
- Longitude MyLongitude = New Longitude(20, 30);
- // Setting the DecimalMinutes recalculated other properties
- Console.WriteLine(MyLongitude.DecimalDegrees)
- // Output: "20.5" the same as 20°30'
- </code>
- </example>
- <remarks>This property returns the value of the angle as a single number.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Longitude.DecimalMinutes">
- <summary>
- Returns the minutes and seconds as a single numeric value.
- </summary>
- <value>A <strong>Double</strong> value.</value>
- <seealso cref="P:DotSpatial.Positioning.Longitude.Minutes">Minutes Property</seealso>
-
- <seealso cref="P:DotSpatial.Positioning.Longitude.DecimalDegrees">DecimalDegrees Property</seealso>
-
- <example>
- This example demonstrates how the <strong>DecimalMinutes</strong> property is
- automatically calculated when creating a new angle.
- <code lang="VB">
- ' Create an angle of 20°10'30"
- Dim MyLongitude As New Longitude(20, 10, 30)
- ' The DecimalMinutes property is automatically calculated
- Debug.WriteLine(MyLongitude.DecimalMinutes)
- ' Output: "10.5"
- </code>
- <code lang="CS">
- // Create an angle of 20°10'30"
- Longitude MyLongitude = new Longitude(20, 10, 30);
- // The DecimalMinutes property is automatically calculated
- Console.WriteLine(MyLongitude.DecimalMinutes)
- // Output: "10.5"
- </code>
- </example>
- <remarks>This property is used when minutes and seconds are represented as a single
- decimal value.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Longitude.Hours">
- <summary>
- Returns the integer hours (degrees) portion of an angular
- measurement.
- </summary>
- <value>An <strong>Integer</strong> value.</value>
- <seealso cref="P:DotSpatial.Positioning.Longitude.Minutes">Minutes Property</seealso>
-
- <seealso cref="P:DotSpatial.Positioning.Longitude.Seconds">Seconds Property</seealso>
-
- <example>
- This example creates an angle of 60.5° then outputs the value of the
- <strong>Hours</strong> property, 60.
- <code lang="VB">
- Dim MyLongitude As New Longitude(60.5)
- Debug.WriteLine(MyLongitude.Hours)
- ' Output: 60
- </code>
- <code lang="CS">
- Longitude MyLongitude = new Longitude(60.5);
- Console.WriteLine(MyLongitude.Hours);
- // Output: 60
- </code>
- </example>
- <remarks>This property is used in conjunction with the <see cref="P:DotSpatial.Positioning.Longitude.Minutes">Minutes</see>
- and <see cref="P:DotSpatial.Positioning.Longitude.Seconds">Seconds</see> properties to create a full angular measurement.
- This property is the same as <strong>DecimalDegrees</strong> without any fractional
- value.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Longitude.Minutes">
- <summary>
- Returns the integer minutes portion of an angular measurement.
- </summary>
- <value>An <strong>Integer</strong>.</value>
- <seealso cref="P:DotSpatial.Positioning.Longitude.Hours">Hours Property</seealso>
-
- <seealso cref="P:DotSpatial.Positioning.Longitude.Seconds">Seconds Property</seealso>
-
- <example>
- This example creates an angle of 45.5° then outputs the value of the
- <strong>Minutes</strong> property, 30.
- <code lang="VB">
- Dim MyLongitude As New Longitude(45.5)
- Debug.WriteLine(MyLongitude.Minutes)
- ' Output: 30
- </code>
- <code lang="CS">
- Longitude MyLongitude = new Longitude(45.5);
- Console.WriteLine(MyLongitude.Minutes);
- // Output: 30
- </code>
- </example>
- <remarks>This property is used in conjunction with the <see cref="P:DotSpatial.Positioning.Longitude.Hours">Hours</see> and
- <see cref="P:DotSpatial.Positioning.Longitude.Seconds">Seconds</see> properties to create a sexagesimal
- measurement.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Longitude.Seconds">
- <summary>
- Returns the seconds minutes portion of an angular measurement.
- </summary>
- <value>A <strong>Double</strong> value.</value>
- <seealso cref="P:DotSpatial.Positioning.Longitude.Hours">Hours Property</seealso>
-
- <seealso cref="P:DotSpatial.Positioning.Longitude.Minutes">Minutes Property</seealso>
-
- <example>
- This example creates an angle of 45°10.5' then outputs the value of the
- <strong>Seconds</strong> property, 30.
- <code lang="VB">
- Dim MyLongitude As New Longitude(45, 10.5)
- Debug.WriteLine(MyLongitude.Seconds)
- ' Output: 30
- </code>
- <code lang="CS">
- Dim MyLongitude As New Longitude(45, 10.5);
- Console.WriteLine(MyLongitude.Seconds);
- // Output: 30
- </code>
- </example>
- <remarks>This property is used in conjunction with the <see cref="P:DotSpatial.Positioning.Longitude.Hours">Hours</see> and
- <see cref="P:DotSpatial.Positioning.Longitude.Minutes">Minutes</see> properties to create a sexagesimal
- measurement.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Longitude.Hemisphere">
- <summary>
- Returns whether the longitude is east or west of the Prime Meridian.
- </summary>
- <remarks>When this property changes, the DecimalDegrees property is adjusted: if the
- hemisphere is <strong>West</strong>, a negative sign is placed in front of the
- DecimalDegrees value, and vice versa.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Longitude.UtmZoneNumber">
- <summary>
- Returns the Universal Transverse Mercator zone number for this longitude.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Longitude.IsEmpty">
- <summary>
- Indicates if the current instance has a non-zero value.
- </summary>
- <value>A <strong>Boolean</strong>, <strong>True</strong> if the
- <strong>DecimalDegrees</strong> property is zero.</value>
- <seealso cref="F:DotSpatial.Positioning.Longitude.Empty">Empty Field</seealso>
- </member>
- <member name="P:DotSpatial.Positioning.Longitude.IsInfinity">
- <summary>
- Indicates if the current instance represents an infinite value.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Longitude.IsInvalid">
- <summary>
- Indicates whether the value is invalid or unspecified.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Longitude.IsNormalized">
- <summary>
- Indicates whether the value has been normalized and is within the
- allowed bounds of -180° and 180°.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.LongitudeHemisphere">
- <summary>
- Indicates the position of a longitude measurement relative to the <a href="http://www.greenwichmeridian.com/">Prime Meridian</a>.
- </summary>
- <seealso cref="P:DotSpatial.Positioning.Latitude.Hemisphere">Hemisphere Property (Latitude Class)</seealso>
-
- <seealso cref="T:DotSpatial.Positioning.LatitudeHemisphere">LatitudeHemisphere Enumeration</seealso>
- <remarks><para>This enumeration is used by the <see cref="P:DotSpatial.Positioning.Longitude.Hemisphere">Hemisphere</see>
- property of the <see cref="T:DotSpatial.Positioning.Longitude">Latitude</see> class. If a longitude is west of the
- Prime Meridian, it's value is displayed as a negative number, or with a single letter (but not
- both). For example, 105 degrees west can be expressed in either of these
- ways:</para>
- <list type="bullet">
- <item>105°W</item>
- <item>-105°</item>
- </list></remarks>
- </member>
- <member name="F:DotSpatial.Positioning.LongitudeHemisphere.None">
- <summary>Missing longitude information.</summary>
- </member>
- <member name="F:DotSpatial.Positioning.LongitudeHemisphere.East">
- <summary>The longitude is east of the Prime Meridian.</summary>
- </member>
- <member name="F:DotSpatial.Positioning.LongitudeHemisphere.West">
- <summary>The longitude is west of the Prime Meridian.</summary>
- </member>
- <member name="T:DotSpatial.Positioning.HostPlatformID">
- <summary>
- Indicates the current host operating system.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.HostPlatformID.Unknown">
- <summary>
- The current platform has not yet been determined.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.HostPlatformID.Desktop">
- <summary>
- The current plarform is a desktop computer.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.HostPlatformID.WindowsCe">
- <summary>
- The current platform is Windows CE 4.2
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.HostPlatformID.PocketPc">
- <summary>
- The current platform is PocketPC (Windows Mobile 2003)
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.HostPlatformID.Smartphone">
- <summary>
- The current platform is Smartphone
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.DotNetFrameworkID">
- <summary>
- Indicates the current .NET framework being used.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DotNetFrameworkID.Unknown">
- <summary>
- The .NET framework version has not been determined.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DotNetFrameworkID.DesktopFramework10">
- <summary>
- .NET framework version 1.0 (Visual Studio 2002) is being used.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DotNetFrameworkID.DesktopFramework11">
- <summary>
- .NET framework version 1.1 (Visual Studio 2003) is being used.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DotNetFrameworkID.DesktopFramework20">
- <summary>
- .NET framework version 2.0 (Visual Studio 2005) is being used.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DotNetFrameworkID.DesktopFramework30">
- <summary>
- .NET framework version 3.0 (Visual Studio 2008) is being used.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DotNetFrameworkID.DesktopFramework40">
- <summary>
- .NET framework version 4.0 (Visual Studio 2010) is being used.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DotNetFrameworkID.CompactFramework10">
- <summary>
- .NET Compact Framework version 1.0 (Visual Studio 2003) is being used.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.DotNetFrameworkID.CompactFramework20">
- <summary>
- .NET Compact Framework version 2.0 (Visual Studio 2005) is being used.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.Platform">
- <summary>
- Provides features for determining the current host platform.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Platform.DOT_NET_FRAMEWORK_ID">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Platform._hostPlatformID">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Platform.#cctor">
- <summary>
- Initializes a new instance of the <see cref="T:System.Object"/> class.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Platform.HostPlatformID">
- <summary>
- Returns the current host platform.
- </summary>
- <remarks>This property is used to determine the current host platform: Windows CE 4.2,
- PocketPC / Windows Mobile 2003, Smartphone, or Desktop. This property is typically
- used to adjust the performance and behavior of an application to work on a specific platform.
- For example, thread priorities are more sensitive on the Smartphone platform than the
- PocketPC platform. This can also be used to determine correct locations of system folders
- and installed system software such as Bluetooth stacks.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Platform.DotNetFrameworkID">
- <summary>
- Returns the current version of the .NET Framework currently in use.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.Position">
- <summary>
- Represents a specific location on Earth's surface.
- </summary>
- <remarks>Instances of this class are guaranteed to be thread-safe because the class is
- immutable (its properties can only be changed via constructors).</remarks>
- </member>
- <member name="F:DotSpatial.Positioning.Position.TARGET_ACCURACY">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Position._latitude">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Position._longitude">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Position.Empty">
- <summary>
- Represents the location at 0°, 0°.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Position.Minimum">
- <summary>
- Represents the smallest possible location of 90°S, 180°W.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Position.Maximum">
- <summary>
- Represents the largest possible location of 90°N, 180°E.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Position.NorthPole">
- <summary>
- Represents the single point at the top of Earth: 90°N, 0°E.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Position.SouthPole">
- <summary>
- Represents the single point at the bottom of Earth: 90°S, 0°E.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Position.Invalid">
- <summary>
- Represents an invalid or unspecified value.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Position.#ctor(DotSpatial.Positioning.Longitude,DotSpatial.Positioning.Latitude)">
- <summary>
- Creates a new instance from the specified longitude and latitude.
- </summary>
- <param name="longitude">The longitude.</param>
- <param name="latitude">The latitude.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Position.#ctor(DotSpatial.Positioning.Latitude,DotSpatial.Positioning.Longitude)">
- <summary>
- Creates a new instance from the specified latitude and longitude.
- </summary>
- <param name="latitude">The latitude.</param>
- <param name="longitude">The longitude.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Position.#ctor(System.String)">
- <summary>
- Creates a new instance by parsing latitude and longitude from a single string.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Position.#ctor(System.String,System.String)">
- <summary>
- Creates a new instance by interpreting the specified latitude and longitude.
- </summary>
- <param name="latitude">The latitude.</param>
- <param name="longitude">The longitude.</param>
- <remarks>Latitude and longitude values are parsed using the current local culture. For better support
- of international cultures, add a CultureInfo parameter.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Position.#ctor(System.String,System.String,System.Globalization.CultureInfo)">
- <summary>
- Creates a new instance by interpreting the specified latitude and longitude.
- </summary>
- <param name="latitude">The latitude.</param>
- <param name="longitude">The longitude.</param>
- <param name="culture">The culture.</param>
- <remarks>Latitude and longitude values are parsed using the current local culture. For better support
- of international cultures, a CultureInfo parameter should be specified to indicate how numbers should
- be parsed.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Position.#ctor(System.String,System.Globalization.CultureInfo)">
- <summary>
- Creates a new instance by converting the specified string using the specific culture.
- </summary>
- <param name="value">The value.</param>
- <param name="culture">The culture.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Position.#ctor(DotSpatial.Positioning.Position)">
- <summary>
- Creates a copy of the specified object.
- </summary>
- <param name="position">The position.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Position.#ctor(System.Xml.XmlReader)">
- <summary>
- Creates a new position by deserializing the specified XML content.
- </summary>
- <param name="reader">The reader.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Position.ToString(System.String)">
- <summary>
- Outputs the current instance as a string using the specified format.
- </summary>
- <param name="format">The format.</param>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- <overloads>Outputs the current instance as a formatted string.</overloads>
- </member>
- <member name="M:DotSpatial.Positioning.Position.ToCartesianPoint">
- <summary>
- Converts the current instance into an Earth-centered, Earth-fixed (ECEF) Cartesian point.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position.ToCartesianPoint(DotSpatial.Positioning.Ellipsoid,DotSpatial.Positioning.Distance)">
- <summary>
- Toes the cartesian point.
- </summary>
- <param name="ellipsoid">The ellipsoid.</param>
- <param name="altitude">The altitude.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position.Normalize">
- <summary>
- Normalizes this instance.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position.BearingTo(DotSpatial.Positioning.Position)">
- <summary>
- Calculates the direction of travel to the specified destination.
- </summary>
- <param name="destination">A <strong>Position</strong> object to which the bearing is calculated.</param>
- <returns>An <strong>Azimuth</strong> object representing the calculated distance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position.BearingTo(DotSpatial.Positioning.Position,DotSpatial.Positioning.Ellipsoid)">
- <summary>
- Calculates the direction of travel to the specified destination using the specified interpretation of Earth's shape.
- </summary>
- <param name="destination">A <strong>Position</strong> object to which the bearing is calculated.</param>
- <param name="ellipsoid">An <strong>Ellipsoid</strong> object used to fine-tune bearing calculations.</param>
- <returns>An <strong>Azimuth</strong> object representing the calculated distance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position.SpeedTo(DotSpatial.Positioning.Position,System.TimeSpan)">
- <summary>
- Returns the minimum speed required to travel from the current location to the
- specified destination within the specified period of time.
- </summary>
- <param name="destination">The destination.</param>
- <param name="time">The time.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position.IsNorthOf(DotSpatial.Positioning.Position)">
- <summary>
- Indicates if the current instance is North of the specified position.
- </summary>
- <param name="value">A <strong>Position</strong> object to examine.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the current instance is more North than the specified instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position.IsSouthOf(DotSpatial.Positioning.Position)">
- <summary>
- Indicates if the current instance is South of the specified position.
- </summary>
- <param name="value">A <strong>Position</strong> object to examine.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the current instance is more South than the specified instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position.IsEastOf(DotSpatial.Positioning.Position)">
- <summary>
- Indicates if the current instance is East of the specified position.
- </summary>
- <param name="value">A <strong>Position</strong> object to examine.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the current instance is more East than the specified instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position.IsWestOf(DotSpatial.Positioning.Position)">
- <summary>
- Indicates if the current instance is West of the specified position.
- </summary>
- <param name="value">A <strong>Position</strong> object to examine.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the current instance is more West than the specified instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position.TimeTo(DotSpatial.Positioning.Position,DotSpatial.Positioning.Speed)">
- <summary>
- Returns the minimum time required to travel to the given destination at the
- specified constant speed.
- </summary>
- <param name="destination">The destination.</param>
- <param name="speed">The speed.</param>
- <returns></returns>
- <exception cref="T:System.ArgumentOutOfRangeException">The TimeTo method expects a value for Speed greater than zero.</exception>
- </member>
- <member name="M:DotSpatial.Positioning.Position.DistanceTo(DotSpatial.Positioning.Position)">
- <summary>
- Returns the distance over land from the given starting point to the specified
- destination.
- </summary>
- <param name="destination">The ending point of a segment.</param>
- <returns>A <strong>Distance</strong> object containing the calculated distance in
- kilometers.</returns>
- <overloads>Calculates the great circle distance between any two points on
- Earth.</overloads>
- <remarks>This method uses trigonometry to calculate the Great Circle (over Earth's curved
- surface) distance between any two points on Earth. The distance is returned in
- kilometers but can be converted to any other unit type using methods in the
- <see cref="T:DotSpatial.Positioning.Distance">Distance</see>
- class.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Position.DistanceTo(DotSpatial.Positioning.Position,System.Boolean)">
- <summary>
- Returns the distance over land from the given starting point to the specified
- destination.
- </summary>
- <param name="destination">The ending point of a segment.</param>
- <param name="isApproximated">if set to <c>true</c> [is approximated].</param>
- <returns>A <strong>Distance</strong> object containing the calculated distance in
- kilometers.</returns>
- <overloads>Calculates the great circle distance between any two points on
- Earth.</overloads>
- <remarks>This method uses a high-speed formula to determine the Great Circle distance from one
- point to another. This method is typically used in situations where hundreds of distance
- measurements must be made in a short period of time. The <strong>DistanceTo</strong> method
- produces accuracy to one millimeter, but its formula is about a hundred times slower than this
- method.
- <see cref="T:DotSpatial.Positioning.Distance">Distance</see>
- class.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Position.DistanceTo(DotSpatial.Positioning.Position,DotSpatial.Positioning.Ellipsoid,System.Boolean)">
- <summary>
- Returns the distance over land from the given starting point to the specified
- destination.
- </summary>
- <param name="destination">The ending point of a segment.</param>
- <param name="ellipsoid">The model of the Earth to use for the distance calculation.</param>
- <param name="isApproximated">if set to <c>true</c> [is approximated].</param>
- <returns>A <strong>Distance</strong> object containing the calculated distance in
- kilometers.</returns>
- <overloads>Calculates the great circle distance between any two points on
- Earth.</overloads>
- <remarks>This method uses a high-speed formula to determine the Great Circle distance from one
- point to another. This method is typically used in situations where hundreds of distance
- measurements must be made in a short period of time. The <strong>DistanceTo</strong> method
- produces accuracy to one millimeter, but its formula is about a hundred times slower than this
- method.
- <see cref="T:DotSpatial.Positioning.Distance">Distance</see>
- class.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Position.DistanceTo(DotSpatial.Positioning.Position,DotSpatial.Positioning.Ellipsoid)">
- <summary>
- Returns the distance over land from the given starting point to the specified
- destination.
- </summary>
- <param name="destination">The ending point of a segment.</param>
- <param name="ellipsoid">The model of the Earth to use for the distance calculation.</param>
- <returns>A <strong>Distance</strong> object containing the calculated distance in
- kilometers.</returns>
- <overloads>Calculates the great circle distance between any two points on
- Earth using a specific model of Earth's shape.</overloads>
- <remarks>This method uses trigonometry to calculate the Great Circle (over Earth's curved
- surface) distance between any two points on Earth. The distance is returned in
- kilometers but can be converted to any other unit type using methods in the
- <see cref="T:DotSpatial.Positioning.Distance">Distance</see>
- class.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Position.DistanceTo(DotSpatial.Positioning.Position,DotSpatial.Positioning.Speed,System.TimeSpan)">
- <summary>
- Returns the remaining travel distance if traveling for a certain speed for a certain period of time.
- </summary>
- <param name="destination">A <strong>Position</strong> marking the destination location.</param>
- <param name="speed">A <strong>Speed</strong> travelled from the current instance.</param>
- <param name="time">A <strong>TimeSpan</strong> representing the time already elapsed during transit to the destination.</param>
- <returns>A <strong>Distance</strong> measuring the remaining distance to travel.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position.IntersectionOf(DotSpatial.Positioning.Azimuth,DotSpatial.Positioning.Position,DotSpatial.Positioning.Azimuth)">
- <summary>
- Calculates the intersection of two lines created by the current instance, another point, and a direction of travel from each point.
- </summary>
- <param name="firstBearing">An <strong>Angle</strong> specifying a travel direction from the current instance.</param>
- <param name="secondPosition">A <strong>Position</strong> specifying the start of the second line of intersection.</param>
- <param name="secondBearing">An <strong>Angle</strong> specifying a travel direction from the second position.</param>
- <returns>A <strong>Position</strong> representing the point of intersection, if one exists.</returns>
- <remarks>This method is typically used to determine the point where two objects in motion would meet.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Position.IntersectionOf(DotSpatial.Positioning.Angle,DotSpatial.Positioning.Position,DotSpatial.Positioning.Angle)">
- <summary>
- Intersections the of.
- </summary>
- <param name="firstBearing">The first bearing.</param>
- <param name="secondPosition">The second position.</param>
- <param name="secondBearing">The second bearing.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position.IntersectionOf(System.Double,DotSpatial.Positioning.Position,System.Double)">
- <summary>
- Intersections the of.
- </summary>
- <param name="firstBearing">The first bearing.</param>
- <param name="secondPosition">The second position.</param>
- <param name="secondBearing">The second bearing.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position.TranslateTo(DotSpatial.Positioning.Angle,DotSpatial.Positioning.Distance)">
- <summary>
- Calculates a position relative to the current instance based upon the given bearing and distance.
- </summary>
- <param name="bearing">An <strong>Angle</strong> object specifying a direction to shift.</param>
- <param name="distance">A <strong>Distance</strong> object specifying the distance to shift.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position.TranslateTo(DotSpatial.Positioning.Angle,DotSpatial.Positioning.Distance,DotSpatial.Positioning.Ellipsoid)">
- <summary>
- Translates to.
- </summary>
- <param name="bearing">The bearing.</param>
- <param name="distance">The distance.</param>
- <param name="ellipsoid">The ellipsoid.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position.TranslateTo(DotSpatial.Positioning.Azimuth,DotSpatial.Positioning.Distance)">
- <summary>
- Calculates a position relative to the current instance based upon the given bearing and distance.
- </summary>
- <param name="bearing">An <strong>Azimuth</strong> object specifying a direction to shift.</param>
- <param name="distance">A <strong>Distance</strong> object specifying the distance to shift.</param>
- <returns>A <strong>Position</strong> representing the calculated position.</returns>
- <remarks>This function is designed to calculate positions for any location on Earth, with
- the exception of coordinates which lie at the poles (e.g. 90°N or 90°S).</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Position.TranslateTo(DotSpatial.Positioning.Azimuth,DotSpatial.Positioning.Distance,DotSpatial.Positioning.Ellipsoid)">
- <summary>
- Calculates a position relative to the current instance based upon the given bearing and distance.
- </summary>
- <param name="bearing">An <strong>Azimuth</strong> object specifying a direction to shift.</param>
- <param name="distance">A <strong>Distance</strong> object specifying the distance to shift.</param>
- <param name="ellipsoid">The model of the Earth to use for the translation calculation.</param>
- <returns>A <strong>Position</strong> representing the calculated position.</returns>
- <remarks>This function is designed to calculate positions for any location on Earth, with
- the exception of coordinates which lie at the poles (e.g. 90°N or 90°S).</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Position.TranslateTo(System.Double,DotSpatial.Positioning.Distance)">
- <summary>
- Calculates a position relative to the current instance based upon the given bearing and distance.
- </summary>
- <param name="bearing">A <strong>Double</strong> specifying a direction to shift.</param>
- <param name="distance">A <strong>Distance</strong> object specifying the distance to shift.</param>
- <returns>A <strong>Position</strong> representing the calculated position.</returns>
- <remarks>This function is designed to calculate positions for any location on Earth, with
- the exception of coordinates which lie at the poles (e.g. 90°N or 90°S).</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Position.TranslateTo(System.Double,DotSpatial.Positioning.Distance,DotSpatial.Positioning.Ellipsoid)">
- <summary>
- Calculates a position relative to the current instance based upon the given bearing and distance.
- </summary>
- <param name="bearing">A <strong>Double</strong> specifying a direction to shift.</param>
- <param name="distance">A <strong>Distance</strong> object specifying the distance to shift.</param>
- <param name="ellipsoid">The model of the Earth to use for the translation calculation.</param>
- <returns>A <strong>Position</strong> representing the calculated position.</returns>
- <remarks>This function is designed to calculate positions for any location on Earth, with
- the exception of coordinates which lie at the poles (e.g. 90°N or 90°S).</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Position.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
- </summary>
- <param name="obj">Another object to compare to.</param>
- <returns><c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position.GetHashCode">
- <summary>
- Returns a hash code for this instance.
- </summary>
- <returns>A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position.ToString">
- <summary>
- Outputs the current instance as a string using the default format.
- </summary>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position.Random">
- <summary>
- Returns a random location using the specified random number seed.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position.Random(System.Random)">
- <summary>
- Returns a random location.
- </summary>
- <param name="generator">The generator.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position.Random(DotSpatial.Positioning.Latitude,DotSpatial.Positioning.Longitude,DotSpatial.Positioning.Latitude,DotSpatial.Positioning.Longitude)">
- <summary>
- Returns a random location within the specified geographic rectangle.
- </summary>
- <param name="southernmost">The southernmost.</param>
- <param name="westernmost">The westernmost.</param>
- <param name="northernmost">The northernmost.</param>
- <param name="easternmost">The easternmost.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position.Random(System.Random,DotSpatial.Positioning.Latitude,DotSpatial.Positioning.Longitude,DotSpatial.Positioning.Latitude,DotSpatial.Positioning.Longitude)">
- <summary>
- Returns a random location within the specified geographic rectangle.
- </summary>
- <param name="generator">A <strong>Random</strong> object used to generate random values.</param>
- <param name="southernmost">A <strong>Latitude</strong> specifying the southern-most allowed latitude.</param>
- <param name="westernmost">A <strong>Longitude</strong> specifying the western-most allowed longitude.</param>
- <param name="northernmost">A <strong>Latitude</strong> specifying the northern-most allowed latitude.</param>
- <param name="easternmost">A <strong>Longitude</strong> specifying the eastern-most allowed longitude.</param>
- <returns>The randomly created position.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position.BearingTo(DotSpatial.Positioning.Position,DotSpatial.Positioning.Position)">
- <summary>
- Bearings to.
- </summary>
- <param name="start">The start.</param>
- <param name="destination">The destination.</param>
- <returns></returns>
- <overloads>Returns the direction of travel from one position to another.</overloads>
- </member>
- <member name="M:DotSpatial.Positioning.Position.TranslateTo(DotSpatial.Positioning.Position,DotSpatial.Positioning.Angle,DotSpatial.Positioning.Distance)">
- <summary>
- Returns a new instance shifted by the specified direction and
- distance.
- </summary>
- <param name="start">The start.</param>
- <param name="bearing">The bearing.</param>
- <param name="distance">The distance.</param>
- <returns>A new <strong>Position</strong> object adjusted by the specified
- amount.</returns>
- <overloads>
- Returns the position shifted by the specified bearing and distance as new
- Position object.
- </overloads>
-
- <example>
- <code lang="VB" title="[New Example]" description="This example creates a destination point ten miles northwest of the
- current location.">
- ' Create a distance of ten miles
- Dim TravelDistance As New Distance(10, DistanceUnit.StatuteMiles)
- ' Calculate the point
- Dim DestinationPoint As Position
- DestinationPoint = Position.CurrentPosition.TranslateTo(Azimuth.Northwest,
- TravelDistance)
- </code>
- </example>
- <remarks><para>This method is typically used to create an destination point relative to an
- existing location. For example, this method could be used to create a point ten
- miles northeast of the current location.</para>
- <para><em>notice: The trigonometric formula used for this method is subject to errors
- when the distance to translate falls below a quarter mile (approximately 433
- meters).</em></para></remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Position.IntersectionOf(DotSpatial.Positioning.Position,DotSpatial.Positioning.Angle,DotSpatial.Positioning.Position,DotSpatial.Positioning.Angle)">
- <summary>
- Calculates the point (if any) at which two imaginary lines
- intersect.
- </summary>
- <param name="firstPosition">A <strong>Position</strong> specifying a position which marks the start of a line.</param>
- <param name="firstBearing">An <strong>Angle</strong> specifying a direction from the first Position.</param>
- <param name="secondPosition">A <strong>Position</strong> specifying the second position, marking the start of a second line.</param>
- <param name="secondBearing">An <strong>Angle</strong> specifying a direction from the second Position.</param>
- <returns>A <strong>Position</strong> object specifying the intersection
- point.</returns>
- <overloads>Calculates a position which marks the intersection of two
- vectors.</overloads>
- <remarks>This method uses trigonometry to calculate the point at which two lines intersect
- on Earth's surface. This method is typically used to see where two objects in motion
- would meet given their current directions of travel. This method does not take the speed
- of each object into account.
- <img src="IntersectionOf.jpg"/></remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Position.DistanceTo(DotSpatial.Positioning.Position,DotSpatial.Positioning.Position,DotSpatial.Positioning.Speed,System.TimeSpan)">
- <summary>
- Returns the remaining travel distance if traveling for a certain speed for a certain period of time.
- </summary>
- <param name="start">A <strong>Position</strong> marking the starting location from which to calculate.</param>
- <param name="destination">A <strong>Position</strong> marking the destination location.</param>
- <param name="speed">A <strong>Speed</strong> travelled from the current instance.</param>
- <param name="time">A <strong>TimeSpan</strong> representing the time already elapsed during transit to the destination.</param>
- <returns>A <strong>Distance</strong> measuring the remaining distance to travel.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position.DistanceTo(DotSpatial.Positioning.Position,DotSpatial.Positioning.Position)">
- <summary>
- Returns the distance over land from the given starting point to the specified
- destination.
- </summary>
- <param name="start">A beginning point from which to calculate distance.</param>
- <param name="destination">The ending point of a segment.</param>
- <returns>A <strong>Distance</strong> object containing the calculated distance in
- kilometers.</returns>
- <overloads>Calculates the great circle distance between any two points on
- Earth.</overloads>
- <remarks>This method uses trigonometry to calculate the Great Circle (over Earth's curved
- surface) distance between any two points on Earth. The distance is returned in
- kilometers but can be converted to any other unit type using methods in the
- <see cref="T:DotSpatial.Positioning.Distance">Distance</see>
- class.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Position.TimeTo(DotSpatial.Positioning.Position,DotSpatial.Positioning.Position,DotSpatial.Positioning.Speed)">
- <summary>
- Returns the minimum amount of time required to reach the specified destination at
- the specified speed.
- </summary>
- <param name="start">The start.</param>
- <param name="destination">The destination.</param>
- <param name="speed">The speed.</param>
- <returns></returns>
- <overloads>
- Calculates the time required to arrive at a destination when traveling at the
- specified speed.
- </overloads>
- </member>
- <member name="M:DotSpatial.Positioning.Position.SpeedTo(DotSpatial.Positioning.Position,DotSpatial.Positioning.Position,System.TimeSpan)">
- <summary>
- Returns the minimum speed required to travel over land from the given starting
- point to the specified destination within the specified period of time.
- </summary>
- <param name="start">The beginning point from which calculations are based.</param>
- <param name="destination">The ending point to which speed is calculated.</param>
- <param name="time">The amount of time allowed to reach the destination.</param>
- <returns>A <strong>Speed</strong> object containing the required minimum travel
- speed.</returns>
- <overloads>
- Calculates the minimum speed required to arrive at a destination in the given
- time.
- </overloads>
- <remarks>This method is typically used to compare the current speed with the minimum
- required speed. For example, if the current rate of travel is 30MPH and the minimum
- speed is 60MPH, it can be derived that the speed must be doubled to arrive at the
- destination on time. Of course, care must be taken when making any suggestion to
- increase driving speed.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Position.Parse(System.String)">
- <summary>
- Converts a string-based positional measurement into a Position
- object.
- </summary>
- <param name="value">A <strong>String</strong> containing both latitude and longitude in the form of a string.</param>
- <returns></returns>
- <remarks>This powerful method will analyze a string containing latitude and longitude and
- create a Position object matching the specified values. The latitude and longitude
- must be separated by a non-space delimiter such as a comma.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Position.Parse(System.String,System.Globalization.CultureInfo)">
- <summary>
- Parses the specified value.
- </summary>
- <param name="value">The value.</param>
- <param name="culture">The culture.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position.ParseAsLatLong(System.String,System.Globalization.CultureInfo)">
- <summary>
- Parses as lat long.
- </summary>
- <param name="value">The value.</param>
- <param name="culture">The culture.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position.op_Equality(DotSpatial.Positioning.Position,DotSpatial.Positioning.Position)">
- <summary>
- Implements the operator ==.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position.op_Inequality(DotSpatial.Positioning.Position,DotSpatial.Positioning.Position)">
- <summary>
- Implements the operator !=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position.op_Addition(DotSpatial.Positioning.Position,DotSpatial.Positioning.Position)">
- <summary>
- Implements the operator +.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position.op_Subtraction(DotSpatial.Positioning.Position,DotSpatial.Positioning.Position)">
- <summary>
- Implements the operator -.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position.op_Multiply(DotSpatial.Positioning.Position,DotSpatial.Positioning.Position)">
- <summary>
- Implements the operator *.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position.op_Division(DotSpatial.Positioning.Position,DotSpatial.Positioning.Position)">
- <summary>
- Implements the operator /.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position.Add(DotSpatial.Positioning.Position)">
- <summary>
- Adds the specified latitude and longitude from the current latitude and longitude.
- </summary>
- <param name="position">The position.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position.Subtract(DotSpatial.Positioning.Position)">
- <summary>
- Subtracts the specified latitude and longitude from the current latitude and longitude.
- </summary>
- <param name="position">The position.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position.Multiply(DotSpatial.Positioning.Position)">
- <summary>
- Multiplies the specified latitude and longitude from the current latitude and longitude.
- </summary>
- <param name="position">The position.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position.Divide(DotSpatial.Positioning.Position)">
- <summary>
- Divides the specified latitude and longitude from the current latitude and longitude.
- </summary>
- <param name="position">The position.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position.op_Explicit(System.String)~DotSpatial.Positioning.Position">
- <summary>
- Performs an explicit conversion from <see cref="T:System.String"/> to <see cref="T:DotSpatial.Positioning.Position"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position.op_Explicit(DotSpatial.Positioning.Position)~System.String">
- <summary>
- Performs an explicit conversion from <see cref="T:DotSpatial.Positioning.Position"/> to <see cref="T:System.String"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position.Clone">
- <summary>
- Creates a copy of the current instance.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position.Equals(DotSpatial.Positioning.Position)">
- <summary>
- Compares the current instance to the specified position.
- </summary>
- <param name="other">A <strong>Position</strong> object to compare with.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the values are identical.</returns>
- <remarks>The two objects are compared at up to four digits of precision.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Position.Equals(DotSpatial.Positioning.Position,System.Int32)">
- <summary>
- Compares the current instance to the specified position using the specified numeric precision.
- </summary>
- <param name="other">A <strong>Position</strong> object to compare with.</param>
- <param name="decimals">An <strong>Integer</strong> specifying the number of fractional digits to compare.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the values are identical.</returns>
- <remarks>This method is typically used when positions do not mark the same location unless they are
- extremely close to one another. Conversely, a low or even negative value for <strong>Precision</strong>
- allows positions to be considered equal even when they do not precisely match.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Position.ToString(System.String,System.IFormatProvider)">
- <summary>
- Outputs the current instance as a string using the specified format and culture information.
- </summary>
- <param name="format">The format to use.-or- A null reference (Nothing in Visual Basic) to use the default format defined for the type of the <see cref="T:System.IFormattable"/> implementation.</param>
- <param name="formatProvider">The provider to use to format the value.-or- A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.</param>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position.System#Xml#Serialization#IXmlSerializable#GetSchema">
- <summary>
- This method is reserved and should not be used. When implementing the IXmlSerializable interface, you should return null (Nothing in Visual Basic) from this method, and instead, if specifying a custom schema is required, apply the <see cref="T:System.Xml.Serialization.XmlSchemaProviderAttribute"/> to the class.
- </summary>
- <returns>An <see cref="T:System.Xml.Schema.XmlSchema"/> that describes the XML representation of the object that is produced by the <see cref="M:System.Xml.Serialization.IXmlSerializable.WriteXml(System.Xml.XmlWriter)"/> method and consumed by the <see cref="M:System.Xml.Serialization.IXmlSerializable.ReadXml(System.Xml.XmlReader)"/> method.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position.WriteXml(System.Xml.XmlWriter)">
- <summary>
- Converts an object into its XML representation.
- </summary>
- <param name="writer">The <see cref="T:System.Xml.XmlWriter"/> stream to which the object is serialized.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Position.ReadXml(System.Xml.XmlReader)">
- <summary>
- Generates an object from its XML representation.
- </summary>
- <param name="reader">The <see cref="T:System.Xml.XmlReader"/> stream from which the object is deserialized.</param>
- </member>
- <member name="P:DotSpatial.Positioning.Position.Latitude">
- <summary>
- Represents the vertical North/South portion of the location.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Position.Longitude">
- <summary>
- Represents the horizontal East/West portion of the location.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Position.IsEmpty">
- <summary>
- Indicates if the position has no value.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Position.IsInvalid">
- <summary>
- Indicates if the position has an invalid or unspecified value.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Position.IsNormalized">
- <summary>
- Indicates whether the position has been normalized and is within the
- allowed bounds of -90° and 90° latitude and -180° and 180° longitude.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.ZoneLetter">
- <summary>
- Indicates a vertical slice of the Earth used as a starting point for UTM positions.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.ZoneLetter.Unknown">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.ZoneLetter.Z">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.ZoneLetter.C">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.ZoneLetter.D">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.ZoneLetter.E">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.ZoneLetter.F">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.ZoneLetter.G">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.ZoneLetter.H">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.ZoneLetter.J">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.ZoneLetter.K">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.ZoneLetter.L">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.ZoneLetter.M">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.ZoneLetter.N">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.ZoneLetter.P">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.ZoneLetter.Q">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.ZoneLetter.R">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.ZoneLetter.S">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.ZoneLetter.T">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.ZoneLetter.U">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.ZoneLetter.V">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.ZoneLetter.W">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.ZoneLetter.X">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.Position3D">
- <summary>
- Represents a position on Earth marked by latitude, longitude, and altitude.
- </summary>
- <remarks>Instances of this class are guaranteed to be thread-safe because the class is
- immutable (its properties can only be changed via constructors).</remarks>
- </member>
- <member name="F:DotSpatial.Positioning.Position3D._position">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Position3D._altitude">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Position3D.#ctor(DotSpatial.Positioning.Distance,DotSpatial.Positioning.Position)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.Position3D"/> struct.
- </summary>
- <param name="altitude">The altitude.</param>
- <param name="location">The location.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Position3D.#ctor(DotSpatial.Positioning.Distance,DotSpatial.Positioning.Longitude,DotSpatial.Positioning.Latitude)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.Position3D"/> struct.
- </summary>
- <param name="altitude">The altitude.</param>
- <param name="longitude">The longitude.</param>
- <param name="latitude">The latitude.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Position3D.#ctor(DotSpatial.Positioning.Distance,DotSpatial.Positioning.Latitude,DotSpatial.Positioning.Longitude)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.Position3D"/> struct.
- </summary>
- <param name="altitude">The altitude.</param>
- <param name="latitude">The latitude.</param>
- <param name="longitude">The longitude.</param>
- <overloads>Creates a new instance.</overloads>
- </member>
- <member name="M:DotSpatial.Positioning.Position3D.#ctor(DotSpatial.Positioning.Longitude,DotSpatial.Positioning.Latitude,DotSpatial.Positioning.Distance)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.Position3D"/> struct.
- </summary>
- <param name="longitude">The longitude.</param>
- <param name="latitude">The latitude.</param>
- <param name="altitude">The altitude.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Position3D.#ctor(DotSpatial.Positioning.Latitude,DotSpatial.Positioning.Longitude,DotSpatial.Positioning.Distance)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.Position3D"/> struct.
- </summary>
- <param name="latitude">The latitude.</param>
- <param name="longitude">The longitude.</param>
- <param name="altitude">The altitude.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Position3D.#ctor(System.String,System.String)">
- <summary>
- Creates a new instance by parsing latitude and longitude from a single string.
- </summary>
- <param name="altitude">The altitude.</param>
- <param name="location">The location.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Position3D.#ctor(System.String,System.String,System.String)">
- <summary>
- Creates a new instance by interpreting the specified latitude and longitude.
- </summary>
- <param name="altitude">The altitude.</param>
- <param name="latitude">The latitude.</param>
- <param name="longitude">The longitude.</param>
- <remarks>Latitude and longitude values are parsed using the current local culture. For better support
- of international cultures, add a CultureInfo parameter.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Position3D.#ctor(System.String,System.String,System.String,System.Globalization.CultureInfo)">
- <summary>
- Creates a new instance by interpreting the specified latitude and longitude.
- </summary>
- <param name="altitude">The altitude.</param>
- <param name="latitude">The latitude.</param>
- <param name="longitude">The longitude.</param>
- <param name="culture">The culture.</param>
- <remarks>Latitude and longitude values are parsed using the current local culture. For better support
- of international cultures, a CultureInfo parameter should be specified to indicate how numbers should
- be parsed.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Position3D.#ctor(System.String,System.String,System.Globalization.CultureInfo)">
- <summary>
- Creates a new instance by converting the specified string using the specific culture.
- </summary>
- <param name="altitude">The altitude.</param>
- <param name="location">The location.</param>
- <param name="culture">The culture.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Position3D.#ctor(DotSpatial.Positioning.Position)">
- <summary>
- Upgrades a Position object to a Position3D object.
- </summary>
- <param name="position">The position.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Position3D.#ctor(System.Xml.XmlReader)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.Position3D"/> struct.
- </summary>
- <param name="reader">The reader.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Position3D.ToCartesianPoint">
- <summary>
- Toes the cartesian point.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position3D.ToCartesianPoint(DotSpatial.Positioning.Ellipsoid)">
- <summary>
- Toes the cartesian point.
- </summary>
- <param name="ellipsoid">The ellipsoid.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position3D.op_Equality(DotSpatial.Positioning.Position3D,DotSpatial.Positioning.Position3D)">
- <summary>
- Implements the operator ==.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position3D.op_Inequality(DotSpatial.Positioning.Position3D,DotSpatial.Positioning.Position3D)">
- <summary>
- Implements the operator !=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position3D.op_Addition(DotSpatial.Positioning.Position3D,DotSpatial.Positioning.Position3D)">
- <summary>
- Implements the operator +.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position3D.op_Subtraction(DotSpatial.Positioning.Position3D,DotSpatial.Positioning.Position3D)">
- <summary>
- Implements the operator -.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position3D.op_Multiply(DotSpatial.Positioning.Position3D,DotSpatial.Positioning.Position3D)">
- <summary>
- Implements the operator *.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position3D.op_Division(DotSpatial.Positioning.Position3D,DotSpatial.Positioning.Position3D)">
- <summary>
- Implements the operator /.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position3D.Add(DotSpatial.Positioning.Position3D)">
- <summary>
- Adds the specified position.
- </summary>
- <param name="position">The position.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position3D.Subtract(DotSpatial.Positioning.Position3D)">
- <summary>
- Subtracts the specified position.
- </summary>
- <param name="position">The position.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position3D.Multiply(DotSpatial.Positioning.Position3D)">
- <summary>
- Multiplies the specified position.
- </summary>
- <param name="position">The position.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position3D.Divide(DotSpatial.Positioning.Position3D)">
- <summary>
- Divides the specified position.
- </summary>
- <param name="position">The position.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position3D.GetHashCode">
- <summary>
- Returns a hash code for this instance.
- </summary>
- <returns>A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position3D.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
- </summary>
- <param name="obj">Another object to compare to.</param>
- <returns><c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position3D.op_Explicit(DotSpatial.Positioning.CartesianPoint)~DotSpatial.Positioning.Position3D">
- <summary>
- Performs an explicit conversion from <see cref="T:DotSpatial.Positioning.CartesianPoint"/> to <see cref="T:DotSpatial.Positioning.Position3D"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position3D.op_Explicit(DotSpatial.Positioning.Position3D)~System.String">
- <summary>
- Performs an explicit conversion from <see cref="T:DotSpatial.Positioning.Position3D"/> to <see cref="T:System.String"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position3D.System#Xml#Serialization#IXmlSerializable#GetSchema">
- <summary>
- This method is reserved and should not be used. When implementing the IXmlSerializable interface, you should return null (Nothing in Visual Basic) from this method, and instead, if specifying a custom schema is required, apply the <see cref="T:System.Xml.Serialization.XmlSchemaProviderAttribute"/> to the class.
- </summary>
- <returns>An <see cref="T:System.Xml.Schema.XmlSchema"/> that describes the XML representation of the object that is produced by the <see cref="M:System.Xml.Serialization.IXmlSerializable.WriteXml(System.Xml.XmlWriter)"/> method and consumed by the <see cref="M:System.Xml.Serialization.IXmlSerializable.ReadXml(System.Xml.XmlReader)"/> method.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position3D.WriteXml(System.Xml.XmlWriter)">
- <summary>
- Converts an object into its XML representation.
- </summary>
- <param name="writer">The <see cref="T:System.Xml.XmlWriter"/> stream to which the object is serialized.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Position3D.ReadXml(System.Xml.XmlReader)">
- <summary>
- Generates an object from its XML representation.
- </summary>
- <param name="reader">The <see cref="T:System.Xml.XmlReader"/> stream from which the object is deserialized.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Position3D.Equals(DotSpatial.Positioning.Position3D)">
- <summary>
- Compares the current instance to the specified position.
- </summary>
- <param name="other">A <strong>Position</strong> object to compare with.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the values are identical.</returns>
- <remarks>The two objects are compared at up to four digits of precision.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Position3D.Equals(DotSpatial.Positioning.Position3D,System.Int32)">
- <summary>
- Compares the current instance to the specified position using the specified numeric precision.
- </summary>
- <param name="other">A <strong>Position</strong> object to compare with.</param>
- <param name="decimals">An <strong>Integer</strong> specifying the number of fractional digits to compare.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the values are identical.</returns>
- <remarks>This method is typically used when positions do not mark the same location unless they are
- extremely close to one another. Conversely, a low or even negative value for <strong>Precision</strong>
- allows positions to be considered equal even when they do not precisely match.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Position3D.ToString(System.String,System.IFormatProvider)">
- <summary>
- Outputs the current instance as a string using the specified format and culture information.
- </summary>
- <param name="format">The format to use.-or- A null reference (Nothing in Visual Basic) to use the default format defined for the type of the <see cref="T:System.IFormattable"/> implementation.</param>
- <param name="formatProvider">The provider to use to format the value.-or- A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.</param>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position3D.TranslateTo(DotSpatial.Positioning.Azimuth,DotSpatial.Positioning.Distance,DotSpatial.Positioning.Ellipsoid)">
- <summary>
- Returns a coordinate which has been shifted the specified bearing and distance.
- </summary>
- <param name="bearing">The bearing.</param>
- <param name="distance">The distance.</param>
- <param name="ellipsoid">The ellipsoid.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Position3D.Clone">
- <summary>
- Clones this instance.
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Positioning.Position3D.Altitude">
- <summary>
- Returns the location's distance above sea level.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Position3D.Latitude">
- <summary>
- Gets the latitude.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Position3D.Longitude">
- <summary>
- Gets the longitude.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Position3D.IsEmpty">
- <summary>
- Returns whether the latitude, longitude and altitude are zero.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.Radian">
- <summary>
- Represents a unit of angular measurement used during trigonometric
- equations.
- </summary>
- <remarks><para>A radian is a unit of measure of an angle formed by an arc whose length is
- the same as the circle's radius, making a shape similar to a slice of pizza.
- Radians are typically used during trigonometric calculations such as calculating
- the distance between two points on Earth's curved surface.</para>
- <para>Instances of this class are guaranteed to be thread-safe because the class is
- immutable (its properties can only be changed during constructors).</para></remarks>
- </member>
- <member name="F:DotSpatial.Positioning.Radian.RADIANS_PER_DEGREE">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Radian.DEGREES_PER_RADIAN">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Radian._value">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Radian.Empty">
- <summary>
- Represents a radian with a value of zero.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.#ctor(System.Double)">
- <summary>
- Creates a new instance with the specified value.
- </summary>
- <param name="value">The value.</param>
- <remarks>this constructor is typically used to initialize an instance when the radian
- value is already known.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.#ctor(System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.Radian"/> struct.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.Radian"/> struct.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.#ctor(System.String,System.Globalization.CultureInfo)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.Radian"/> struct.
- </summary>
- <param name="value">The value.</param>
- <param name="culture">The culture.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.#ctor(System.Xml.XmlReader)">
- <summary>
- Creates a new instance by deserializing the specified XML.
- </summary>
- <param name="reader">The reader.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.Cosine">
- <summary>
- Returns the cosine of the current instance.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.Sine">
- <summary>
- Sines this instance.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.Tangent">
- <summary>
- Tangents this instance.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.SquareRoot">
- <summary>
- Squares the root.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.AbsoluteValue">
- <summary>
- Returns the absolute value of the current instance.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.ArcCosine">
- <summary>
- Returns the arccosine of the current instance.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.ArcSine">
- <summary>
- Returns the arcsine of the current instance.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.ArcTangent">
- <summary>
- Returns the arctangent of the current instance.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.Logarithm(System.Double)">
- <summary>
- Logarithms the specified new base.
- </summary>
- <param name="newBase">The new base.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.LogarithmBase10">
- <summary>
- Logarithms the base10.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.ToDegrees">
- <summary>
- Converts the current instance into an <strong>Angle</strong> object.
- </summary>
- <returns>An <strong>Angle</strong> object.</returns>
- <remarks>This method is typically used to convert a radian measurement back to latitude or
- longitude after a trigonometric formula has completed.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.ToAngle">
- <summary>
- Converts the current instance into an <strong>Angle</strong> object.
- </summary>
- <returns>An <strong>Angle</strong> object.</returns>
- <remarks>This method is typically used to convert a radian measurement back to latitude or
- longitude after a trigonometric formula has completed.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.ToLatitude">
- <summary>
- Converts the current instance to a latitude.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.ToLongitude">
- <summary>
- Converts the current instance to a longitude.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.ToString(System.String)">
- <summary>
- Outputs the speed measurement as a formatted string using the specified
- format.
- </summary>
- <param name="format">The format.</param>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
- </summary>
- <param name="obj">Another object to compare to.</param>
- <returns><c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.GetHashCode">
- <summary>
- Returns the unique code for this instance used in hash tables.
- </summary>
- <returns>A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.FromDegrees(System.Double)">
- <summary>
- Converts the specified value in degrees into radians.
- </summary>
- <param name="value">A <strong>Double</strong> containing the value to convert.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.FromAngle(DotSpatial.Positioning.Angle)">
- <summary>
- Converts the specified value in degrees into radians.
- </summary>
- <param name="value">An <strong>Angle</strong> containing the value to convert.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.ToDegrees(System.Double)">
- <summary>
- Converts the specified value from radians to degrees.
- </summary>
- <param name="radians">The radians.</param>
- <returns>A <strong>Double</strong> measuring degrees.</returns>
- <remarks>This method is typically used to convert a radian measurement back to latitude or
- longitude after a trigonometric formula has completed.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.ToAngle(DotSpatial.Positioning.Radian)">
- <summary>
- Converts a Radian object into decimal degrees.
- </summary>
- <param name="value">A <strong>Radian</strong> object to convert to an <strong>Angle</strong>.</param>
- <returns>An <strong>Angle</strong> object containing the converted value.</returns>
- <remarks>This method is typically used for trigonometric functions which work with values expressed as radians. Then the formula has completed, results are converted from radians to decimal degrees to make them easier to use.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.Parse(System.String)">
- <summary>
- Parses the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.Parse(System.String,System.Globalization.CultureInfo)">
- <summary>
- Parses the specified value.
- </summary>
- <param name="value">The value.</param>
- <param name="culture">The culture.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.op_Addition(DotSpatial.Positioning.Radian,DotSpatial.Positioning.Radian)">
- <summary>
- Implements the operator +.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.op_Subtraction(DotSpatial.Positioning.Radian,DotSpatial.Positioning.Radian)">
- <summary>
- Implements the operator -.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.op_Multiply(DotSpatial.Positioning.Radian,DotSpatial.Positioning.Radian)">
- <summary>
- Implements the operator *.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.op_Division(DotSpatial.Positioning.Radian,DotSpatial.Positioning.Radian)">
- <summary>
- Implements the operator /.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.op_LessThan(DotSpatial.Positioning.Radian,DotSpatial.Positioning.Radian)">
- <summary>
- Implements the operator <.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.op_LessThanOrEqual(DotSpatial.Positioning.Radian,DotSpatial.Positioning.Radian)">
- <summary>
- Implements the operator <=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.op_Equality(DotSpatial.Positioning.Radian,DotSpatial.Positioning.Radian)">
- <summary>
- Implements the operator ==.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.op_Inequality(DotSpatial.Positioning.Radian,DotSpatial.Positioning.Radian)">
- <summary>
- Implements the operator !=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.op_GreaterThanOrEqual(DotSpatial.Positioning.Radian,DotSpatial.Positioning.Radian)">
- <summary>
- Implements the operator >=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.op_GreaterThan(DotSpatial.Positioning.Radian,DotSpatial.Positioning.Radian)">
- <summary>
- Implements the operator >.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.op_Addition(DotSpatial.Positioning.Radian,System.Double)">
- <summary>
- Implements the operator +.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.op_Subtraction(DotSpatial.Positioning.Radian,System.Double)">
- <summary>
- Implements the operator -.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.op_Multiply(DotSpatial.Positioning.Radian,System.Double)">
- <summary>
- Implements the operator *.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.op_Division(DotSpatial.Positioning.Radian,System.Double)">
- <summary>
- Implements the operator /.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.op_LessThan(DotSpatial.Positioning.Radian,System.Double)">
- <summary>
- Implements the operator <.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.op_LessThanOrEqual(DotSpatial.Positioning.Radian,System.Double)">
- <summary>
- Implements the operator <=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.op_Equality(DotSpatial.Positioning.Radian,System.Double)">
- <summary>
- Implements the operator ==.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.op_Inequality(DotSpatial.Positioning.Radian,System.Double)">
- <summary>
- Implements the operator !=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.op_GreaterThanOrEqual(DotSpatial.Positioning.Radian,System.Double)">
- <summary>
- Implements the operator >=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.op_GreaterThan(DotSpatial.Positioning.Radian,System.Double)">
- <summary>
- Implements the operator >.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.Add(DotSpatial.Positioning.Radian)">
- <summary>
- Adds the current instance to the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.Add(System.Double)">
- <summary>
- Adds the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.Subtract(DotSpatial.Positioning.Radian)">
- <summary>
- Subtracts the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.Subtract(System.Double)">
- <summary>
- Subtracts the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.Multiply(DotSpatial.Positioning.Radian)">
- <summary>
- Multiplies the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.Multiply(System.Double)">
- <summary>
- Multiplies the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.Divide(DotSpatial.Positioning.Radian)">
- <summary>
- Returns the current value divided by the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.Divide(System.Double)">
- <summary>
- Divides the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.Increment">
- <summary>
- Increments this instance.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.Decrement">
- <summary>
- Returns the current value decreased by one.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.IsLessThan(DotSpatial.Positioning.Radian)">
- <summary>
- Determines whether [is less than] [the specified value].
- </summary>
- <param name="value">The value.</param>
- <returns><c>true</c> if [is less than] [the specified value]; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.IsLessThan(System.Double)">
- <summary>
- Determines whether [is less than] [the specified value].
- </summary>
- <param name="value">The value.</param>
- <returns><c>true</c> if [is less than] [the specified value]; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.IsLessThanOrEqualTo(DotSpatial.Positioning.Radian)">
- <summary>
- Determines whether [is less than or equal to] [the specified value].
- </summary>
- <param name="value">The value.</param>
- <returns><c>true</c> if [is less than or equal to] [the specified value]; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.IsLessThanOrEqualTo(System.Double)">
- <summary>
- Determines whether [is less than or equal to] [the specified value].
- </summary>
- <param name="value">The value.</param>
- <returns><c>true</c> if [is less than or equal to] [the specified value]; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.IsGreaterThan(DotSpatial.Positioning.Radian)">
- <summary>
- Determines whether [is greater than] [the specified value].
- </summary>
- <param name="value">The value.</param>
- <returns><c>true</c> if [is greater than] [the specified value]; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.IsGreaterThan(System.Double)">
- <summary>
- Determines whether [is greater than] [the specified value].
- </summary>
- <param name="value">The value.</param>
- <returns><c>true</c> if [is greater than] [the specified value]; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.IsGreaterThanOrEqualTo(DotSpatial.Positioning.Radian)">
- <summary>
- Determines whether [is greater than or equal to] [the specified value].
- </summary>
- <param name="value">The value.</param>
- <returns><c>true</c> if [is greater than or equal to] [the specified value]; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.IsGreaterThanOrEqualTo(System.Double)">
- <summary>
- Determines whether [is greater than or equal to] [the specified value].
- </summary>
- <param name="value">The value.</param>
- <returns><c>true</c> if [is greater than or equal to] [the specified value]; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.op_Explicit(DotSpatial.Positioning.Radian)~System.Double">
- <summary>
- Performs an explicit conversion from <see cref="T:DotSpatial.Positioning.Radian"/> to <see cref="T:System.Double"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.op_Explicit(DotSpatial.Positioning.Longitude)~DotSpatial.Positioning.Radian">
- <summary>
- Performs an explicit conversion from <see cref="T:DotSpatial.Positioning.Longitude"/> to <see cref="T:DotSpatial.Positioning.Radian"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.op_Explicit(DotSpatial.Positioning.Latitude)~DotSpatial.Positioning.Radian">
- <summary>
- Performs an explicit conversion from <see cref="T:DotSpatial.Positioning.Latitude"/> to <see cref="T:DotSpatial.Positioning.Radian"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.op_Explicit(DotSpatial.Positioning.Azimuth)~DotSpatial.Positioning.Radian">
- <summary>
- Performs an explicit conversion from <see cref="T:DotSpatial.Positioning.Azimuth"/> to <see cref="T:DotSpatial.Positioning.Radian"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.op_Explicit(DotSpatial.Positioning.Angle)~DotSpatial.Positioning.Radian">
- <summary>
- Performs an explicit conversion from <see cref="T:DotSpatial.Positioning.Angle"/> to <see cref="T:DotSpatial.Positioning.Radian"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.op_Explicit(System.Double)~DotSpatial.Positioning.Radian">
- <summary>
- Performs an explicit conversion from <see cref="T:System.Double"/> to <see cref="T:DotSpatial.Positioning.Radian"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.op_Explicit(System.String)~DotSpatial.Positioning.Radian">
- <summary>
- Performs an explicit conversion from <see cref="T:System.String"/> to <see cref="T:DotSpatial.Positioning.Radian"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.Equals(DotSpatial.Positioning.Radian)">
- <summary>
- Equalses the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.Equals(DotSpatial.Positioning.Radian,System.Int32)">
- <summary>
- Equalses the specified value.
- </summary>
- <param name="value">The value.</param>
- <param name="decimals">The decimals.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.CompareTo(DotSpatial.Positioning.Radian)">
- <summary>
- Compares the current instance with the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.ToString(System.String,System.IFormatProvider)">
- <summary>
- Outputs the speed measurement as a formatted string using the specified format
- and culture information.
- </summary>
- <param name="format">The format to use.-or- A null reference (Nothing in Visual Basic) to use the default format defined for the type of the <see cref="T:System.IFormattable"/> implementation.</param>
- <param name="formatProvider">The provider to use to format the value.-or- A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.</param>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.System#Xml#Serialization#IXmlSerializable#GetSchema">
- <summary>
- This method is reserved and should not be used. When implementing the IXmlSerializable interface, you should return null (Nothing in Visual Basic) from this method, and instead, if specifying a custom schema is required, apply the <see cref="T:System.Xml.Serialization.XmlSchemaProviderAttribute"/> to the class.
- </summary>
- <returns>An <see cref="T:System.Xml.Schema.XmlSchema"/> that describes the XML representation of the object that is produced by the <see cref="M:System.Xml.Serialization.IXmlSerializable.WriteXml(System.Xml.XmlWriter)"/> method and consumed by the <see cref="M:System.Xml.Serialization.IXmlSerializable.ReadXml(System.Xml.XmlReader)"/> method.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.WriteXml(System.Xml.XmlWriter)">
- <summary>
- Converts an object into its XML representation.
- </summary>
- <param name="writer">The <see cref="T:System.Xml.XmlWriter"/> stream to which the object is serialized.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Radian.ReadXml(System.Xml.XmlReader)">
- <summary>
- Generates an object from its XML representation.
- </summary>
- <param name="reader">The <see cref="T:System.Xml.XmlReader"/> stream from which the object is deserialized.</param>
- </member>
- <member name="P:DotSpatial.Positioning.Radian.Value">
- <summary>
- Represents the numeric portion of a radian measurement.
- </summary>
- <value>A <strong>Double</strong> value indicating an angular measurement expressed in
- radians.</value>
- <remarks>This property stores the numeric radian measurement. A radian can be converted into a degree
- measurements via the <see cref="M:DotSpatial.Positioning.Radian.ToAngle(DotSpatial.Positioning.Radian)">ToAngle</see> method.</remarks>
- </member>
- <member name="T:DotSpatial.Positioning.Segment">
- <summary>
- Represents a line connected by two points on Earth's surface.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Segment._start">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Segment._end">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Segment.Empty">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Segment.#ctor(DotSpatial.Positioning.Position,DotSpatial.Positioning.Position)">
- <summary>
- Creates a new instance using the specified end points.
- </summary>
- <param name="start">The start.</param>
- <param name="end">The end.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Segment.DistanceTo(DotSpatial.Positioning.Position)">
- <summary>
- Returns the distance from the segment to the specified position.
- </summary>
- <param name="position">The position.</param>
- <returns></returns>
- <remarks>This method analyzes the relative position of the segment to the line to determine the
- best mathematical approach.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Segment.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Segment.ToString(System.String,System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format to use.-or- A null reference (Nothing in Visual Basic) to use the default format defined for the type of the <see cref="T:System.IFormattable"/> implementation.</param>
- <param name="formatProvider">The provider to use to format the value.-or- A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.</param>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="P:DotSpatial.Positioning.Segment.Distance">
- <summary>
- Returns the distance from the starting point to the end point.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Segment.Bearing">
- <summary>
- Returns the bearing from the start to the end of the line.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Segment.Start">
- <summary>
- Returns the starting point of the segment.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Segment.End">
- <summary>
- Returns the end point of the segment.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Segment.Midpoint">
- <summary>
- Returns the location halfway from the start to the end point.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.SizeD">
- <summary>
- Represents a highly-precise two-dimensional size.
- </summary>
- <remarks><para>This structure is a <em>DotSpatial.Positioning</em> "parseable type" whose value can
- be freely converted to and from <strong>String</strong> objects via the
- <strong>ToString</strong> and <strong>Parse</strong> methods.</para>
- <para>Instances of this structure are guaranteed to be thread-safe because it is
- immutable (its properties can only be modified via constructors).</para></remarks>
- </member>
- <member name="F:DotSpatial.Positioning.SizeD._width">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.SizeD._height">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.SizeD.Empty">
- <summary>
- Represents a size with no value.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.SizeD.Infinity">
- <summary>
- Represents an infinite size.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.SizeD.Minimum">
- <summary>
- Represents the smallest possible size.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.SizeD.Maximum">
- <summary>
- Represents the largest possible size.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.SizeD.#ctor(DotSpatial.Positioning.PointD)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.SizeD"/> struct.
- </summary>
- <param name="pt">The pt.</param>
- </member>
- <member name="M:DotSpatial.Positioning.SizeD.#ctor(DotSpatial.Positioning.SizeD)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.SizeD"/> struct.
- </summary>
- <param name="size">The size.</param>
- </member>
- <member name="M:DotSpatial.Positioning.SizeD.#ctor(System.Double,System.Double)">
- <summary>
- Creates a new instance.
- </summary>
- <param name="width">The width.</param>
- <param name="height">The height.</param>
- </member>
- <member name="M:DotSpatial.Positioning.SizeD.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.SizeD"/> struct.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:DotSpatial.Positioning.SizeD.#ctor(System.String,System.Globalization.CultureInfo)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.SizeD"/> struct.
- </summary>
- <param name="value">The value.</param>
- <param name="culture">The culture.</param>
- </member>
- <member name="M:DotSpatial.Positioning.SizeD.#ctor(System.Xml.XmlReader)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.SizeD"/> struct.
- </summary>
- <param name="reader">The reader.</param>
- </member>
- <member name="M:DotSpatial.Positioning.SizeD.ToAspectRatio(DotSpatial.Positioning.SizeD)">
- <summary>
- Toes the aspect ratio.
- </summary>
- <param name="size">The size.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.SizeD.ToAspectRatio(System.Double)">
- <summary>
- Toes the aspect ratio.
- </summary>
- <param name="aspectRatio">The aspect ratio.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.SizeD.Clone">
- <summary>
- Returns a copy of the current instance.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.SizeD.ToString(System.String)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format.</param>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.SizeD.Equals(System.Object)">
- <summary>
- Compares the current instance to the specified object.
- </summary>
- <param name="obj">An <strong>Object</strong> to compare with.</param>
- <returns>A <strong>Boolean</strong>, True if the values are equivalent.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.SizeD.GetHashCode">
- <summary>
- Returns a hash code for this instance.
- </summary>
- <returns>A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.SizeD.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.SizeD.Parse(System.String)">
- <summary>
- Parses the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.SizeD.Parse(System.String,System.Globalization.CultureInfo)">
- <summary>
- Parses the specified value.
- </summary>
- <param name="value">The value.</param>
- <param name="culture">The culture.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.SizeD.op_Equality(DotSpatial.Positioning.SizeD,DotSpatial.Positioning.SizeD)">
- <summary>
- Implements the operator ==.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.SizeD.op_Inequality(DotSpatial.Positioning.SizeD,DotSpatial.Positioning.SizeD)">
- <summary>
- Implements the operator !=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.SizeD.op_Addition(DotSpatial.Positioning.SizeD,DotSpatial.Positioning.SizeD)">
- <summary>
- Implements the operator +.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.SizeD.op_Subtraction(DotSpatial.Positioning.SizeD,DotSpatial.Positioning.SizeD)">
- <summary>
- Implements the operator -.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.SizeD.op_Multiply(DotSpatial.Positioning.SizeD,DotSpatial.Positioning.SizeD)">
- <summary>
- Implements the operator *.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.SizeD.op_Division(DotSpatial.Positioning.SizeD,DotSpatial.Positioning.SizeD)">
- <summary>
- Implements the operator /.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.SizeD.Add(DotSpatial.Positioning.SizeD)">
- <summary>
- Returns the sum of the current instance with the specified size.
- </summary>
- <param name="size">The size.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.SizeD.Subtract(DotSpatial.Positioning.SizeD)">
- <summary>
- Returns the current instance decreased by the specified value.
- </summary>
- <param name="size">The size.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.SizeD.Multiply(DotSpatial.Positioning.SizeD)">
- <summary>
- Returns the product of the current instance with the specified value.
- </summary>
- <param name="size">The size.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.SizeD.Divide(DotSpatial.Positioning.SizeD)">
- <summary>
- Returns the current instance divided by the specified value.
- </summary>
- <param name="size">The size.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.SizeD.Equals(DotSpatial.Positioning.SizeD)">
- <summary>
- Compares the current instance to the specified object.
- </summary>
- <param name="other">A <strong>SizeD</strong> object to compare with.</param>
- <returns>A <strong>Boolean</strong>, True if the values are equivalent.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.SizeD.ToString(System.String,System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format to use.-or- A null reference (Nothing in Visual Basic) to use the default format defined for the type of the <see cref="T:System.IFormattable"/> implementation.</param>
- <param name="formatProvider">The provider to use to format the value.-or- A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.</param>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.SizeD.System#Xml#Serialization#IXmlSerializable#GetSchema">
- <summary>
- This method is reserved and should not be used. When implementing the IXmlSerializable interface, you should return null (Nothing in Visual Basic) from this method, and instead, if specifying a custom schema is required, apply the <see cref="T:System.Xml.Serialization.XmlSchemaProviderAttribute"/> to the class.
- </summary>
- <returns>An <see cref="T:System.Xml.Schema.XmlSchema"/> that describes the XML representation of the object that is produced by the <see cref="M:System.Xml.Serialization.IXmlSerializable.WriteXml(System.Xml.XmlWriter)"/> method and consumed by the <see cref="M:System.Xml.Serialization.IXmlSerializable.ReadXml(System.Xml.XmlReader)"/> method.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.SizeD.WriteXml(System.Xml.XmlWriter)">
- <summary>
- Converts an object into its XML representation.
- </summary>
- <param name="writer">The <see cref="T:System.Xml.XmlWriter"/> stream to which the object is serialized.</param>
- </member>
- <member name="M:DotSpatial.Positioning.SizeD.ReadXml(System.Xml.XmlReader)">
- <summary>
- Generates an object from its XML representation.
- </summary>
- <param name="reader">The <see cref="T:System.Xml.XmlReader"/> stream from which the object is deserialized.</param>
- </member>
- <member name="P:DotSpatial.Positioning.SizeD.Width">
- <summary>
- Returns the horizontal size.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.SizeD.Height">
- <summary>
- Returns the vertical size.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.SizeD.AspectRatio">
- <summary>
- Returns the ratio width to height.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.SizeD.IsEmpty">
- <summary>
- Indicates if the instance has any value.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.Speed">
- <summary>
- Represents a measurement of an object's rate of travel.
- </summary>
- <remarks><para>This structure is used to measure the rate at which something moves in a
- given period of time. This structure supports several different unit types in both
- Imperial and Metric measurement systems. A speed is measured in two parts: a
- numeric value and a label indicating the units of measurement.</para>
- <para>Speed measurements can be converted to their equivalent values in other unit
- types through the use of several conversion methods such as ToMetersPerSecond,
- <strong>ToFeetPerSecond</strong>, <strong>ToKilometersPerHour</strong>, and others.
- Three methods, <strong>ToImperialUnitType</strong>,
- <strong>ToMetricUnitType</strong> and <strong>ToLocalUnitType</strong> also exist
- for converting a speed measurement to the most readable unit type (i.e. 1 meter vs.
- 0.0001 kilometers) in any local culture.</para>
- <para>This structure is a <em>DotSpatial.Positioning</em> "parseable type" whose value can
- be freely converted to and from <strong>String</strong> objects via the
- <strong>ToString</strong> and <strong>Parse</strong> methods.</para>
- <para>Instances of this structure are guaranteed to be thread-safe because it is
- immutable (its properties can only be modified via constructors).</para></remarks>
- </member>
- <member name="F:DotSpatial.Positioning.Speed.STATUTE_MPH_PER_KNOT">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Speed.KPH_PER_KNOT">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Speed.FPS_PER_KNOT">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Speed.MPS_PER_KNOT">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Speed.KPS_PER_KNOT">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Speed.KNOTS_PER_STATUTE_MPH">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Speed.KPH_PER_STATUTE_MPH">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Speed.FPS_PER_STATUTE_MPH">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Speed.MPS_PER_STATUTE_MPH">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Speed.KPS_PER_STATUTE_MPH">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Speed.KNOTS_PER_KPH">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Speed.STATUTE_MPH_PER_KPH">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Speed.FPS_PER_KPH">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Speed.MPS_PER_KPH">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Speed.KPS_PER_KPH">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Speed.KNOTS_PER_KPS">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Speed.STATUTE_MPH_PER_KPS">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Speed.FPS_PER_KPS">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Speed.MPS_PER_KPS">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Speed.KPH_PER_KPS">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Speed.KNOTS_PER_FPS">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Speed.STATUTE_MPH_PER_FPS">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Speed.KPH_PER_FPS">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Speed.MPS_PER_FPS">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Speed.KPS_PER_FPS">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Speed.KNOTS_PER_MPS">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Speed.STATUTE_MPH_PER_MPS">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Speed.FPS_PER_MPS">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Speed.KPH_PER_MPS">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Speed.KPS_PER_MPS">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Speed._value">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Speed._units">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Speed.Empty">
- <summary>
- Represents a speed of zero.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Speed.AtRest">
- <summary>
- Represents a speed of zero.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Speed.SpeedOfLight">
- <summary>
- Returns the rate of travel of light in a vacuum.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Speed.Maximum">
- <summary>
- Represents the largest possible speed.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Speed.Minimum">
- <summary>
- Represents the smallest possible speed.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Speed.SpeedOfSoundAtSeaLevel">
- <summary>
- Returns the rate of travel of sound waves at sea level.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Speed.Infinity">
- <summary>
- Represents an infinite speed.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Speed.Invalid">
- <summary>
- Represents an invalid or unspecified value.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.#ctor(System.Double,DotSpatial.Positioning.SpeedUnit)">
- <summary>
- Creates a new instance using the specified value and unit type.
- </summary>
- <param name="value">The value.</param>
- <param name="units">The units.</param>
- <remarks>This is the most frequently used constructor of the speed class.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.Speed"/> struct.
- </summary>
- <param name="value">The value.</param>
- <remarks>This powerful method is designed to simplify the process of parsing values read
- from a data store or typed in by the user.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.#ctor(System.String,System.Globalization.CultureInfo)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.Speed"/> struct.
- </summary>
- <param name="value">The value.</param>
- <param name="culture">The culture.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.#ctor(System.Xml.XmlReader)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Positioning.Speed"/> struct.
- </summary>
- <param name="reader">The reader.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.Clone">
- <summary>
- Returns a copy of the current instance.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.Round(System.Int32)">
- <summary>
- Returns a new instance rounded to the specified number of digits.
- </summary>
- <param name="decimals">An <strong>Integer</strong> specifying the number of digits to round off to.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.ToFeetPerSecond">
- <summary>
- Returns the current instance converted to feet per second.
- </summary>
- <returns></returns>
- <remarks>The measurement is converted regardless of its current unit type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.ToKilometersPerHour">
- <summary>
- Converts the current measurement into kilometers per hour.
- </summary>
- <returns></returns>
- <remarks>The measurement is converted regardless of its current unit type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.ToKilometersPerSecond">
- <summary>
- Converts the current measurement into kilometers per second.
- </summary>
- <returns></returns>
- <remarks>The measurement is converted regardless of its current unit type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.ToKnots">
- <summary>
- Returns the current instance converted to knots.
- </summary>
- <returns></returns>
- <remarks>The measurement is converted regardless of its current unit type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.ToMetersPerSecond">
- <summary>
- Returns the current instance converted to meters per second.
- </summary>
- <returns></returns>
- <remarks>The measurement is converted regardless of its current unit type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.ToStatuteMilesPerHour">
- <summary>
- Returns the current instance converted to miles per hours (MPH).
- </summary>
- <returns></returns>
- <remarks>The measurement is converted regardless of its current unit type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.ToUnitType(DotSpatial.Positioning.SpeedUnit)">
- <summary>
- Returns the current instance converted to the specified unit type.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.ToImperialUnitType">
- <summary>
- Returns the current instance converted to the most readable Imperial unit
- type.
- </summary>
- <returns>A <strong>Speed</strong> converted to the chosen unit type.</returns>
- <remarks>When a Speed becomes smaller, it may make more sense to the
- user to be expressed in a smaller unit type. For example, a Speed of
- 0.001 kilometers might be better expressed as 1 meter. This method will
- determine the smallest Imperial unit type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.ToMetricUnitType">
- <summary>
- Returns the current instance converted to the most readable Metric unit
- type.
- </summary>
- <returns>A <strong>Speed</strong> converted to the chosen unit type.</returns>
- <remarks>When a Speed becomes smaller, it may make more sense to the
- user to be expressed in a smaller unit type. For example, a Speed of
- 0.001 kilometers per second might be better expressed as 1 meter per second. This method will
- determine the smallest metric unit type.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.ToLocalUnitType">
- <summary>
- Returns the current instance converted to the most readable Imperial or Metric
- unit type depending on the local culture.
- </summary>
- <returns>A <strong>Speed</strong> converted to the chosen unit type.</returns>
- <remarks>When a Speed becomes smaller, it may make more sense to the
- user to be expressed in a smaller unit type. For example, a Speed of
- 0.001 kilometers might be better expressed as 1 meter. This method will
- find the smallest unit type and convert the unit to the user's local
- numeric system (Imperial or Metric).</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.ToString(System.String)">
- <summary>
- Outputs the speed measurement as a formatted string using the specified
- format.
- </summary>
- <param name="format">The format.</param>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.ToDistance(System.TimeSpan)">
- <summary>
- Returns the total distance traveled at the current speed for the specified
- time.
- </summary>
- <param name="time">The time.</param>
- <returns>A <strong>Distance</strong> representing the distance travelled at
- the current speed for the specified length of time.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.Equals(System.Object)">
- <summary>
- Compares the current instance to the specified arbitrary value.
- </summary>
- <param name="obj">An <strong>Object</strong> representing a value to compare.</param>
- <returns>A <strong>Boolean</strong>, <strong>True</strong> if the values are equivalent.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.GetHashCode">
- <summary>
- Returns a unique code for the current instance used in hash tables.
- </summary>
- <returns>A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.ToString">
- <summary>
- Outputs the speed measurement as a formatted string.
- </summary>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.Parse(System.String)">
- <summary>
- Creates a speed measurement based on a string value.
- </summary>
- <param name="value"><para>A <strong>String</strong> in any of the following formats (or variation
- depending on the local culture):</para>
- <para>
- <table cellspacing="0" cols="4" cellpadding="2" width="100%">
- <tbody>
- <tr>
- <td>vu</td>
- <td>vv.vu</td>
- <td>v u</td>
- </tr>
- </tbody>
- </table>
- </para>
- <para>where <strong>vv.v</strong> is a decimal value and <strong>u</strong> is a
- unit type made from words in the following list:</para>
- <para>
- <table cellspacing="0" cols="3" cellpadding="2" width="100%">
- <tbody>
- <tr>
- <td>FEET</td>
- <td>FOOT</td>
- <td>METER</td>
- </tr>
- <tr>
- <td>METERS</td>
- <td>METRE</td>
- <td>METRES</td>
- </tr>
- <tr>
- <td>KILOMETER</td>
- <td>KILOMETRE</td>
- <td>KILOMETERS</td>
- </tr>
- <tr>
- <td>KILOMETRES</td>
- <td>KNOT</td>
- <td>KNOTS</td>
- </tr>
- <tr>
- <td>MILE</td>
- <td>MILES</td>
- <td>STATUTE MILE</td>
- </tr>
- <tr>
- <td>STATUTE MILES</td>
- <td>F</td>
- <td>FT</td>
- </tr>
- <tr>
- <td>M</td>
- <td>KM</td>
- <td>K</td>
- </tr>
- <tr>
- <td>PER</td>
- <td>-PER-</td>
- <td>/</td>
- </tr>
- <tr>
- <td>SECOND</td>
- <td>SEC</td>
- <td>S</td>
- </tr>
- <tr>
- <td>HOUR</td>
- <td>HR</td>
- <td>H</td>
- </tr>
- </tbody>
- </table>
- </para>
- <para>For example, "12 miles per hour" is acceptable because the words "miles,"
- "per," and "hour" are found in the above list. Some combinations are not supported,
- such as "feet/hour." The word combination should look similar to a value from the
- <see cref="T:DotSpatial.Positioning.SpeedUnit">SpeedUnit</see> enumeration.</para></param>
- <returns>A new <strong>Speed</strong> object with the specified value and
- units.</returns>
- <remarks>This powerful method simplifies the process of processing values read from a data
- store or entered via the user. This method even supports some natural language
- processing ability by understanding words (see list above). This method can parse any
- value created via the ToString method.</remarks>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.Parse(System.String,System.Globalization.CultureInfo)">
- <summary>
- Parses the specified value.
- </summary>
- <param name="value">The value.</param>
- <param name="culture">The culture.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.FromKnots(System.Double)">
- <summary>
- Froms the knots.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.FromStatuteMilesPerHour(System.Double)">
- <summary>
- Froms the statute miles per hour.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.FromKilometersPerHour(System.Double)">
- <summary>
- Froms the kilometers per hour.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.FromKilometersPerSecond(System.Double)">
- <summary>
- Froms the kilometers per second.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.FromFeetPerSecond(System.Double)">
- <summary>
- Froms the feet per second.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.FromMetersPerSecond(System.Double)">
- <summary>
- Froms the meters per second.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.ParseSpeedUnit(System.String)">
- <summary>
- Parses the speed unit.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.Random">
- <summary>
- Returns a random distance between 0 and 200 kilometers per hour.
- </summary>
- <returns>A <strong>Distance</strong> containing a random value, converted to local units.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.Random(System.Random)">
- <summary>
- Returns a random distance between 0 and 200 kilometers per hour.
- </summary>
- <param name="generator">A <strong>Random</strong> object used to generate random values.</param>
- <returns>A <strong>Distance</strong> containing a random value, converted to local units.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.op_Addition(DotSpatial.Positioning.Speed,DotSpatial.Positioning.Speed)">
- <summary>
- Implements the operator +.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.op_Subtraction(DotSpatial.Positioning.Speed,DotSpatial.Positioning.Speed)">
- <summary>
- Implements the operator -.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.op_Multiply(DotSpatial.Positioning.Speed,DotSpatial.Positioning.Speed)">
- <summary>
- Implements the operator *.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.op_Division(DotSpatial.Positioning.Speed,DotSpatial.Positioning.Speed)">
- <summary>
- Implements the operator /.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.op_LessThan(DotSpatial.Positioning.Speed,DotSpatial.Positioning.Speed)">
- <summary>
- Implements the operator <.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.op_LessThanOrEqual(DotSpatial.Positioning.Speed,DotSpatial.Positioning.Speed)">
- <summary>
- Implements the operator <=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.op_Equality(DotSpatial.Positioning.Speed,DotSpatial.Positioning.Speed)">
- <summary>
- Implements the operator ==.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.op_Inequality(DotSpatial.Positioning.Speed,DotSpatial.Positioning.Speed)">
- <summary>
- Implements the operator !=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.op_GreaterThanOrEqual(DotSpatial.Positioning.Speed,DotSpatial.Positioning.Speed)">
- <summary>
- Implements the operator >=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.op_GreaterThan(DotSpatial.Positioning.Speed,DotSpatial.Positioning.Speed)">
- <summary>
- Implements the operator >.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.Add(DotSpatial.Positioning.Speed)">
- <summary>
- Adds the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.Add(System.Double)">
- <summary>
- Adds the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.Subtract(DotSpatial.Positioning.Speed)">
- <summary>
- Subtracts the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.Subtract(System.Double)">
- <summary>
- Subtracts the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.Multiply(DotSpatial.Positioning.Speed)">
- <summary>
- Multiplies the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.Multiply(System.Double)">
- <summary>
- Multiplies the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.Divide(DotSpatial.Positioning.Speed)">
- <summary>
- Divides the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.Divide(System.Double)">
- <summary>
- Divides the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.Increment">
- <summary>
- Returns the current instance increased by one.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.Decrement">
- <summary>
- Returns the current instance decreased by one.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.IsLessThan(DotSpatial.Positioning.Speed)">
- <summary>
- Indicates if the current instance is smaller than the specified speed.
- </summary>
- <param name="value">The value.</param>
- <returns><c>true</c> if [is less than] [the specified value]; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.IsLessThanOrEqualTo(DotSpatial.Positioning.Speed)">
- <summary>
- Indicates if the current instance is smaller or equivalent to than the specified
- speed.
- </summary>
- <param name="value">The value.</param>
- <returns><c>true</c> if [is less than or equal to] [the specified value]; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.IsGreaterThan(DotSpatial.Positioning.Speed)">
- <summary>
- Indicates if the current instance is larger than the specified speed.
- </summary>
- <param name="value">The value.</param>
- <returns><c>true</c> if [is greater than] [the specified value]; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.IsGreaterThanOrEqualTo(DotSpatial.Positioning.Speed)">
- <summary>
- Indicates if the current instance is larger or equivalent to than the specified
- speed.
- </summary>
- <param name="value">The value.</param>
- <returns><c>true</c> if [is greater than or equal to] [the specified value]; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.op_Explicit(System.String)~DotSpatial.Positioning.Speed">
- <summary>
- Performs an explicit conversion from <see cref="T:System.String"/> to <see cref="T:DotSpatial.Positioning.Speed"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.op_Explicit(DotSpatial.Positioning.Speed)~System.String">
- <summary>
- Performs an explicit conversion from <see cref="T:DotSpatial.Positioning.Speed"/> to <see cref="T:System.String"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.Equals(DotSpatial.Positioning.Speed)">
- <summary>
- Indicates whether the current object is equal to another object of the same type.
- </summary>
- <param name="other">An object to compare with this object.</param>
- <returns>true if the current object is equal to the <paramref name="other"/> parameter; otherwise, false.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.Equals(DotSpatial.Positioning.Speed,System.Int32)">
- <summary>
- Equalses the specified other.
- </summary>
- <param name="other">The other.</param>
- <param name="decimals">The decimals.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.CompareTo(DotSpatial.Positioning.Speed)">
- <summary>
- Compares the current instance to the specified speed.
- </summary>
- <param name="other">An object to compare with this object.</param>
- <returns>A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has the following meanings:
- Value
- Meaning
- Less than zero
- This object is less than the <paramref name="other"/> parameter.
- Zero
- This object is equal to <paramref name="other"/>.
- Greater than zero
- This object is greater than <paramref name="other"/>.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.ToString(System.String,System.IFormatProvider)">
- <summary>
- Outputs the speed measurement as a formatted string using the specified format
- and culture information.
- </summary>
- <param name="format">The format to use.-or- A null reference (Nothing in Visual Basic) to use the default format defined for the type of the <see cref="T:System.IFormattable"/> implementation.</param>
- <param name="formatProvider">The provider to use to format the value.-or- A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.</param>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.System#Xml#Serialization#IXmlSerializable#GetSchema">
- <summary>
- This method is reserved and should not be used. When implementing the IXmlSerializable interface, you should return null (Nothing in Visual Basic) from this method, and instead, if specifying a custom schema is required, apply the <see cref="T:System.Xml.Serialization.XmlSchemaProviderAttribute"/> to the class.
- </summary>
- <returns>An <see cref="T:System.Xml.Schema.XmlSchema"/> that describes the XML representation of the object that is produced by the <see cref="M:System.Xml.Serialization.IXmlSerializable.WriteXml(System.Xml.XmlWriter)"/> method and consumed by the <see cref="M:System.Xml.Serialization.IXmlSerializable.ReadXml(System.Xml.XmlReader)"/> method.</returns>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.WriteXml(System.Xml.XmlWriter)">
- <summary>
- Converts an object into its XML representation.
- </summary>
- <param name="writer">The <see cref="T:System.Xml.XmlWriter"/> stream to which the object is serialized.</param>
- </member>
- <member name="M:DotSpatial.Positioning.Speed.ReadXml(System.Xml.XmlReader)">
- <summary>
- Generates an object from its XML representation.
- </summary>
- <param name="reader">The <see cref="T:System.Xml.XmlReader"/> stream from which the object is deserialized.</param>
- </member>
- <member name="P:DotSpatial.Positioning.Speed.Value">
- <summary>
- Returns the numeric portion of the speed measurement.
- </summary>
- <remarks>This property is combined with the
- <see cref="P:DotSpatial.Positioning.Speed.Units">Units</see> property to form a complete
- speed measurement.</remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Speed.Units">
- <summary>
- Returns the units portion of the speed measurement.
- </summary>
- <value>A value from the <see cref="T:DotSpatial.Positioning.SpeedUnit">SpeedUnits</see> enumeration.</value>
- <remarks><para>Following proper scientific practices, speed measurements are always made
- using a value paired with a unit type. </para>
- <para><img src="BestPractice.jpg"/></para><para><strong>Always explicitly
- convert to a specific speed unit type before performing
- mathematics.</strong></para>
- <para>Since the Units property of the Speed class can be modified, it is not
- safe to assume that a speed measurement will always be of a certain unit type.
- Therefore, use a conversion method such as <see cref="M:DotSpatial.Positioning.Speed.ToKilometersPerHour">
- ToKilometersPerHour</see> or <see cref="M:DotSpatial.Positioning.Speed.ToStatuteMilesPerHour">
- ToStatuteMilesPerHour</see> to ensure that the speed is in the correct unit
- type before perfoming mathematics.</para></remarks>
- </member>
- <member name="P:DotSpatial.Positioning.Speed.IsEmpty">
- <summary>
- Indicates if the measurement is zero.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Speed.IsMetric">
- <summary>
- Indicates if the unit of measurement is a Metric unit type.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Speed.IsInfinity">
- <summary>
- Indicates if the measurement is infinite.
- </summary>
- </member>
- <member name="P:DotSpatial.Positioning.Speed.IsInvalid">
- <summary>
- Indicates if the current instance is invalid or unspecified.
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.SpeedUnit">
- <summary>
- Indicates the unit of measure for speed measurements.
- </summary>
- <seealso cref="P:DotSpatial.Positioning.Speed.Units">Units Property (Speed Class)</seealso>
-
- <seealso cref="T:DotSpatial.Positioning.Speed">Speed Class</seealso>
- <remarks>This enumeration is used by the
- <see cref="P:DotSpatial.Positioning.Speed.Units">Units</see> property of the
- <see cref="T:DotSpatial.Positioning.Speed">Speed</see>
- class in conjunction with the <see cref="P:DotSpatial.Positioning.Speed.Value">Value</see>
- property to describe a speed measurement.</remarks>
- </member>
- <member name="F:DotSpatial.Positioning.SpeedUnit.Knots">
- <summary>The number of nautical miles travelled in one hour.</summary>
- </member>
- <member name="F:DotSpatial.Positioning.SpeedUnit.StatuteMilesPerHour">
- <summary>The number of statute miles travelled in one hour, also known as MPH.</summary>
- </member>
- <member name="F:DotSpatial.Positioning.SpeedUnit.KilometersPerHour">
- <summary>The number of kilometers travelled in one hour, also known as KPH.</summary>
- </member>
- <member name="F:DotSpatial.Positioning.SpeedUnit.KilometersPerSecond">
- <summary>The number of kilometers travelled in one second, also known as
- KM/S.</summary>
- </member>
- <member name="F:DotSpatial.Positioning.SpeedUnit.FeetPerSecond">
- <summary>The number of feet travelled in one second, also known as FT/S.</summary>
- </member>
- <member name="F:DotSpatial.Positioning.SpeedUnit.MetersPerSecond">
- <summary>The number of meters travelled in one hour, also known as M/S.</summary>
- </member>
- <member name="T:DotSpatial.Positioning.StaticFinalizer">
- <summary>
- Serves as a notification to dispose of static objects.
- </summary>
- <example lang="cs">
- private static StaticFinalizer MyStaticFinalizer = new StaticFinalizer();
- private static Brush UnmanagedResource = new SolidBrush(Color.Blue);
- void Constructor()
- {
- MyStaticFinalizer.Disposed += new EventHandler(StaticFinalize);
- }
- void StaticFinalize(object sender, EventArgs e)
- {
- UnmanagedResource.Dispose();
- }
- </example>
- <remarks>It is not uncommon for static variables to contain unmanaged resources. Yet,
- the .NET Garbage Collector does not allow for finalizers on static objects. The StaticFinalizer
- class serves to work around this problem. To use this class, declare an instance as a
- private, static variable. Then, hook into its Disposed event. The event will be raised
- during the StaticFinalizer's own finalizer, allowing you to safely dispose of static resources.</remarks>
- </member>
- <member name="F:DotSpatial.Positioning.StaticFinalizer.Current">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.StaticFinalizer.Finalize">
- <summary>
- Releases unmanaged resources and performs other cleanup operations before the <see cref="T:DotSpatial.Positioning.StaticFinalizer"/> is reclaimed by garbage collection.
- </summary>
- </member>
- <member name="E:DotSpatial.Positioning.StaticFinalizer.Disposed">
- <summary>
- Occurs when [disposed].
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.VirtualDevice">
- <summary>
- Represents a simulated GPS device.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.VirtualDevice._emulator">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.VirtualDevice.#ctor(DotSpatial.Positioning.Emulator)">
- <summary>
- Creates a new instance using the specified emulator.
- </summary>
- <param name="emulator">The emulator.</param>
- </member>
- <member name="M:DotSpatial.Positioning.VirtualDevice.OnCacheRemove">
- <summary>
- Overrides OnChaceRemove
- Since emulators don't qualify as detected devices, this
- method has no behavior.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.VirtualDevice.OnCacheWrite">
- <summary>
- Records information about this device to the registry.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.VirtualDevice.OnCacheRead">
- <summary>
- Reads information about this device from the registry.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.VirtualDevice.OpenStream(System.IO.FileAccess,System.IO.FileShare)">
- <summary>
- Creates a new Stream object for the device.
- </summary>
- <param name="access">The access.</param>
- <param name="sharing">The sharing.</param>
- <returns>A <strong>Stream</strong> object.</returns>
- </member>
- <member name="P:DotSpatial.Positioning.VirtualDevice.Name">
- <summary>
- Gets the Name of the Virtual Device
- </summary>
- </member>
- <member name="T:DotSpatial.Positioning.Xml">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Xml.GML_XML_NAMESPACE">
- <summary>
- Returns the XML namespace for GML documents.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Xml.GML_XML_PREFIX">
- <summary>
- Returns the prefix applied to all GML XML elements.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Xml.DOT_SPATIAL_POSITIONING_XML_NAMESPACE">
- <summary>
- Returns the XML namespace for DotSpatial.Positioning documents.
- </summary>
- </member>
- <member name="F:DotSpatial.Positioning.Xml.DOT_SPATIAL_POSITIONING_XML_PREFIX">
- <summary>
- Returns the prefix applied to all DotSpatial.Positioning XML elements.
- </summary>
- </member>
- <member name="M:DotSpatial.Positioning.Xml.Serialize``1(``0)">
- <summary>
- Used to test the <see cref="M:System.Xml.Serialization.IXmlSerializable.WriteXml(System.Xml.XmlWriter)"/> implementations of DotSpatial.Positioning types.
- </summary>
- <typeparam name="T"></typeparam>
- <param name="obj">The obj.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Positioning.Xml.Deserialize``1(System.String)">
- <summary>
- Used to test the <see cref="M:System.Xml.Serialization.IXmlSerializable.ReadXml(System.Xml.XmlReader)"/> implementations of DotSpatial.Positioning types.
- </summary>
- <typeparam name="T"></typeparam>
- <param name="xml">The XML.</param>
- <returns></returns>
- </member>
- </members>
-</doc>
diff --git a/MES_Wind/bin/Debug/DotSpatial.Projections.Forms.pdb b/MES_Wind/bin/Debug/DotSpatial.Projections.Forms.pdb
deleted file mode 100644
index 8eeefbf66a3e38a86c7e49455c3a1d4d1285ae00..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/DotSpatial.Projections.Forms.pdb and /dev/null differ
diff --git a/MES_Wind/bin/Debug/DotSpatial.Projections.Forms.xml b/MES_Wind/bin/Debug/DotSpatial.Projections.Forms.xml
deleted file mode 100644
index 46c9caeb962a34a46e1b5f5ae21bb688ee9ab962..0000000000000000000000000000000000000000
--- a/MES_Wind/bin/Debug/DotSpatial.Projections.Forms.xml
+++ /dev/null
@@ -1,349 +0,0 @@
-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>DotSpatial.Projections.Forms</name>
- </assembly>
- <members>
- <member name="T:DotSpatial.Projections.Forms.DoubleBox">
- <summary>
- A User control for entering double values into text boxes
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Forms.DoubleBox.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Forms.DoubleBox.#ctor">
- <summary>
- Creates a new instance of DoubleBox
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Forms.DoubleBox.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Forms.DoubleBox.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Projections.Forms.DoubleBox.OnTextChanged">
- <summary>
- Fires TextChanged
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Forms.DoubleBox.OnValidChanged">
- <summary>
- Fires ValidChanged
- </summary>
- </member>
- <member name="E:DotSpatial.Projections.Forms.DoubleBox.TextChanged">
- <summary>
- Occurs when the user changes values in the text box
- </summary>
- </member>
- <member name="E:DotSpatial.Projections.Forms.DoubleBox.ValidChanged">
- <summary>
- Occurs either when changing from valid to invalid or when
- changing from invalid to valid.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Forms.DoubleBox.BackColorRegular">
- <summary>
- Gets or sets the normal background color
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Forms.DoubleBox.BackColorInvalid">
- <summary>
- Gets or sets the invalid background color
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Forms.DoubleBox.Caption">
- <summary>
- Gets or sets the caption
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Forms.DoubleBox.NumberFormat">
- <summary>
- Gets or sets the string number format
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Forms.DoubleBox.InvalidHelp">
- <summary>
- Gets or sets teh tool tip text help when this
- item has an invalid entry.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Forms.DoubleBox.IsValid">
- <summary>
- Gets or sets a boolean indicating if the text in this box can be parsed
- into a double precision value.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Forms.DoubleBox.RegularHelp">
- <summary>
- Gets or sets the tool tip text for regular help
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Forms.DoubleBox.Text">
- <summary>
- Gets the raw text entered in the textbox
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Forms.DoubleBox.Value">
- <summary>
- Gets the currently entered double value.
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.Forms.ProjectionCustomDialog">
- <summary>
- ProjectionCustomDialog
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Forms.ProjectionCustomDialog.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Forms.ProjectionCustomDialog.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Forms.ProjectionCustomDialog.#ctor">
- <summary>
- Creates a new instance of CollectionPropertyGrid
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Forms.ProjectionCustomDialog.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Projections.Forms.ProjectionCustomDialog.OnApplyChanges">
- <summary>
- Fires the ChangesApplied event
- </summary>
- </member>
- <member name="E:DotSpatial.Projections.Forms.ProjectionCustomDialog.ChangesApplied">
- <summary>
- Occurs whenever the apply changes button is clicked, or else when the ok button is clicked.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Forms.ProjectionCustomDialog.SelectedProjectionInfo">
- <summary>
- gets or sets the selected projection info
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Forms.ProjectionSelectControl.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Forms.ProjectionSelectControl.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Projections.Forms.ProjectionSelectControl.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Forms.ProjectionSelectControl.SelectedCoordinateSystem">
- <summary>
- Gets or sets the currently chosen coordinate system
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.Forms.ProjectionSelectDialog">
- <summary>
- ProjectionSelectDialog
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Forms.ProjectionSelectDialog.#ctor">
- <summary>
- Creates a new instance of <see cref="T:DotSpatial.Projections.Forms.ProjectionSelectDialog"/>
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Forms.ProjectionSelectDialog.OnApplyChanges">
- <summary>
- Fires the ChangesApplied event
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Forms.ProjectionSelectDialog.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Forms.ProjectionSelectDialog.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Projections.Forms.ProjectionSelectDialog.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="E:DotSpatial.Projections.Forms.ProjectionSelectDialog.ChangesApplied">
- <summary>
- Occurs whenever the apply changes button is clicked, or else when the ok button is clicked.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Forms.ProjectionSelectDialog.SelectedCoordinateSystem">
- <summary>
- Gets or sets the currently chosen coordinate system
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.Forms.ProjectionStrings">
- <summary>
- A strongly-typed resource class, for looking up localized strings, etc.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Forms.ProjectionStrings.ResourceManager">
- <summary>
- Returns the cached ResourceManager instance used by this class.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Forms.ProjectionStrings.Culture">
- <summary>
- Overrides the current thread's CurrentUICulture property for all
- resource lookups using this strongly typed resource class.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Forms.ProjectionStrings.DoubleError">
- <summary>
- Looks up a localized string similar to The value entered could not be correctly parsed into a valid double precision floating point value..
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Forms.ProjectionStrings.DoubleHelp">
- <summary>
- Looks up a localized string similar to Enter a double precision floating point value..
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.Forms.Properties.Resources">
- <summary>
- A strongly-typed resource class, for looking up localized strings, etc.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Forms.Properties.Resources.ResourceManager">
- <summary>
- Returns the cached ResourceManager instance used by this class.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Forms.Properties.Resources.Culture">
- <summary>
- Overrides the current thread's CurrentUICulture property for all
- resource lookups using this strongly typed resource class.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Forms.Properties.Resources.Nothing">
- <summary>
- Looks up a localized string similar to [Nothing].
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.Forms.UndefinedProjectionAction">
- <summary>
- The Undefined Projection Action enumeration
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Forms.UndefinedProjectionAction.Nothing">
- <summary>
- No action should be taken.
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Forms.UndefinedProjectionAction.WGS84">
- <summary>
- Always assume an undefined projection is Latitude Longitude
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Forms.UndefinedProjectionAction.Map">
- <summary>
- Always rely on the existing Map projection
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Forms.UndefinedProjectionAction.Chosen">
- <summary>
- Use a projection that was specified from the list
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.Forms.UndefinedProjectionDialog">
- <summary>
- A Dialog for choosing how to define a projection.
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Forms.UndefinedProjectionDialog.#ctor">
- <summary>
- Initializes a new instance of the Undefined Projection Dialog
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Forms.UndefinedProjectionDialog.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Forms.UndefinedProjectionDialog.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Projections.Forms.UndefinedProjectionDialog.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Forms.UndefinedProjectionDialog.UseProjection">
- <summary>
- Gets or sets a value that indicates that the newly selected Projection should be used. If this
- is false, then this layer should be drawn unmodified.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Forms.UndefinedProjectionDialog.SelectedCoordinateSystem">
- <summary>
- Gets or sets the Projection chosen to be the final defined projection.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Forms.UndefinedProjectionDialog.MapProjection">
- <summary>
- Gets or sets the current MapProjection.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Forms.UndefinedProjectionDialog.OriginalString">
- <summary>
- Gets or sets the original projection string that could not be identified.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Forms.UndefinedProjectionDialog.AlwaysUse">
- <summary>
- Gets or sets whether the option chosen here should be used for the rest of the session.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Forms.UndefinedProjectionDialog.LayerName">
- <summary>
- Gets or sets the layername of the layer that could not be identified.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Forms.UndefinedProjectionDialog.Action">
- <summary>
- Gets the action selected from the dialog.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Forms.UndefinedProjectionDialog.Result">
- <summary>
- Gets the result of the dialog.
- </summary>
- </member>
- </members>
-</doc>
diff --git a/MES_Wind/bin/Debug/DotSpatial.Projections.pdb b/MES_Wind/bin/Debug/DotSpatial.Projections.pdb
deleted file mode 100644
index 48d6058f60c6c337d0e14898e44a1a1fa8f38049..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/DotSpatial.Projections.pdb and /dev/null differ
diff --git a/MES_Wind/bin/Debug/DotSpatial.Projections.xml b/MES_Wind/bin/Debug/DotSpatial.Projections.xml
deleted file mode 100644
index 7024b19b70da56108eae74e05c71c8b98d6b1c33..0000000000000000000000000000000000000000
--- a/MES_Wind/bin/Debug/DotSpatial.Projections.xml
+++ /dev/null
@@ -1,5879 +0,0 @@
-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>DotSpatial.Projections</name>
- </assembly>
- <members>
- <member name="T:DotSpatial.Projections.AuthorityCodes.AuthorityCodeHandler">
- <summary>
- AuthorityCodeHandler
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.AuthorityCodes.AuthorityCodeHandler.#ctor">
- <summary>
- Creates an instance of this class
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.AuthorityCodes.AuthorityCodeHandler.Add(System.String,System.Int32,System.String)">
- <summary>
- Adds the specified authority.
- </summary>
- <param name="authority">The authority.</param>
- <param name="code">The code.</param>
- <param name="proj4String">The proj4 string.</param>
- </member>
- <member name="M:DotSpatial.Projections.AuthorityCodes.AuthorityCodeHandler.Add(System.String,System.Int32,System.String,System.Boolean)">
- <summary>
- Adds the specified authority.
- </summary>
- <param name="authority">The authority.</param>
- <param name="code">The code.</param>
- <param name="proj4String">The proj4 string.</param>
- <param name="replace">if set to <c>true</c> [replace].</param>
- </member>
- <member name="M:DotSpatial.Projections.AuthorityCodes.AuthorityCodeHandler.Add(System.String,System.Int32,System.String,System.String)">
- <summary>
- Adds the specified authority.
- </summary>
- <param name="authority">The authority.</param>
- <param name="code">The code.</param>
- <param name="name">The name.</param>
- <param name="proj4String">The proj4 string.</param>
- </member>
- <member name="M:DotSpatial.Projections.AuthorityCodes.AuthorityCodeHandler.Add(System.String,System.Int32,System.String,System.String,System.Boolean)">
- <summary>
- Adds a new projection info to the store, replaces the old one
- </summary>
- <param name="authority">The authority, e.g. EPSG</param>
- <param name="code">The code assigned by the authority</param>
- <param name="name">A declarative name</param>
- <param name="proj4String">the proj4 definition string</param>
- <param name="replace">a value indicating if a previously defined projection should be replaced or not.</param>
- </member>
- <member name="P:DotSpatial.Projections.AuthorityCodes.AuthorityCodeHandler.Instance">
- <summary>
- The one and only <see cref="T:DotSpatial.Projections.AuthorityCodes.AuthorityCodeHandler"/>
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.AuthorityCodes.AuthorityCodeHandler.Item(System.String)">
- <summary>
- Gets the
- </summary>
- <param name="authorityCodeOrName"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Projections.AuxiliarySphereType">
- <summary>
- AuxiliarySphereTypes
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.AuxiliarySphereType.SemimajorAxis">
- <summary>
- Use semimajor axis or radius of the geographic coordinate system
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.AuxiliarySphereType.SemiminorAxis">
- <summary>
- Use semiminor axis or radius
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.AuxiliarySphereType.Authalic">
- <summary>
- Calculate and use authalic radius
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.AuxiliarySphereType.AuthalicWithConvertedLatitudes">
- <summary>
- Use authalic radius and convert geodetic latitudes to authalic latitudes
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.AuxiliarySphereType.NotSpecified">
- <summary>
- This indicates that this parameter should not appear in the projection string.
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.DatNadTable">
- <summary>
- Handles the specific case of dat files like the ntv1 file format.
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.NadTable">
- <summary>
- NadRecord is a single entry from an lla file
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.NadTable.DEG_TO_RAD">
- <summary>
- Converts degree values into radians
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.NadTable.USecToRad">
- <summary>
- I think this converts micro-seconds of arc to radians
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.NadTable._cellSize">
- <summary>
- The delta lambda and delta phi for a single cell
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.NadTable._cvs">
- <summary>
- The set of conversion matrix coefficients for lambda
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.NadTable._lowerLeft">
- <summary>
- The lower left coordinate
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.NadTable._name">
- <summary>
- The character based id for this record
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.NadTable._numLambdas">
- <summary>
- The total count of coordinates in the lambda direction
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.NadTable._numPhis">
- <summary>
- The total count of coordinates in the phi direction
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.NadTable.#ctor">
- <summary>
- Creates a blank nad Table
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.NadTable.#ctor(System.String)">
- <summary>
- This initializes a new table with the assumption that the offset is 0
- </summary>
- <param name="resourceLocation">The resource location</param>
- </member>
- <member name="M:DotSpatial.Projections.NadTable.#ctor(System.String,System.Boolean)">
- <summary>
- This initializes a new table with the assumption that the offset is 0
- </summary>
- <param name="resourceLocation">The resource location</param>
- <param name="embedded">Indicates if grid file is in embedded resource or external file</param>
- </member>
- <member name="M:DotSpatial.Projections.NadTable.#ctor(System.String,System.Int64)">
- <summary>
- This initializes a new table with the assumption that the offset needs to be specified
- because in gsb files, more than one table is listed, and this is a subtable.
- </summary>
- <param name="resourceLocation">The resource location</param>
- <param name="offset">The offset marking the start of the header in the file</param>
- </member>
- <member name="M:DotSpatial.Projections.NadTable.#ctor(System.String,System.Int64,System.Boolean)">
- <summary>
- This initializes a new table with the assumption that the offset needs to be specified
- because in gsb files, more than one table is listed, and this is a subtable. This also allows
- specifying if the grid file is included as an embedded resource.
- </summary>
- <param name="location">The resource (or file) location</param>
- <param name="offset">The offset marking the start of the header in the file</param>
- <param name="embedded">Indicates if embedded resource or external file</param>
- </member>
- <member name="M:DotSpatial.Projections.NadTable.ReadHeader">
- <summary>
- Given the resource setup, this causes the file to read the
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.NadTable.FillData">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.NadTable.FromSourceName(System.String)">
- <summary>
- This method parses the extension of a resource location or
- path and creates the new NadTable type.
- </summary>
- <param name="resourceLocation"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Projections.NadTable.FromSourceName(System.String,System.Boolean)">
- <summary>
- This method parses the extension of a resource location or
- path and creates the new NadTable type.
- </summary>
- <param name="location"></param>
- <param name="embedded"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Projections.NadTable.ReadDouble(System.IO.BinaryReader)">
- <summary>
- Reads a double in BigEndian format (consistent with ntv1 and ntv2 formats.)
- </summary>
- <param name="br">The binary reader</param>
- <returns>The double value parsed from the binary in big endian byte order.</returns>
- </member>
- <member name="M:DotSpatial.Projections.NadTable.GetDouble(System.Byte[],System.Int32)">
- <summary>
- Gets the double value from the specified position in the byte array
- Using BigEndian format.
- </summary>
- <param name="array"></param>
- <param name="offset"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Projections.NadTable.GetStream">
- <summary>
- Get the stream to the grid
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Projections.NadTable.Name">
- <summary>
- Gets or sets the string name for this record
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.NadTable.LowerLeft">
- <summary>
- Gets or sets the lower left corner in radians
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.NadTable.CellSize">
- <summary>
- Gets or sets the angular cell size in radians
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.NadTable.NumPhis">
- <summary>
- Gets or sets the integer count of phi coefficients
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.NadTable.NumLambdas">
- <summary>
- Gets or sets the integer count of lambda coefficients
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.NadTable.SubGrids">
- <summary>
- These represent smaller, higher resolution subgrids that should fall within the extents
- of the larger grid. If this list exists, and there is a fit here, it should be used
- in preference to the low-resolution main grid.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.NadTable.Cvs">
- <summary>
- Gets or sets the array of lambda coefficients organized
- in a spatial Table (phi major)
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.NadTable.Filled">
- <summary>
- Gets or sets a boolean indicating whether or not the values have been filled.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.NadTable.ManifestResourceString">
- <summary>
- Gets or sets the location this table should look for source data.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.NadTable.DataOffset">
- <summary>
- Gets or sets the long integer data offset where the stream should skip to to begin reading data
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.NadTable.Format">
- <summary>
- Gets or sets the format being used.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.NadTable.FileIsEmbedded">
- <summary>
- True if grid file is an embedded resource
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.NadTable.GridFilePath">
- <summary>
- If FileIsEmbedded is false, this contains the full path to the grid file
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.DatNadTable.#ctor(System.String)">
- <summary>
- Creates a new instance of GsbNadTable
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.DatNadTable.#ctor(System.String,System.Boolean)">
- <summary>
- Creates a new instance of GsbNadTable
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.DatNadTable.ReadHeader">
- <inheritdoc></inheritdoc>
- </member>
- <member name="M:DotSpatial.Projections.DatNadTable.FillData">
- <inheritdoc></inheritdoc>
- </member>
- <member name="T:DotSpatial.Projections.DatumTransform">
- <summary>
- IDatumTransform
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.IDatumTransform">
- <summary>
- IDatumTransform
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.IDatumTransform.Transform(DotSpatial.Projections.ProjectionInfo,DotSpatial.Projections.ProjectionInfo,System.Double[],System.Double[],System.Int32,System.Int32)">
- <summary>
- Transform function
- </summary>
- <param name="source"></param>
- <param name="dest"></param>
- <param name="xy"></param>
- <param name="z"></param>
- <param name="startIndex"></param>
- <param name="numPoints"></param>
- </member>
- <member name="F:DotSpatial.Projections.DatumTransform.SecToRad">
- <summary>Arc-seconds to radians conversion factor</summary>
- </member>
- <member name="M:DotSpatial.Projections.DatumTransform.#ctor(DotSpatial.Projections.IDatumTransformStage[])">
- <summary>
-
- </summary>
- <param name="aiDatumTransformStage"></param>
- </member>
- <member name="M:DotSpatial.Projections.DatumTransform.Transform(DotSpatial.Projections.ProjectionInfo,DotSpatial.Projections.ProjectionInfo,System.Double[],System.Double[],System.Int32,System.Int32)">
- <summary>
- datum tranform method
- </summary>
- <param name="source"></param>
- <param name="dest"></param>
- <param name="xy"></param>
- <param name="z"></param>
- <param name="startIndex"></param>
- <param name="numPoints"></param>
- </member>
- <member name="M:DotSpatial.Projections.DatumTransform.GetStage(System.Int32)">
- <summary>
- Returns an interface to the stage at the specified index
- </summary>
- <param name="index"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Projections.DatumTransform.ApplyParameterizedTransform(DotSpatial.Projections.IDatumTransformStage,System.Double[],System.Double[],System.Int32,System.Int32)">
- <summary>
-
- </summary>
- <param name="idts"></param>
- <param name="xy"></param>
- <param name="zArr"></param>
- <param name="startIndex"></param>
- <param name="numPoints"></param>
- </member>
- <member name="P:DotSpatial.Projections.DatumTransform.NumStages">
- <summary>
- Returns the number of datum transform stages for this datum transform
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.DatumTransform.FromID">
- <summary>
- source datum
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.DatumTransform.ToID">
- <summary>
- destination datum
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.TransformMethod">
- <summary>
- Datum Transform Type: GridShift, Param3, or Param7
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.TransformMethod.GridShift">
- <summary>Grid shift table</summary>
- </member>
- <member name="F:DotSpatial.Projections.TransformMethod.Param3">
- <summary>3-parameter geocentric transform: delat x, delta y, and delta z</summary>
- </member>
- <member name="F:DotSpatial.Projections.TransformMethod.Param7">
- <summary>7-parameter geocentric tranform: delta x,y,z, plus rotataion of x,y,z axes, and delta scale</summary>
- </member>
- <member name="T:DotSpatial.Projections.DatumTransformStage">
- <summary>
- DatumTransfromStage implementation
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.IDatumTransformStage">
- <summary>
- DatumTransformStage interface
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.IDatumTransformStage.FromDatum">
- <summary>
- String identifier of the datum from which the transform proceeds
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.IDatumTransformStage.ToDatum">
- <summary>
- String identifier of the datum to which the transform proceeds
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.IDatumTransformStage.Method">
- <summary>
- Transform method; one of: GeoCentric, Coordinate_Frame, Position_Vector, NADCON, HARN, NTv2
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.IDatumTransformStage.DeltaX">
- <summary>
- Detla X of geocentric origin, in meters
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.IDatumTransformStage.DeltaY">
- <summary>
- Delta Y of geocentric origin, in meters
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.IDatumTransformStage.DeltaZ">
- <summary>
- Delta Z of geocentric origin, in meters
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.IDatumTransformStage.RotateX">
- <summary>
- Rotation about the geocentric X-axis, in arc-seconds
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.IDatumTransformStage.RotateY">
- <summary>
- Rotation about the geocentric Y-axis, in arc-seconds
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.IDatumTransformStage.RotateZ">
- <summary>
- Rotation about the geocentric Z-axis, in arc-seconds
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.IDatumTransformStage.DeltaScale">
- <summary>
- Delta scale in parts-per-million. Actaul scale is 1+DS/1000000.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.IDatumTransformStage.GridShiftTable">
- <summary>
- If Method is one of: NADCON, HARN, or NTv2, this field contains the name of the grid shift table
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.IDatumTransformStage.ApplyTableInverse">
- <summary>
- True if the table must be used in the direction opposite that specified by the From/To Datum properties
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.IDatumTransformStage.FromSpheroid">
- <summary>
- Spheriod on which the From datum is based
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.IDatumTransformStage.ToSpheroid">
- <summary>
- Spheriod on which the To datum is based
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.DatumTransformStage.ApplyTableInv">
- <summary>True if the table must be used in the direction opposite that specified by the From/To Datum properties</summary>
- </member>
- <member name="F:DotSpatial.Projections.DatumTransformStage.Ds">
- <summary>Delta scale in parts-per-million. Actaul scale is 1+DS/1000000.</summary>
- </member>
- <member name="F:DotSpatial.Projections.DatumTransformStage.Dx">
- <summary>Detla X of geocentric origin, in meters</summary>
- </member>
- <member name="F:DotSpatial.Projections.DatumTransformStage.Dy">
- <summary>Delta Y of geocentric origin, in meters</summary>
- </member>
- <member name="F:DotSpatial.Projections.DatumTransformStage.Dz">
- <summary>Delta Z of geocentric origin, in meters</summary>
- </member>
- <member name="F:DotSpatial.Projections.DatumTransformStage.From">
- <summary>String identifer of datum from which the transform proceeds</summary>
- </member>
- <member name="F:DotSpatial.Projections.DatumTransformStage.FromSph">
- <summary>Spheriod on which the From datum is based</summary>
- </member>
- <member name="F:DotSpatial.Projections.DatumTransformStage.Rx">
- <summary>Rotation about the geocentric X-axis, in arc-seconds</summary>
- </member>
- <member name="F:DotSpatial.Projections.DatumTransformStage.Ry">
- <summary>Rotation about the geocentric Y-axis, in arc-seconds</summary>
- </member>
- <member name="F:DotSpatial.Projections.DatumTransformStage.Rz">
- <summary>Rotation about the geocentric Z-axis, in arc-seconds</summary>
- </member>
- <member name="F:DotSpatial.Projections.DatumTransformStage.TableName">
- <summary>If Method is one of: NADCON, HARN, or NTv2, this field contains the name of the grid shift table</summary>
- </member>
- <member name="F:DotSpatial.Projections.DatumTransformStage.Tm">
- <summary>Transform method; one of: GridShift, Param3, or Param7</summary>
- </member>
- <member name="F:DotSpatial.Projections.DatumTransformStage.To">
- <summary>String identifier of the datum to which the transform proceeds</summary>
- </member>
- <member name="F:DotSpatial.Projections.DatumTransformStage.ToSph">
- <summary>Spheriod on which the To datum is based</summary>
- </member>
- <member name="M:DotSpatial.Projections.DatumTransformStage.#ctor(System.String,System.String,DotSpatial.Projections.Spheroid,DotSpatial.Projections.Spheroid,System.Double,System.Double,System.Double)">
- <summary>
- DatumTranformStage constructor for a geocentric transform
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.DatumTransformStage.#ctor">
- <summary>
- Parmeterless constructor
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.DatumTransformStage.#ctor(System.String,System.String,DotSpatial.Projections.Spheroid,DotSpatial.Projections.Spheroid,System.String,System.Boolean)">
- <summary>
- DatumTranformStage constructor for a gridshift transform
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.DatumTransformStage.#ctor(System.String,System.String,DotSpatial.Projections.Spheroid,DotSpatial.Projections.Spheroid,System.Double,System.Double,System.Double,System.Double,System.Double,System.Double,System.Double)">
- <summary>
- DatumTranformStage constructor for a 7-parameter transform
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.DatumTransformStage.#ctor(DotSpatial.Projections.DatumTransformStage)">
- <summary>
- DatumTransfromStage copy constructor
- </summary>
- <param name="dts"></param>
- </member>
- <member name="P:DotSpatial.Projections.DatumTransformStage.FromDatum">
- <summary>
- Source datum
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.DatumTransformStage.ToDatum">
- <summary>
- Destination datum
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.DatumTransformStage.Method">
- <summary>
- TranformMethod to be used
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.DatumTransformStage.DeltaX">
- <summary>
- geocentric X offset
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.DatumTransformStage.DeltaY">
- <summary>
- geocentric Y offset
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.DatumTransformStage.DeltaZ">
- <summary>
- geocentric Z offset
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.DatumTransformStage.RotateX">
- <summary>
- rotation about X axis in arc-seconds
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.DatumTransformStage.RotateY">
- <summary>
- rotation about Y axis in arc-seconds
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.DatumTransformStage.RotateZ">
- <summary>
- rotation about Z axis in arc-seconds
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.DatumTransformStage.DeltaScale">
- <summary>
- delta scale in ppm
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.DatumTransformStage.GridShiftTable">
- <summary>
- if type is one of: NADCON, HARN, or NTv2, GridShiftTable is the file base name
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.DatumTransformStage.ApplyTableInverse">
- <summary>
- If false, use inverse of table
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.DatumTransformStage.FromSpheroid">
- <summary>
- Spheroid of source datum
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.DatumTransformStage.ToSpheroid">
- <summary>
- Spheroid of destination datum
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.GridShiftTableFormat">
- <summary>
- GridShiftTableFormats
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.GridShiftTableFormat.DAT">
- <summary>
- The data format used by ntv1
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.GridShiftTableFormat.GSB">
- <summary>
- The data format used by ntv2 and many others
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.GridShiftTableFormat.LLA">
- <summary>
- The data format use by several other grid types
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.GridShiftTableFormat.LOS">
- <summary>
- The data format used by National Geodetic Survey (NGS). Note
- there is always a matching LAS file.
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.GsbNadTable">
- <summary>
- This is a special case of a NadTable and has specific reading techniques that need to be handled
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.GsbNadTable.#ctor(System.String,System.Int64)">
- <summary>
- Creates a new instance of GsbNadTable
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.GsbNadTable.#ctor(System.String,System.Int64,System.Boolean)">
- <summary>
- Creates a new instance of GsbNadTable
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.GsbNadTable.ReadHeader">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Projections.GsbNadTable.Initialize">
- <summary>
- This handles the creation of the
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.GsbNadTable.FillData">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Projections.GsbNadTable.GetDouble(System.Byte[],System.Int32)">
- <summary>
- Gets the double value from the specified position in the byte array
- Using BigEndian format.
- </summary>
- <param name="array"></param>
- <param name="offset"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Projections.ICoordinateSystemCategoryHolder.GetCategory(System.String)">
- <summary>
- Given the string name, this will return the specified coordinate category
- </summary>
- <param name="name">Category name</param>
- <returns>Coordinate system category</returns>
- </member>
- <member name="P:DotSpatial.Projections.ICoordinateSystemCategoryHolder.Names">
- <summary>
- Gets an array of all the names of the coordinate system categories
- in this collection of systems.
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.LasLosNadTable">
- <summary>
- Overrides the NadTable methods in the context of an las/los file pair.
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.LasLosNadTable.#ctor(System.String)">
- <summary>
- An LasLosNadTable constructor
- </summary>
- <param name="resourceLocation">The Manifest Assembly resource location</param>
- </member>
- <member name="M:DotSpatial.Projections.LasLosNadTable.#ctor(System.String,System.Boolean)">
- <summary>
- An LasLosNadTable constructor
- </summary>
- <param name="location">The resource location or grid file path</param>
- <param name="embedded">Indicates if grid is an embedded resource</param>
- </member>
- <member name="M:DotSpatial.Projections.LasLosNadTable.ReadHeader">
- <inheritdoc></inheritdoc>
- </member>
- <member name="M:DotSpatial.Projections.LasLosNadTable.FillData">
- <inheritdoc></inheritdoc>
- </member>
- <member name="M:DotSpatial.Projections.LasLosNadTable.GetLasStream">
- <summary>
- LasLosNadTables are constructs from a pair of input files: .los AND .las
- </summary>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Projections.LlaNadTable">
- <summary>
- Overrides the NadTable methods in the context of an lla resource file.
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.LlaNadTable.#ctor(System.String)">
- <summary>
- An LlaNadTable constructor
- </summary>
- <param name="resourceLocation">The Manifest Assembly resource location</param>
- </member>
- <member name="M:DotSpatial.Projections.LlaNadTable.#ctor(System.String,System.Boolean)">
- <summary>
- An LlaNadTable constructor
- </summary>
- <param name="location">The Manifest Assembly resource location or file path</param>
- <param name="embedded">Indicates if grid file is embedded resource or external file</param>
- </member>
- <member name="M:DotSpatial.Projections.LlaNadTable.ReadHeader">
- <inheritdoc></inheritdoc>
- </member>
- <member name="M:DotSpatial.Projections.LlaNadTable.FillData">
- <inheritdoc></inheritdoc>
- </member>
- <member name="T:DotSpatial.Projections.ProjCloneableEM">
- <summary>
- CloneableEM
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjCloneableEM.Copy``1(``0)">
- <summary>
- The type parameter T is optional, so the intended use would be like:
- ObjectType copy = myObject.Copy();
- </summary>
- <typeparam name="T">The type of the object</typeparam>
- <param name="original">The original object</param>
- <returns>A new object of the same type as the type being copied.</returns>
- </member>
- <member name="T:DotSpatial.Projections.IProjDescriptor">
- <summary>
- IDescriptor
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.IProjMatchable">
- <summary>
- Matching is defined as being a different object, but having properties
- that would make it indistinguishable from the comparision property.
- This is an alternative to overriding the equals behavior in cases
- where you might ALSO need to see if the object reference is the same.
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.IProjMatchable.Matches(DotSpatial.Projections.IProjMatchable,System.Collections.Generic.List{System.String}@)">
- <summary>
- Tests this object against the comparison object. If any of the
- value type members are different, or if any of the properties
- are IMatchable and do not match, then this returns false.
- </summary>
- <param name="other">The other IMatcheable object of the same type</param>
- <param name="mismatchedProperties">The list of property names that do not match</param>
- <returns>Boolean, true if the properties are comparably equal.</returns>
- </member>
- <member name="T:DotSpatial.Projections.IProjRandomizable">
- <summary>
- IRandomizable
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.IProjRandomizable.Randomize(System.Random)">
- <summary>
- This method will set the values for this class with random values that are
- within acceptable parameters for this class.
- </summary>
- <param name="generator">An existing random number generator so that the random seed can be controlled</param>
- </member>
- <member name="M:DotSpatial.Projections.IProjDescriptor.CopyProperties(System.Object)">
- <summary>
- This copies the public descriptor properties from the specified object to
- this object.
- </summary>
- <param name="other">An object that has properties that match the public properties on this object.</param>
- </member>
- <member name="T:DotSpatial.Projections.ProjMatchableEM">
- <summary>
- MatchableEM
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjMatchableEM.Matches(DotSpatial.Projections.IProjMatchable,DotSpatial.Projections.IProjMatchable)">
- <summary>
- This tests the public properties from the two objects. If any properties implement
- the IMatchable interface, and do not match, this returns false. If any public
- properties are value types, and they are not equal, then this returns false.
- </summary>
- <param name="self">This matchable item </param>
- <param name="other">The other item to compare to this item</param>
- <returns>Boolean, true if there is a match</returns>
- </member>
- <member name="T:DotSpatial.Projections.AngularUnit">
- <summary>
- Unit
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjDescriptor">
- <summary>
- Descriptors are simple classes that are used for storing symbology or other basic characteristics.
- They are presumed to be made up of value types and other descriptors, and are expected to be serializable.
- This being said, some basic capabilities are supported for randomizing, copying and comparing the
- properties of descriptors.
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjCopyBase">
- <summary>
- CopyBase
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjCopyBase.#ctor">
- <summary>
- Creates a new instance of CopyBase
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjCopyBase.System#ICloneable#Clone">
- <summary>
- Creates a duplicate of this descriptor using MemberwiseClone
- </summary>
- <returns>A clone of this object as a duplicate</returns>
- </member>
- <member name="M:DotSpatial.Projections.ProjCopyBase.DistinctNames(System.Collections.Generic.IEnumerable{System.Reflection.PropertyInfo})">
- <summary>
- PropertyInfo returns overridden members as separate entries. We would rather work with each members
- only one time.
- </summary>
- <param name="allProperties">All the properties, including duplicates created by overridden members</param>
- <returns>An Array of PropertyInfo members</returns>
- </member>
- <member name="M:DotSpatial.Projections.ProjCopyBase.OnCopy(DotSpatial.Projections.ProjDescriptor)">
- <summary>
- This occurs during the Copy method and is overridable by sub-classes
- </summary>
- <param name="copy">The duplicate descriptor</param>
- </member>
- <member name="M:DotSpatial.Projections.ProjDescriptor.#ctor">
- <summary>
- Creates a new instance of MatchableObject
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjDescriptor.CopyProperties(System.Object)">
- <summary>
- For each of the publicly accessible properties found on this object, this attempts
- to copy a public property from the source object of the same name, if it can find it.
- For each matching property name/type, it will attempt to copy the value.
- </summary>
- <param name="source">The</param>
- </member>
- <member name="M:DotSpatial.Projections.ProjDescriptor.Matches(DotSpatial.Projections.IProjMatchable,System.Collections.Generic.List{System.String}@)">
- <summary>
- Compares the properties of this object with the specified IMatchable other.
- This does not test every property of other, but does test every property
- of this item. As long as the other item has corresponding properties
- for every property on this item, the items are said to match.
- The IMatchable interface allows custom definitions of matching.
- For collections to match, all of their sub-members must match.
- </summary>
- <param name="other"></param>
- <param name="mismatchedProperties"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Projections.ProjDescriptor.Randomize(System.Random)">
- <summary>
- The default behavior is to cycle through all the properties of this
- object, and call Randomize on any that implement the IRandomizable interface.
- </summary>
- <param name="generator">The Random seed generator for controling how the random content is created</param>
- </member>
- <member name="M:DotSpatial.Projections.ProjDescriptor.OnCopyProperties(System.Object)">
- <summary>
- This occurs while copying properties from the specified source, and
- is the default handling for subclasses
- </summary>
- <param name="source"></param>
- </member>
- <member name="M:DotSpatial.Projections.ProjDescriptor.OnMatch(DotSpatial.Projections.IProjMatchable,System.Collections.Generic.List{System.String})">
- <summary>
- This gives sub-classes the chance to directly override, control or otherwise tamper
- with the matching process. This is also where normal matching is performed,
- so to replace it, simply don't call the base.OnMatch method. To tweak the results,
- the base method should be performed first, and the results can then be modified.
- </summary>
- <param name="other"></param>
- <param name="mismatchedProperties"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Projections.ProjDescriptor.OnRandomize(System.Random)">
- <summary>
- This allows overrideable behavior that can replace or extend the basic behavior,
- which is to call Randomize on any public properties that are listed as randomizeable.
- This does nothing to normal properties or non public members and needs to be overriden
- to provide the special case functionality for sub-classes.
- </summary>
- <param name="generator">The random number generator to be used during randomization</param>
- </member>
- <member name="T:DotSpatial.Projections.IEsriString">
- <summary>
- EsriString
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.IEsriString.ToEsriString">
- <summary>
- Writes the value in the format that it would appear in within a prj file
- </summary>
- <returns>The a nested portion of the total esri string.</returns>
- </member>
- <member name="M:DotSpatial.Projections.IEsriString.ParseEsriString(System.String)">
- <summary>
- This reads the string and attempts to parse the relavent values.
- </summary>
- <param name="esriString">The string to read</param>
- </member>
- <member name="M:DotSpatial.Projections.AngularUnit.#ctor">
- <summary>
- Creates a new instance of Unit
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.AngularUnit.ToEsriString">
- <summary>
- Generates the Esri string from the values in this class
- </summary>
- <returns>The resulting esri string</returns>
- </member>
- <member name="M:DotSpatial.Projections.AngularUnit.ParseEsriString(System.String)">
- <summary>
- Reads an esri string to determine the angular unit
- </summary>
- <param name="esriString">The esri string to read</param>
- </member>
- <member name="P:DotSpatial.Projections.AngularUnit.Name">
- <summary>
- Gets or sets the name of this
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.AngularUnit.Radians">
- <summary>
- Gets or sets the constant to multiply against this unit to get radians.
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.CoordinateSystemCategory">
- <summary>
- CoordinateSystem
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.CoordinateSystemCategory.#ctor">
- <summary>
- Creates a new instance of CoordinateSystem
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.CoordinateSystemCategory.GetProjection(System.String)">
- <summary>
- Retrieves the specified projection given the specified name.
- </summary>
- <param name="name">The string name of the projection to obtain information for</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Projections.CoordinateSystemCategory.ToArray">
- <summary>
- Obtains all the members of this category, building a single
- array of the projection info classes. This returns the
- original classes, not a copy.
- </summary>
- <returns>The array of projection info classes</returns>
- </member>
- <member name="M:DotSpatial.Projections.CoordinateSystemCategory.AsEnumerable">
- <summary>
- Obtains all the members of this category. This returns the
- original classes, not a copy.
- </summary>
- <returns>The enumerable of projection info classes with field names</returns>
- </member>
- <member name="P:DotSpatial.Projections.CoordinateSystemCategory.Names">
- <summary>
- Gets the list of names of all the members on this object
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.Datum">
- <summary>
- Datum
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Datum.#ctor">
- <summary>
- Creates a new instance of Datum
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Datum.#ctor(System.String)">
- <summary>
- uses a string name of a standard datum to create a new instance of the Datum class
- </summary>
- <param name="standardDatum">The string name of the datum to use</param>
- </member>
- <member name="M:DotSpatial.Projections.Datum.#ctor(DotSpatial.Projections.Proj4Datum)">
- <summary>
- Uses a Proj4Datums enumeration in order to specify a known datum to
- define the spheroid and to WGS calculation method and parameters
- </summary>
- <param name="standardDatum">The Proj4Datums enumeration specifying the known datum</param>
- </member>
- <member name="M:DotSpatial.Projections.Datum.ToProj4String">
- <summary>
- Returns a representaion of this object as a Proj4 string.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Projections.Datum.Matches(DotSpatial.Projections.Datum)">
- <summary>
- Compares two datums to see if they are actually describing the same thing and
- therefore don't need to be transformed.
- </summary>
- <param name="otherDatum">The other datum to compare against</param>
- <returns>The boolean result of the operation.</returns>
- </member>
- <member name="M:DotSpatial.Projections.Datum.ToEsriString">
- <summary>
- Creates an esri well known text string for the datum part of the string
- </summary>
- <returns>The datum portion of the esri well known text</returns>
- </member>
- <member name="M:DotSpatial.Projections.Datum.ParseEsriString(System.String)">
- <summary>
- parses the datum from the esri string
- </summary>
- <param name="esriString">The string to parse values from</param>
- </member>
- <member name="M:DotSpatial.Projections.Datum.InitializeToWgs84(System.String[])">
- <summary>
- Initializes to WGS84.
- </summary>
- <param name="values">The values.</param>
- </member>
- <member name="P:DotSpatial.Projections.Datum.Name">
- <summary>
- Gets or sets the name of the datum defining the spherical characteristics of the model of the earth
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Datum.Spheroid">
- <summary>
- The spheroid of the earth, defining the maximal radius and the flattening factor
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Datum.ToWGS84">
- <summary>
- Gets or sets the set of double parameters, (this can either be 3 or 7 parameters)
- used to transform this
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Datum.DatumType">
- <summary>
- Gets or sets the datum type, which clarifies how to perform transforms to WGS84
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Datum.Description">
- <summary>
- Gets or sets an english description for this datum
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Datum.NadGrids">
- <summary>
- Gets or sets the array of string nadGrid
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Datum.Proj4DatumName">
- <summary>
- Lookups the proj4 datum based on the stored name.
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.DatumType">
- <summary>
- DatumTypes
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.DatumType.Unknown">
- <summary>
- The datum type is not with a well defined ellips or grid-shift
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.DatumType.Param3">
- <summary>
- The datum transform to WGS84 can be defined using 3 double parameters
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.DatumType.Param7">
- <summary>
- The datum transform to WGS84 can be defined using 7 double parameters
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.DatumType.GridShift">
- <summary>
- The transform requires a special nad gridshift
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.DatumType.WGS84">
- <summary>
- The datum is already the WGS84 datum
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.GeocentricGeodetic">
- <summary>
- Wenzel, H.-G.(1985): Hochauflösende Kugelfunktionsmodelle für
- das Gravitationspotential der Erde. Wiss. Arb. Univ. Hannover
- Nr. 137, p. 130-131.
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.GeocentricGeodetic.#ctor(DotSpatial.Projections.Spheroid)">
- <summary>
- Creates a new instance of GeocentricGeodetic
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.GeocentricGeodetic.GeodeticToGeocentric(System.Double[],System.Double[],System.Int32,System.Int32)">
- <summary>
- Converts lon, lat, height to x, y, z where lon and lat are in radians and everything else is meters
- </summary>
- <param name="xy"></param>
- <param name="z"></param>
- <param name="startIndex"></param>
- <param name="numPoints"></param>
- </member>
- <member name="M:DotSpatial.Projections.GeocentricGeodetic.GeocentricToGeodetic(System.Double[],System.Double[],System.Int32,System.Int32)">
- <summary>
- Converts x, y, z to lon, lat, height
- </summary>
- <param name="xy"></param>
- <param name="z"></param>
- <param name="startIndex"></param>
- <param name="numPoints"></param>
- </member>
- <member name="M:DotSpatial.Projections.GeocentricGeodetic.GeocentricToGeodetic(System.Double@,System.Double@,System.Double@)">
- <summary>
- Converts geocentric x, y, z coords to geodetic lon, lat, h
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.GeographicCategories.Africa">
- <summary>
- Africa
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.GeographicCategories.Africa.Abidjan1987">
- <summary>
- Abidjan 1987
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.GeographicCategories.Africa.#ctor">
- <summary>
- Creates a new instance of Africa
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.GeographicCategories.Antarctica">
- <summary>
- Antarctica
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.GeographicCategories.Antarctica.#ctor">
- <summary>
- Creates a new instance of Antarctica
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.GeographicCategories.Asia">
- <summary>
- Asia
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.GeographicCategories.Asia.#ctor">
- <summary>
- Creates a new instance of Asia
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.GeographicCategories.Australia">
- <summary>
- Australia
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.GeographicCategories.Australia.#ctor">
- <summary>
- Creates a new instance of Australia
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.GeographicCategories.CountySystems">
- <summary>
- CountySystems
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.GeographicCategories.CountySystems.#ctor">
- <summary>
- Creates a new instance of CountySystems
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.GeographicCategories.Europe">
- <summary>
- Europe
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.GeographicCategories.Europe.#ctor">
- <summary>
- Creates a new instance of Europe
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.GeographicCategories.NorthAmerica">
- <summary>
- NorthAmerica
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.GeographicCategories.NorthAmerica.#ctor">
- <summary>
- Creates a new instance of NorthAmerica
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.GeographicCategories.Oceans">
- <summary>
- Oceans
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.GeographicCategories.Oceans.#ctor">
- <summary>
- Creates a new instance of Oceans
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.GeographicCategories.SolarSystem">
- <summary>
- SolarSystem
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.GeographicCategories.SolarSystem.#ctor">
- <summary>
- Creates a new instance of SolarSystem
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.GeographicCategories.SouthAmerica">
- <summary>
- SouthAmerica
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.GeographicCategories.SouthAmerica.#ctor">
- <summary>
- Creates a new instance of SouthAmerica
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.GeographicCategories.SpheroidBased">
- <summary>
- SpheroidBased
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.GeographicCategories.SpheroidBased.#ctor">
- <summary>
- Creates a new instance of SpheroidBased
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.GeographicCategories.World">
- <summary>
- World
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.GeographicCategories.World.#ctor">
- <summary>
- Creates a new instance of World
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.GeographicInfo">
- <summary>
- GeographicInfo
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.GeographicInfo.#ctor">
- <summary>
- Creates a new instance of GeographicInfo
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.GeographicInfo.ToEsriString">
- <summary>
- Generates an esri string from the information in this geographic info class, including the name, datum, meridian, and unit.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Projections.GeographicInfo.ParseEsriString(System.String)">
- <summary>
- Reads an esri string in order to parse the datum, meridian and unit as well as the name.
- </summary>
- <param name="esriString">The string to parse</param>
- </member>
- <member name="M:DotSpatial.Projections.GeographicInfo.ToProj4String">
- <summary>
- Returns a representaion of this object as a Proj4 string.
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Projections.GeographicInfo.Datum">
- <summary>
- Gets or sets the datum
- eg: D_WGS_1984
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.GeographicInfo.Meridian">
- <summary>
- Gets or sets the prime meridian longitude of the 0 mark, relative to Greenwitch
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.GeographicInfo.Name">
- <summary>
- Gets or sets the geographic coordinate system name
- eg: GCS_WGS_1984
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.GeographicInfo.Unit">
- <summary>
- Gets or sets the units
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.GeographicSystems">
- <summary>
- GeographicSystems
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.GeographicSystems.GetCategory(System.String)">
- <summary>
- Given the string name, this will return the specified coordinate category
- </summary>
- <param name="name"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Projections.GeographicSystems.Names">
- <summary>
- Gets an array of all the names of the coordinate system categories
- in this collection of systems.
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.GridShift">
- <summary>
- GridShift
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.GridShift.Apply(System.String[],System.Boolean,System.Double[],System.Int32,System.Int64)">
- <summary>
- Applies either a forward or backward gridshift based on the specified name
- </summary>
- <param name="names"></param>
- <param name="inverse"></param>
- <param name="xy"></param>
- <param name="startIndex"></param>
- <param name="numPoints"></param>
- </member>
- <member name="M:DotSpatial.Projections.GridShift.NadInterpolate(DotSpatial.Projections.PhiLam,DotSpatial.Projections.NadTable)">
- <summary>
-
- </summary>
- <param name="t"></param>
- <param name="ct"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Projections.GridShift.GetValue(System.Int32,System.Int32,DotSpatial.Projections.NadTable)">
- <summary>
- Checks the edges to make sure that we are not attempting to interpolate
- from cells that don't exist.
- </summary>
- <param name="iPhi">The cell index in the phi direction</param>
- <param name="iLam">The cell index in the lambda direction</param>
- <param name="table">The Table with the values</param>
- <returns>A PhiLam that has the shift coefficeints.</returns>
- </member>
- <member name="M:DotSpatial.Projections.GridShift.InitializeExternalGrids">
- <summary>
- Load grids from the default GeogTransformsGrids subfolder
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.GridShift.InitializeExternalGrids(System.String,System.Boolean)">
- <summary>
- Load grids from the specified folder
- </summary>
- <param name="gridsFolder"></param>
- <param name="recursive"></param>
- </member>
- <member name="T:DotSpatial.Projections.IProjectionCategory">
- <summary>
- IProjectionCategory
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.IProjectionCategory.MainCategory">
- <summary>
- Gets or sets the main category for this projection
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.IProjectionCategory.Category">
- <summary>
- Gets or sets the category for this projection
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.IProjectionCategory.Name">
- <summary>
- Gets or sets the string name
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.IProjectionCategory.Proj4String">
- <summary>
- Gets or sets the proj4 string that defines this projection
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.IReproject">
- <summary>
- This interface defines how reprojection classes should be accessed
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.IReproject.ReprojectPoints(System.Double[][],DotSpatial.Projections.ProjectionInfo,DotSpatial.Projections.ProjectionInfo,System.Int32,System.Int32)">
- <summary>
- Reprojects the specified points. The first is the projection info to start from, while the destination
- is the projection to end with.
- </summary>
- <param name="points"></param>
- <param name="source"></param>
- <param name="dest"></param>
- <param name="startIndex"></param>
- <param name="numPoints"></param>
- </member>
- <member name="T:DotSpatial.Projections.KnownCoordinateSystems">
- <summary>
- KnownCoordinateSystems
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.KnownCoordinateSystems._geographic">
- <summary>
- Geographic systems operate in angular units, but can use different
- spheroid definitions or angular offsets.
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.KnownCoordinateSystems._projected">
- <summary>
- Projected systems are systems that use linear units like meters or feet
- rather than angular units like degrees or radians
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.KnownCoordinateSystems.Projected">
- <summary>
- Projected systems are systems that use linear units like meters or feet
- rather than angular units like degrees or radians
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.KnownCoordinateSystems.Geographic">
- <summary>
- Geographic systems operate in angular units, but can use different
- spheroid definitions or angular offsets.
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.LinearUnit">
- <summary>
- Unit
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.LinearUnit.#ctor">
- <summary>
- Creates a new instance of Unit
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.LinearUnit.ToEsriString">
- <summary>
- Generates the part of the Esri well known text for this linear unit
- </summary>
- <returns>A string that contains the name and conversion factor to meters </returns>
- </member>
- <member name="M:DotSpatial.Projections.LinearUnit.ParseEsriString(System.String)">
- <summary>
- Parses the UNIT member of Esri well known text into a linear unit
- </summary>
- <param name="esriString"></param>
- </member>
- <member name="M:DotSpatial.Projections.LinearUnit.ReadCode(System.Int32)">
- <summary>
- Interprets a UOM code. For instance 9001 = meters.
- These codes and ratios were from GDAL unit_of_measure.csv, and I'm not
- sure if the numeric code is used outside of GDAL internal references.
- </summary>
- <param name="uomCode"></param>
- </member>
- <member name="P:DotSpatial.Projections.LinearUnit.Name">
- <summary>
- Gets or sets the name of this
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.LinearUnit.Meters">
- <summary>
- Gets or sets the constant to multiply with maps distances to get the distances in meters
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.Meridian">
- <summary>
- Meridian
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Meridian.#ctor">
- <summary>
- Creates a new instance of Meridian
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Meridian.#ctor(System.Double,System.String)">
- <summary>
- Generates a custom meridian given a name and a longitude
- </summary>
- <param name="longitude">The longitude to use</param>
- <param name="name">The string name for this meridian</param>
- </member>
- <member name="M:DotSpatial.Projections.Meridian.#ctor(DotSpatial.Projections.Proj4Meridian)">
- <summary>
- Creates a new meridian from one of the known, proj4 meridian locations.
- Presumably the longitudes here correspond to various standard meridians
- rather than some arbitrary longitudes of capital cities.
- </summary>
- <param name="standardMeridian">One of the enumerations listed</param>
- </member>
- <member name="M:DotSpatial.Projections.Meridian.#ctor(System.String)">
- <summary>
- Creates a new meridian from one of the known, proj4 meridian locations.
- </summary>
- <param name="standardMeridianName">The string name of the meridian to use</param>
- </member>
- <member name="M:DotSpatial.Projections.Meridian.ReadCode(System.Int32)">
- <summary>
- Reads the integer code (possibly only an internal GDAL code) for the Meridian.
- The value can be from 8901 (Greenwich) to 8913 (Oslo). This will also alter
- the name and longitude for this meridian.
- </summary>
- <param name="code">The integer meridian code.</param>
- </member>
- <member name="M:DotSpatial.Projections.Meridian.AssignMeridian(DotSpatial.Projections.Proj4Meridian)">
- <summary>
- Changes the longitude to correspond with the specified standard meridian
- </summary>
- <param name="standardMeridian"></param>
- </member>
- <member name="M:DotSpatial.Projections.Meridian.ToEsriString">
- <summary>
- Writes the longitude and prime meridian content to the esri string
- </summary>
- <returns>A string that is formatted for an esri prj file</returns>
- </member>
- <member name="M:DotSpatial.Projections.Meridian.ParseEsriString(System.String)">
- <summary>
- Reads content from an esri string, learning information about the prime meridian
- </summary>
- <param name="esriString"></param>
- </member>
- <member name="M:DotSpatial.Projections.Meridian.ToProj4String">
- <summary>
- Returns a representaion of this object as a Proj4 string.
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Projections.Meridian.Code">
- <summary>
- Gets or sets the code. Setting this will not impact the longitude or name.
- In order to read a standard code (8901-8913) use the ReadCode method.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Meridian.Name">
- <summary>
- Gets or sets the string name
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Meridian.Longitude">
- <summary>
- Gets or sets the longitude where the prime meridian for this geographic coordinate occurs.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Meridian.pm">
- <summary>
- Gets or sets the pm.
- </summary>
- <value>
- Alternate prime meridian (typically a city name).
- </value>
- </member>
- <member name="T:DotSpatial.Projections.MeridionalDistance">
- <summary>
- MeridinalDistance
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.MeridionalDistance.GetEn(System.Double)">
- <summary>
- Formerly pj_enfn from Proj4
- </summary>
- <param name="es"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Projections.MeridionalDistance.MeridionalLength(System.Double,System.Double,System.Double,System.Double[])">
- <summary>
- Formerly pj_mlfn
- Given geodetic angular displacement phi, this calculates the equivalent meridional distance
- </summary>
- <param name="phi">The geodetic angular displacement</param>
- <param name="sphi"></param>
- <param name="cphi"></param>
- <param name="en"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Projections.MeridionalDistance.AngularDistance(System.Double,System.Double,System.Double[])">
- <summary>
- Formerly pj_inv_mlfn
- Given the linear distance, this calculates the equivalent geodetic angular displacement
- </summary>
- <param name="arg"></param>
- <param name="es"></param>
- <param name="en"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Projections.NadTables">
- <summary>
- NadTables
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.NadTables.#ctor">
- <summary>
- Creates a new instance of NadTables
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.NadTables.InitializeExternalGrids">
- <summary>
- Load grids from the default GeogTransformsGrids subfolder
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.NadTables.InitializeExternalGrids(System.String,System.Boolean)">
- <summary>
- Load grids from the specified folder
- </summary>
- <param name="strGridsFolder"></param>
- <param name="recursive"></param>
- </member>
- <member name="P:DotSpatial.Projections.NadTables.Tables">
- <summary>
- Gets an array of the lla tables that have been added as a resource
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.PhiLam">
- <summary>
- PhiLam has two double values and is used like a coordinate.
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.PhiLam.Lambda">
- <summary>
- Geodetic Lambda coordinate (longitude)
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.PhiLam.Phi">
- <summary>
- Geodetic Phi coordinate (latitude)
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.Proj4Datum">
- <summary>
- Proj4Datums
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Datum.WGS84">
- <summary>
- World Geodetic System 1984
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Datum.GGRS87">
- <summary>
- Greek Geodetic Reference system 1987
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Datum.NAD83">
- <summary>
- North American Datum 1983
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Datum.NAD27">
- <summary>
- North American Datum 1927
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Datum.Potsdam">
- <summary>
- Potsdam Rauenburg 1950 DHDN
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Datum.Carthage">
- <summary>
- Carthage 1934 Tunisia
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Datum.Hermannskogel">
- <summary>
- Hermannskogel
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Datum.Ire65">
- <summary>
- Ireland 1965
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Datum.Nzgd49">
- <summary>
- New Zealand Grid
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Datum.OSGB36">
- <summary>
- Airy 1830
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.Proj4Ellipsoid">
- <summary>
- Proj4Ellipsoids
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.Custom">
- <summary>
- Custom will use the a parameter for the major axis and the
- rf parameter for the flattening divisor
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.Merit_1983">
- <summary>
- MERIT 1983
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.SovietGeodeticSystem_1985">
- <summary>
- Soviet Geodetic System 85
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.GRS_1980">
- <summary>
- Geodetic Reference System 1980(IUGG, 1980)
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.IAU_1976">
- <summary>
- International Astronomical Union 1976
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.Airy_1830">
- <summary>
- Sir George Biddell Airy 1830 (Britain)
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.AppPhysics_1965">
- <summary>
- App. Physics. 1965
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.NavalWeaponsLab_1965">
- <summary>
- Naval Weapons Lab., 1965
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.AiryModified">
- <summary>
- Modified Airy
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.Andrae_1876">
- <summary>
- Andrae 1876 (Den., Iclnd.)
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.Austrailia_SouthAmerica">
- <summary>
- Austrailian National and South American 1969
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.GRS_1967">
- <summary>
- Geodetic Reference System 67 (IUGG 1967)
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.Bessel_1841">
- <summary>
- Bessel 1841
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.BesselNamibia">
- <summary>
- Bessel 1841 (Namibia)
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.Clarke_1866">
- <summary>
- Clarke 1866
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.ClarkeModified_1880">
- <summary>
- Clarke 1880 Modified
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.CPM_1799">
- <summary>
- Comm. des Poids et Mesures 1799
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.Delambre_1810">
- <summary>
- Delambre 1810 (Belgium)
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.Engelis_1985">
- <summary>
- Engelis 1985
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.Everest_1830">
- <summary>
- Everest 1830
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.Everest_1948">
- <summary>
- Everest 1948
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.Everest_1956">
- <summary>
- Everest 1956
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.Everest_1969">
- <summary>
- Everest 1969
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.Everest_SS">
- <summary>
- Everest (Sabah and Sarawak)
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.Everest_Pakistan">
- <summary>
- Everest (Pakistan)
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.Fischer_1960">
- <summary>
- Fischer (Mercury Datum) 1960
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.FischerModified_1960">
- <summary>
- Modified Fischer 1960
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.Fischer_1968">
- <summary>
- Fischer 1968
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.Helmert_1906">
- <summary>
- Helmert 1906
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.Hough">
- <summary>
- Hough
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.Indonesian_1974">
- <summary>
- Indonesian 1974
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.International_1909">
- <summary>
- International 1909
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.Krassovsky_1942">
- <summary>
- Krassovsky 1942
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.Kaula_1961">
- <summary>
- Kaula 1961
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.Lerch_1979">
- <summary>
- Lerch 1979
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.Maupertius_1738">
- <summary>
- Maupertius 1738
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.InternationalNew_1967">
- <summary>
- New International 1967
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.Plessis_1817">
- <summary>
- Plessis 1817 (France)
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.SoutheastAsia">
- <summary>
- Southeast Asia
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.Walbeck">
- <summary>
- Walbekc (Germany)
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.WGS_1960">
- <summary>
- World Geodetic System 1960
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.WGS_1966">
- <summary>
- World Geodetic System 1966
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.WGS_1972">
- <summary>
- World Geodetic System 1972
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.WGS_1984">
- <summary>
- World Geodetic System 1984
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Ellipsoid.Sphere">
- <summary>
- Normal Sphere
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.Proj4Meridian">
- <summary>
- Proj4Meridians
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Meridian.Greenwich">
- <summary>
- Greenwich, England
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Meridian.Lisbon">
- <summary>
- Lisbon, Portugal
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Meridian.Paris">
- <summary>
- Paris, France
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Meridian.Bogota">
- <summary>
- Bogota, Colombia
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Meridian.Madrid">
- <summary>
- Madrid, Spain
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Meridian.Rome">
- <summary>
- Rome, Italy
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Meridian.Bern">
- <summary>
- Berne, Switzerland
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Meridian.Jakarta">
- <summary>
- Jakarta, Indonesia
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Meridian.Ferro">
- <summary>
- Brasil
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Meridian.Brussels">
- <summary>
- Brussels, Belgiuum
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Meridian.Stockholm">
- <summary>
- Stockholm, Sweden
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Meridian.Athens">
- <summary>
- Athens, Greece
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Proj4Meridian.Oslo">
- <summary>
- Oslo, Norway
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectedCategories.Africa">
- <summary>
- Africa
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectedCategories.Africa.#ctor">
- <summary>
- Creates a new instance of Africa
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectedCategories.Asia">
- <summary>
- Asia
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectedCategories.Asia.#ctor">
- <summary>
- Creates a new instance of Asia
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectedCategories.Europe">
- <summary>
- Europe
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectedCategories.Europe.#ctor">
- <summary>
- Creates a new instance of Europe
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectedCategories.GaussKrugerBeijing1954">
- <summary>
- GaussKrugerBeijing1954
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectedCategories.GaussKrugerBeijing1954.#ctor">
- <summary>
- Creates a new instance of GaussKrugerBeijing1954
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectedCategories.GaussKrugerOther">
- <summary>
- GaussKrugerOther
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectedCategories.GaussKrugerOther.#ctor">
- <summary>
- Creates a new instance of GaussKrugerOther
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectedCategories.GaussKrugerPulkovo1942">
- <summary>
- GaussKrugerPulkovo1942
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectedCategories.GaussKrugerPulkovo1942.#ctor">
- <summary>
- Creates a new instance of GaussKrugerPulkovo1942
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectedCategories.GaussKrugerPulkovo1995">
- <summary>
- GaussKrugerPulkovo1995
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectedCategories.GaussKrugerPulkovo1995.#ctor">
- <summary>
- Creates a new instance of GaussKrugerPulkovo1995
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectedCategories.KrugerXian1980">
- <summary>
- KrugerZian1980
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectedCategories.KrugerXian1980.#ctor">
- <summary>
- Creates a new instance of KrugerZian1980
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectedCategories.Minnesota">
- <summary>
- Not sure why we have all these county based Minnesota and Wisconsin projections
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectedCategories.Minnesota.#ctor">
- <summary>
- Creates a new instance of Minnesota
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectedCategories.Nad1983IntlFeet">
- <summary>
- Nad1983IntlFeet
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectedCategories.Nad1983IntlFeet.#ctor">
- <summary>
- Creates a new instance of Nad1983IntlFeet
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectedCategories.NationalGrids">
- <summary>
- NationalGrids
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectedCategories.NationalGrids.#ctor">
- <summary>
- Creates a new instance of NationalGrids
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectedCategories.NationalGridsAustralia">
- <summary>
- NatGridsAustralia
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectedCategories.NationalGridsAustralia.#ctor">
- <summary>
- Creates a new instance of NatGridsAustralia
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectedCategories.NationalGridsCanada">
- <summary>
- NationalGridsCanada
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectedCategories.NationalGridsCanada.#ctor">
- <summary>
- Creates a new instance of NationalGridsCanada
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectedCategories.NationalGridsIndia">
- <summary>
- IndianSubcontinent
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectedCategories.NationalGridsIndia.#ctor">
- <summary>
- Creates a new instance of IndianSubcontinent
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectedCategories.NationalGridsJapan">
- <summary>
- NationalGridsJapan
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectedCategories.NationalGridsJapan.#ctor">
- <summary>
- Creates a new instance of NationalGridsJapan
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectedCategories.NationalGridsNewZealand">
- <summary>
- NationalGridsNewZealand
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectedCategories.NationalGridsNewZealand.#ctor">
- <summary>
- Creates a new instance of NationalGridsNewZealand
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectedCategories.NationalGridsNorway">
- <summary>
- NationalGridsNorway
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectedCategories.NationalGridsNorway.#ctor">
- <summary>
- Creates a new instance of NationalGridsNorway
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectedCategories.NationalGridsSweden">
- <summary>
- NationalGridsSweden
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectedCategories.NationalGridsSweden.#ctor">
- <summary>
- Creates a new instance of NationalGridsSweden
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectedCategories.NorthAmerica">
- <summary>
- NorthAmerica
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectedCategories.NorthAmerica.#ctor">
- <summary>
- Creates a new instance of NorthAmerica
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectedCategories.Polar">
- <summary>
- Polar
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectedCategories.Polar.#ctor">
- <summary>
- Creates a new instance of Polar
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectedCategories.SouthAmerica">
- <summary>
- SouthAmerica
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectedCategories.SouthAmerica.#ctor">
- <summary>
- Creates a new instance of SouthAmerica
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectedCategories.SpheroidBased">
- <summary>
- SpheroidBased
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.ProjectedCategories.SpheroidBased.Lambert2">
- <summary>
- Lambert 2 (Central France)
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.ProjectedCategories.SpheroidBased.Lambert2Wide">
- <summary>
- Lambert 2 (Étendu)
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectedCategories.SpheroidBased.#ctor">
- <summary>
- Creates a new instance of SpheroidBased
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectedCategories.StatePlaneNad1927">
- <summary>
- StatePlaneNad1927
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectedCategories.StatePlaneNad1927.#ctor">
- <summary>
- Creates a new instance of StatePlaneNad1927
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectedCategories.StatePlaneNad1983">
- <summary>
- StatePlaneNad1983
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.ProjectedCategories.StatePlaneNad1983.MichiganGeoRef2008">
- <summary>
- Michigan Geo Ref 2008
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.ProjectedCategories.StatePlaneNad1983.NAD1983Maine2000CentralZone">
- <summary>
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectedCategories.StatePlaneNad1983.#ctor">
- <summary>
- Creates a new instance of StatePlaneNad1983
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectedCategories.StatePlaneNad1983Feet">
- <summary>
- StatePlaneNad1983Feet
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectedCategories.StatePlaneNad1983Feet.#ctor">
- <summary>
- Creates a new instance of StatePlaneNad1983Feet
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectedCategories.StatePlaneNad1983Harn">
- <summary>
- StatePlaneNad1983Harn
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectedCategories.StatePlaneNad1983Harn.#ctor">
- <summary>
- Creates a new instance of StatePlaneNad1983Harn
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectedCategories.StatePlaneNad1983HarnFeet">
- <summary>
- StatePlaneNad1983HarnFeet
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectedCategories.StatePlaneNad1983HarnFeet.#ctor">
- <summary>
- Creates a new instance of StatePlaneNad1983HarnFeet
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectedCategories.StatePlaneOther">
- <summary>
- StatePlaneOther
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectedCategories.StatePlaneOther.#ctor">
- <summary>
- Creates a new instance of StatePlaneOther
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectedCategories.StateSystems">
- <summary>
- StateSystems
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectedCategories.StateSystems.#ctor">
- <summary>
- Creates a new instance of StateSystems
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectedCategories.TransverseMercatorSystems">
- <summary>
- TransverseMercator
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectedCategories.TransverseMercatorSystems.#ctor">
- <summary>
- Creates a new instance of TransverseMercator
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectedCategories.UtmNad1927">
- <summary>
- UtmNad1927
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectedCategories.UtmNad1927.#ctor">
- <summary>
- Creates a new instance of UtmNad1927
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectedCategories.UtmNad1983">
- <summary>
- UtmNad1983
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectedCategories.UtmNad1983.#ctor">
- <summary>
- Creates a new instance of UtmNad1983
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectedCategories.UtmOther">
- <summary>
- UtmOther
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectedCategories.UtmOther.#ctor">
- <summary>
- Creates a new instance of UtmOther
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectedCategories.UtmWgs1972">
- <summary>
- UtmWgs1972
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectedCategories.UtmWgs1972.#ctor">
- <summary>
- Creates a new instance of UtmWgs1972
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectedCategories.UtmWgs1984">
- <summary>
- UtmWgs1984
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectedCategories.UtmWgs1984.#ctor">
- <summary>
- Creates a new instance of UtmWgs1984
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectedCategories.Wisconsin">
- <summary>
- Wisconsin
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectedCategories.Wisconsin.#ctor">
- <summary>
- Creates a new instance of Wisconsin
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectedCategories.World">
- <summary>
- World
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectedCategories.World.#ctor">
- <summary>
- Creates a new instance of World
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectedCategories.WorldSpheroid">
- <summary>
- WorldSpheroid
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectedCategories.WorldSpheroid.#ctor">
- <summary>
- Creates a new instance of WorldSpheroid
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectedSystems">
- <summary>
- Projected
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectedSystems.GetCategory(System.String)">
- <summary>
- Given the string name, this will return the specified coordinate category
- </summary>
- <param name="name"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Projections.ProjectedSystems.Names">
- <summary>
- Gets an array of all the names of the coordinate system categories
- in this collection of systems.
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectionException">
- <summary>
- ProjectionErrorCodes
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectionException.#ctor(System.Int32)">
- <summary>
- Creates a new projection exception with the appropriate message code
- </summary>
- <param name="errorCode"></param>
- </member>
- <member name="M:DotSpatial.Projections.ProjectionException.#ctor(System.String)">
- <summary>
- Creates a new projection exception with the specified message
- </summary>
- <param name="message"></param>
- </member>
- <member name="M:DotSpatial.Projections.ProjectionException.GetMessage(System.Int32)">
- <summary>
- Returns a string message given the correct numeric code.
- </summary>
- <param name="projectionCode"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionException.ErrorCode">
- <summary>
- Gets the error code that was used when this exception was created
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectionInfo">
- <summary>
- Parameters based on http://trac.osgeo.org/proj/wiki/GenParms. Also, see http://home.comcast.net/~gevenden56/proj/manual.pdf
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectionInfo.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Projections.ProjectionInfo"/> class.
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectionInfo.ToEsriString">
- <summary>
- Expresses the entire projection as the Esri well known text format that can be found in .prj files
- </summary>
- <returns>
- The generated string
- </returns>
- </member>
- <member name="M:DotSpatial.Projections.ProjectionInfo.FromEpsgCode(System.Int32)">
- <summary>
- Using the specified code, this will attempt to look up the related reference information
- from the appropriate pcs code.
- </summary>
- <param name="epsgCode">
- The epsg Code.
- </param>
- <exception cref="T:System.ArgumentOutOfRangeException">Throws when there is no projection for given epsg code</exception>
- </member>
- <member name="M:DotSpatial.Projections.ProjectionInfo.FromAuthorityCode(System.String,System.Int32)">
- <summary>
- Using the specified code, this will attempt to look up the related reference information from the appropriate authority code.
- </summary>
- <param name="authority"> The authority. </param>
- <param name="code"> The code. </param>
- <returns>ProjectionInfo</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">Throws when there is no projection for given authority and code</exception>
- </member>
- <member name="M:DotSpatial.Projections.ProjectionInfo.FromEsriString(System.String)">
- <summary>
- Parses the entire projection from an Esri string. In some cases, this will have
- default projection information since only geographic information is obtained.
- </summary>
- <param name="esriString">
- The Esri string to parse
- </param>
- </member>
- <member name="M:DotSpatial.Projections.ProjectionInfo.FromProj4String(System.String)">
- <summary>
- Creates a new projection and automatically reads in the proj4 string
- </summary>
- <param name="proj4String">
- The proj4String to read in while defining the projection
- </param>
- </member>
- <member name="M:DotSpatial.Projections.ProjectionInfo.Open(System.String)">
- <summary>
- Open a given prj fileName
- </summary>
- <param name="prjFilename">
- </param>
- </member>
- <member name="M:DotSpatial.Projections.ProjectionInfo.Equals(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Gets a boolean that is true if the Esri WKT string created by the projections matches.
- There are multiple ways to write the same projection, but the output Esri WKT string
- should be a good indicator of whether or not they are the same.
- </summary>
- <param name="other">
- The other projection to compare with.
- </param>
- <returns>
- Boolean, true if the projections are the same.
- </returns>
- </member>
- <member name="M:DotSpatial.Projections.ProjectionInfo.GetUnitText(System.Double)">
- <summary>
- If this is a geographic coordinate system, this will show decimal degrees. Otherwise,
- this will show the linear unit units.
- </summary>
- <param name="quantity">
- The quantity.
- </param>
- <returns>
- The get unit text.
- </returns>
- </member>
- <member name="M:DotSpatial.Projections.ProjectionInfo.SaveAs(System.String)">
- <summary>
- Exports this projection info by saving it to a *.prj file.
- </summary>
- <param name="prjFilename">
- The prj file to save to
- </param>
- </member>
- <member name="M:DotSpatial.Projections.ProjectionInfo.ToProj4String">
- <summary>
- Returns a representaion of this object as a Proj4 string.
- </summary>
- <returns>
- The to proj 4 string.
- </returns>
- </member>
- <member name="M:DotSpatial.Projections.ProjectionInfo.ToString">
- <summary>
- This overrides ToString to get the Esri name of the projection.
- </summary>
- <returns>
- The to string.
- </returns>
- </member>
- <member name="M:DotSpatial.Projections.ProjectionInfo.ParseProj4String(System.String)">
- <summary>
- Attempts to parse known parameters from the set of proj4 parameters
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.ProjectionInfo.TryParseEsriString(System.String)">
- <summary>
- This will try to read the string, but if the validation fails, then it will return false,
- rather than throwing an exception.
- </summary>
- <param name="esriString">
- The string to test and define this projection if possible.
- </param>
- <returns>
- Boolean, true if at least the GEOGCS tag was found.
- </returns>
- </member>
- <member name="M:DotSpatial.Projections.ProjectionInfo.ParseEsriString(System.String)">
- <summary>
- Re-sets the parameters of this projection info by parsing the esri projection string
- </summary>
- <param name="esriString">The projection information string in Esri WKT format</param>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.Authority">
- <summary>
- Gets or sets the athority, for example EPSG
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.AuthorityCode">
- <summary>
- Gets or sets the athority code
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.AuxiliarySphereType">
- <summary>
- Gets or sets the auxiliary sphere type.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.CentralMeridian">
- <summary>
- The horizontal 0 point in geographic terms
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.EpsgCode">
- <summary>
- Gets or sets the Reference Code
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.FalseEasting">
- <summary>
- The false easting for this coordinate system
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.FalseNorthing">
- <summary>
- The false northing for this coordinate system
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.Geoc">
- <summary>
- Gets or sets a boolean indicating a geocentric latitude parameter
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.GeographicInfo">
- <summary>
- The geographic information
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.IsGeocentric">
- <summary>
- Gets or sets a boolean that indicates whether or not this
- projection is geocentric.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.IsLatLon">
- <summary>
- True if this coordinate system is expressed only using geographic coordinates
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.IsSouth">
- <summary>
- Gets or sets a boolean indicating whether this projection applies to the
- southern coordinate system or not.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.IsValid">
- <summary>
- True if the transform is defined. That doesn't really mean it accurately represents the named
- projection, but rather it won't throw a null exception during transformation for the lack of
- a transform definition.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.LatitudeOfOrigin">
- <summary>
- The zero point in geographic terms
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.LongitudeOfCenter">
- <summary>
- The longitude of center for this coordinate system
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.M">
- <summary>
- Gets or sets the M.
- </summary>
- <value>
- The M.
- </value>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.Name">
- <summary>
- Gets or sets the name of this projection information
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.NoDefs">
- <summary>
- A boolean that indicates whether to use the /usr/share/proj/proj_def.dat defaults file (proj4 parameter "no_defs").
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.Over">
- <summary>
- Gets or sets a boolean for the over-ranging flag
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.ScaleFactor">
- <summary>
- The scale factor for this coordinate system
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.StandardParallel1">
- <summary>
- The line of latitude where the scale information is preserved.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.StandardParallel2">
- <summary>
- The standard parallel 2.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.Transform">
- <summary>
- Gets or sets the transform that converts between geodetic coordinates and projected coordinates.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.Unit">
- <summary>
- The unit being used for measurements.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.W">
- <summary>
- Gets or sets the w.
- </summary>
- <value>
- The w.
- </value>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.Zone">
- <summary>
- Gets or sets the integer zone parameter if it is specified.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.alpha">
- <summary>
- Gets or sets the alpha/ azimuth.
- </summary>
- <value>
- ? Used with Oblique Mercator and possibly a few others. For our purposes this is exactly the same as azimuth
- </value>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.bns">
- <summary>
- Gets or sets the BNS.
- </summary>
- <value>
- The BNS.
- </value>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.czech">
- <summary>
- Gets or sets the czech.
- </summary>
- <value>
- The czech.
- </value>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.guam">
- <summary>
- Gets or sets the guam.
- </summary>
- <value>
- The guam.
- </value>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.h">
- <summary>
- Gets or sets the h.
- </summary>
- <value>
- The h.
- </value>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.lat_ts">
- <summary>
- Gets or sets the lat_ts.
- </summary>
- <value>
- Latitude of true scale.
- </value>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.lon_1">
- <summary>
- Gets or sets the lon_1.
- </summary>
- <value>
- The lon_1.
- </value>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.lon_2">
- <summary>
- Gets or sets the lon_2.
- </summary>
- <value>
- The lon_2.
- </value>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.lonc">
- <summary>
- Gets or sets the lonc.
- </summary>
- <value>
- The lonc.
- </value>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.mGeneral">
- <summary>
- Gets or sets the m. Named mGeneral to prevent CLS conflicts.
- </summary>
- <value>
- The m.
- </value>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.n">
- <summary>
- Gets or sets the n.
- </summary>
- <value>
- The n.
- </value>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.no_rot">
- <summary>
- Gets or sets the no_rot.
- </summary>
- <value>
- The no_rot. Seems to be used as a boolean.
- </value>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.no_uoff">
- <summary>
- Gets or sets the no_uoff.
- </summary>
- <value>
- The no_uoff. Seems to be used as a boolean.
- </value>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.rot_conv">
- <summary>
- Gets or sets the rot_conv.
- </summary>
- <value>
- The rot_conv. Seems to be used as a boolean.
- </value>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.to_meter">
- <summary>
- Gets or sets the to_meter.
- </summary>
- <value>
- Multiplier to convert map units to 1.0m
- </value>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.Lam1">
- <summary>
- Gets the lon_1 parameter in radians
- </summary>
- <returns>
- The get lam 1.
- </returns>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.Lam2">
- <summary>
- Gets the lon_2 parameter in radians
- </summary>
- <returns>
- The get lam 2.
- </returns>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.Phi1">
- <summary>
- Gets the lat_1 parameter multiplied by radians
- </summary>
- <returns>
- The get phi 1.
- </returns>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.Phi2">
- <summary>
- Gets the lat_2 parameter multiplied by radians
- </summary>
- <returns>
- The get phi 2.
- </returns>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.Lam0">
- <summary>
- Sets the lambda 0, or central meridian in radial coordinates
- </summary>
- <param name="value">
- The value of Lambda 0 in radians
- </param>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionInfo.Phi0">
- <summary>
- Sets the phi 0 or latitude of origin in radial coordinates
- </summary>
- <param name="value">
- </param>
- </member>
- <member name="T:DotSpatial.Projections.InvalidEsriFormatException">
- <summary>
- Validation exception for Esri string.
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.InvalidEsriFormatException.#ctor(System.String)">
- <summary>
- Initializes a new instance of an invlaidEsriFormatException.
- </summary>
- <param name="projectionString">The text string that failed validation.</param>
- </member>
- <member name="P:DotSpatial.Projections.InvalidEsriFormatException.ProjectionString">
- <summary>
- Gets the string that had the invalid format.
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectionMessages">
- <summary>
- A strongly-typed resource class, for looking up localized strings, etc.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.ResourceManager">
- <summary>
- Returns the cached ResourceManager instance used by this class.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Culture">
- <summary>
- Overrides the current thread's CurrentUICulture property for all
- resource lookups using this strongly typed resource class.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.DuplicateTableName">
- <summary>
- Looks up a localized string similar to The name %S was found for more than one lla Table in the Nad folder..
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err1_NoArguments">
- <summary>
- Looks up a localized string similar to No arguments in initialization list.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err10_ZeroRecFlattening">
- <summary>
- Looks up a localized string similar to The reciprocal flattening (1/f) = 0.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err11_LatitudeOutOfBounds">
- <summary>
- Looks up a localized string similar to The Latitude was greater than 90 or less than -90.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err12_ESquareNegative">
- <summary>
- Looks up a localized string similar to The square of eccentricity cannot be a negative value..
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err13_NoMajorRadius">
- <summary>
- Looks up a localized string similar to The given semi-major axis was 0 or not given..
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err14_LatLonOutOfBounds">
- <summary>
- Looks up a localized string similar to The Latitude or Longitude exceeded limits.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err15_InvalidXY">
- <summary>
- Looks up a localized string similar to The cartesian X or Y coordinate was invalid.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err16_ImproperDMS">
- <summary>
- Looks up a localized string similar to The Degree Minute Second value is formed imporperly.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err17_NonConvergentRMeridDist">
- <summary>
- Looks up a localized string similar to The inverse meridinal distance was non-convergent.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err18_NonConvergentRPhi2">
- <summary>
- Looks up a localized string similar to The inverse Phi2 value was non-converngent.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err19_TrigException">
- <summary>
- Looks up a localized string similar to The ArcCosign or ArcSign value was too large..
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err2_NoOptions">
- <summary>
- Looks up a localized string similar to No options found in 'init' file.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err20_ToleranceConditionError">
- <summary>
- Looks up a localized string similar to Tolerance Condition Error.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err21_ConicLatitudeError">
- <summary>
- Looks up a localized string similar to The conic lat_1 value cannot be its -lat_2.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err22_Lat1TooLarge">
- <summary>
- Looks up a localized string similar to Latitude 1 cannot be greater than or equal to 90.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err23_Lat1TooSmall">
- <summary>
- Looks up a localized string similar to Latitude 2 cannot be equal to 0.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err24_Lat_tsTooLarge">
- <summary>
- Looks up a localized string similar to The lat_ts parameter cannot be greater than or equal to 90.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err25_NoControlPtSeparation">
- <summary>
- Looks up a localized string similar to There was no distance between the control points.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err26_ProjectionNotRotated">
- <summary>
- Looks up a localized string similar to Projection not selected to be rotated.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err27_WorMTooSmall">
- <summary>
- Looks up a localized string similar to W <= 0 or M <= 0.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err28_LsatOutOfBounds">
- <summary>
- Looks up a localized string similar to lsat not in 1-5 range.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err29_PathNotInRange">
- <summary>
- Looks up a localized string similar to Path not in range.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err3_NoColon">
- <summary>
- Looks up a localized string similar to No colon in init= string.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err30_HTooSmall">
- <summary>
- Looks up a localized string similar to H was negative or 0.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err31_KTooSmall">
- <summary>
- Looks up a localized string similar to K was less than 0.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err32_LatOutOfBounds">
- <summary>
- Looks up a localized string similar to The central latitude was 0 or 90 or alpha = 90.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err33_InvalidLatitudes">
- <summary>
- Looks up a localized string similar to Lat_1 = lat_2 or lat_1 = 0 or lat_2 = 90.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err34_EllipticalRequired">
- <summary>
- Looks up a localized string similar to Elliptical Usage Required.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err35_InvalidUTMZone">
- <summary>
- Looks up a localized string similar to The UTM zone parameter was invalid.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err36_TchebyException">
- <summary>
- Looks up a localized string similar to The arguments were out of range for Tcheby eval.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err37_ProjNotFound">
- <summary>
- Looks up a localized string similar to Projection Not Found.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err38_CorrectionNotFound">
- <summary>
- Looks up a localized string similar to Failed to load NAD27-83 correction file.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err39_NorMnotSpecified">
- <summary>
- Looks up a localized string similar to Both n and m must be specified and > 0.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err4_NotNamed">
- <summary>
- Looks up a localized string similar to Projection not named.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err40_InvalidN">
- <summary>
- Looks up a localized string similar to N<= 0, n > 1 or not specified.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err41_Lat1OrLat2Missing">
- <summary>
- Looks up a localized string similar to lat_1 or lat_2 not specified.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err42_Lat1EqualsLat2">
- <summary>
- Looks up a localized string similar to |lat_1| =|lat_2| .
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err43_MeanLatError">
- <summary>
- Looks up a localized string similar to lat_0 is pi/2 from mean lat.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err44_CoordinateUnreadable">
- <summary>
- Looks up a localized string similar to Failed to parse coordinate system definition.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err45_GeocentricMissingZ">
- <summary>
- Looks up a localized string similar to Geocentric transformation missing z or ellips.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err46_UknownPMID">
- <summary>
- Looks up a localized string similar to Uknown prime meridian conversion ID.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err5_UknownProjection">
- <summary>
- Looks up a localized string similar to UnknownProjectionId.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err6_EffectiveEccentricity1">
- <summary>
- Looks up a localized string similar to Effective eccentricity = 1.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err7_UknownUnitID">
- <summary>
- Looks up a localized string similar to Unkown unit conversion ID.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err8_Invalidboolean">
- <summary>
- Looks up a localized string similar to Invalid boolean parameter argument.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.Err9_UknownEllipse">
- <summary>
- Looks up a localized string similar to The elliptical parameter ellps= was unkown.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.IndexMismatch">
- <summary>
- Looks up a localized string similar to There was an index mismatch problem with the specified file..
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.InverseShiftFailed">
- <summary>
- Looks up a localized string similar to Inverse grid shift iteration faield, presumably at grid edge. Using first approximation..
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionMessages.InvShiftConvergeFailed">
- <summary>
- Looks up a localized string similar to Inverse grid shift iterator failed to converge..
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjectionNames">
- <summary>
- A strongly-typed resource class, for looking up localized strings, etc.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionNames.ResourceManager">
- <summary>
- Returns the cached ResourceManager instance used by this class.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionNames.Culture">
- <summary>
- Overrides the current thread's CurrentUICulture property for all
- resource lookups using this strongly typed resource class.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.ProjectionNames.Michigan">
- <summary>
- Looks up a localized string similar to Michigan GeoRef (2008).
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.Reproject">
- <summary>
- Reproject
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Reproject.ReprojectAffine(System.Double[],System.Double,System.Double,DotSpatial.Projections.ProjectionInfo,DotSpatial.Projections.ProjectionInfo)">
- <summary>
- This method reprojects the affine transform coefficients. This is used for projection on the fly,
- where image transforms can take advantage of an affine projection, but does not have the power of
- a full projective transform and gets less and less accurate as the image covers larger and larger
- areas. Since most image layers represent small rectangular areas, this should not be a problem in
- most cases. the affine array should be ordered as follows:
- X' = [0] + [1] * Column + [2] * Row
- Y' = [3] + [4] * Column + [5] * Row
- </summary>
- <param name="affine">The array of double affine coefficients.</param>
- <param name="numRows">The number of rows to use for the lower bounds. Value of 0 or less will be set to 1.</param>
- <param name="numCols">The number of columns to use to get the right bounds. Values of 0 or less will be set to 1.</param>
- <param name="source"></param>
- <param name="dest"></param>
- <returns>The transformed coefficients</returns>
- </member>
- <member name="M:DotSpatial.Projections.Reproject.ReprojectPoints(System.Double[],System.Double[],DotSpatial.Projections.ProjectionInfo,DotSpatial.Projections.ProjectionInfo,System.Int32,System.Int32)">
- <summary>
-
- </summary>
- <param name="xy">The xy array should be in interleaved set of xy coordinates like [x1, y1, x2, y2, ... xn, yn]</param>
- <param name="z">The z array is the array of all the z values</param>
- <param name="source"></param>
- <param name="dest"></param>
- <param name="startIndex"></param>
- <param name="numPoints"></param>
- </member>
- <member name="M:DotSpatial.Projections.Reproject.ReprojectPoints(System.Double[],System.Double[],DotSpatial.Projections.ProjectionInfo,System.Double,DotSpatial.Projections.ProjectionInfo,System.Double,DotSpatial.Projections.IDatumTransform,System.Int32,System.Int32)">
- <summary>
-
- </summary>
- <param name="xy">The xy array should be in interleaved set of xy coordinates like [x1, y1, x2, y2, ... xn, yn]</param>
- <param name="z">The z array is the array of all the z values</param>
- <param name="source"></param>
- <param name="srcZtoMeter"></param>
- <param name="dest"></param>
- <param name="dstZtoMeter"></param>
- <param name="idt"></param>
- <param name="startIndex"></param>
- <param name="numPoints"></param>
- </member>
- <member name="T:DotSpatial.Projections.Spheroid">
- <summary>
- Spheroid (Defaults to WGS84)
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Spheroid.#ctor">
- <summary>
- Creates a new instance of Spheroid
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Spheroid.#ctor(System.Double,System.Double)">
- <summary>
- Creates a new spheroid using an the equatorial radius in meters and
- a flattening coefficient that is the inverse flattening factor.
- eg. for WGS84 (6378137.0, 298.257223563)
- </summary>
- <param name="equatorialRadius">The semi-major axis</param>
- <param name="inverseFlattening">The inverse of the flattening factor</param>
- </member>
- <member name="M:DotSpatial.Projections.Spheroid.#ctor(System.Double)">
- <summary>
- For perfect spheres, you just need to specify one radius, which will be
- applied to both radii. You can then directly change the polar or
- equatorial radius if necessary using the properties.
- </summary>
- <param name="radius">The radius of the sphere</param>
- </member>
- <member name="M:DotSpatial.Projections.Spheroid.#ctor(DotSpatial.Projections.Proj4Ellipsoid)">
- <summary>
- The ellps parameter in a proj4 string will only work with certain
- pre-defined spheroids, enumerated in the Proj4Ellipsoids enumeration.
- Custom spheroids can be specified but will use the a and b parameters
- when creating a proj4 parameter instead of using the ellps parameter.
- </summary>
- <param name="knownEllipse">Any of several predefined geographic ellipses</param>
- </member>
- <member name="M:DotSpatial.Projections.Spheroid.#ctor(System.String)">
- <summary>
- Given the proj4 code, this will set the radii correctly.
- </summary>
- <param name="proj4Ellips"></param>
- </member>
- <member name="M:DotSpatial.Projections.Spheroid.ReadSedrisCode(System.String)">
- <summary>
- Assigns a known projection that is defined by a two character SEDRIS code,
- using nothing but that code.
- </summary>
- <param name="code">The two character SEDRIS code defining 22 distinct ellipsoids.</param>
- </member>
- <member name="M:DotSpatial.Projections.Spheroid.AssignKnownEllipsoid(DotSpatial.Projections.Proj4Ellipsoid)">
- <summary>
- Given the enumeration of known ellipsoids, this will redefine this spheroid
- so that it matches the A and B coefficients for the known ellipsoids.
- </summary>
- <param name="knownEllipse">The known Ellipse</param>
- </member>
- <member name="M:DotSpatial.Projections.Spheroid.FlatteningFactor">
- <summary>
- Calculates the flattening factor, (a - b) / a.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Projections.Spheroid.ToProj4String">
- <summary>
- Uses the current known ellipsoid to return a code name for the proj4 string if possible.
- Otherwise, this returns the radial parameters a and b.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Projections.Spheroid.Eccentricity">
- <summary>
- Calculates the eccentrity according to e = sqrt(2f - f^2) where f is the flattening factor.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Projections.Spheroid.EccentricitySquared">
- <summary>
- Calculates the square of eccentricity according to es = (2f - f^2) where f is the flattening factor.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Projections.Spheroid.GetInverseFlattening">
- <summary>
- Calculates the inverse of the flattening factor, commonly saved to Esri projections,
- or else provided as the "rf" parameter for Proj4 strings. This is simply calculated
- as a / (a - b) where a is the semi-major axis and b is the semi-minor axis.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Projections.Spheroid.IsOblate">
- <summary>
- Gets a boolean that is true if the spheroid has been flattened.
- </summary>
- <returns>Boolean, true if the spheroid is oblate (or flattened)</returns>
- </member>
- <member name="M:DotSpatial.Projections.Spheroid.ToEsriString">
- <summary>
- Converts the spheroid parameters into a valid esri expression that uses the semi-major axis
- and the reciprocal flattening factor
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Projections.Spheroid.ParseEsriString(System.String)">
- <summary>
- Reads the Esri string to define the spheroid, which controls how flattened the earth's radius is
- </summary>
- <param name="esriString"></param>
- </member>
- <member name="P:DotSpatial.Projections.Spheroid.Code">
- <summary>
- Gets or sets the two character Synthetic Environment Data
- Representation and Interchange Specification (SEDRIS) code
- eg. AA represents Airy 1830. Setting this will not modify the values,
- To read a SEDRIS Code use the constructor or AssignKnownEllipsoid overload.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Spheroid.Proj4Names">
- <summary>
- Each of the enumerated known ellipsoids is encoded by an ellps parameter specified by
- the corresponding string value. Ellipsoids that are not found here or are specified
- as "Custom" in the enuemration will be replaced with an 'a' and a 'b' parameter instead.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Spheroid.InverseFlattening">
- <summary>
- Sets the value by using the current semi-major axis (Equatorial Radius) in order to
- calculate the semi-minor axis (Polar Radius).
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Spheroid.Name">
- <summary>
- Gets or sets the string name of the spheroid.
- e.g.: WGS_1984
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Spheroid.EquatorialRadius">
- <summary>
- A spheroid is a pole flattened (oblate) sphere, with the radii of two axes being equal and longer
- than the third. This is the radial measure of one of these major axes in meters.
- e.g. 6, 378, 137 for WGS 84
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Spheroid.PolarRadius">
- <summary>
- A spheroid is a pole flattened (oblate) sphere, with the radii of two axes being equal and longer
- than the third. This is the radial measure of the smaller polar axis in meters. One option is
- to specify this directly, but it can also be calculated using the major axis and the flattening factor.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Spheroid.KnownEllipsoid">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.Aitoff">
- <summary>
- Aitoff
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.Transform">
- <summary>
- TransverseMercator is a class allowing the transverse mercator transform as transcribed
- from the 4.6 version of the Proj4 library (pj_tmerc.c)
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.ITransform">
- <summary>
- ITransform
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.ITransform.Init(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the parameters from the projection info
- </summary>
- <param name="proj">The projection information used to control this transform</param>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.ITransform.Forward(System.Double[],System.Int32,System.Int32)">
- <summary>
- Transforms all the coordinates by cycling through them in a loop,
- transforming each one. Only the 0 and 1 values of each coordinate will be
- transformed, higher dimensional values will be copied.
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.ITransform.Inverse(System.Double[],System.Int32,System.Int32)">
- <summary>
- Transforms all the coordinates by cycling through them in a loop,
- transforming each one. Only the 0 and 1 values of each coordinate will be
- transformed, higher dimensional values will be copied.
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.ITransform.Special(System.Double[],DotSpatial.Projections.ProjectionInfo,DotSpatial.Projections.Transforms.Factors)">
- <summary>
- Special factor calculations for a factors calculation
- </summary>
- <param name="lp"></param>
- <param name="p"></param>
- <param name="fac"></param>
- </member>
- <member name="P:DotSpatial.Projections.Transforms.ITransform.Name">
- <summary>
- Gets or sets the string name of this projection. This should uniquely define the projection,
- and controls what appears in the .prj files. This name is required.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Transforms.ITransform.Proj4Name">
- <summary>
- Gets or sets the string name of this projection as it is known to proj4, or should appear
- in a proj4 string. This name is required to read and write to proj4 strings.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Transforms.ITransform.Proj4Aliases">
- <summary>
- This is the list of alternate names to check besides the Proj4Name. This will not be used
- for writing Proj4 strings, but may be helpful for reading them.
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.Transform.HALF_PI">
- <summary>
- Pi/2
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.Transform.FORT_PI">
- <summary>
- Math.Pi / 4
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.Transform.TWO_PI">
- <summary>
- 2 * Math.Pi
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.Transform.EPS10">
- <summary>
- 1E-10
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.Transform.IS_ANAL_HK">
- <summary>
- Analytic Hk
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.Transform.IS_ANAL_CONV">
- <summary>
- Analytic Conv
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.Transform.IS_ANAL_XL_YL">
- <summary>
- Analytic Xl Yl
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.Transform.IS_ANAL_XP_YP">
- <summary>
- Analytic Xp Yp
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.Transform.RAD_TO_DEG">
- <summary>
- Radians to Degrees
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.Transform.DEG_TO_RAD">
- <summary>
- Degrees to Radians
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.Transform.LAMBDA">
- <summary>
- The integer index representing lambda values in arrays representing geodetic coordinates
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.Transform.PHI">
- <summary>
- The integer index representing phi values in arrays representing geodetic coordinates
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.Transform.X">
- <summary>
- The integer index representing X values in arrays representing linear coordinates
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.Transform.Y">
- <summary>
- The integer index representing Y values in arrays representing linear coordinates
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.Transform.R">
- <summary>
- The integer index representing real values in arrays representing complex numbers
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.Transform.I">
- <summary>
- The integer index representing immaginary values in arrays representing complex numbers
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Transform.Init(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the parameters from the projection info
- </summary>
- <param name="projectionInfo">The projection information used to control this transform</param>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Transform.Forward(System.Double[],System.Int32,System.Int32)">
- <summary>
- Transforms all the coordinates by cycling through them in a loop,
- transforming each one. Only the 0 and 1 values of each coordinate will be
- transformed, higher dimensional values will be copied.
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Transform.Inverse(System.Double[],System.Int32,System.Int32)">
- <summary>
- Transforms all the coordinates by cycling through them in a loop,
- transforming each one. Only the 0 and 1 values of each coordinate will be
- transformed, higher dimensional values will be copied.
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Transform.Special(System.Double[],DotSpatial.Projections.ProjectionInfo,DotSpatial.Projections.Transforms.Factors)">
- <summary>
- Special factor calculations for a factors calculation
- </summary>
- <param name="lp">lambda-phi</param>
- <param name="p">The projection</param>
- <param name="fac">The Factors</param>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Transform.FromKnownTransform(DotSpatial.Projections.Transforms.KnownTransform)">
- <summary>
- Uses an enumeration to generate a new instance of a known transform class
- </summary>
- <param name="value">The member of the KnownTransforms to instantiate</param>
- <returns>A new ITransform interface representing the specific transform</returns>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Transform.OnSpecial(System.Double[],DotSpatial.Projections.ProjectionInfo,DotSpatial.Projections.Transforms.Factors)">
- <summary>
- Allows for some custom code during a process method
- </summary>
- <param name="lp">lambda-phi</param>
- <param name="p">The projection coordinate system information</param>
- <param name="fac">The Factors</param>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Transform.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Transform.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <summary>
- Transforms cartesian x, y to geodetic lambda, phi
- </summary>
- <param name="lp">in -> the lambda, phi coordinates</param>
- <param name="xy">out -> the cartesian x, y</param>
- <param name="startIndex">The zero based starting point index. If this is 1, for instance, reading will skip the x and y of the first point and start at the second point.</param>
- <param name="numPoints">The integer count of the pairs of xy values to consider.</param>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Transform.OnInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <summary>
- The inverse transform from linear units to geodetic units
- </summary>
- <param name="xy">The double values for the input x and y values stored in an array</param>
- <param name="lp">The double values for the output lambda and phi values stored in an array</param>
- <param name="startIndex">The zero based starting point index. If this is 1, for instance, reading will skip the x and y of the first point and start at the second point.</param>
- <param name="numPoints">The integer count of the pairs of xy values to consider</param>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Transform.Clone">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Projections.Transforms.Transform.A">
- <summary>
- The major axis
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Transforms.Transform.Ra">
- <summary>
- 1/a
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Transforms.Transform.OneEs">
- <summary>
- 1 - e^2;
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Transforms.Transform.ROneEs">
- <summary>
- 1/OneEs
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Transforms.Transform.E">
- <summary>
- Eccentricity
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Transforms.Transform.IsElliptical">
- <summary>
- True if the spheroid is flattened
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Transforms.Transform.Es">
- <summary>
- Eccentricity Squared
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Transforms.Transform.Phi0">
- <summary>
- Central Latitude
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Transforms.Transform.Lam0">
- <summary>
- Central Longitude
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Transforms.Transform.X0">
- <summary>
- False Easting
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Transforms.Transform.Y0">
- <summary>
- False Northing
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Transforms.Transform.K0">
- <summary>
- Scaling Factor
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Transforms.Transform.ToMeter">
- <summary>
- Scaling to meter
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Transforms.Transform.FromMeter">
- <summary>
- Scaling from meter
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Transforms.Transform.B">
- <summary>
- The B parameter, which should be consisten with the semi-minor axis
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Transforms.Transform.Name">
- <summary>
- Gets or sets the string name of this projection as it appears in .prj files and
- Esri wkt. This can also be several names separated by a semicolon.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Transforms.Transform.Proj4Name">
- <summary>
- Gets or sets the string name of this projection as it should appear in proj4 strings.
- This can also be several names deliminated by a semicolon.
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Transforms.Transform.Proj4Aliases">
- <summary>
- Gets or sets a list of optional aliases that can be used in the place of the Proj4Name.
- This will only be used during reading, and will not be used during writing.
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.Transform.Modes">
- <summary>
- For transforms that distinguish between polar, oblique and equitorial modes
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.Transform.Modes.NorthPole">
- <summary>
- North Pole
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.Transform.Modes.SouthPole">
- <summary>
- South Pole
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.Transform.Modes.Equitorial">
- <summary>
- Equitorial
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.Transform.Modes.Oblique">
- <summary>
- Oblique
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Aitoff.#ctor">
- <summary>
- Creates a new instance of Aitoff
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Aitoff.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="T:DotSpatial.Projections.Transforms.AlbersConicEqualArea">
- <summary>
- AlbersConicEqualArea
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.AlbersEqualArea">
- <summary>
- AlbersEqualArea
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.AlbersEqualArea.#ctor">
- <summary>
- Creates a new instance of AlbersEqualArea
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.AlbersEqualArea.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.AlbersEqualArea.OnInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.AlbersEqualArea.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.AlbersEqualArea.Setup">
- <summary>
- Internal code handling the setup operations for the transform
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Transforms.AlbersEqualArea.Phi1">
- <summary>
- Gets or sets the Phi1 parameter
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Transforms.AlbersEqualArea.Phi2">
- <summary>
- Gets or sets the Phi2 parameter
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.AlbersConicEqualArea.#ctor">
- <summary>
- Creates a new instance of AlbersConicEqualArea
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.AnalyticModes">
- <summary>
- AnalyticCodes
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.AnalyticModes.IsAnalXlYl">
- <summary>
- Derivatives of lon analytic
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.AnalyticModes.IsAnalXpYp">
- <summary>
- Derivatives of lat analytic
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.AnalyticModes.IsAnalHk">
- <summary>
- h and k are analytic
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.AnalyticModes.IsAnalConv">
- <summary>
- convergence analytic
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.AzimuthalEquidistant">
- <summary>
- AzimuthalEquidistant
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.EllipticalTransform">
- <summary>
- Elliptical Transform supports a built in framework for assuming a
- separate function occurs if the spheroid is elliptical
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.EllipticalTransform.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.EllipticalTransform.EllipticalForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <summary>
- Calculates the forward transformation from geodetic lambda and phi coordinates to
- linear xy coordinates for projections that have elliptical earth models.
- </summary>
- <param name="lp">The input interleaved lambda-phi coordinates where lambda is longitude in radians and phi is latitude in radians.</param>
- <param name="xy">The resulting interleaved x-y coordinates</param>
- <param name="startIndex">The zero based integer start index in terms of coordinate pairs</param>
- <param name="numPoints">The integer number of xy pairs to evaluate.</param>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.EllipticalTransform.SphericalForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <summary>
- Calculates the forward transformation from geodetic lambda and phi coordinates to
- linear xy coordinates for projections that have spherical earth models.
- </summary>
- <param name="lp">The input interleaved lambda-phi coordinates where lambda is longitude in radians and phi is latitude in radians.</param>
- <param name="xy">The resulting interleaved x-y coordinates</param>
- <param name="startIndex">The zero based integer start index in terms of coordinate pairs</param>
- <param name="numPoints">The integer number of xy pairs to evaluate.</param>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.EllipticalTransform.OnInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.EllipticalTransform.EllipticalInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <summary>
- Calculates the inverse transformation from linear xy coordinates to geodetic lambda and phi coordinates
- for projections that have elliptical earth models.
- </summary>
- <param name="xy">The input interleaved x-y coordinates</param>
- <param name="lp">The output interleaved lambda-phi coordinates where lambda is longitude in radians and phi is latitude in radians.</param>
- <param name="startIndex">The zero based integer start index in terms of coordinate pairs</param>
- <param name="numPoints">The integer number of xy pairs to evaluate.</param>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.EllipticalTransform.SphericalInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <summary>
- Calculates the inverse transformation from linear xy coordinates to geodetic lambda and phi coordinates
- for projections that have spherical earth models.
- </summary>
- <param name="xy">The input interleaved x-y coordinates</param>
- <param name="lp">The output interleaved lambda-phi coordinates where lambda is longitude in radians and phi is latitude in radians.</param>
- <param name="startIndex">The zero based integer start index in terms of coordinate pairs</param>
- <param name="numPoints">The integer number of xy pairs to evaluate.</param>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.AzimuthalEquidistant.#ctor">
- <summary>
- Creates a new instance of AzimuthalEquidistant
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.AzimuthalEquidistant.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.AzimuthalEquidistant.SphericalForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.AzimuthalEquidistant.EllipticalForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.AzimuthalEquidistant.SphericalInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.AzimuthalEquidistant.EllipticalInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="T:DotSpatial.Projections.Transforms.BipolarObliqueConformalConic">
- <summary>
- BipolarObliqueConformalConic
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.BipolarObliqueConformalConic.#ctor">
- <summary>
- Creates a new instance of BipolarObliqueConformalConic
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.BipolarObliqueConformalConic.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.BipolarObliqueConformalConic.OnInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.BipolarObliqueConformalConic.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.Bonne">
- <summary>
- Bonne
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Bonne.#ctor">
- <summary>
- Creates a new instance of Bonne
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Bonne.EllipticalForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Bonne.SphericalForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Bonne.SphericalInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Bonne.EllipticalInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Bonne.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.Cassini">
- <summary>
- Cassini
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Cassini.#ctor">
- <summary>
- Creates a new instance of Cassini
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Cassini.SphericalForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Cassini.EllipticalForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Cassini.EllipticalInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Cassini.SphericalInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Cassini.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.DoubleStereographic">
- <summary>
- DoubleStereographic
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.DoubleStereographic.#ctor">
- <summary>
- Creates a new instance of DoubleStereographic
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.DoubleStereographic.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.DoubleStereographic.OnInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.DoubleStereographic.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.Extensions">
- <summary>
- Extensions can be used after the namespace is included as follows. _w = projInfo.W.ToRadians();
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Extensions.FromDegreesToRadians(System.Nullable{System.Double})">
- <summary>
- Obtains the double valued parameter after converting from degrees to radians.
- </summary>
- <param name="value">The value.</param>
- <returns>
- The double valued parameter in radians.
- </returns>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Extensions.FromDegreesToRadians(System.Double)">
- <summary>
- Obtains the double valued parameter after converting from degrees to radians.
- </summary>
- <param name="value">The value.</param>
- <returns>
- The double valued parameter in radians.
- </returns>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.GaussKruger">
- <summary>
- Gauss Kruger is basically transverse mercator
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.TransverseMercator">
- <summary>
- TransverseMercator
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.TransverseMercator.#ctor">
- <summary>
- Creates a new instance of TransverseMercator
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.TransverseMercator.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.TransverseMercator.SphericalForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <summary>
- The forward transform in the special case where there is no flattening of the spherical model of the earth.
- </summary>
- <param name="lp">The input lambda and phi geodetic values organized in an array</param>
- <param name="xy">The output x and y values organized in an array</param>
- <param name="startIndex">The zero based integer start index</param>
- <param name="numPoints">The integer count of the number of xy pairs in the lp and xy arrays</param>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.TransverseMercator.EllipticalForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <summary>
- The forward transform where the spheroidal model of the earth has a flattening factor,
- matching more closely with the oblique spheroid of the actual earth
- </summary>
- <param name="lp">The double values for geodetic lambda and phi organized into a one dimensional array</param>
- <param name="xy">The double values for linear x and y organized into a one dimensional array</param>
- <param name="startIndex">The zero based integer start index</param>
- <param name="numPoints">The integer count of the number of xy pairs in the lp and xy arrays</param>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.TransverseMercator.SphericalInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <summary>
- Performs the inverse transform from a single coordinate of linear units to the same coordinate in geodetic lambda and
- phi units in the special case where the shape of the earth is being approximated as a perfect sphere.
- </summary>
- <param name="xy">The double linear input x and y values organized into a 1 dimensional array</param>
- <param name="lp">The double geodetic output lambda and phi values organized into a 1 dimensional array</param>
- <param name="startIndex">The zero based integer start index</param>
- <param name="numPoints">The integer count of the number of xy pairs in the lp and xy arrays</param>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.TransverseMercator.EllipticalInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <summary>
- Performs the inverse transfrom from a single coordinate of linear units to the same coordinate in geodetic units
- </summary>
- <param name="xy">The double linear input x and y values organized into a 1 dimensional array</param>
- <param name="lp">The double geodetic output lambda and phi values organized into a 1 dimensional array</param>
- <param name="startIndex">The zero based integer start index</param>
- <param name="numPoints">The integer count of the number of xy pairs in the lp and xy arrays</param>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.GaussKruger.#ctor">
- <summary>
- Creates a new instance of GaussKruger
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.HotineObliqueMercatorAzimuthNaturalOrigin">
- <summary>
- OrthogonalMercator
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.HotineObliqueMercatorAzimuthNaturalOrigin.#ctor">
- <summary>
- Creates a new instance of OrthogonalMercator
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.HotineObliqueMercatorAzimuthNaturalOrigin.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.HotineObliqueMercatorAzimuthNaturalOrigin.OnInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.HotineObliqueMercatorAzimuthNaturalOrigin.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.MercatorAuxiliarySphere">
- <summary>
- Mercator
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.MercatorAuxiliarySphere.#ctor">
- <summary>
- Creates a new instance of Mercator
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.MercatorAuxiliarySphere.EllipticalForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.MercatorAuxiliarySphere.SphericalForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.MercatorAuxiliarySphere.EllipticalInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.MercatorAuxiliarySphere.SphericalInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.MercatorAuxiliarySphere.Np(System.Double)">
- <summary>
- n' is a calculation based on the eccentricity
- </summary>
- <param name="phi"></param>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.MercatorAuxiliarySphere.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.CrasterParabolic">
- <summary>
- CrasterParabolic
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.CrasterParabolic.#ctor">
- <summary>
- Creates a new instance of CrasterParabolic
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.CrasterParabolic.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.CrasterParabolic.OnInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="T:DotSpatial.Projections.Transforms.CylindricalEqualArea">
- <summary>
- CylindricalEqualArea
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.CylindricalEqualArea.#ctor">
- <summary>
- Creates a new instance of CylindricalEqualArea
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.CylindricalEqualArea.EllipticalForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.CylindricalEqualArea.SphericalForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.CylindricalEqualArea.EllipticalInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.CylindricalEqualArea.SphericalInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.CylindricalEqualArea.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.Eckert1">
- <summary>
- Eckert1
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Eckert1.#ctor">
- <summary>
- Creates a new instance of Eckert1
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Eckert1.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Eckert1.OnInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="T:DotSpatial.Projections.Transforms.Eckert2">
- <summary>
- Eckert2
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Eckert2.#ctor">
- <summary>
- Creates a new instance of Eckert2
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Eckert2.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Eckert2.OnInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="T:DotSpatial.Projections.Transforms.Eckert3">
- <summary>
- Eckert3
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Eckert3.#ctor">
- <summary>
- Creates a new instance of Eckert3
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Eckert3.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Eckert3.OnInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="T:DotSpatial.Projections.Transforms.Eckert4">
- <summary>
- Eckert4
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Eckert4.#ctor">
- <summary>
- Creates a new instance of Eckert4
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Eckert4.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Eckert4.OnInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="T:DotSpatial.Projections.Transforms.Eckert5">
- <summary>
- Eckert5
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Eckert5.#ctor">
- <summary>
- Creates a new instance of Eckert5
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Eckert5.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Eckert5.OnInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="T:DotSpatial.Projections.Transforms.Eckert6">
- <summary>
- Eckert6
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.Sinusoidal">
- <summary>
- Sinusoidal
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Sinusoidal.#ctor">
- <summary>
- Creates a new instance of Sinusoidal
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Sinusoidal.SphericalForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Sinusoidal.SphericalInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Sinusoidal.EllipticalForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Sinusoidal.EllipticalInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Sinusoidal.Setup">
- <summary>
- Handles the original configuration of sinusoidal transforms
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Sinusoidal.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="P:DotSpatial.Projections.Transforms.Sinusoidal.M">
- <summary>
- Gets or sets the double M value
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Transforms.Sinusoidal.N">
- <summary>
- Gets or sets the N value
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Eckert6.#ctor">
- <summary>
- Creates a new instance of Eckert6
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Eckert6.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.EquidistantConic">
- <summary>
- EquidistantConic
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.EquidistantConic.#ctor">
- <summary>
- Creates a new instance of EquidistantConic
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.EquidistantConic.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.EquidistantConic.OnInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.EquidistantConic.OnSpecial(System.Double[],DotSpatial.Projections.ProjectionInfo,DotSpatial.Projections.Transforms.Factors)">
- <summary>
- This exists in the case that we ever develop code to perform the special proj4 calculations
- </summary>
- <param name="lp"></param>
- <param name="p"></param>
- <param name="fac"></param>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.EquidistantConic.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.EquidistantCylindrical">
- <summary>
- EquidistantCylindrical
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.EquidistantCylindrical.#ctor">
- <summary>
- Creates a new instance of EquidistantCylindrical
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.EquidistantCylindrical.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.EquidistantCylindrical.OnInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.EquidistantCylindrical.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <inheritdoc />
- </member>
- <member name="T:DotSpatial.Projections.Transforms.Factors">
- <summary>
- Factors
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.Factors.A">
- <summary>
- max scale error
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.Factors.B">
- <summary>
- min scale error
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.Factors.Code">
- <summary>
- Info as to analytics
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.Factors.Conv">
- <summary>
- Convergence
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.Factors.H">
- <summary>
- Meridinal scale
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.Factors.K">
- <summary>
- parallel scale
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.Factors.Omega">
- <summary>
- Angular distortion
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.Factors.S">
- <summary>
- Areal scale factor
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.Factors.Thetap">
- <summary>
- theta prime
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.Factors.Xl">
- <summary>
- derivatives of x for lambda
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.Factors.Xp">
- <summary>
- derivatives of x for phi
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.Factors.Yl">
- <summary>
- derivatives of y for lambda
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.Factors.Yp">
- <summary>
- derivatives of y for phi
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.Foucaut">
- <summary>
- Foucaut is a tweaked version of QuarticAuthalic that uses tan mode.
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.QuarticAuthalic">
- <summary>
- QuarticAuthalic
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.QuarticAuthalic.#ctor">
- <summary>
- Creates a new instance of QuarticAuthalic
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.QuarticAuthalic.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.QuarticAuthalic.OnInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.QuarticAuthalic.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.QuarticAuthalic.Setup(System.Double,System.Double,System.Boolean)">
- <summary>
- Setup
- </summary>
- <param name="p"></param>
- <param name="q"></param>
- <param name="mode"></param>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Foucaut.#ctor">
- <summary>
- Creates a new instance of Foucaut
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Foucaut.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.GallStereographic">
- <summary>
- GallStereographic
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.GallStereographic.#ctor">
- <summary>
- Creates a new instance of GallStereographic
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.GallStereographic.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.GallStereographic.OnInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="T:DotSpatial.Projections.Transforms.Gauss">
- <summary>
- Gauss
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Gauss.#ctor(System.Double,System.Double,System.Double@,System.Double@)">
- <summary>
- Creates a new instance of Gauss
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Gauss.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Gauss.OnInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="T:DotSpatial.Projections.Transforms.GeneralSinusoidal">
- <summary>
- GeneralSinusoidal
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.GeneralSinusoidal.#ctor">
- <summary>
- Creates a new instance of GeneralSinusoidal
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.GeneralSinusoidal.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.GeostationarySatellite">
- <summary>
- GeostationarySatellite
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.GeostationarySatellite.#ctor">
- <summary>
- Creates a new instance of GeostationarySatellite
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.GeostationarySatellite.SphericalForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.GeostationarySatellite.EllipticalForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.GeostationarySatellite.SphericalInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.GeostationarySatellite.EllipticalInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.GeostationarySatellite.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.Gnomonic">
- <summary>
- Gnomonic
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Gnomonic.#ctor">
- <summary>
- Creates a new instance of Gnomonic
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Gnomonic.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Gnomonic.OnInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Gnomonic.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.GoodeHomolosine">
- <summary>
- GoodeHomolosine
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.GoodeHomolosine.#ctor">
- <summary>
- Creates a new instance of GoodeHomolosine
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.GoodeHomolosine.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.GoodeHomolosine.OnInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.GoodeHomolosine.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.HammerAitoff">
- <summary>
- HammerAitoff
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.HammerAitoff.#ctor">
- <summary>
- Creates a new instance of HammerAitoff
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.HammerAitoff.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.HammerAitoff.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.HotineObliqueMercatorAzimuthCenter">
- <summary>
- HotineObliqueMercatorAzimuthalCenter - Used to properly direct the Swiss Oblique Mercator
- when it appears as Hotine Oblique Mercator Azimuth Center. At current, the Azimuth
- parameter is ignored as I don't know how to send it into Proj4.
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.ObliqueMercator">
- <summary>
- OrthogonalMercator
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.ObliqueMercator.#ctor">
- <summary>
- Creates a new instance of OrthogonalMercator
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.ObliqueMercator.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.ObliqueMercator.OnInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.ObliqueMercator.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.HotineObliqueMercatorAzimuthCenter.#ctor">
- <summary>
- Creates a new instance of HotineObliqueMercatorAzimuthalCenter
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.HotineObliqueMercatorAzimuthCenter.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.HotineObliqueMercatorAzimuthCenter.OnInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.HotineObliqueMercatorAzimuthCenter.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.Kavraisky5">
- <summary>
- Kavraisky5 is just a tweaked version of Quartic Authalic
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Kavraisky5.#ctor">
- <summary>
- Creates a new instance of Kavraisky5
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Kavraisky5.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.Kavraisky7">
- <summary>
- Kavraisky6
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Kavraisky7.#ctor">
- <summary>
- Creates a new instance of Kavraisky6
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Kavraisky7.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Kavraisky7.OnInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="T:DotSpatial.Projections.Transforms.KnownTransform">
- <summary>
- KnownTransforms
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Aitoff">
- <summary>
- Aitoff
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Albers_Equal_Area">
- <summary>
- Albers Equal Area
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Azimuthal_Equidistant">
- <summary>
- Azimuthal Equidistant
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Bipolar_Oblique_Conformal_Conic">
- <summary>
- Bipolar Oblique Conformal Conic
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Bonne">
- <summary>
- Bonne
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Cassini">
- <summary>
- Cassini
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Craster_Parabolic">
- <summary>
- Craster Parabolic
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Cylindrical_Equal_Area">
- <summary>
- Cylindrical Equal Area
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Eckert_I">
- <summary>
- Eckert 1
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Eckert_II">
- <summary>
- Eckert 2
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Eckert_III">
- <summary>
- Eckert 3
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Eckert_IV">
- <summary>
- Eckert 4
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Eckert_V">
- <summary>
- Eckert 5
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Eckert_VI">
- <summary>
- Eckert 6
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Elliptical_Transform">
- <summary>
- Elliptical Transform
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Equidistant_Conic">
- <summary>
- Equidistant Conic
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Equidistant_Cylindrical">
- <summary>
- Equidistant_Cylindrical
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Foucaut">
- <summary>
- Foucaut
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Gall_Stereographic">
- <summary>
- Gall Stereographic
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.General_Sinusoidal">
- <summary>
- General Sinusoidal
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Geostationary_Satellite">
- <summary>
- Geostationary Satellite
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Gnomonic">
- <summary>
- Gnomonic
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Goode_Homolosine">
- <summary>
- Goode Homolosine
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Hammer_Aitoff">
- <summary>
- Hammer Aitoff
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Kavraisky_V">
- <summary>
- Kavraisky 5
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Kavraisky_VII">
- <summary>
- Kavraisky 7
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Krovak">
- <summary>
- Krovak
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Lambert_Azimuthal_Equal_Area">
- <summary>
- Lambert Azimuthal Equal Area
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Lambert_Conformal_Conic">
- <summary>
- Lambert Conformal Conic
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Lambert_Equal_Area_Conic">
- <summary>
- Lambert Equal Area Conic
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.LongLat">
- <summary>
- Latitude / Longitude
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Loximuthal">
- <summary>
- Loximuthal
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.McBryde_Thomas_Flat_Polar_Sine">
- <summary>
- McBryde Thomas Flat Polar Sine
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Mercator">
- <summary>
- Mercator
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Miller_Cylindrical">
- <summary>
- Miller Cylindrical
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Mollweide">
- <summary>
- Mollweide
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.New_Zealand_Map_Grid">
- <summary>
- New Zealand Map Grid
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Oblique_Cylindrical_Equal_Area">
- <summary>
- Oblique Cylindrical Equal Area
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Oblique_Mercator">
- <summary>
- Oblique Mercator
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Oblique_Stereographic_Alternative">
- <summary>
- Oblique Stereographic Alternative
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Orthographic">
- <summary>
- Orthographic
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Polyconic">
- <summary>
- Polyconic
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Putins_P1">
- <summary>
- PutinsP1
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Quartic_Authalic">
- <summary>
- Quartic Authalic
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Robinson">
- <summary>
- Robinson
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Sinusoidal">
- <summary>
- Sinusoidal
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Stereographic">
- <summary>
- Stereographic
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Swiss_Oblique_Mercator">
- <summary>
- Swiss Oblique Mercator
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Transverse_Mercator">
- <summary>
- Transverse Mercator
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Two_Point_Equidistant">
- <summary>
- Two Point Equidistant
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Universal_Polar_Stereographic">
- <summary>
- Universal Polar Stereographic
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Universal_Transverse_Mercator">
- <summary>
- Universal Transverse Mercator
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Vander_Grinten_I">
- <summary>
- Vander Grinten 1
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Wagner_IV">
- <summary>
- Wagner 4
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Wagner_V">
- <summary>
- Wagner 5
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Wagner6">
- <summary>
- Wagner 6
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Winkel_I">
- <summary>
- Winkel 1
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Winkel_II">
- <summary>
- Winkel 2
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.KnownTransform.Winkel_Tripel">
- <summary>
- Winkel Tripel
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.Krovak">
- <summary>
- Krovak
- NOTES: According to EPSG the full Krovak projection method should have
- the following parameters. Within PROJ.4 the azimuth, and pseudo
- standard parallel are hardcoded in the algorithm and can't be
- altered from outside. The others all have defaults to match the
- common usage with Krovak projection.
-
- lat_0 = latitude of centre of the projection
-
- lon_0 = longitude of centre of the projection
-
- ** = azimuth (true) of the centre line passing through the centre of the projection
-
- ** = latitude of pseudo standard parallel
-
- k = scale factor on the pseudo standard parallel
-
- x_0 = False Easting of the centre of the projection at the apex of the cone
-
- y_0 = False Northing of the centre of the projection at the apex of the cone
-
- _czech = specifies the EAST-NORTH GIS usage where the axis are reversed:
- X [S-JTSK KROVAK EAST NORTH] = -Y [KROVAK]
- Y [S-JTSK KROVAK EAST NORTH] = -X [KROVAK]
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Krovak.#ctor">
- <summary>
- Creates a new instance of Krovak
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Krovak.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Krovak.OnInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Krovak.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- <remarks>The default value of CZECH is true: The X and Y axis are reversed and multiplied by -1 as typically used in GIS applications of Krovak</remarks>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.LambertAzimuthalEqualArea">
- <summary>
- LambertAzimuthalEqualArea
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.LambertAzimuthalEqualArea.#ctor">
- <summary>
- Creates a new instance of LambertAzimuthalEqualArea
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.LambertAzimuthalEqualArea.EllipticalForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.LambertAzimuthalEqualArea.SphericalForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.LambertAzimuthalEqualArea.EllipticalInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.LambertAzimuthalEqualArea.SphericalInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.LambertAzimuthalEqualArea.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.LambertConformalConic">
- <summary>
- LambertConformalConic
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.LambertConformalConic.#ctor">
- <summary>
- Creates a new instance of the Lambert Conformal Conic projection
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.LambertConformalConic.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.LambertConformalConic.OnInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.LambertConformalConic.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.LambertConformalConic.OnSpecial(System.Double[],DotSpatial.Projections.ProjectionInfo,DotSpatial.Projections.Transforms.Factors)">
- <summary>
- Special factor calculations for a factors calculation
- </summary>
- <param name="lp">lambda-phi</param>
- <param name="p">The projection</param>
- <param name="fac">The Factors</param>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.LambertEqualAreaConic">
- <summary>
- LambertEqualAreaConic
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.LambertEqualAreaConic.#ctor">
- <summary>
- Creates a new instance of LambertEqualAreaConic
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.LambertEqualAreaConic.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.LongLat">
- <summary>
- LongLat
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.LongLat.#ctor">
- <summary>
- Creates a new instance of LongLat
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.LongLat.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.LongLat.OnInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.LongLat.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.Loximuthal">
- <summary>
- Loximuthal
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Loximuthal.#ctor">
- <summary>
- Creates a new instance of Loximuthal
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Loximuthal.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Loximuthal.OnInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Loximuthal.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.McBrydeThomasFlatPolarSine">
- <summary>
- McBrydeThomasFlatPolarSine is a tweaked version of Qaurtic Authalic
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.McBrydeThomasFlatPolarSine.#ctor">
- <summary>
- Creates a new instance of McBrydeThomasFlatPolarSine
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.McBrydeThomasFlatPolarSine.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.Mercator">
- <summary>
- Mercator
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Mercator.#ctor">
- <summary>
- Creates a new instance of Mercator
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Mercator.EllipticalForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Mercator.SphericalForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Mercator.EllipticalInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Mercator.SphericalInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Mercator.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.MillerCylindrical">
- <summary>
- MillerCylindrical
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.MillerCylindrical.#ctor">
- <summary>
- Creates a new instance of MillerCylindrical
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.MillerCylindrical.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.MillerCylindrical.OnInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="T:DotSpatial.Projections.Transforms.Mollweide">
- <summary>
- Mollweide also acts as the base for Wag4 and Wag5
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Mollweide.#ctor">
- <summary>
- Creates a new instance of Mollweide
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Mollweide.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Mollweide.OnInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Mollweide.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Mollweide.Setup(System.Double)">
- <summary>
- Finalizes the setup based on the provided P paraemter
- </summary>
- <param name="p"></param>
- </member>
- <member name="P:DotSpatial.Projections.Transforms.Mollweide.Cx">
- <summary>
- Gets or sets the x coefficient
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Transforms.Mollweide.Cy">
- <summary>
- Gets or sets the y coefficient value
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Transforms.Mollweide.Cp">
- <summary>
- Gets or sets the P coefficient
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.NewZealandMapGrid">
- <summary>
- NewZealandMapGrid
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.NewZealandMapGrid.#ctor">
- <summary>
- Creates a new instance of NewZealandMapGrid
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.NewZealandMapGrid.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.NewZealandMapGrid.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.NewZealandMapGrid.OnInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="T:DotSpatial.Projections.Transforms.ObliqueCylindricalEqualArea">
- <summary>
- ObliqueCylindricalEqualArea
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.ObliqueCylindricalEqualArea.#ctor">
- <summary>
- Creates a new instance of ObliqueCylindricalEqualArea
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.ObliqueCylindricalEqualArea.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.ObliqueCylindricalEqualArea.OnInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.ObliqueCylindricalEqualArea.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.ObliqueStereographicAlternative">
- <summary>
- ObliqueStereographicAlternative
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.ObliqueStereographicAlternative.#ctor">
- <summary>
- Creates a new instance of ObliqueStereographicAlternative
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.ObliqueStereographicAlternative.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.ObliqueStereographicAlternative.OnInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.ObliqueStereographicAlternative.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.Orthographic">
- <summary>
- Orthographic
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Orthographic.#ctor">
- <summary>
- Creates a new instance of Orthographic
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Orthographic.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Orthographic.OnInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Orthographic.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.Polyconic">
- <summary>
- Polygconic
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Polyconic.#ctor">
- <summary>
- Creates a new instance of Polygconic
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Polyconic.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Polyconic.EllipticalForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Polyconic.SphericalForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Polyconic.EllipticalInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Polyconic.SphericalInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="T:DotSpatial.Projections.Transforms.Proj">
- <summary>
- Proj contains frequently used static helper methods for doing projection calculations
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.Proj.ONE_TOL">
- <summary>
- Effectively 1 but with a tolerance of 1E-14
- </summary>
- </member>
- <member name="F:DotSpatial.Projections.Transforms.Proj.ATOL">
- <summary>
- 1E-50
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Proj.Aasin(System.Double)">
- <summary>
- Tolerant Arcsin
- </summary>
- <param name="v"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Proj.Aacos(System.Double)">
- <summary>
- Tolerant ArcCosine
- </summary>
- <param name="v"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Proj.Asqrt(System.Double)">
- <summary>
- Tollerant Sqrt
- </summary>
- <param name="v"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Proj.Aatan2(System.Double,System.Double)">
- <summary>
- Tollerant Math.Atan method.
- </summary>
- <param name="n"></param>
- <param name="d"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Proj.Hypot(System.Double,System.Double)">
- <summary>
- Calculates the hypotenuse of a triangle: Sqrt(x*x + y*y);
- </summary>
- <param name="x">The length of one orthogonal leg of the triangle</param>
- <param name="y">The length of the other orthogonal leg of the triangle</param>
- <returns>The length of the diagonal.</returns>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Proj.Adjlon(System.Double)">
- <summary>
-
- </summary>
- <param name="lon"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Proj.Authset(System.Double)">
- <summary>
- Determines latitude from authalic latitude
- </summary>
- <param name="es">Epsilon squared</param>
- <returns>The array of double values for the apa parameter</returns>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Proj.AuthLat(System.Double,System.Double[])">
- <summary>
- Obtains the authalic latitude
- </summary>
- <param name="beta"></param>
- <param name="apa"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Proj.Enfn(System.Double)">
- <summary>
- Obtains the EN parameters for the Meridional distance
- </summary>
- <param name="es"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Proj.Mlfn(System.Double,System.Double,System.Double,System.Double[])">
- <summary>
- Meridonal length function
- </summary>
- <param name="phi"></param>
- <param name="sphi"></param>
- <param name="cphi"></param>
- <param name="en"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Proj.InvMlfn(System.Double,System.Double,System.Double[])">
- <summary>
-
- </summary>
- <param name="arg"></param>
- <param name="es"></param>
- <param name="en"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Proj.Qsfn(System.Double,System.Double,System.Double)">
- <summary>
-
- </summary>
- <param name="sinphi"></param>
- <param name="e"></param>
- <param name="oneEs"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Proj.Tsfn(System.Double,System.Double,System.Double)">
- <summary>
-
- </summary>
- <param name="phi"></param>
- <param name="sinphi"></param>
- <param name="e"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Proj.Msfn(System.Double,System.Double,System.Double)">
- <summary>
-
- </summary>
- <param name="sinphi"></param>
- <param name="cosphi"></param>
- <param name="es"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Proj.Phi2(System.Double,System.Double)">
- <summary>
-
- </summary>
- <param name="ts"></param>
- <param name="e"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Proj.Zpoly1(System.Double[],System.Double[][],System.Int32)">
- <summary>
- </summary>
- <param name="z"></param>
- <param name="c"></param>
- <param name="n"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Proj.Zpolyd1(System.Double[],System.Double[][],System.Int32,System.Double[]@)">
- <summary>
- </summary>
- <param name="z"></param>
- <param name="c"></param>
- <param name="n"></param>
- <param name="der"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.PutinsP1">
- <summary>
- PutinsP1
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.PutinsP1.#ctor">
- <summary>
- Creates a new instance of PutinsP1
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.PutinsP1.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.PutinsP1.OnInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="T:DotSpatial.Projections.Transforms.Robinson">
- <summary>
- Robinson
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Robinson.#ctor">
- <summary>
- Creates a new instance of Robinson
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Robinson.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Robinson.OnInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="T:DotSpatial.Projections.Transforms.Stereographic">
- <summary>
- Stereographic
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Stereographic.#ctor">
- <summary>
- Creates a new instance of Stereographic
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Stereographic.EllipticalForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Stereographic.SphericalForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Stereographic.EllipticalInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Stereographic.SphericalInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Stereographic.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.StereographicNorthPole">
- <summary>
- StereographicNorthPole
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.StereographicNorthPole.#ctor">
- <summary>
- Creates a new instance of StereographicNorthPole
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.SwissObliqueMercator">
- <summary>
- SwissObliqueMercator
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.SwissObliqueMercator.#ctor">
- <summary>
- Creates a new instance of SwissObliqueMercator
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.SwissObliqueMercator.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.SwissObliqueMercator.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.SwissObliqueMercator.OnInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="T:DotSpatial.Projections.Transforms.TransformManager">
- <summary>
- TransformManager
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.TransformManager.#ctor">
- <summary>
- Creates a new instance of TransformManager
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.TransformManager.GetProj4(System.String)">
- <summary>
- Given the proj4 string, returns the matching transform eg: tmerc.
- </summary>
- <param name="name">The string name</param>
- <returns>The ITransform that has the matching proj4 name</returns>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.TransformManager.GetProjection(System.String)">
- <summary>
- Given the .prj name (Esri wkt), returns the matching transform
- </summary>
- <param name="name">The string name for the trnasform eg. Transverse_Mercator</param>
- <returns>The ITransform that has the matching Esri wkt name</returns>
- </member>
- <member name="P:DotSpatial.Projections.Transforms.TransformManager.Transforms">
- <summary>
- The entire list of transforms
- </summary>
- </member>
- <member name="P:DotSpatial.Projections.Transforms.TransformManager.DefaultTransformManager">
- <summary>
- Gets the default instance of the transform manager
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.TwoPointEquidistant">
- <summary>
- TwoPointEquidistant
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.TwoPointEquidistant.#ctor">
- <summary>
- Creates a new instance of TwoPointEquidistant
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.TwoPointEquidistant.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.TwoPointEquidistant.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.TwoPointEquidistant.OnInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="T:DotSpatial.Projections.Transforms.UniversalPolarStereographic">
- <summary>
- UniversalPolarStereographic
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.UniversalPolarStereographic.#ctor">
- <summary>
- Creates a new instance of UniversalPolarStereographic
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.UniversalPolarStereographic.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.UniversalTransverseMercator">
- <summary>
- UniversalTransverseMercator
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.UniversalTransverseMercator.#ctor">
- <summary>
- Creates a new instance of UniversalTransverseMercator. The only difference
- for this one is that the proj4 name is a little different and when reading
- from proj4, we have to parse the zone and south parameters in order to
- create the transverse mercator projection.
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.UniversalTransverseMercator.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.VanderGrinten1">
- <summary>
- VanderGrinten1
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.VanderGrinten1.#ctor">
- <summary>
- Creates a new instance of VanderGrinten1
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.VanderGrinten1.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.VanderGrinten1.OnInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="T:DotSpatial.Projections.Transforms.Wagner4">
- <summary>
- Wagner4
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Wagner4.#ctor">
- <summary>
- Creates a new instance of Wagner4
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Wagner4.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.Wagner5">
- <summary>
- Wagner5
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Wagner5.#ctor">
- <summary>
- Creates a new instance of Wagner5
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Wagner5.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="T:DotSpatial.Projections.Transforms.Wagner6">
- <summary>
- Wagner6
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Wagner6.#ctor">
- <summary>
- Creates a new instance of Wagner6
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Wagner6.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Wagner6.OnInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="T:DotSpatial.Projections.Transforms.Winkel1">
- <summary>
- Winkel1
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Winkel1.#ctor">
- <summary>
- Creates a new instance of Winkel1
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Winkel1.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Winkel1.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Winkel1.OnInverse(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="T:DotSpatial.Projections.Transforms.Winkel2">
- <summary>
- Winkel2
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Winkel2.#ctor">
- <summary>
- Creates a new instance of Winkel2
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Winkel2.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.Winkel2.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="T:DotSpatial.Projections.Transforms.WinkelTripel">
- <summary>
- WinkelTripel
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.WinkelTripel.#ctor">
- <summary>
- Creates a new instance of WinkelTripel
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Transforms.WinkelTripel.OnForward(System.Double[],System.Double[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Projections.Transforms.WinkelTripel.OnInit(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Initializes the transform using the parameters from the specified coordinate system information
- </summary>
- <param name="projInfo">A ProjectionInfo class contains all the standard and custom parameters needed to initialize this transform</param>
- </member>
- <member name="M:DotSpatial.Projections.Reflection.MemberInfoExtensions.GetFirst``1(System.Collections.Generic.IEnumerable{``0},System.String)">
- <summary>
- Gets the first member in the enumerable collection of property info with the specified name.
- </summary>
- </member>
- <member name="M:DotSpatial.Projections.Reflection.MemberInfoExtensions.Contains(System.Collections.Generic.IEnumerable{System.Reflection.MemberInfo},System.String)">
- <summary>
- Determines whether there is a member with the specified name
- </summary>
- </member>
- <member name="T:DotSpatial.Projections.ProjShallowCopy">
- <summary>
- Normally, cloning an object starts with MemberwiseClone, which
- creates a shallow copy of the object. For any members that
- derive from the Descriptor, however, any public properties
- or fields that implement ICloneable are copied (deep copy behavior).
- This is not always desirable, even if the member CAN be copied.
- This attribute causes the deep copy behavior to skip over
- properties marked with this attribute.
- </summary>
- </member>
- </members>
-</doc>
diff --git a/MES_Wind/bin/Debug/DotSpatial.Serialization.pdb b/MES_Wind/bin/Debug/DotSpatial.Serialization.pdb
deleted file mode 100644
index 05890e39484e4275d422a465416402e8a0c9e983..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/DotSpatial.Serialization.pdb and /dev/null differ
diff --git a/MES_Wind/bin/Debug/DotSpatial.Serialization.xml b/MES_Wind/bin/Debug/DotSpatial.Serialization.xml
deleted file mode 100644
index f79b2de9b5c1b4bbb83f0148150b13afabfc5116..0000000000000000000000000000000000000000
--- a/MES_Wind/bin/Debug/DotSpatial.Serialization.xml
+++ /dev/null
@@ -1,829 +0,0 @@
-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>DotSpatial.Serialization</name>
- </assembly>
- <members>
- <member name="T:DotSpatial.Serialization.AssemblyMissingException">
- <summary>
- This exception will occur if an assembly referenced by a saved map layer could not be found.
- </summary>
- </member>
- <member name="M:DotSpatial.Serialization.AssemblyMissingException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the AssemblyMissingException.
- </summary>
- <param name="message">The string message to show as the error.</param>
- </member>
- <member name="M:DotSpatial.Serialization.AssemblyMissingException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the AssemblyMissingException.
- </summary>
- <param name="message">The string message to show as the error.</param>
- <param name="innerException">The inner exception to send as part of this exception.</param>
- </member>
- <member name="M:DotSpatial.Serialization.AssemblyMissingException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the AssemblyMissingException.
- </summary>
- <param name="info">The SerializationInfo that holds the information about the serialized object about the exception being thrown.</param>
- <param name="context">The StreamingContext that contains contextual information about the source or destination.</param>
- </member>
- <member name="T:DotSpatial.Serialization.BaseCollection`1">
- <summary>
- BaseCollection
- </summary>
- </member>
- <member name="F:DotSpatial.Serialization.BaseCollection`1._innerList">
- <summary>
- Private storage for the inner list.
- </summary>
- </member>
- <member name="M:DotSpatial.Serialization.BaseCollection`1.Add(`0)">
- <summary>
- Adds an item to this base collection
- </summary>
- <param name="item"></param>
- </member>
- <member name="M:DotSpatial.Serialization.BaseCollection`1.Contains(`0)">
- <summary>
- A boolean that is true if this set contains the specified item
- </summary>
- <param name="item"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Serialization.BaseCollection`1.CopyTo(`0[],System.Int32)">
- <summary>
- Copies the items from this collection to the specified array
- </summary>
- <param name="array">The array to copy to</param>
- <param name="arrayIndex">The zero based integer array index to start copying to</param>
- </member>
- <member name="M:DotSpatial.Serialization.BaseCollection`1.Move(`0,System.Int32)">
- <summary>
- Moves the given item to the new position.
- </summary>
- <param name="item">Item that gets moved.</param>
- <param name="newPosition">Position the item is moved to.</param>
- </member>
- <member name="M:DotSpatial.Serialization.BaseCollection`1.Remove(`0)">
- <summary>
- Removes the specified item from the collection
- </summary>
- <param name="item">The item to remove from the collection</param>
- <returns>Boolean, true if the remove operation is successful. </returns>
- </member>
- <member name="M:DotSpatial.Serialization.BaseCollection`1.GetEnumerator">
- <summary>
- Returns a type specific enumerator
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Serialization.BaseCollection`1.Clear">
- <summary>
- Clears the list
- </summary>
- </member>
- <member name="M:DotSpatial.Serialization.BaseCollection`1.OnInnerListSet">
- <summary>
- After serialization, the inner list is directly set. This is uzed by the FeatureLayer, for instance,
- to apply the new scheme.
- </summary>
- </member>
- <member name="M:DotSpatial.Serialization.BaseCollection`1.OnClear">
- <summary>
- Clears this collection
- </summary>
- </member>
- <member name="M:DotSpatial.Serialization.BaseCollection`1.OnInsert(System.Int32,System.Object)">
- <summary>
- Occurs when items are inserted
- </summary>
- <param name="index"></param>
- <param name="value"></param>
- </member>
- <member name="M:DotSpatial.Serialization.BaseCollection`1.OnInsertComplete(System.Int32,System.Object)">
- <summary>
- Occurs after a new item has been inserted, and fires IncludeComplete
- </summary>
- <param name="index"></param>
- <param name="value"></param>
- </member>
- <member name="M:DotSpatial.Serialization.BaseCollection`1.OnRemoveComplete(System.Int32,System.Object)">
- <summary>
- Fires after the remove operation, ensuring that OnExclude gets called
- </summary>
- <param name="index"></param>
- <param name="value"></param>
- </member>
- <member name="M:DotSpatial.Serialization.BaseCollection`1.OnSet(System.Int32,System.Object,System.Object)">
- <summary>
- Fires before the set operation ensuring the new item is included if necessary
- </summary>
- <param name="index"></param>
- <param name="oldValue"></param>
- <param name="newValue"></param>
- </member>
- <member name="M:DotSpatial.Serialization.BaseCollection`1.OnSetComplete(System.Int32,System.Object,System.Object)">
- <summary>
- Fires after the set operation, ensuring that the item is removed
- </summary>
- <param name="index"></param>
- <param name="oldValue"></param>
- <param name="newValue"></param>
- </member>
- <member name="M:DotSpatial.Serialization.BaseCollection`1.OnInclude(`0)">
- <summary>
- Occurs any time an item is added or inserted into the collection
- and did not previously exist in the collection
- </summary>
- <param name="item"></param>
- </member>
- <member name="M:DotSpatial.Serialization.BaseCollection`1.OnMoved(`0,System.Int32)">
- <summary>
- Occurs whenever a layer is moved.
- </summary>
- <param name="item">Layer that is moved.</param>
- <param name="newPosition">Position the layer is moved to.</param>
- </member>
- <member name="M:DotSpatial.Serialization.BaseCollection`1.OnIncludeComplete(`0)">
- <summary>
- Occurs after the item has been included either by set, insert, or addition.
- </summary>
- <param name="item"></param>
- </member>
- <member name="M:DotSpatial.Serialization.BaseCollection`1.OnExclude(`0)">
- <summary>
- Occurs any time an item is removed from the collection and no longer
- exists anywhere in the collection
- </summary>
- <param name="item"></param>
- </member>
- <member name="M:DotSpatial.Serialization.BaseCollection`1.Include(`0)">
- <summary>
- Includes the specified item. This should be called BEFORE an item
- is added to the list.
- </summary>
- <param name="item"></param>
- </member>
- <member name="M:DotSpatial.Serialization.BaseCollection`1.Exclude(`0)">
- <summary>
- Exclude should be called AFTER the item is successfully removed from the list.
- This allows any handlers that connect to the item to be removed in the event
- that the item is no longer anywhere in the list.
- </summary>
- <param name="item">The item to be removed</param>
- </member>
- <member name="M:DotSpatial.Serialization.BaseCollection`1.#ctor">
- <summary>
- Creates a new instance of BaseCollection
- </summary>
- </member>
- <member name="P:DotSpatial.Serialization.BaseCollection`1.InnerList">
- <summary>
- Gets or sets the inner list of T that actually controls the content for this BaseCollection.
- </summary>
- </member>
- <member name="P:DotSpatial.Serialization.BaseCollection`1.IsReadOnly">
- <summary>
- False
- </summary>
- </member>
- <member name="P:DotSpatial.Serialization.BaseCollection`1.Count">
- <summary>
- Returns the count of the inner list
- </summary>
- </member>
- <member name="T:DotSpatial.Serialization.BaseCollection`1.BaseCollectionEnumerator`1">
- <summary>
- Defines a new kind of enumerator designed to make the CollectionBase cooperate with strong type collections
- </summary>
- <typeparam name="TE">The enumerator type.</typeparam>
- </member>
- <member name="M:DotSpatial.Serialization.BaseCollection`1.BaseCollectionEnumerator`1.#ctor(System.Collections.IEnumerator)">
- <summary>
- Creates the new enumerator
- </summary>
- <param name="innerEnumerator">A non type specific enumerator</param>
- </member>
- <member name="M:DotSpatial.Serialization.BaseCollection`1.BaseCollectionEnumerator`1.Dispose">
- <summary>
- Does nothing
- </summary>
- </member>
- <member name="M:DotSpatial.Serialization.BaseCollection`1.BaseCollectionEnumerator`1.MoveNext">
- <summary>
- Moves to the next item in the collection
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Serialization.BaseCollection`1.BaseCollectionEnumerator`1.Reset">
- <summary>
- resets the enumerator
- </summary>
- </member>
- <member name="P:DotSpatial.Serialization.BaseCollection`1.BaseCollectionEnumerator`1.Current">
- <summary>
- The current item
- </summary>
- </member>
- <member name="T:DotSpatial.Serialization.BaseList`1">
- <summary>
- BaseList
- </summary>
- </member>
- <member name="M:DotSpatial.Serialization.BaseList`1.IndexOf(`0)">
- <summary>
- Gets the integer index of the specified item.
- </summary>
- <param name="item">The implementation of T to obtain the zero based integer index of.</param>
- <returns>An integer that is -1 if the item is not found, or the zero based index.</returns>
- </member>
- <member name="M:DotSpatial.Serialization.BaseList`1.Insert(System.Int32,`0)">
- <summary>
- If the read-only property is false, then this inserts the item to the specified index.
- </summary>
- <param name="index">The zero based integer index describing the target index for the item.</param>
- <param name="item">The implementation of T to insert into this index.</param>
- <exception cref="T:DotSpatial.Serialization.ReadOnlyException">If ReadOnly is true, then this method will cause an exception</exception>
- </member>
- <member name="M:DotSpatial.Serialization.BaseList`1.OnInsert(System.Int32,`0)">
- <summary>
- This happens after an item of type T was added to the list
- </summary>
- </member>
- <member name="M:DotSpatial.Serialization.BaseList`1.OnItemSet(System.Int32,`0,`0)">
- <summary>
- This happens after a value has been updated in the list.
- </summary>
- <param name="index">The index where the replacement took place.</param>
- <param name="oldItem">The item that was removed from the position.</param>
- <param name="newItem">The new item that is replacing it in the list.</param>
- </member>
- <member name="M:DotSpatial.Serialization.BaseList`1.OnRemoveAt(System.Int32,`0)">
- <summary>
- The happens after an item was removed from the specified index.
- </summary>
- <param name="index">The index the item was removed from.</param>
- <param name="item">The item that was removed</param>
- </member>
- <member name="M:DotSpatial.Serialization.BaseList`1.RemoveAt(System.Int32)">
- <summary>
- Removes the item from the specified index
- </summary>
- <param name="index">The zero based integer index</param>
- </member>
- <member name="P:DotSpatial.Serialization.BaseList`1.Item(System.Int32)">
- <summary>
- Gets or sets the value of type T at the specified index
- </summary>
- <param name="index">The zero-base integer index marking the position of the item</param>
- <returns>The item</returns>
- </member>
- <member name="T:DotSpatial.CloneableEM">
- <summary>
- CloneableEM
- </summary>
- </member>
- <member name="M:DotSpatial.CloneableEM.Copy``1(``0)">
- <summary>
- The type parameter T is optional, so the intended use would be like:
- ObjectType copy = myObject.Copy();
- </summary>
- <typeparam name="T">The type of the object</typeparam>
- <param name="original">The original object</param>
- <returns>A new object of the same type as the type being copied.</returns>
- </member>
- <member name="T:DotSpatial.SerializeExtent">
- <summary>
- Extent works like an envelope but is faster acting, has a minimum memory profile, only works in 2D and has no events.
- </summary>
- </member>
- <member name="F:DotSpatial.SerializeExtent.XMax">
- <summary>
- Max X
- </summary>
- </member>
- <member name="F:DotSpatial.SerializeExtent.XMin">
- <summary>
- Min X
- </summary>
- </member>
- <member name="F:DotSpatial.SerializeExtent.YMax">
- <summary>
- Max Y
- </summary>
- </member>
- <member name="F:DotSpatial.SerializeExtent.YMin">
- <summary>
- Min Y
- </summary>
- </member>
- <member name="M:DotSpatial.SerializeExtent.#ctor">
- <summary>
- Creates a new instance of Extent. This introduces no error checking and assumes
- that the user knows what they are doing when working with this.
- </summary>
- </member>
- <member name="M:DotSpatial.SerializeExtent.#ctor(System.Double,System.Double,System.Double,System.Double)">
- <summary>
- Creates a new extent from the specified ordinates
- </summary>
- <param name="xMin"></param>
- <param name="yMin"></param>
- <param name="xMax"></param>
- <param name="yMax"></param>
- </member>
- <member name="M:DotSpatial.SerializeExtent.#ctor(System.Double[],System.Int32)">
- <summary>
- Given a long array of doubles, this builds an extent from a small part of that
- xmin, ymin, xmax, ymax
- </summary>
- <param name="values"></param>
- <param name="offset"></param>
- </member>
- <member name="M:DotSpatial.SerializeExtent.#ctor(System.Double[])">
- <summary>
- XMin, YMin, XMax, YMax order
- </summary>
- <param name="values"></param>
- </member>
- <member name="M:DotSpatial.SerializeExtent.Clone">
- <summary>
- Produces a clone, rather than using this same object.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.SerializeExtent.IsEmpty">
- <summary>
- If this is undefined, it will have a min that is larger than the max.
- </summary>
- <returns>Boolean, true if the envelope has not had values set for it yet.</returns>
- </member>
- <member name="T:DotSpatial.Serialization.Properties.Resources">
- <summary>
- A strongly-typed resource class, for looking up localized strings, etc.
- </summary>
- </member>
- <member name="P:DotSpatial.Serialization.Properties.Resources.ResourceManager">
- <summary>
- Returns the cached ResourceManager instance used by this class.
- </summary>
- </member>
- <member name="P:DotSpatial.Serialization.Properties.Resources.Culture">
- <summary>
- Overrides the current thread's CurrentUICulture property for all
- resource lookups using this strongly typed resource class.
- </summary>
- </member>
- <member name="P:DotSpatial.Serialization.Properties.Resources.ReadOnly">
- <summary>
- Looks up a localized string similar to The collection cannot be altered because it is read only..
- </summary>
- </member>
- <member name="T:DotSpatial.Serialization.QualifiedTypeName">
- <summary>
- A class for parsing the components of the assembly qualified type name.
- </summary>
- </member>
- <member name="M:DotSpatial.Serialization.QualifiedTypeName.#ctor(System.String)">
- <summary>
- Reads in the full string, parsing out the separate elements. These are not always in the specified order,
- and many times there are several optional elements. This class helps find the optional elements that are
- necessary. This does not support mulitple enclosed types yet, like dictionaries or something. We needed
- the single enclosed type for supporting the layer collection however.
- </summary>
- <param name="qualifiedName">The string qualified name.</param>
- </member>
- <member name="M:DotSpatial.Serialization.QualifiedTypeName.ToString">
- <summary>
- Returns the full qualified type name as "TypeName, Assembly, Version=x, Culture=x, PublicKeyToken=x".
- </summary>
- <returns>The string expression with the full type name.</returns>
- </member>
- <member name="P:DotSpatial.Serialization.QualifiedTypeName.EnclosedName">
- <summary>
- Gets or sets the name for the enclosed type.
- </summary>
- </member>
- <member name="P:DotSpatial.Serialization.QualifiedTypeName.TypeName">
- <summary>
- Gets or sets the TypeName
- </summary>
- </member>
- <member name="P:DotSpatial.Serialization.QualifiedTypeName.Assembly">
- <summary>
- Gets or sets the name of the assembly
- </summary>
- </member>
- <member name="P:DotSpatial.Serialization.QualifiedTypeName.Version">
- <summary>
- Gets or sets a System.Version for getting or setting the version.
- </summary>
- </member>
- <member name="P:DotSpatial.Serialization.QualifiedTypeName.Culture">
- <summary>
- Gets or sets the CultureInfo of the Culture
- </summary>
- </member>
- <member name="P:DotSpatial.Serialization.QualifiedTypeName.PublicKeyToken">
- <summary>
- Gets or sets the public key token for the strong name of the assembly.
- </summary>
- </member>
- <member name="T:DotSpatial.Serialization.ReadOnlyException">
- <summary>
- ReadOnlyException
- </summary>
- </member>
- <member name="M:DotSpatial.Serialization.ReadOnlyException.#ctor">
- <summary>
- Creates a new instance of ReadOnlyException
- </summary>
- </member>
- <member name="M:DotSpatial.Serialization.ReadOnlyException.#ctor(System.String)">
- <summary>
- Obsolete
- </summary>
- <param name="message"></param>
- </member>
- <member name="T:DotSpatial.Serialization.ReflectionHelper">
- <summary>
- A set of utilities to automate some common reflection tasks.
- </summary>
- </member>
- <member name="M:DotSpatial.Serialization.ReflectionHelper.FindDerivedClasses``1">
- <summary>
- Searches the entire folder tree beginning at the entry assembly path for types that derive from the specified type.
- </summary>
- <typeparam name="T">The base class/interface type</typeparam>
- <returns>A list of all types found in the search.</returns>
- </member>
- <member name="M:DotSpatial.Serialization.ReflectionHelper.FindDerivedClasses(System.Type)">
- <summary>
- Searches the entire folder tree beginning at the entry assembly path for types that derive from the specified type.
- </summary>
- <param name="baseType">The base class/interface type.</param>
- <returns>A list of all types found in the search.</returns>
- </member>
- <member name="T:DotSpatial.Serialization.SerializationFormatter">
- <summary>
- Base class for formatters responsible for converting objects to and from string values.
- </summary>
- </member>
- <member name="M:DotSpatial.Serialization.SerializationFormatter.ToString(System.Object)">
- <summary>
- Converts an object to a string value.
- </summary>
- <param name="value">The object to convert.</param>
- <returns>The string representation of the given object.</returns>
- </member>
- <member name="M:DotSpatial.Serialization.SerializationFormatter.FromString(System.String)">
- <summary>
- Converts a string representation of an object back into the original object form.
- </summary>
- <param name="value">The string representation of an object.</param>
- <returns>The object represented by the given string.</returns>
- </member>
- <member name="T:DotSpatial.Serialization.SerializationMap">
- <summary>
- This class stores the reflected data required for serialization.
- </summary>
- </member>
- <member name="M:DotSpatial.Serialization.SerializationMap.#cctor">
- <summary>
- The static constructor creates a dictionary that maps an object type to a specific SerializationMap instance.
- </summary>
- </member>
- <member name="M:DotSpatial.Serialization.SerializationMap.#ctor(System.Type)">
- <summary>
- Creates a new instance of the SerializationMap class.
- </summary>
- <param name="forType">The type associated with this SerializationMap.</param>
- </member>
- <member name="M:DotSpatial.Serialization.SerializationMap.FromType(System.Type)">
- <summary>
- This overload is used for objects that are marked with the <see cref="T:DotSpatial.Serialization.SerializeAttribute"/>.
- </summary>
- <param name="type">The type to generate a <c>SerializationMap</c> for.</param>
- <returns>A new serialization map that can be used to serialize the given type.</returns>
- </member>
- <member name="M:DotSpatial.Serialization.SerializationMap.Serialize(System.Reflection.MemberInfo,System.String)">
- <summary>
- The forward method that will serialize a property or field with the specified name.
- The name does not have to be the same as the name of the member.
- </summary>
- <param name="memberInfo">The property or field information to serialize</param>
- <param name="name">The name to remove</param>
- <returns>The Serialization Map Entry created by the serialize method</returns>
- </member>
- <member name="P:DotSpatial.Serialization.SerializationMap.ForType">
- <summary>
- The type that this serialization map instance is associated with.
- </summary>
- </member>
- <member name="P:DotSpatial.Serialization.SerializationMap.Members">
- <summary>
- The members that participate in serialization.
- </summary>
- </member>
- <member name="T:DotSpatial.Serialization.SerializationMapEntry">
- <summary>
- Contains the information needed to serialize a single property or field.
- </summary>
- </member>
- <member name="M:DotSpatial.Serialization.SerializationMapEntry.#ctor(System.Reflection.MemberInfo,DotSpatial.Serialization.SerializeAttribute)">
- <summary>
- Creates a new SerializationMapEntry instance.
- </summary>
- <param name="memberInfo">Info about the field or property to serialize.</param>
- <param name="attribute">Details about how to serialize this member.</param>
- </member>
- <member name="M:DotSpatial.Serialization.SerializationMapEntry.AsConstructorArgument(System.Int32)">
- <summary>
- Assigns the constructor argument index of this entry's attribute.
- </summary>
- <param name="index">The constructor argument index to assign</param>
- </member>
- <member name="M:DotSpatial.Serialization.SerializationMapEntry.WithFormatterType(System.Type)">
- <summary>
- Assigns the formatter value of this entry's attribute.
- </summary>
- <param name="formatterType">The serialization formatter to use for the associated member.</param>
- </member>
- <member name="M:DotSpatial.Serialization.SerializationMapEntry.Equals(System.Object)">
- <summary>
- Overrides the normal equality test to take into account serialization
- </summary>
- <param name="obj"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Serialization.SerializationMapEntry.GetHashCode">
- <summary>
- Returns a numeric hash code austensibly uniquishly controlled by the member and attribute hash code.
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Serialization.SerializationMapEntry.Member">
- <summary>
- The <see cref="T:System.Reflection.FieldInfo"/> or <see cref="T:System.Reflection.PropertyInfo"/> instance for the associated member.
- </summary>
- </member>
- <member name="P:DotSpatial.Serialization.SerializationMapEntry.Attribute">
- <summary>
- The attribute that contains more details about how to serialize this member.
- </summary>
- </member>
- <member name="T:DotSpatial.Serialization.SerializeAttribute">
- <summary>
- This class contains details on how to serialize a field or property.
- </summary>
- </member>
- <member name="M:DotSpatial.Serialization.SerializeAttribute.#ctor(System.String)">
- <summary>
- Creates a new instance of the SerializeAttribute.
- </summary>
- <param name="name">The name to use when serializing the associated member.</param>
- </member>
- <member name="P:DotSpatial.Serialization.SerializeAttribute.Name">
- <summary>
- The name to use when serializing the associated member.
- </summary>
- </member>
- <member name="P:DotSpatial.Serialization.SerializeAttribute.ConstructorArgumentIndex">
- <summary>
- The constructor argument index that the associated member represents.
- The default value is -1, which indicates that the associated member is
- not used as a constructor argument.
- </summary>
- </member>
- <member name="P:DotSpatial.Serialization.SerializeAttribute.Formatter">
- <summary>
- The type of the formatter to use for the associated value.
- The type must be derived from <see cref="T:DotSpatial.Serialization.SerializationFormatter"/>.
- </summary>
- </member>
- <member name="T:DotSpatial.Serialization.TypeNameManager">
- <summary>
- In many cases, the explicit type name references a version or public key token that is expired,
- even though the reference is still perfectly valid in the new instance. This type allows testing
- for that eventuality, as well as working directly with the components of a fully qualified name.
- </summary>
- </member>
- <member name="M:DotSpatial.Serialization.TypeNameManager.#ctor">
- <summary>
- Initializes a new instance of the TypeManager class.
- </summary>
- </member>
- <member name="M:DotSpatial.Serialization.TypeNameManager.UpdateTypename(System.String)">
- <summary>
- Since the version, or even possibly the strong name may be dynamic, an older
- reference may need to be updated with local assembly information.
- </summary>
- <param name="invalidTypeName">The invalidated type name, usually because the version is out of date.</param>
- <returns>A string represnting the same type, but with a modern assmebly.</returns>
- </member>
- <member name="M:DotSpatial.Serialization.TypeNameManager.UpdateAssembly(System.String)">
- <summary>
- This method searches the executable path, as well as sub-folders looking for an instance of
- the specified assembly. Since this class is only needed if the fully qualified assembly name
- is invalid, we have to assume that we are looking for something else.
- </summary>
- <param name="assembly">The string assembly name.</param>
- </member>
- <member name="T:DotSpatial.Serialization.XmlConstants">
- <summary>
- A class that works like an enumeration to define several constants.
- </summary>
- </member>
- <member name="F:DotSpatial.Serialization.XmlConstants.DICTIONARY">
- <summary>
- dictionary
- </summary>
- </member>
- <member name="F:DotSpatial.Serialization.XmlConstants.DICTIONARY_ENTRY">
- <summary>
- entry
- </summary>
- </member>
- <member name="F:DotSpatial.Serialization.XmlConstants.DICTIONARY_KEY">
- <summary>
- key
- </summary>
- </member>
- <member name="F:DotSpatial.Serialization.XmlConstants.DICTIONARY_VALUE">
- <summary>
- value
- </summary>
- </member>
- <member name="F:DotSpatial.Serialization.XmlConstants.ENUM">
- <summary>
- enum
- </summary>
- </member>
- <member name="F:DotSpatial.Serialization.XmlConstants.LIST">
- <summary>
- list
- </summary>
- </member>
- <member name="F:DotSpatial.Serialization.XmlConstants.OBJECT">
- <summary>
- object
- </summary>
- </member>
- <member name="F:DotSpatial.Serialization.XmlConstants.PRIMITIVE">
- <summary>
- primitive
- </summary>
- </member>
- <member name="F:DotSpatial.Serialization.XmlConstants.STRING">
- <summary>
- string
- </summary>
- </member>
- <member name="F:DotSpatial.Serialization.XmlConstants.ROOT">
- <summary>
- root
- </summary>
- </member>
- <member name="F:DotSpatial.Serialization.XmlConstants.MEMBER">
- <summary>
- member
- </summary>
- </member>
- <member name="F:DotSpatial.Serialization.XmlConstants.ITEM">
- <summary>
- item
- </summary>
- </member>
- <member name="F:DotSpatial.Serialization.XmlConstants.TYPE_CACHE">
- <summary>
- types
- </summary>
- </member>
- <member name="F:DotSpatial.Serialization.XmlConstants.TYPE_ID">
- <summary>
- type
- </summary>
- </member>
- <member name="F:DotSpatial.Serialization.XmlConstants.VALUE">
- <summary>
- value
- </summary>
- </member>
- <member name="F:DotSpatial.Serialization.XmlConstants.ARG">
- <summary>
- arg
- </summary>
- </member>
- <member name="F:DotSpatial.Serialization.XmlConstants.FORMATTER">
- <summary>
- formatter
- </summary>
- </member>
- <member name="F:DotSpatial.Serialization.XmlConstants.NAME">
- <summary>
- name
- </summary>
- </member>
- <member name="F:DotSpatial.Serialization.XmlConstants.KEY">
- <summary>
- key
- </summary>
- </member>
- <member name="F:DotSpatial.Serialization.XmlConstants.ID">
- <summary>
- id
- </summary>
- </member>
- <member name="F:DotSpatial.Serialization.XmlConstants.REF">
- <summary>
- ref
- </summary>
- </member>
- <member name="M:DotSpatial.Serialization.XmlConstants.GetMemberType(System.Reflection.MemberInfo)">
- <summary>
- Returns a System.Type that corresponds to the MemberInfo,
- regardless of whether the member is a field or property.
- </summary>
- <param name="memberInfo">The base class that can be either a FieldInfo or PropertyInfo</param>
- <returns>The System.Type</returns>
- </member>
- <member name="T:DotSpatial.Serialization.XmlDeserializer">
- <summary>
- Converts serialized XML into an object.
- </summary>
- </member>
- <member name="M:DotSpatial.Serialization.XmlDeserializer.Deserialize``1(System.String)">
- <summary>
- Converts the given XML string into an object.
- </summary>
- <typeparam name="T">The type to cast the returned object as.</typeparam>
- <param name="xml">The serialized XML text.</param>
- <returns>The object represented by the serialized XML.</returns>
- </member>
- <member name="M:DotSpatial.Serialization.XmlDeserializer.Deserialize``1(``0,System.String)">
- <summary>
- Deserializes the given XML, writing the values into the given object.
- </summary>
- <typeparam name="T">The type of the given object.</typeparam>
- <param name="existingObject">An existing object to fill with data.</param>
- <param name="xml">The serialized XML text.</param>
- </member>
- <member name="M:DotSpatial.Serialization.XmlDeserializer.ReadObject(System.Xml.Linq.XElement,System.Object)">
- <summary>
- Creates and populates an object from the given XML element.
- </summary>
- <param name="element">The element containing the object description</param>
- <param name="parent">The parent.</param>
- <returns>
- A populated object specified by the given XML element.
- </returns>
- </member>
- <member name="T:DotSpatial.Serialization.XmlHelper">
- <summary>
- A class that helps with xml project serialization
- </summary>
- </member>
- <member name="M:DotSpatial.Serialization.XmlHelper.EscapeInvalidCharacters(System.String)">
- <summary>
- Some characters create problems in xml format by being interpreted by xml parsers as
- content formatting tags.
- </summary>
- <param name="text">The string text of the unescaped original characters</param>
- <returns>The modified string where the characters are replaced</returns>
- </member>
- <member name="M:DotSpatial.Serialization.XmlHelper.UnEscapeInvalidCharacters(System.String)">
- <summary>
- This converts the invalid characters back to the original, unescaped text
- </summary>
- <param name="text">The string text of the escaped characters</param>
- <returns>The unescaped string text</returns>
- </member>
- <member name="M:DotSpatial.Serialization.XmlHelper.IsValidEscapeSequence(System.String,System.Int32)">
- <summary>
- This tests the string in the provided text parameter starting at the specified startIndex.
- If the combination of characters builds one of the recognized escape sequences, then this
- returns true.
- </summary>
- <param name="text">The string to test.</param>
- <param name="startIndex">The zero based integer start index.</param>
- <returns>A boolean that is true if the startIndex begins an escape sequence.</returns>
- </member>
- <member name="T:DotSpatial.Serialization.XmlSerializer">
- <summary>
- Serializes data to XML. A valid serialization map must be available for all classes being serialized.
- The serialization map is generally created at runtime from fields and properties marked with the
- <see cref="T:DotSpatial.Serialization.SerializeAttribute"/>. For classes that cannot be directly marked up with attributes a
- new map class can be created explicitly as needed.
- </summary>
- </member>
- <member name="M:DotSpatial.Serialization.XmlSerializer.Serialize(System.Object)">
- <summary>
- Converts an object into XML.
- </summary>
- <param name="value">The object to serialize.</param>
- <returns>A string containing the serialization of the given object.</returns>
- </member>
- </members>
-</doc>
diff --git a/MES_Wind/bin/Debug/DotSpatial.Symbology.Forms.pdb b/MES_Wind/bin/Debug/DotSpatial.Symbology.Forms.pdb
deleted file mode 100644
index ccdb7801ab2b667f6a67790d99a0b1212b67864e..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/DotSpatial.Symbology.Forms.pdb and /dev/null differ
diff --git a/MES_Wind/bin/Debug/DotSpatial.Symbology.Forms.xml b/MES_Wind/bin/Debug/DotSpatial.Symbology.Forms.xml
deleted file mode 100644
index ef52e3e140757385962ffb24f572f5a3ba57c3c5..0000000000000000000000000000000000000000
--- a/MES_Wind/bin/Debug/DotSpatial.Symbology.Forms.xml
+++ /dev/null
@@ -1,8245 +0,0 @@
-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>DotSpatial.Symbology.Forms</name>
- </assembly>
- <members>
- <member name="T:DotSpatial.Symbology.Forms.AddCustomSymbolDialog">
- <summary>
- ExportFeature
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Forms.AddCustomSymbolDialog.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AddCustomSymbolDialog.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AddCustomSymbolDialog.#ctor(System.Collections.Generic.List{System.String},DotSpatial.Symbology.IFeatureSymbolizer)">
- <summary>
- This looks like a function created by Mr. Jiri and not commented on.
- </summary>
- <param name="symbolCategories"></param>
- <param name="symbolizer"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AddCustomSymbolDialog.CreateCustomSymbolizer">
- <summary>
- Creates the new custom symbolizer with the specified name and category
- </summary>
- <returns>the custom symbolizer</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AddCustomSymbolDialog.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.AddCustomSymbolDialog.CustomSymbolizer">
- <summary>
- The custom symbolizer edited by this form
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.AngleControl">
- <summary>
- A user control for specifying angles
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AngleControl.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AngleControl.#ctor">
- <summary>
- A user control designed to allow an angle to be chosen
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AngleControl.OnAngleChanged">
- <summary>
- Fires the angle changed event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AngleControl.OnAngleChosen">
- <summary>
- fires an event once the mouse has been released.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.AngleControl.AngleChanged">
- <summary>
- Occurs when the angle changes either by the picker or the textbox.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.AngleControl.AngleChosen">
- <summary>
- Occurs when the mouse up event occurs on the picker
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.AngleControl.Angle">
- <summary>
- Gets or sets the integer angle in degrees.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.AngleControl.Clockwise">
- <summary>
- Gets or sets a boolean indicating if the values should increase in the
- clockwise direction instead of the counter clockwise direction
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.AngleControl.KnobColor">
- <summary>
- Gets or sets the base Knob Color
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.AngleControl.StartAngle">
- <summary>
- Gets or sets the start angle in degrees measured counter clockwise from the X axis.
- For instance, for an azimuth angle that starts at the top, this should be set to 90.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.AngleControl.Caption">
- <summary>
- Gets or sets the string text for this control.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.AngleEditor">
- <summary>
- CharacterCodeEditor
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AngleEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)">
- <summary>
- Edits a value based on some user input which is collected from a character control.
- </summary>
- <param name="context"></param>
- <param name="provider"></param>
- <param name="value"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AngleEditor.GetEditStyle(System.ComponentModel.ITypeDescriptorContext)">
- <summary>
- Gets the UITypeEditorEditStyle, which in this case is drop down.
- </summary>
- <param name="context"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.AngleEditor.IsDropDownResizable">
- <summary>
- Ensures that we can widen the drop-down without having to close the drop down,
- widen the control, and re-open it again.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.AnglePicker">
- <summary>
- A component that allows the easy selection of a rotation situation.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Forms.AnglePicker.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AnglePicker.#ctor">
- <summary>
- A class designed to allow easy rotation to change the angle
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AnglePicker.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AnglePicker.OnAngleChanged">
- <summary>
- Fires the angle changed event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AnglePicker.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AnglePicker.OnPaintBackground(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Prevent flicker
- </summary>
- <param name="pevent"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AnglePicker.OnPaint(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Paints the current state of the control
- </summary>
- <param name="pe"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AnglePicker.OnMouseMove(System.Windows.Forms.MouseEventArgs)">
- <summary>
- Handles the case where we are rotating the handle
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AnglePicker.OnMouseUp(System.Windows.Forms.MouseEventArgs)">
- <summary>
- Handles the Mouse Up event
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AnglePicker.OnAngleChosen">
- <summary>
- Fires the AngleChosen event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AnglePicker.OnResize(System.EventArgs)">
- <summary>
- Forces this control to redraw while changing size.
- </summary>
- <param name="e"></param>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.AnglePicker.AngleChanged">
- <summary>
- Occurs when the angle is changed either by dragging or by typing a hard value.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.AnglePicker.AngleChosen">
- <summary>
- Occurs after the mouse up event when dragging the angle
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.AnglePicker.Angle">
- <summary>
- Gets or sets the angle measured in degrees, counter-clockwise from the x axis.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.AnglePicker.BorderStyle">
- <summary>
- Gets or sets the current border style for the entire picker control
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.AnglePicker.Clockwise">
- <summary>
- Gets or sets a boolean indicating if the values should increase in the
- clockwise direction instead of the counter clockwise direction
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.AnglePicker.CircleFillColor">
- <summary>
- Gets or sets the fill color of the circle
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.AnglePicker.CircleBorderColor">
- <summary>
- Gets or sets the border color of the circle
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.AnglePicker.CircleBorderStyle">
- <summary>
- Gets or sets the border style for the circle.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.AnglePicker.PieFillColor">
- <summary>
- Gets or sets the color of the angular pie section illustrating the angle
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.AnglePicker.TextAlignment">
- <summary>
- Gets or sets the alignment of the text in the control.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.AnglePicker.KnobColor">
- <summary>
- Gets or sets the color of the circle that illustrates the position of the current angle
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.AnglePicker.KnobVisible">
- <summary>
- Gets or sets a boolean. If this is false, then the knob will not be drawn.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.AnglePicker.Snap">
- <summary>
- Gets or sets an integer in degrees specifying the snapping tollerance for multiples of 45 degrees.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.AnglePicker.StartAngle">
- <summary>
- Gets or sets the start angle in degrees measured counter clockwise from the X axis.
- For instance, for an azimuth angle that starts at the top, this should be set
- to 90.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.AngleTextBox">
- <summary>
- This parses the input values and changes the background color to salmon
- if the value won't work as a degree.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.ValidTextBox">
- <summary>
- This parses the input values and changes the background color to salmon
- if the value won't work as a degree.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.IErrorCheck.HasError">
- <summary>
- Boolean, true if there is an error on this device.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.IErrorCheck.ErrorMessage">
- <summary>
- Specifies the current error message.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.IErrorCheck.MessageName">
- <summary>
- Gets the cleanly formatted name for this control for an error message
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ValidTextBox.#ctor">
- <summary>
- Creates a new instance of AngleTextBox
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ValidTextBox.ClearError">
- <summary>
- This changes the error text,
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ValidTextBox.NormalToolTipText">
- <summary>
- Gets or sets the text that should appear as the mouse hovers over this textbox
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ValidTextBox.BackColor">
- <summary>
- Hide the actual BackColor property which will be controlled
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ValidTextBox.ErrorBackgroundColor">
- <summary>
- Gets or sets the background color of this control if the text is not valid.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ValidTextBox.NormalBackgroundColor">
- <summary>
- Gets or sets the normal background color for when the value is valid.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ValidTextBox.HasError">
- <summary>
- Gets a boolean indicating if this textbox has an error.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ValidTextBox.ErrorMessage">
- <summary>
- Gets a string indicating the current error for this control.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ValidTextBox.MessageName">
- <summary>
- Gets or sets the formatted name to use for this control in an error message.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AngleTextBox.#ctor">
- <summary>
- Creates a new instance of AngleTextBox
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AngleTextBox.OnTextChanged(System.EventArgs)">
- <summary>
- Fires the TextChanged method and also determines whether or not the text is a valid integer.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AngleTextBox.OnAngleChanged(System.EventArgs)">
- <summary>
- Fires the AngleChanged event
- </summary>
- <param name="e"></param>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.AngleTextBox.AngleChanged">
- <summary>
- Occurs continuously as someone drags the angle control around
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.AngleTextBox.Angle">
- <summary>
- Gets or sets the integer angle for this textbox.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.AngleTextBox.MinAngle">
- <summary>
- Gets or sets the minimum valid angle. An angle below the minimum will
- register an error and show the error color.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.AngleTextBox.MaxAngle">
- <summary>
- Gets or sets the maximum valid angle. An angle above the maximum will
- register an error and show the error color.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.AttributeDialog">
- <summary>
- Atrribute Table editor form
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AttributeDialog.#ctor(DotSpatial.Symbology.IFeatureLayer)">
- <summary>
- Creates a new instance of the attribute Table editor form
- <param name="featureLayer">The feature layer associated with
- this instance and displayed in the editor</param>
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Forms.AttributeDialog.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AttributeDialog.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AttributeDialog.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.AddNewColum">
- <summary>
- A Dialog for adding new column information to a data table.
- </summary>
- <summary>
- Presumably a class for adding a new column to the attribute Table editor
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Forms.AddNewColum._name">
- <summary>
- This form will display when the user want to add new fiels in the Table
- </summary>
-
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AddNewColum.#ctor">
- <summary>
- A public constructor for creating a new column
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Forms.AddNewColum.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AddNewColum.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AddNewColum.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.AddNewColum.Name">
- <summary>
- set or get the Name of the field.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.AddNewColum.Type">
- <summary>
- set or get the type of the field.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.AddNewColum.Size">
- <summary>
- set or get the size of the field.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.AttributeCalculator">
- <summary>
- A Dialog for performing calculations on attributes.
- </summary>
- <summary>
- Presumably a form for performing calculations
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AttributeCalculator.#ctor">
- <summary>
- this form will show to user to algebra calculation
- with attribute fields and user can save it back in attribute Table.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AttributeCalculator.LoadTableField(System.Collections.Generic.List{System.String})">
- <summary>
- This will load the attribute field in Table Field.
- </summary>
- <param name="list"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AttributeCalculator.DisplyExpression">
- <summary>
- This will display the Expression in RichText box
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AttributeCalculator.ParExp(System.String)">
- <summary>
- Tral: This will divide the string to relavent functions level
- </summary>
- <param name="exp"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AttributeCalculator.FindFieldInDataTable(System.String)">
- <summary>
- This will check and return the column index as given field name or -1 for not find.
- </summary>
- <param name="arg"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AttributeCalculator.OnNewFieldAdded">
- <summary>
- This will activate the NewFieldAdded event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AttributeCalculator.GetTokenNo(System.String)">
- <summary>
- this give the relavent token no
- </summary>
- <param name="subExp">Function Name</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AttributeCalculator.ExpIntegr(System.Double)">
- <summary>
- exponential integral Ei(x) for x >0.
- </summary>
- <param name="x"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AttributeCalculator.Zeta(System.Double)">
- <summary>
- Riemman's zeta function
- </summary>
- <param name="x"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AttributeCalculator.Beta(System.Double,System.Double)">
- <summary>
- beta function
- </summary>
- <param name="z"></param>
- <param name="w"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AttributeCalculator.Fact(System.Double)">
- <summary>
- Calculate the Factorial in given number
- </summary>
- <param name="n"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AttributeCalculator.Comb(System.Double,System.Double)">
- <summary>
- combination n objects, k classes
- </summary>
- <param name="a"></param>
- <param name="b"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AttributeCalculator.Mcd(System.Double,System.Double)">
- <summary>
- FIdx the MCD between two integer numbers
- </summary>
- <param name="a"></param>
- <param name="b"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AttributeCalculator.Mcm(System.Double,System.Double)">
- <summary>
- FIdx the mcm between two integer numbers
- </summary>
- <param name="a"></param>
- <param name="b"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AttributeCalculator.Erf(System.Double)">
- <summary>
- error distribution function
- </summary>
- <param name="x"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AttributeCalculator.Gamma">
- <summary>
- gamma function
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AttributeCalculator.GammaLn">
- <summary>
- logarithm gamma function
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AttributeCalculator.Digamma(System.Double)">
- <summary>
- digamma function
- </summary>
- <param name="x"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AttributeCalculator.GammaSplit(System.Double@,System.Int32@)">
- <summary>
- gamma - Lanczos approximation algorithm for gamma function
- </summary>
- <param name="mantissa"></param>
- <param name="expo"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AttributeCalculator.CheckExpo(System.String)">
- <summary>
- this will return true if string is Exponetial.eg 1.2E+2,
- </summary>
- <param name="arg"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AttributeCalculator.IsNumeric(System.Collections.Generic.IEnumerable{System.Char})">
- <summary>
- check if argument is number
- x must have always the decimal point "123.756", ".0056", "1.3455E-12"
- </summary>
- <param name="arg"></param>
- <returns></returns>
- </member>
- <member name="F:DotSpatial.Symbology.Forms.AttributeCalculator.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AttributeCalculator.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AttributeCalculator.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.AttributeCalculator.Expression">
- <summary>
- set or get the Expression of computation.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.AttributeCalculator.FeatureSet">
- <summary>
- get or set dataset
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.AttributeCalculator.NewFieldAdded">
- <summary>
- Occurs whenever the user Added new field to the Table
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.CalculatorUserGuide">
- <summary>
- This form is strictly designed to show some helpful information about using a calculator.
- </summary>
- <summary>
- A class giving information on how to use the calculator functions.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.CalculatorUserGuide.#ctor">
- <summary>
- Creates a new instance of the calculator user guide form.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Forms.CalculatorUserGuide.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.CalculatorUserGuide.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.CalculatorUserGuide.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.ColorCategoryActions">
- <summary>
- Default implementation of IColorCategoryActions
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.LegendItemActionsBase">
- <summary>
- Contains common methods for "Actions" classes (e.g. LayerActions, etc...)
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.IIWin32WindowOwner">
- <summary>
- Contains IWin32Window Owner
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.IIWin32WindowOwner.Owner">
- <summary>
- Allows setting the owner for any dialogs that need to be launched.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LegendItemActionsBase.ShowDialog(System.Windows.Forms.Form)">
- <summary>
- Shows the form as a modal dialog box with the owner defined in this class.
- </summary>
- <param name="form">Form to show.</param>
- <returns>One of the <see cref="T:System.Windows.Forms.DialogResult"/> values.</returns>
- <exception cref="T:System.ArgumentNullException">form is null.</exception>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LegendItemActionsBase.ShowDialog(System.Windows.Forms.CommonDialog)">
- <summary>
- Runs a common dialog box with the owner defined in this class.
- </summary>
- <param name="dlg">Dialog to show.</param>
- <returns>One of the <see cref="T:System.Windows.Forms.DialogResult"/> values.</returns>
- <exception cref="T:System.ArgumentNullException">dlg is null.</exception>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.LegendItemActionsBase.Owner">
- <summary>
- Allows setting the owner for any dialogs that need to be launched.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ColorCategoryActions.ShowEdit(DotSpatial.Symbology.IColorCategory)">
- <summary>
- Show the color category editor form.
- </summary>
- <param name="e"></param>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.DetailedLineSymbolControl">
- <summary>
- DetailedLineSymbolDialog
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Forms.DetailedLineSymbolControl.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DetailedLineSymbolControl.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DetailedLineSymbolControl.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DetailedLineSymbolControl.#ctor">
- <summary>
- Creates a new instance of DetailedLineSymbolDialog
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DetailedLineSymbolControl.#ctor(DotSpatial.Symbology.ILineSymbolizer)">
- <summary>
- Creates a new Detailed Line Symbol Dialog that displays a copy of the original,
- and when apply changes is pressed, will copy properties to the original.
- </summary>
- <param name="original">The current symbolizer being viewed on the map</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DetailedLineSymbolControl.#ctor(DotSpatial.Symbology.ILineSymbolizer,DotSpatial.Symbology.ILineSymbolizer)">
- <summary>
- This constructor shows a different symbolizer in the view from what is currently loaded on the map.
- If apply changes is clicked, the properties of the current symbolizer will be copied to the original.
- </summary>
- <param name="original">The symbolizer on the map</param>
- <param name="displayed">The symbolizer that defines the form setup</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DetailedLineSymbolControl.UpdateOpacity(System.Single)">
- <summary>
- Updates the opacity of the simple/cartographic stroke
- </summary>
- <param name="value">THe floating point value to use for the opacity, where 0 is transparent and 1 is opaque</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DetailedLineSymbolControl.Initialize(DotSpatial.Symbology.ILineSymbolizer)">
- <summary>
- Initializes the control by updating the symbolizer
- </summary>
- <param name="original"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DetailedLineSymbolControl.UpdateStrokeControls">
- <summary>
- When the stroke is changed, this updates the controls to match it.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DetailedLineSymbolControl.ApplyChanges">
- <summary>
- Forces the original to apply the changes to the new control
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DetailedLineSymbolControl.OnAddToCustomSymbols">
- <summary>
- Fires the AddtoCustomSymbols event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DetailedLineSymbolControl.OnApplyChanges">
- <summary>
- Fires the ChangesApplied event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DetailedLineSymbolControl.nudPercentualPosition_ValueChanged(System.Object,System.EventArgs)">
- <summary>
- Update the selected linedecoration: set the percentual position between line start and end of the single decoration.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DetailedLineSymbolControl.chkFlipAll_CheckedChanged(System.Object,System.EventArgs)">
- <summary>
- Update the selected linedecoration: set whether all decorations should be flipped.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DetailedLineSymbolControl.chkFlipFirst_CheckedChanged(System.Object,System.EventArgs)">
- <summary>
- Update the selected linedecoration: set whether the first decoration should be flipped.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.DetailedLineSymbolControl.ChangesApplied">
- <summary>
- Fires an event indicating that changes should be applied.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.DetailedLineSymbolControl.AddToCustomSymbols">
- <summary>
- Occurs when the user clicks the AddToCustomSymbols button
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DetailedLineSymbolControl.Symbolizer">
- <summary>
- Gets the current (copied) symbolizer or initializes this control to work with the
- specified symbolizer as the original.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.ExpressionControl">
- <summary>
- Control to create, edit and validate label expressions.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ExpressionControl.#ctor">
- <summary>
- Control to edit and validate expressions that can be used to label features.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ExpressionControl.btNewLine_Click(System.Object,System.EventArgs)">
- <summary>
- Adds a new line.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ExpressionControl.btValidate_Click(System.Object,System.EventArgs)">
- <summary>
- Validates the expression and shows the error or result.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ExpressionControl.dgvFields_CellMouseDoubleClick(System.Object,System.Windows.Forms.DataGridViewCellMouseEventArgs)">
- <summary>
- Adds the field that was double clicked to the expression.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ExpressionControl.rtbExpression_KeyDown(System.Object,System.Windows.Forms.KeyEventArgs)">
- <summary>
- Suppress tab if it was entered because it is illigal in expressions.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ExpressionControl.ValidateExpression">
- <summary>
- Validates the Expression including syntax and operations.
- </summary>
- <returns>True, if Expression is valid.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ExpressionControl.UpdateFields">
- <summary>
- Replaces the expression fields by the columns of the current _attributeSource or _table.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Forms.ExpressionControl.components">
- <summary>
- Erforderliche Designervariable.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ExpressionControl.Dispose(System.Boolean)">
- <summary>
- Verwendete Ressourcen bereinigen.
- </summary>
- <param name="disposing">True, wenn verwaltete Ressourcen gelöscht werden sollen; andernfalls False.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ExpressionControl.InitializeComponent">
- <summary>
- Erforderliche Methode für die Designerunterstützung.
- Der Inhalt der Methode darf nicht mit dem Code-Editor geändert werden.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ExpressionControl.AllowEmptyExpression">
- <summary>
- Gets/Sets whether empty expressions are valid.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ExpressionControl.AttributeSource">
- <summary>
- Setting this is an alternative to specifying the table. This allows the
- query control to build a query using pages of data instead of the whole
- table at once.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ExpressionControl.Table">
- <summary>
- Gets or sets the data Table for this control. Setting this will
- automatically update the fields shown in the list.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ExpressionControl.ExpressionText">
- <summary>
- Expression that gets edited and validated in ExpressionControl.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.FeatureCategoryControl">
- <summary>
- Dialog for the 'unique values' feature symbol classification scheme
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.ICategoryControl">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ICategoryControl.Initialize(DotSpatial.Symbology.ILayer)">
- <summary>
- Initializes the specified layer.
- </summary>
- <param name="layer">The layer.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ICategoryControl.ApplyChanges">
- <summary>
- Applies the changes.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ICategoryControl.Cancel">
- <summary>
- Cancels changes.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FeatureCategoryControl.Dispose(System.Boolean)">
- <summary>
- Handles disposing unmanaged memory
- </summary>
- <param name="disposing">The disposed item</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FeatureCategoryControl.#ctor">
- <summary>
- Creates an empty FeatureCategoryControl without specifying any particular layer to use
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FeatureCategoryControl.#ctor(DotSpatial.Symbology.IFeatureLayer)">
- <summary>
- Creates a new instance of the unique values category Table
- </summary>
- <param name="layer">The original scheme</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FeatureCategoryControl.OnMouseWheel(System.Windows.Forms.MouseEventArgs)">
- <summary>
- Handles the mouse wheel, allowing the breakSldierGraph to zoom in or out.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FeatureCategoryControl.Initialize(DotSpatial.Symbology.IFeatureLayer)">
- <summary>
- Sets up the Table to work with the specified layer. This should be the copy,
- and not the original.
- </summary>
- <param name="layer"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FeatureCategoryControl.GetSchemeType(DotSpatial.Symbology.IFeatureLayer)">
- <summary>
- Gets the scheme type based on the type of the layer's underlying dataset
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FeatureCategoryControl.UpdateFields">
- <summary>
- Updates the fields in the fields combo box
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FeatureCategoryControl.UpdateTable(DotSpatial.Data.ICancelProgressHandler)">
- <summary>
- Updates the Table using the unique values
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FeatureCategoryControl.ApplyChanges">
- <summary>
- Fires the apply changes situation externally, forcing the Table to
- write its values to the original layer.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FeatureCategoryControl.OnApplyChanges">
- <summary>
- Applies the changes that have been specified in this control
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FeatureCategoryControl.Cancel">
- <summary>
- Cancel the action.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FeatureCategoryControl.cmbField_SelectedIndexChanged(System.Object,System.EventArgs)">
- <summary>
- When the user changes the selected attribute field
- </summary>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FeatureCategoryControl.DgvCategoriesCellDoubleClick(System.Object,System.Windows.Forms.DataGridViewCellEventArgs)">
- <summary>
- When the user double clicks the cell then we should display the detailed
- symbology dialog
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FeatureCategoryControl.DgvCategoriesCellFormatting(System.Object,System.Windows.Forms.DataGridViewCellFormattingEventArgs)">
- <summary>
- When the cell is formatted
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FeatureCategoryControl.Initialize(DotSpatial.Symbology.ILayer)">
- <summary>
- Initializes the specified layer.
- </summary>
- <param name="layer">The layer.</param>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.FeatureCategoryControl.ChangesApplied">
- <summary>
- Occurs when the apply changes option has been triggered.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.FeatureCategoryControl.Maximum">
- <summary>
- Gets or sets the Maximum value currently displayed in the graph.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.FeatureCategoryControl.Minimum">
- <summary>
- Gets or sets the Minimum value currently displayed in the graph.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.FilterEventArgs">
- <summary>
- This class in an EventArgs that also supports a filter expression.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FilterEventArgs.#ctor(System.String)">
- <summary>
- Initializes a new instance of the FilterEventArgs class.
- </summary>
- <param name="filterExpression">String, the filter expression to add.</param>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.FilterEventArgs.FilterExpression">
- <summary>
- Gets the string filter expression.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ImageCategoryControl.Initialize(DotSpatial.Symbology.IImageLayer)">
- <summary>
- Sets up the Table to work with the specified layer
- </summary>
- <param name="layer"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ImageCategoryControl.ApplyChanges">
- <summary>
- Fires the apply changes situation externally, forcing the Table to
- write its values to the original layer.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ImageCategoryControl.OnApplyChanges">
- <summary>
- Applies the changes that have been specified in this control
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ImageCategoryControl.Cancel">
- <summary>
- Cancel the action.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ImageCategoryControl.OnCancel">
- <summary>
- Event that fires when the action is canceled.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Forms.ImageCategoryControl.components">
- <summary>
- Erforderliche Designervariable.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ImageCategoryControl.Dispose(System.Boolean)">
- <summary>
- Verwendete Ressourcen bereinigen.
- </summary>
- <param name="disposing">True, wenn verwaltete Ressourcen gelöscht werden sollen; andernfalls False.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ImageCategoryControl.InitializeComponent">
- <summary>
- Erforderliche Methode für die Designerunterstützung.
- Der Inhalt der Methode darf nicht mit dem Code-Editor geändert werden.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.ImageCategoryControl.ChangesApplied">
- <summary>
- Occurs when the apply changes option has been triggered.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.ImageLayerActions">
- <summary>
- Actions that occur on an image layer in the legend.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ImageLayerActions.ShowProperties(DotSpatial.Symbology.IImageLayer)">
- <summary>
- Show the properties of an image layer in the legend.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ImageLayerActions.ExportData(DotSpatial.Data.IImageData)">
- <summary>
- Export data from an image layer.
- </summary>
- <param name="e"></param>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.LabelSetup">
- <summary>
- Label Setup form
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Forms.LabelSetup.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.#ctor">
- <summary>
- Creates a new instance of LabelSetup
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.TabsSelecting(System.Object,System.Windows.Forms.TabControlCancelEventArgs)">
- <summary>
- Shows the help for the selected tab.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.OnChangesApplied">
- <summary>
- Fires the ChangesApplied event.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.UpdatePreview">
- <summary>
- Updates any content that visually displays the currently selected characteristics.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.UpdateLayer">
- <summary>
- When the layer is updated or configured, this updates the data Table aspects if possible.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.UpdateControls">
- <summary>
- Updates the controls with the data of the active categories symbolizer.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.UpdateCategories">
- <summary>
- Updates the category list with the categories of the layers symbology.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.btnCategoryUp_Click(System.Object,System.EventArgs)">
- <summary>
- Moves the selected category up.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.btnCategoryDown_Click(System.Object,System.EventArgs)">
- <summary>
- Moves the selected category down.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.btnAdd_Click(System.Object,System.EventArgs)">
- <summary>
- Adds a new category.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.btnSubtract_Click(System.Object,System.EventArgs)">
- <summary>
- Removes the selected category.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.lbCategories_SelectedIndexChanged(System.Object,System.EventArgs)">
- <summary>
- Updates the controls with the data of the selected category.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.cbFontColor_ColorChanged(System.Object,System.EventArgs)">
- <summary>
- Rembemer selected FontColor and update Preview.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.fontFamilyControl1_SelectedItemChanged(System.Object,System.EventArgs)">
- <summary>
- Shows the preview with the selected font and corrects the style-selection.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.UpdateFontStyles">
- <summary>
- Updates the FontStyles with the styles that exist for the selected font.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.cmbStyle_SelectedIndexChanged(System.Object,System.EventArgs)">
- <summary>
- Shows the preview with the selected font style.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.cmbSize_SelectedIndexChanged(System.Object,System.EventArgs)">
- <summary>
- Shows the preview with the selected font size.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.chkBackgroundColor_CheckedChanged(System.Object,System.EventArgs)">
- <summary>
- Remembers whether BackColor is enabled.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.cbBackgroundColor_ColorChanged(System.Object,System.EventArgs)">
- <summary>
- Remembers the BackgroundColor and updates the preview.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.chkBorder_CheckedChanged(System.Object,System.EventArgs)">
- <summary>
- Remembers whether border gets used.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.cbBorderColor_ColorChanged(System.Object,System.EventArgs)">
- <summary>
- Remembers the BorderColor and updates the preview.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.chkPrioritizeLow_CheckedChanged(System.Object,System.EventArgs)">
- <summary>
- Remember whether low values get prioritized.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.cmbPriorityField_SelectedIndexChanged(System.Object,System.EventArgs)">
- <summary>
- Remember selected PriorityField.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.chkPreventCollision_CheckedChanged(System.Object,System.EventArgs)">
- <summary>
- Remember selected PreventCollision.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.cmbLabelAngleField_SelectedIndexChanged(System.Object,System.EventArgs)">
- <summary>
- Remember the selected LabelAngleField.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.nudAngle_ValueChanged(System.Object,System.EventArgs)">
- <summary>
- Save the changed angle.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.rbCommonAngle_CheckedChanged(System.Object,System.EventArgs)">
- <summary>
- De-/active NumericUpDown for common angle.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.rbIndividualAngle_CheckedChanged(System.Object,System.EventArgs)">
- <summary>
- De-/activate combobox for LabelAngleField.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.rbLineBasedAngle_CheckedChanged(System.Object,System.EventArgs)">
- <summary>
- De-/activate combobox for linebased angles.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.cmbLineAngle_SelectedIndexChanged(System.Object,System.EventArgs)">
- <summary>
- Remember selected LineOrientation.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.tbFloatingFormat_TextChanged(System.Object,System.EventArgs)">
- <summary>
- Remember floatingFormat.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.chkShadow_CheckedChanged(System.Object,System.EventArgs)">
- <summary>
- Remembers whether shadow is used.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.colorButtonShadow_ColorChanged(System.Object,System.EventArgs)">
- <summary>
- Remembers the shadows color.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.sliderOpacityShadow_ValueChanged(System.Object,System.EventArgs)">
- <summary>
- Remembers the shadows opacity.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.UpDownShadowOffsetY_ValueChanged(System.Object,System.EventArgs)">
- <summary>
- Remember the Y offset of the labelshadow from the center of the placement point.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.UpDownShadowOffsetX_ValueChanged(System.Object,System.EventArgs)">
- <summary>
- Remember the X offset of the labelshadow from the center of the placement point.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.chkHalo_CheckedChanged(System.Object,System.EventArgs)">
- <summary>
- Remembers whether halo is used.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.clrHalo_SelectedItemChanged(System.Object,System.EventArgs)">
- <summary>
- Remembers the halo color.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.nudYOffset_ValueChanged(System.Object,System.EventArgs)">
- <summary>
- Remember the Y offset of the label from the center of the placement point.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.nudXOffset_ValueChanged(System.Object,System.EventArgs)">
- <summary>
- Remember the X offset of the label from the center of the placement point.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.labelAlignmentControl1_ValueChanged(System.Object,System.EventArgs)">
- <summary>
- Remembers the position of the label relative to the placement point.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.cmbAlignment_SelectedIndexChanged(System.Object,System.EventArgs)">
- <summary>
- Remembers the alignment of multiline text.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.cmbLabelingMethod_SelectedIndexChanged(System.Object,System.EventArgs)">
- <summary>
- Remembers the labeling method.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.cmbLabelParts_SelectedIndexChanged(System.Object,System.EventArgs)">
- <summary>
- Remembers the way parts get labeled.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelSetup.sqlMembers_ExpressionTextChanged(System.Object,System.EventArgs)">
- <summary>
- Remembers the expression that is used to find the members that belong to the active category.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.LabelSetup.ChangesApplied">
- <summary>
- Occurs after the Apply button has been pressed
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.LabelSetup.Layer">
- <summary>
- Gets or sets the layer to use for defining this dialog
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.LayerActions">
- <summary>
- Actions that occur on a layer legend item.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LayerActions.DynamicVisibility(DotSpatial.Symbology.IDynamicVisibility,DotSpatial.Symbology.IFrame)">
- <summary>
- Determines whether a layer has dynamic visibility and hence is only shown at certain scales.
- </summary>
- <param name="e"></param>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.FeatureLayerActions">
- <summary>
- This member is virtual to allow custom event handlers to be used instead.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FeatureLayerActions.ShowProperties(DotSpatial.Symbology.IFeatureLayer)">
- <summary>
- Show the properties of a feature layer in the legend.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FeatureLayerActions.ExcelJoin(DotSpatial.Data.IFeatureSet)">
- <summary>
- Show the dialog to join an Excel table with a feature set.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FeatureLayerActions.LabelExtents(DotSpatial.Symbology.IDynamicVisibility)">
- <summary>
- Show the dialog to set label extents.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FeatureLayerActions.LabelSetup(DotSpatial.Symbology.ILabelLayer)">
- <summary>
- Show the dialog to set up labels.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FeatureLayerActions.ShowAttributes(DotSpatial.Symbology.IFeatureLayer)">
- <summary>
- Show the attribute table editor.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FeatureLayerActions.ExportData(DotSpatial.Symbology.IFeatureLayer)">
- <summary>
- Show the dialog for exporting data from a feature layer.
- </summary>
- <param name="e"></param>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.DeleteFieldsDialog">
- <summary>
- This will load to user select field to remove.
- </summary>
- <summary>
- A dialog for deleting a field.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DeleteFieldsDialog.#ctor">
- <summary>
- Creates a new instance of the form for deleting a field
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DeleteFieldsDialog.#ctor(System.Collections.Generic.List{System.String})">
- <summary>
- Creates a new instance of the form for deleting a field while passing in a new field.
- </summary>
- <param name="fields"></param>
- </member>
- <member name="F:DotSpatial.Symbology.Forms.DeleteFieldsDialog.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DeleteFieldsDialog.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DeleteFieldsDialog.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DeleteFieldsDialog.clb_SelectedIndexChanged(System.Object,System.EventArgs)">
- <summary>
- This event will fire when user select the item.
- </summary>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DeleteFieldsDialog.SelectedFieldIdList">
- <summary>
- get or set the list of selected Fields
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FunClass.#ctor">
- <summary>
- Initializes a new instance of the FunClass class.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FunClass.#ctor(System.String,System.Int32)">
- <summary>
- Initializes a new instance of the FunClass class.
- </summary>
- <param name="function">The function name.</param>
- <param name="index">The index of the class.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FunClass.#ctor(System.String,System.Int32,System.Int32)">
- <summary>
- Initializes a new instance of the FunClass class.
- </summary>
- <param name="function">The function name.</param>
- <param name="index">The index of the class.</param>
- <param name="posInExp">The position in the expression.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FunClass.#ctor(System.String,System.Int32,System.Int32,System.Int32)">
- <summary>
- Initializes a new instance of the FunClass class.
- </summary>
- <param name="function">The function name.</param>
- <param name="index">The index of the class.</param>
- <param name="posInExp">The position in the expression.</param>
- <param name="tokVal">The token value.</param>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.FunClass.FunctionName">
- <summary>
- Gets or sets the function string.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.FunClass.Index">
- <summary>
- Gets or sets the integer index.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.FunClass.PriorityLevel">
- <summary>
- Gets or sets the priority level.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.FunClass.PreviousArgument">
- <summary>
- Gets or sets the previous argument.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.FunClass.NextArgument">
- <summary>
- Gets or sets the next argument.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.FunClass.Value">
- <summary>
- Gets or sets the value.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.FunClass.PositionInExpression">
- <summary>
- Gets or sets position in the expression.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.FunClass.TokenVal">
- <summary>
- Gets or sets the token value.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.FunClass.NoOfArg">
- <summary>
- set or get the no Of arg fuction type
- either one or two or more than two
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.Properties.Resources">
- <summary>
- A strongly-typed resource class, for looking up localized strings, etc.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.Properties.Resources.ResourceManager">
- <summary>
- Returns the cached ResourceManager instance used by this class.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.Properties.Resources.Culture">
- <summary>
- Overrides the current thread's CurrentUICulture property for all
- resource lookups using this strongly typed resource class.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.Properties.Resources.TableEditorControl_FileNameInMemory">
- <summary>
- Looks up a localized string similar to In Memory.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.RasterCategoryControl">
- <summary>
- Dialog for the 'unique values' feature symbol classification scheme
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.RasterCategoryControl.Dispose(System.Boolean)">
- <summary>
- Handles disposing unmanaged memory
- </summary>
- <param name="disposing">The disposed item</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.RasterCategoryControl.#ctor">
- <summary>
- Creates an empty FeatureCategoryControl without specifying any particular layer to use
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.RasterCategoryControl.#ctor(DotSpatial.Symbology.IRasterLayer)">
- <summary>
- Creates a new instance of the unique values category Table
- </summary>
- <param name="layer">The feature set that is used</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.RasterCategoryControl.OnMouseWheel(System.Windows.Forms.MouseEventArgs)">
- <summary>
- Handles the mouse wheel, allowing the breakSliderGraph to zoom in or out.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.RasterCategoryControl.Initialize(DotSpatial.Symbology.IRasterLayer)">
- <summary>
- Sets up the Table to work with the specified layer
- </summary>
- <param name="layer"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.RasterCategoryControl.UpdateTable">
- <summary>
- Updates the Table using the unique values
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.RasterCategoryControl.ApplyChanges">
- <summary>
- Fires the apply changes situation externally, forcing the Table to
- write its values to the original layer.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.RasterCategoryControl.OnApplyChanges">
- <summary>
- Applies the changes that have been specified in this control
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.RasterCategoryControl.Cancel">
- <summary>
- Cancel the action.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.RasterCategoryControl.OnCancel">
- <summary>
- Event that fires when the action is canceled.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.RasterCategoryControl.DgvCategoriesCellDoubleClick(System.Object,System.Windows.Forms.DataGridViewCellEventArgs)">
- <summary>
- When the user double clicks the cell then we should display the detailed
- symbology dialog
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.RasterCategoryControl.DgvCategoriesCellFormatting(System.Object,System.Windows.Forms.DataGridViewCellFormattingEventArgs)">
- <summary>
- When the cell is formatted
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.RasterCategoryControl.Initialize(DotSpatial.Symbology.ILayer)">
- <summary>
- Initializes the specified layer.
- </summary>
- <param name="layer">The layer.</param>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.RasterCategoryControl.ChangesApplied">
- <summary>
- Occurs when the apply changes option has been triggered.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.RasterCategoryControl.ProgressBar">
- <summary>
- Gets the current progress bar.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.RasterCategoryControl.Maximum">
- <summary>
- Gets or sets the Maximum value currently displayed in the graph.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.RasterCategoryControl.Minimum">
- <summary>
- Gets or sets the Minimum value currently displayed in the graph.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.RasterLayerActions">
- <summary>
- Legend actions on a raster layer.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.RasterLayerActions.ShowProperties(DotSpatial.Symbology.IRasterLayer)">
- <summary>
- Shows the properties of the current raster legend item.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.RasterLayerActions.ExportData(DotSpatial.Data.IRaster)">
- <summary>
- Export data from a raster layer.
- </summary>
- <param name="e"></param>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.RenameFieldDialog">
- <summary>
- This will Pop when user want to rename the field
- </summary>
- <summary>
- A Dialog for renaming a field.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.RenameFieldDialog.#ctor">
- <summary>
- Constructs a new instance of the form for renaming a field
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.RenameFieldDialog.#ctor(System.Collections.Generic.List{System.String})">
- <summary>
- Creates a new instance of the form for renaming a field
- </summary>
- <param name="field"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.RenameFieldDialog.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.RenameFieldDialog.ResultCombination">
- <summary>
- get or set ResultCombination
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.SearchAndReplaceDialog">
- <summary>
- This form diplay to user to find perticular value or string in DataGridView and replace.
- </summary>
- <summary>
- The Designer for a dialog to replace a field.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SearchAndReplaceDialog.#ctor">
- <summary>
- Creates a new instance of the replace form.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Forms.SearchAndReplaceDialog.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SearchAndReplaceDialog.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SearchAndReplaceDialog.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SearchAndReplaceDialog.FindString">
- <summary>
- get the Find String
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SearchAndReplaceDialog.ReplaceString">
- <summary>
- get the ReplaceString
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.SelectByAttributes">
- <summary>
- SelectByAttributes
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Forms.SelectByAttributes.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SelectByAttributes.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SelectByAttributes.#ctor">
- <summary>
- Creates a new instance of SelectByAttributes
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SelectByAttributes.#ctor(DotSpatial.Symbology.IFrame)">
- <summary>
- Creates a new instance of SelectByAttributes
- </summary>
- <param name="mapFrame">the MapFrame containing the layers</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SelectByAttributes.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SelectByAttributes.MapFrame">
- <summary>
- Gets or sets the map frame to use for this control
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.SelectField">
- <summary>
- SelectField class
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Forms.SelectField.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SelectField.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SelectField.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SelectField.#ctor">
- <summary>
- Creates a new instance of a SelectField
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SelectField.#ctor(System.Collections.Generic.List{System.String})">
- <summary>
- Creates a new instance of a SelectField
- </summary>
- <param name="field"></param>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SelectField.FieldName">
- <summary>
- get Field Name
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.SQLQueryControl">
- <summary>
- Creates a new instance of the SQLQueryControl
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Forms.SQLQueryControl.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SQLQueryControl.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SQLQueryControl.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SQLQueryControl.#ctor">
- <summary>
- Creates a new instance of the control with no fields specified.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.SQLQueryControl.ExpressionTextChanged">
- <summary>
- Occurs when the text in the expression textbox has changed.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SQLQueryControl.ExpressionText">
- <summary>
- Gets or sets the string expression text
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SQLQueryControl.Table">
- <summary>
- Gets or sets the data Table for this control. Setting this will
- automatically update the fields shown in the list.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SQLQueryControl.AttributeSource">
- <summary>
- Setting this is an alternative to specifying the table. This allows the
- query control to build a query using pages of data instead of the whole
- table at once.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SQLQueryControl.Text">
- <summary>
- Gets or sets the string that appears in the filter text.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.TableEditorControl">
- <summary>
- A Table editor user control. This may be used for displaying attributes of a feature layer.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TableEditorControl.#ctor">
- <summary>
- Creates a new instance of the Table editor control without any data
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TableEditorControl.#ctor(DotSpatial.Symbology.IFeatureLayer)">
- <summary>
- Creates a new Table editor control for editing a feature layer's attribute values. This allows interaction
- with the map. If a row is selected in the Table the corresponding row is selected in the map
- </summary>
- <param name="layer">The symbolizer on the map</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TableEditorControl.ZoomToSelected">
- <summary>
- Zoom to selected rows (features)
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TableEditorControl.ZoomToEditedRow">
- <summary>
- Zooms to the row which is being edited
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TableEditorControl.SelectFeatures(System.Collections.Generic.IEnumerable{DotSpatial.Data.IFeature})">
- <summary>
- This assumes that the datarows displayed correspond to features in the data Table.
- </summary>
- <param name="features"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TableEditorControl.DisplaySelectedRowNumberLabel(System.Int32)">
- <summary>
- This will update the Label of Selected Number of rows.
- </summary>
- <param name="numRows"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TableEditorControl.DisplayFilePathLabel(System.String)">
- <summary>
- This will update the Label of File path.
- </summary>
- <param name="file"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TableEditorControl.OnSelectionChanged">
- <summary>
- Fires the SelectionChanged event whenver the selection on this dialog has been altered
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TableEditorControl.OnSelectionZoom">
- <summary>
- Fires the SelectioinZoom event whenver the selectionZoom button click
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TableEditorControl.OnRefreshMap">
- <summary>
- Fires the OnRefreshMap event whenver the RefreshMap button click
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TableEditorControl.OnzoomToShapeBeingEdited">
- <summary>
- Fires the OnFieldCalculation event whenver the zoomToShapeBeingEdited menu click
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TableEditorControl.SetEditableIcons">
- <summary>
- when 'IsEditable' is set to false, some toolbar icons are
- hidden
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TableEditorControl.FindString(System.String)">
- <summary>
- Will find the string in the attribute Table (Search Operation)
- </summary>
- <param name="exp">the string to be found</param>
- <returns>true if the string was found, false otherwise</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TableEditorControl.BuildFindExpression(System.String)">
- <summary>
- Builds a 'find' select expression to find a string
- </summary>
- <param name="findString"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TableEditorControl.ReplaceString(System.String,System.String)">
- <summary>
- Will find the string in the dataGridView and replace
- </summary>
- <param name="exp">Find expression string</param>
- <param name="expReplace">replace expression string</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TableEditorControl.CopyFid(System.String,System.Boolean)">
- <summary>
- This will copy the FID of features to given column
- </summary>
- <param name="field">the field where FID should be copied</param>
- <param name="isNewField">if isNewField is true, a new field will be added</param>
- </member>
- <member name="F:DotSpatial.Symbology.Forms.TableEditorControl.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TableEditorControl.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.TableEditorControl.SelectionChanged">
- <summary>
- Occurs whenever the user selects, de-selects or in any way updates the row selections
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.TableEditorControl.SelectionZoom">
- <summary>
- Occurs whenever the user click SelectioinZoom button.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.TableEditorControl.MapRefreshed">
- <summary>
- occurs whenever the user click RefreshMap button.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.TableEditorControl.ZoomToShapeBeingEdited">
- <summary>
- This will fire when user press ZoomToShapeBeingEdited button.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.TableEditorControl.ShowSelectedRowsOnly">
- <summary>
- If set to true, only the selected rows are displayed.
- If set to false, all rows are displayed.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.TableEditorControl.FeatureLayer">
- <summary>
- Gets or sets the feature layer used by this data Table
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.TableEditorControl.Selection">
- <summary>
- Gets the collection of selected data rows. The row indices are
- 1 based instead of zero based, so be sure to subtract one before matching with a feature.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.TableEditorControl.IgnoreSelectionChanged">
- <summary>
- Gets or sets the boolean that controls whether or not this form will throw an
- event during the selection changed process.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.TableEditorControl.FeatureSetData">
- <summary>
- set or get the relavant full featureset
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.TableEditorControl.ShowMenuStrip">
- <summary>
- gets or sets the visibility of the main menu strip
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.TableEditorControl.ShowToolStrip">
- <summary>
- gets or sets the visibility of the main tool strip
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.TableEditorControl.ShowFileName">
- <summary>
- Gets or sets if the file path is shown in the status bar
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.TableEditorControl.ShowProgressBar">
- <summary>
- Gets or sets if the progress bar is visible
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.TableEditorControl.IsEditable">
- <summary>
- Gets or sets whether the Table is editable by the user
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.AzimuthAngleEditor">
- <summary>
- CharacterCodeEditor
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AzimuthAngleEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)">
- <summary>
- Edits a value based on some user input which is collected from a character control.
- </summary>
- <param name="context"></param>
- <param name="provider"></param>
- <param name="value"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.AzimuthAngleEditor.GetEditStyle(System.ComponentModel.ITypeDescriptorContext)">
- <summary>
- Gets the UITypeEditorEditStyle, which in this case is drop down.
- </summary>
- <param name="context"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.AzimuthAngleEditor.IsDropDownResizable">
- <summary>
- Ensures that we can widen the drop-down without having to close the drop down,
- widen the control, and re-open it again.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.CategoryCollectionConverter">
- <summary>
- CategoryCollectionConverter
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.CategoryCollectionConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)">
- <summary>
- Converts the collection to a string
- </summary>
- <param name="context"></param>
- <param name="culture"></param>
- <param name="value"></param>
- <param name="destinationType"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.CategoryCollectionConverter.CanConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Type)">
- <summary>
- Determines how to convert from an interface
- </summary>
- <param name="context"></param>
- <param name="sourceType"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.BarGraph">
- <summary>
- The bar graph, when given a rectangular frame to work in, calculates appropriate bins
- from values, and draws the various labels and bars necessary.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.BarGraph.#ctor(System.Int32,System.Int32)">
- <summary>
- Creates a new instance of BarGraph
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.BarGraph.GetGraphBounds">
- <summary>
- Gets the bounding rectangle for the actual graph itself
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.BarGraph.Dispose">
- <summary>
- Disposes the font and titlefont
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.BarGraph.Draw(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Draws the graph, the colored bins, selected region, and any text, but not any sliders.
- </summary>
- <param name="g"></param>
- <param name="clip"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.BarGraph.GetPosition(System.Double)">
- <summary>
- Given a double value, this returns the floating point position on this graph,
- based on the current minimum, maximum values.
- </summary>
- <param name="value">The double value to locate</param>
- <returns>A floating point X position</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.BarGraph.GetValue(System.Single)">
- <summary>
- Given a floating point X coordinate (relative to the control, not just the graph)
- this will return the double value represented by that location.
- </summary>
- <param name="position">The floating point position</param>
- <returns>The double value at the specified X coordinate</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.BarGraph.CenterValue(System.Int32)">
- <summary>
- Gets the real data value at the center of one of the bins.
- </summary>
- <param name="binIndex"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.BarGraph.DrawText(System.Drawing.Graphics)">
- <summary>
- Draws only the text for this bar graph. This will also calculate some critical
- font measurements to help size the internal part of the graph.
- </summary>
- <param name="g"></param>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BarGraph.Bins">
- <summary>
- Gets or sets the array of integers that represent the positive integer value stored in
- each bar.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BarGraph.ColorRanges">
- <summary>
- Gets or sets the list of color ranges that control how the colors are drawn to the graph.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BarGraph.Font">
- <summary>
- Gets or sets the Font for text like the axis labels
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BarGraph.Height">
- <summary>
- Gets or sets the integer height
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BarGraph.LogY">
- <summary>
- Gets or sets a boolean that indicates whether or not count values should be drawn with
- heights that are proportional to the logarithm of the count, instead of the count itself.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BarGraph.MaxBinCount">
- <summary>
- Gets or sets the integer maximum from all of the current bins.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BarGraph.Maximum">
- <summary>
- This doesn't affect the statistical minimum or maximum, but rather the current view extents.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BarGraph.Mean">
- <summary>
- The mean line can be drawn if it is in the view range. This is the statistical mean
- for all the values, not just the values currently in view.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BarGraph.StandardDeviation">
- <summary>
- Gets or sets the double standard deviation. If ShowStandardDeviation is true, then
- they will be represented by red lines on either side of the mean.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BarGraph.MinHeight">
- <summary>
- Very small counts frequently dissappear next to big counts. One strategey is to use a
- minimum height, so that the difference between 0 and 1 is magnified on the columns.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BarGraph.Minimum">
- <summary>
- Gets or sets the maximum extent for this graph. This doesn't affect the numeric statistics,
- but only the current view of that statistics.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BarGraph.NumColumns">
- <summary>
- Gets or sets the number of columns. Setting this will recalculate the bins.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BarGraph.SelectedRange">
- <summary>
- Gets or sets the color range.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BarGraph.ShowMean">
- <summary>
- Boolean, if this is true, the mean will be shown as a blue dotted line.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BarGraph.ShowStandardDeviation">
- <summary>
- Boolean, if this is true, the integral standard deviations from the mean will be drawn
- as red dotted lines.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BarGraph.Title">
- <summary>
- Gets or sets the title of the graph.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BarGraph.TitleFont">
- <summary>
- Gets or sets the font to use for the graph title
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BarGraph.Width">
- <summary>
- Gets or sets the width of this graph in pixels.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.ColorRange">
- <summary>
- ColorRange
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ColorRange.#ctor">
- <summary>
- Generates a color range with no limits and the color gray.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ColorRange.#ctor(System.Drawing.Color)">
- <summary>
- Generates a color range with no limits of the specified color
- </summary>
- <param name="color">The Color to use</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ColorRange.#ctor(System.Drawing.Color,DotSpatial.Symbology.Range)">
- <summary>
- Generates a color range with the specified color and range.
- </summary>
- <param name="color">The Color to use for this range</param>
- <param name="range">The numeric bounds to use for this color.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ColorRange.#ctor(System.Drawing.Color,System.Nullable{System.Double},System.Nullable{System.Double})">
- <summary>
- Creates a new ColorRange using the specified color and the specified
- nullable double values. A null value represents an unbounded range.
- </summary>
- <param name="color">The Color to use.</param>
- <param name="min">A double value representing the minimum value (inclusive).</param>
- <param name="max">A double value representing the maximum (exclusive).</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ColorRange.Contains(System.Double)">
- <summary>
- Gets a boolean that is true if the specified value falls within the specified range.
- </summary>
- <param name="value">The double value to test</param>
- <returns>Boolean, true if the value is within the Range.</returns>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ColorRange.Color">
- <summary>
- Gets or sets the Color for this range.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ColorRange.Range">
- <summary>
- Gets or sets the numeric range for which the color is valid.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.ColorRangeEventArgs">
- <summary>
- ColorRangeEventArgs
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ColorRangeEventArgs.#ctor(System.Drawing.Color,System.Drawing.Color,System.Int32,System.Boolean,System.Boolean)">
- <summary>
- Creates a new instance of ColorRangeEventArgs
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ColorRangeEventArgs.StartColor">
- <summary>
- Gets the start color
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ColorRangeEventArgs.EndColor">
- <summary>
- Gets the end color
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ColorRangeEventArgs.HueShift">
- <summary>
- Gets or sets the hue shift
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ColorRangeEventArgs.HSL">
- <summary>
- Gets a boolean. If true, the ramp of colors should
- be built using the HSL characteristics of the start and
- end colors rather than the RGB characteristics
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ColorRangeEventArgs.UseColorRange">
- <summary>
- Gets a boolean, true if this color range should be used.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.FeatureSizeRange">
- <summary>
- SizeRange
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FeatureSizeRange.#ctor">
- <summary>
- Creates a new instance of SizeRange
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FeatureSizeRange.#ctor(DotSpatial.Symbology.IFeatureSymbolizer,System.Double,System.Double)">
- <summary>
- Gets or sets the Point Size Range
- </summary>
- <param name="symbolizer"></param>
- <param name="start"></param>
- <param name="end"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FeatureSizeRange.GetSymbolizer(System.Double,System.Drawing.Color)">
- <summary>
- Given a size, this will return the native
- symbolizer that has been adjusted to the
- specified size.
- </summary>
- <param name="size">The size of the symbol</param>
- <param name="color">The color of the symbol</param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.FeatureSizeRange.Symbolizer">
- <summary>
- Gets or sets the symbolizer that controls everything except for size.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.FeatureSizeRange.Start">
- <summary>
- Minimum size
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.FeatureSizeRange.End">
- <summary>
- Maximum size
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.FeatureSizeRange.UseSizeRange">
- <summary>
- Gets or sets a boolean indicating if the size range should be used.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.FeatureSizeRangeControl">
- <summary>
- PointSizeRangeControl
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FeatureSizeRangeControl.#ctor">
- <summary>
- Creates a new instance of PointSizeRangeControl
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FeatureSizeRangeControl.Initialize(DotSpatial.Symbology.Forms.SizeRangeEventArgs)">
- <summary>
- Initializes this point size range control
- </summary>
- <param name="args"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FeatureSizeRangeControl.UpdateControls">
- <summary>
- Handles the inter-connectivity of the various controls and updates
- them all to match the latest value.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FeatureSizeRangeControl.OnSizeRangeChanged">
- <summary>
- Fires the SizeRangeChanged event args
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.FeatureSizeRangeControl.Scheme">
- <summary>
- Gets or sets the point scheme to work with.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.FeatureSizeRangeControl.SizeRange">
- <summary>
- Gets or sets the point Size Range, which controls the symbolizer,
- as well as allowing the creation of a dynamically sized version
- of the symbolizer.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.FeatureSizeRangeControl.SizeRangeChanged">
- <summary>
- Occurs when either the sizes or the template has changed.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.LineSymbolView">
- <summary>
- PointSymbolView
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LineSymbolView.OnDraw(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Draws the point symbol in the view
- </summary>
- <param name="g"></param>
- <param name="clip"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LineSymbolView.OnPaintBackground(System.Windows.Forms.PaintEventArgs)">
- <summary>
- prevents flicker by preventing the white background being drawn here
- </summary>
- <param name="pevent"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LineSymbolView.OnPaint(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Custom drawing
- </summary>
- <param name="e"></param>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.LineSymbolView.Symbolizer">
- <summary>
- Gets or sets the symbolizer being drawn in this view.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.LineSymbolView.BorderStyle">
- <summary>
- Gets or sets the way that the border of this control will be drawn.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.PointSymbolView">
- <summary>
- PointSymbolView
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.PointSymbolView.OnDraw(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Draws the point symbol in the view
- </summary>
- <param name="g"></param>
- <param name="clip"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.PointSymbolView.OnPaintBackground(System.Windows.Forms.PaintEventArgs)">
- <summary>
- prevents flicker by preventing the white background being drawn here
- </summary>
- <param name="pevent"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.PointSymbolView.OnPaint(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Custom drawing
- </summary>
- <param name="e"></param>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.PointSymbolView.Symbolizer">
- <summary>
- Gets or sets the symbolizer being drawn in this view.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.PointSymbolView.BorderStyle">
- <summary>
- Gets or sets the way that the border of this control will be drawn.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.SizeRangeEventArgs">
- <summary>
- PointSizeRangeEventArgs
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SizeRangeEventArgs.#ctor(System.Double,System.Double,DotSpatial.Symbology.IFeatureSymbolizer,System.Boolean)">
- <summary>
- Creates a new instance of PointSizeRangeEventArgs
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SizeRangeEventArgs.#ctor(DotSpatial.Symbology.Forms.FeatureSizeRange)">
- <summary>
- Creates a new instance of the PointSizeRangeEventArgs derived from a PointSizeRange
- </summary>
- <param name="range"></param>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SizeRangeEventArgs.StartSize">
- <summary>
- Gets the start size of the size range
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SizeRangeEventArgs.EndSize">
- <summary>
- Gets the end size of the range
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SizeRangeEventArgs.UseSizeRange">
- <summary>
- Gets a boolean indicating whether the size range should be used
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SizeRangeEventArgs.Template">
- <summary>
- Gets the symbolizer template that describes everything not covered by a range parameter
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.TabColorControl">
- <summary>
- TabColorControl
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TabColorControl.#ctor">
- <summary>
- Creates a new instance of TabColorControl
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TabColorControl.Initialize(DotSpatial.Symbology.Forms.ColorRangeEventArgs)">
- <summary>
- Initializes a new instance of this control using the specified values.
- </summary>
- <param name="args">The ColorRangeEventArgs that stores the initial values.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TabColorControl.Dispose(System.Boolean)">
- <summary>
- Disposes the unmanaged memory or controls
- </summary>
- <param name="disposing"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TabColorControl.OnColorChanged">
- <summary>
- Fires the ColorChanged event
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.TabColorControl.ColorChanged">
- <summary>
- Occurs when the color is changed.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.TabColorControl.StartColor">
- <summary>
- Gets or sets the start color, which controls the RGB start colors and the HSL left ranges
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.TabColorControl.EndColor">
- <summary>
- Gets or sets the end color, which controls the RGB end color and the right HSL ranges
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.TabColorControl.HueShift">
- <summary>
- Gets or sets the integer hue shift marking how much the hue slider should be shifted
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.TabColorControl.UseRangeChecked">
- <summary>
- Gets or sets a boolean indicating whether or not the hue range is to be used.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.TextFont">
- <summary>
- System.Font is notoriously difficult when serialization comes up. This replaces that
- with a more serializable version.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TextFont.#ctor">
- <summary>
- Creates a default, black, 8pt sans serif font with a normal style.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TextFont.#ctor(System.Single)">
- <summary>
- Creates a sans serif, black, normal font of the specified size.
- </summary>
- <param name="size">The size to use.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TextFont.#ctor(System.Drawing.Font,System.Drawing.Color)">
- <summary>
- Creates a new instance of TextFont
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TextFont.#ctor(System.Drawing.FontFamily,System.Single,System.Drawing.FontStyle,System.Drawing.Color)">
- <summary>
-
- </summary>
- <param name="family"></param>
- <param name="size"></param>
- <param name="style"></param>
- <param name="color"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TextFont.SetFormat(System.Drawing.StringFormat)">
- <summary>
- Assigns the parameters from the specifed StringFormat class to the members of
- this TextFont.
- </summary>
- <param name="format">The StringFormat to apply to this object</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TextFont.SetFont(System.Drawing.Font)">
- <summary>
- Sets the font on this Textfont to the specified value.
- </summary>
- <param name="font">The font to use.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TextFont.GetFont">
- <summary>
- This returns the actual internal font. Be careful not to dispose this.
- </summary>
- <returns>A System.Font</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TextFont.Draw(System.Drawing.Graphics,System.String,System.Single,System.Single)">
- <summary>
- Draws the specified text to the specified graphics object in the specified location,
- but using all of the parameters specified by this TextFont object.
- </summary>
- <param name="g">The Graphics surface to draw to</param>
- <param name="text">The string text to draw</param>
- <param name="x">The x coordinate of the top left position</param>
- <param name="y">The y coordinate of the top left position</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TextFont.Draw(System.Drawing.Graphics,System.String,System.Drawing.PointF)">
- <summary>
- Draws the specified text to the specified graphics object in the specified location,
- but using all of the parameters specified by this TextFont object.
- </summary>
- <param name="g">The Graphics surface to draw to</param>
- <param name="text">The string text to draw</param>
- <param name="location">The PointF describing the location to draw</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TextFont.OnDraw(System.Drawing.Graphics,System.String,System.Single,System.Single)">
- <summary>
- Handles drawing for point location drawing
- </summary>
- <param name="g">The Graphics surface to draw to.</param>
- <param name="text">The string to draw</param>
- <param name="x">The x floating point value</param>
- <param name="y">The y floating point value</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TextFont.OnDraw(System.Drawing.Graphics,System.String,System.Drawing.RectangleF)">
- <summary>
- Handles drawing for drawing that falls within a rectangleF structure.
- </summary>
- <param name="g">The Graphics surface to draw to</param>
- <param name="text">The string to draw</param>
- <param name="box">The RectangleF structure</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TextFont.Draw(System.Drawing.Graphics,System.String,System.Drawing.RectangleF)">
- <summary>
- Draws the specified text to the specified graphics object within the specified box.
- </summary>
- <param name="g">The graphics surface to draw to.</param>
- <param name="text">The text to draw</param>
- <param name="box">The rectangular box to draw within</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TextFont.Dispose">
- <summary>
- Disposes of the font, brush and format that are stored internally
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.TextFont.Alignment">
- <summary>
- Gets or sets the alignment information on the vertical plane
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.TextFont.Color">
- <summary>
- Gets or sets the System.Color to use for the font color.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.TextFont.FamilyName">
- <summary>
- Gets or sets the string family name for this font.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.TextFont.FormatFlags">
- <summary>
- Gets or sets the string format flags
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.TextFont.LineAlignment">
- <summary>
- Gets or sets the line alignment on the horizontal plane
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.TextFont.Size">
- <summary>
- Gets or sets the floating point value controling the size.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.TextFont.Style">
- <summary>
- Gets or sets the style
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.TextFont.Trimming">
- <summary>
- Gets or sets the StringTrimming options
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.CharacterCodeEditor">
- <summary>
- CharacterCodeEditor
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.CharacterCodeEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)">
- <summary>
- Edits a value based on some user input which is collected from a character control.
- </summary>
- <param name="context"></param>
- <param name="provider"></param>
- <param name="value"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.CharacterCodeEditor.GetEditStyle(System.ComponentModel.ITypeDescriptorContext)">
- <summary>
- Gets the UITypeEditorEditStyle, which in this case is drop down.
- </summary>
- <param name="context"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.CharacterCodeEditor.IsDropDownResizable">
- <summary>
- Ensures that we can widen the drop-down without having to close the drop down,
- widen the control, and re-open it again.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.CharacterControl">
- <summary>
- CharacterControl
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.VerticalScrollControl">
- <summary>
- A vertical scroll control adds a scroll bar in the vertical case, but never in the horizontal case.
- This is useful if the content should simply autosize to fit the horizontal width of the control.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.VerticalScrollControl.#ctor">
- <summary>
- Creates a new instance of ScrollingControl
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.VerticalScrollControl.ClientToDocument(System.Drawing.Rectangle)">
- <summary>
- Gets a rectangle in document coordinates for hte specified rectangle in client coordinates
- </summary>
- <param name="rect"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.VerticalScrollControl.DocumentToClient(System.Drawing.Rectangle)">
- <summary>
- Translates a rectangle from document coordinates to coordinates relative to the client control
- </summary>
- <param name="rect"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.VerticalScrollControl.ResetScroll">
- <summary>
- Recalculates the size and visibility of the scroll bars based on the current document.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.VerticalScrollControl.OnPaintBackground(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Prevent flicker by preventing this
- </summary>
- <param name="pevent"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.VerticalScrollControl.OnPaint(System.Windows.Forms.PaintEventArgs)">
- <summary>
- On Paint only paints the specified clip rectangle, but paints
- it from the page buffer.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.VerticalScrollControl.OnDrawBackground(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Occurs during custom drawing when erasing things
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.VerticalScrollControl.OnDraw(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Occurs during custom drawing
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.VerticalScrollControl.Dispose(System.Boolean)">
- <summary>
- Disposes the unmanaged memory objects and optionally disposes
- the managed memory objects
- </summary>
- <param name="disposing"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.VerticalScrollControl.OnInitialize(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Fires the Initialized event
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.VerticalScrollControl.OnResize(System.EventArgs)">
- <summary>
-
- </summary>
- <param name="e"></param>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.VerticalScrollControl.Initialized">
- <summary>
- Occurs after the base drawing content has been rendered to the page.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.VerticalScrollControl.BackColor">
- <summary>
- Gets or sets the background color to use for this control
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.VerticalScrollControl.BackgroundImage">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.VerticalScrollControl.ControlRectangle">
- <summary>
- Gets the rectangular region of the control in page coordinates.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.VerticalScrollControl.DocumentRectangle">
- <summary>
- Gets or sets the rectangle for the entire content, whether on the page buffer or not. X and Y for this
- are always 0.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.VerticalScrollControl.IsInitialized">
- <summary>
- Gets or sets whether or not the page for this control has been drawn.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.VerticalScrollControl.VerticalScrollEnabled">
- <summary>
- Gets or sets a boolean indicating whether the vertical scroll should be permitted
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.CharacterControl.#ctor">
- <summary>
- Creates a new instance of CharacterControl
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.CharacterControl.#ctor(System.Windows.Forms.Design.IWindowsFormsEditorService,DotSpatial.Symbology.ICharacterSymbol)">
- <summary>
- Creates a new instance of a CharacterControl designed to edit the specific symbol
- </summary>
- <param name="editorService"></param>
- <param name="symbol"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.CharacterControl.OnMouseUp(System.Windows.Forms.MouseEventArgs)">
- <summary>
- Handles the situation where a mouse up should show a magnified version of the character.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.CharacterControl.OnPopupClicked">
- <summary>
- Fires the PopupClicked event args, and closes a drop down editor if it exists.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.CharacterControl.OnInitialize(System.Windows.Forms.PaintEventArgs)">
- <summary>
-
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.CharacterControl.OnResize(System.EventArgs)">
- <summary>
- Occurs whenever this control is resized, and forces invalidation of the entire control because
- we are completely changing how the paging works.
- </summary>
- <param name="e"></param>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.CharacterControl.PopupClicked">
- <summary>
- Occurs when a magnification box is clicked
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.CharacterControl.CellSize">
- <summary>
- Gets or sets the cell size.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.CharacterControl.DocumentRectangle">
- <summary>
- Overrides underlying behavior to hide it in the properties list for this control from serialization
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.CharacterControl.DynamicColumns">
- <summary>
- Gets or sets a boolean that, if true, indicates that this form should restructure the columns
- as it is resized so that all the columns are visible.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.CharacterControl.IsSelected">
- <summary>
- Gets or sets whether or not this item is selected
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.CharacterControl.NumColumns">
- <summary>
- Gets or sets the number of columns
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.CharacterControl.NumRows">
- <summary>
- Gets the number of rows, which is controlled by having to show 256 cells
- in the given number of columns.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.CharacterControl.SelectionBackColor">
- <summary>
- Gets or sets the background color for the selection
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.CharacterControl.SelectionForeColor">
- <summary>
- The Font Color for the selection
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.CharacterControl.TypeSet">
- <summary>
- Gets or sets the byte that describes the "larger" of the two bytes for a unicode set.
- The 256 character slots illustrate the sub-categories for those elements.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.CharacterControl.SelectedChar">
- <summary>
- Gets or sets the selected character
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.CharacterControl.SelectedString">
- <summary>
- Gets the string form of the selected character
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.CollectionControl">
- <summary>
- This is designed to automatically have add, subtract, up and down arrows for working with a simple collection of items.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Forms.CollectionControl.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.CollectionControl.#ctor">
- <summary>
- Creates a new instance of the Collection Control
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.CollectionControl.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.CollectionControl.OnSelectedItemChanged">
- <summary>
- Fires the SelectedItemChanged event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.CollectionControl.RefreshList">
- <summary>
- Refreshes the items in the list to accuratly reflect the current collection
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.CollectionControl.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.CollectionControl.OnAdd">
- <summary>
- Fires the AddClicked event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.CollectionControl.OnListChanged">
- <summary>
- Fires the ListChanged event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.CollectionControl.OnRemoveClick">
- <summary>
- Fires the RemoveCLicked event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.CollectionControl.OnOrderChanged">
- <summary>
- Fires the OnOrderChanged event
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.CollectionControl.AddClicked">
- <summary>
- Occurs when someone clicks the add button.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.CollectionControl.SelectedItemChanged">
- <summary>
- Occurs when someone selects one of the items in the list box
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.CollectionControl.OrderChanged">
- <summary>
- Occurs when either the Promote or Demote function has been used,
- changing the order.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.CollectionControl.RemoveClicked">
- <summary>
- Occurs when the remove button has been clicked
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.CollectionControl.ListChanged">
- <summary>
- Occurs when the list has been added, removed, or re-ordered in any way.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.CollectionControl.SelectedName">
- <summary>
- Gets or sets the currently selected name.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.CollectionControl.SelectedObject">
- <summary>
- Gets the selected item cast as an object.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.CollectionControl.ItemNames">
- <summary>
- This control works with the INamedList, which in turn can work with any strong typed
- IList. The only button
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.DecorationCollectionControl">
- <summary>
- This is designed to automatically have add, subtract, up and down arrows for working with a simple collection of items.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DecorationCollectionControl.#ctor">
- <summary>
- Creates a new instance of the Collection Control
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DecorationCollectionControl.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DecorationCollectionControl.OnSelectedItemChanged">
- <summary>
- Fires the SelectedItemChanged event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DecorationCollectionControl.RefreshList">
- <summary>
- Refreshes the items in the list to accuratly reflect the current collection
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DecorationCollectionControl.OnAdd">
- <summary>
- Fires the AddClicked event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DecorationCollectionControl.OnListChanged">
- <summary>
- Fires the ListChanged event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DecorationCollectionControl.OnRemoveClick">
- <summary>
- Fires the RemoveCLicked event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DecorationCollectionControl.OnOrderChanged">
- <summary>
- Fires the OnOrderChanged event
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.DecorationCollectionControl.AddClicked">
- <summary>
- Occurs when someone clicks the add button.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.DecorationCollectionControl.SelectedItemChanged">
- <summary>
- Occurs when someone selects one of the items in the list box
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.DecorationCollectionControl.OrderChanged">
- <summary>
- Occurs when either the Promote or Demote function has been used,
- changing the order.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.DecorationCollectionControl.RemoveClicked">
- <summary>
- Occurs when the remove button has been clicked
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.DecorationCollectionControl.ListChanged">
- <summary>
- Occurs when the list has been added, removed, or re-ordered in any way.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DecorationCollectionControl.SelectedDecoration">
- <summary>
- Gets the selected item cast as an object.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DecorationCollectionControl.Decorations">
- <summary>
- Gets or sets the core list of lineDecorations that will be drawn here.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.PatternCollectionControl">
- <summary>
- This is designed to automatically have add, subtract, up and down arrows for working with a simple collection of items.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.PatternCollectionControl.#ctor">
- <summary>
- Creates a new instance of the Collection Control
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.PatternCollectionControl.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.PatternCollectionControl.OnSelectedItemChanged">
- <summary>
- Fires the SelectedItemChanged event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.PatternCollectionControl.RefreshList">
- <summary>
- Refreshes the items in the list to accuratly reflect the current collection
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.PatternCollectionControl.OnAdd">
- <summary>
- Fires the AddClicked event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.PatternCollectionControl.OnListChanged">
- <summary>
- Fires the ListChanged event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.PatternCollectionControl.OnRemoveClick">
- <summary>
- Fires the RemoveCLicked event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.PatternCollectionControl.OnOrderChanged">
- <summary>
- Fires the OnOrderChanged event
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.PatternCollectionControl.AddClicked">
- <summary>
- Occurs when someone clicks the add button.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.PatternCollectionControl.SelectedItemChanged">
- <summary>
- Occurs when someone selects one of the items in the list box
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.PatternCollectionControl.OrderChanged">
- <summary>
- Occurs when either the Promote or Demote function has been used,
- changing the order.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.PatternCollectionControl.RemoveClicked">
- <summary>
- Occurs when the remove button has been clicked
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.PatternCollectionControl.ListChanged">
- <summary>
- Occurs when the list has been added, removed, or re-ordered in any way.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.PatternCollectionControl.SelectedPattern">
- <summary>
- Gets the selected item cast as an object.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.PatternCollectionControl.Patterns">
- <summary>
- Gets or sets the core list of patterns that will be drawn here.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.StrokeCollectionControl">
- <summary>
- This is designed to automatically have add, subtract, up and down arrows for working with a simple collection of items.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.StrokeCollectionControl.#ctor">
- <summary>
- Creates a new instance of the Collection Control
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.StrokeCollectionControl.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.StrokeCollectionControl.OnSelectedItemChanged">
- <summary>
- Fires the SelectedItemChanged event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.StrokeCollectionControl.RefreshList">
- <summary>
- Refreshes the items in the list to accuratly reflect the current collection
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.StrokeCollectionControl.OnAdd">
- <summary>
- Fires the AddClicked event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.StrokeCollectionControl.OnListChanged">
- <summary>
- Fires the ListChanged event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.StrokeCollectionControl.OnRemoveClick">
- <summary>
- Fires the RemoveCLicked event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.StrokeCollectionControl.OnOrderChanged">
- <summary>
- Fires the OnOrderChanged event
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.StrokeCollectionControl.AddClicked">
- <summary>
- Occurs when someone clicks the add button.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.StrokeCollectionControl.SelectedItemChanged">
- <summary>
- Occurs when someone selects one of the items in the list box
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.StrokeCollectionControl.OrderChanged">
- <summary>
- Occurs when either the Promote or Demote function has been used,
- changing the order.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.StrokeCollectionControl.RemoveClicked">
- <summary>
- Occurs when the remove button has been clicked
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.StrokeCollectionControl.ListChanged">
- <summary>
- Occurs when the list has been added, removed, or re-ordered in any way.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.StrokeCollectionControl.SelectedStroke">
- <summary>
- Gets the selected item cast as an object.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.StrokeCollectionControl.Strokes">
- <summary>
- Gets or sets the core list of strokes that will be drawn here.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.SymbolCollectionControl">
- <summary>
- This is designed to automatically have add, subtract, up and down arrows for working with a simple collection of items.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbolCollectionControl.#ctor">
- <summary>
- Creates a new instance of the Collection Control
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbolCollectionControl.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbolCollectionControl.OnSelectedItemChanged">
- <summary>
- Fires the SelectedItemChanged event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbolCollectionControl.RefreshList">
- <summary>
- Refreshes the items in the list to accuratly reflect the current collection
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbolCollectionControl.OnAdd">
- <summary>
- Fires the AddClicked event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbolCollectionControl.OnListChanged">
- <summary>
- Fires the ListChanged event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbolCollectionControl.OnRemoveClick">
- <summary>
- Fires the RemoveCLicked event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbolCollectionControl.OnOrderChanged">
- <summary>
- Fires the OnOrderChanged event
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.SymbolCollectionControl.AddClicked">
- <summary>
- Occurs when someone clicks the add button.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.SymbolCollectionControl.SelectedItemChanged">
- <summary>
- Occurs when someone selects one of the items in the list box
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.SymbolCollectionControl.OrderChanged">
- <summary>
- Occurs when either the Promote or Demote function has been used,
- changing the order.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.SymbolCollectionControl.RemoveClicked">
- <summary>
- Occurs when the remove button has been clicked
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.SymbolCollectionControl.ListChanged">
- <summary>
- Occurs when the list has been added, removed, or re-ordered in any way.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbolCollectionControl.ItemHeight">
- <summary>
- Gets or sets the item height for this control.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbolCollectionControl.ScaleMode">
- <summary>
- Gets or sets the scale mode. If the scale mode is set to geographic, then the
- specified size will be ignored when drawing the symbolic representation.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbolCollectionControl.SelectedSymbol">
- <summary>
- Gets the selected item cast as an object.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbolCollectionControl.Symbols">
- <summary>
- Gets or sets the core list of strokes that will be drawn here.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.SymbolizerCollectionControl">
- <summary>
- This control displays a list box where each item is a preview of a category symbolizer
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Forms.SymbolizerCollectionControl._symbolizers">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbolizerCollectionControl.#ctor">
- <summary>
- Creates a new instance of the Collection Control
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbolizerCollectionControl.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbolizerCollectionControl.OnSelectedItemChanged">
- <summary>
- Fires the SelectedItemChanged event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbolizerCollectionControl.RefreshList">
- <summary>
- Refreshes the items in the list to accuratly reflect the current collection
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbolizerCollectionControl.DrawLineSymbolizer(DotSpatial.Symbology.LineSymbolizer,System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Draws a preview of a line symbolizer inside of the specified rectangle
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbolizerCollectionControl.DrawPointSymbolizer(DotSpatial.Symbology.PointSymbolizer,System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Draws a preview of a point symbolizer inside of the specified rectangle
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbolizerCollectionControl.DrawPolygonSymbolizer(DotSpatial.Symbology.PolygonSymbolizer,System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Draws a preview of a polygon symbolizer inside of the specified rectangle
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbolizerCollectionControl.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposingManagedResources">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbolizerCollectionControl.OnAdd">
- <summary>
- Fires the AddClicked event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbolizerCollectionControl.OnListChanged">
- <summary>
- Fires the ListChanged event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbolizerCollectionControl.OnRemoveClick">
- <summary>
- Fires the RemoveCLicked event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbolizerCollectionControl.OnOrderChanged">
- <summary>
- Fires the OnOrderChanged event
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.SymbolizerCollectionControl.AddClicked">
- <summary>
- Occurs when someone clicks the add button.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.SymbolizerCollectionControl.SelectedItemChanged">
- <summary>
- Occurs when someone selects one of the items in the list box
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.SymbolizerCollectionControl.OrderChanged">
- <summary>
- Occurs when either the Promote or Demote function has been used,
- changing the order.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.SymbolizerCollectionControl.RemoveClicked">
- <summary>
- Occurs when the remove button has been clicked
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.SymbolizerCollectionControl.ListChanged">
- <summary>
- Occurs when the list has been added, removed, or re-ordered in any way.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbolizerCollectionControl.ItemHeight">
- <summary>
- Gets or sets the item height for this control.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbolizerCollectionControl.ScaleMode">
- <summary>
- Gets or sets the scale mode. If the scale mode is set to geographic, then the
- specified size will be ignored when drawing the symbolic representation.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbolizerCollectionControl.SelectedSymbol">
- <summary>
- Gets the selected item cast as an object.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbolizerCollectionControl.Symbols">
- <summary>
- Gets or sets the core list of syms that will be drawn here.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.CollectionPropertyGrid">
- <summary>
- CollectionPropertyGrid
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Forms.CollectionPropertyGrid.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.CollectionPropertyGrid.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.CollectionPropertyGrid.#ctor">
- <summary>
- Creates a new instance of CollectionPropertyGrid
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.CollectionPropertyGrid.#ctor(DotSpatial.Data.INamedList)">
- <summary>
- Creates a new instance of CollectionPropertyGrid
- </summary>
- <param name="list">The INamedList to display</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.CollectionPropertyGrid.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.CollectionPropertyGrid.OnAddClicked">
- <summary>
- Occurs when the add button is clicked
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.CollectionPropertyGrid.OnApplyChanges">
- <summary>
- Fires the ChangesApplied event
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.CollectionPropertyGrid.ChangesApplied">
- <summary>
- Occurs whenever the apply changes button is clicked, or else when the ok button is clicked.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.CollectionPropertyGrid.AddItemClicked">
- <summary>
- Occurs whenever the add item is clicked. This is because the Collection Property Grid
- doesn't necessarilly know how to create a default item. (An alternative would be
- to send in a factory, but I think this will work just as well.)
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.CollectionPropertyGrid.NamedList">
- <summary>
- Gets or sets the tool that connects each item with a string name.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.ColorBox">
- <summary>
- ColorBox
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Forms.ColorBox.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ColorBox.#ctor">
- <summary>
- Creates a new instance of ColorBox
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ColorBox.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ColorBox.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ColorBox.Reset">
- <summary>
- Changes the starting location of the color drop down based on the current text.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.ColorBox.SelectedItemChanged">
- <summary>
- Occurs when the selected color has been changed in the drop-down
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ColorBox.Value">
- <summary>
- Gets or sets the selected color
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ColorBox.LabelText">
- <summary>
- Gets or sets the text for the label portion
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ColorBox.Font">
- <summary>
- Gets or set the font for the label portion of the component.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.ColorButton">
- <summary>
- A button that is a certain color with beveled edges. The default use of this control is to work as a simple
- color dialog launcher that happens to show a preview of the currently selected color.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ColorButton.#ctor">
- <summary>
- Creates a new instance of ColorButton
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ColorButton.SetColorQuietly(System.Drawing.Color)">
- <summary>
- Sets the color but will not fire the ColorChanged event.
- </summary>
- <param name="color"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ColorButton.OnColorChanged">
- <summary>
- Fires the ColorChanged event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ColorButton.OnDraw(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Custom drawing code
- </summary>
- <param name="g"></param>
- <param name="clipRectangle"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ColorButton.OnMouseDown(System.Windows.Forms.MouseEventArgs)">
- <summary>
- when the mouse down event is received this also "depresses" the button
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ColorButton.OnMouseUp(System.Windows.Forms.MouseEventArgs)">
- <summary>
- Handles the situation where the mouse is moving up.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ColorButton.OnClick(System.EventArgs)">
- <summary>
- Clicking launches a color dialog by default.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ColorButton.OnPaintBackground(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Cancels the on paint background event to prevent flicker
- </summary>
- <param name="pevent"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ColorButton.OnPaint(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Sets up a bitmap to use as a double buffer for doing all the drawing code.
- </summary>
- <param name="e"></param>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.ColorButton.ColorChanged">
- <summary>
- Occurs when the color has changed.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ColorButton.Color">
- <summary>
- Gets or sets the color of this button
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ColorButton.BevelRadius">
- <summary>
- Gets or sets the floating point radius between the outside of the button and the flat central portion.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ColorButton.RoundingRadius">
- <summary>
- Gets or sets the rounding radius that controls how rounded this button appears
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ColorButton.LaunchDialogOnClick">
- <summary>
- Gets or sets a boolean that indicates whether this button should launch a
- color dialog to alter its color when it is clicked.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.ColorDropDown">
- <summary>
- A drop down coded by
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ColorDropDown.#ctor">
- <summary>
- Creates a dropdown with known colors populated in it
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ColorDropDown.Dispose(System.Boolean)">
- <summary>
- Disposes stuff
- </summary>
- <param name="disposing"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ColorDropDown.OnPaintBackground(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Prevents flicker .. or possibly does nothing.. I'm not sure.
- </summary>
- <param name="pevent">PaintEventArgs</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ColorDropDown.OnDrawItem(System.Windows.Forms.DrawItemEventArgs)">
- <summary>
- Actually handles the drawing of a single item
- </summary>
- <param name="e">DrawItemEventArgs</param>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ColorDropDown.DrawMode">
- <summary>
- Basically still allow this to be affected in code, but remove it from the designer stuff
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ColorDropDown.Value">
- <summary>
- Gets or sets the currently selected color from this dropdown control
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ColorDropDown.DropDownStyle">
- <summary>
- Basically still allow this to be affected in code, but remove it from the designer stuff
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.ColorPanelStyle">
- <summary>
- ColorPanelStyle
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Forms.ColorPanelStyle.Colors">
- <summary>
- This panel draws color boxes
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Forms.ColorPanelStyle.Values">
- <summary>
- This panel draws values
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Forms.ColorPanelStyle.Captions">
- <summary>
- This panel draws captions
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.ColorPicker">
- <summary>
- A form for selecting colors
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ColorPicker.#ctor">
- <summary>
- Creates a new instance of this form.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ColorPicker.#ctor(DotSpatial.Symbology.IColorCategory)">
- <summary>
- Constructs a new instance and sets it up for a specific color break
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ColorPicker.#ctor(System.Drawing.Color,System.Drawing.Color)">
- <summary>
- Constructs a new instance and sets up the colors, but won;t allow
- </summary>
- <param name="startColor"></param>
- <param name="endColor"></param>
- </member>
- <member name="F:DotSpatial.Symbology.Forms.ColorPicker.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ColorPicker.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ColorPicker.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ColorPicker.OnChangesApplied">
- <summary>
- Fires the ChangesApplied event
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.ColorPicker.ChangesApplied">
- <summary>
- Occurs when the Apply button is pressed, implying to set the changes using the current colorbreak.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ColorPicker.Original">
- <summary>
- Gets or sets the original instance for updating when the apply button is pressed.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ColorPicker.LowColor">
- <summary>
- Gets or sets the start color for this dialog
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ColorPicker.HighColor">
- <summary>
- Gets or sets the end color for this dialog
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ColorPicker.ProgressHandler">
- <summary>
- Gets the IProgressHandler version of the status bar on this form
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.ButtonStates">
- <summary>
- ButtonState
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Forms.ButtonStates.None">
- <summary>
- This is the default case, wher the button is neither depressed nor illuminated
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Forms.ButtonStates.Depressed">
- <summary>
- The Button is depressed or pressed down
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Forms.ButtonStates.Illuminated">
- <summary>
- The Button is illuminated or lit up
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.ButtonStatesEM">
- <summary>
- ButtonStatesEM
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ButtonStatesEM.IsPressed(DotSpatial.Symbology.Forms.ButtonStates)">
- <summary>
- Returns true if the button state is depressed
- </summary>
- <param name="self">the button state</param>
- <returns>Boolean, true if the button is currently pressed</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ButtonStatesEM.IsLit(DotSpatial.Symbology.Forms.ButtonStates)">
- <summary>
- Returns true if the button state is illuminated
- </summary>
- <param name="self">The button state</param>
- <returns>Boolean, true if the button is currently illuminated</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ButtonStatesEM.Lit(DotSpatial.Symbology.Forms.ButtonStates)">
- <summary>
- Sets the state to being lit
- </summary>
- <param name="self">This button state</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ButtonStatesEM.Pressed(DotSpatial.Symbology.Forms.ButtonStates)">
- <summary>
- Sets the state to being Depressed
- </summary>
- <param name="self">This button state</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ButtonStatesEM.Raised(DotSpatial.Symbology.Forms.ButtonStates)">
- <summary>
- Removes the pressed condition from the button
- </summary>
- <param name="self">This button state</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ButtonStatesEM.Darkened(DotSpatial.Symbology.Forms.ButtonStates)">
- <summary>
- Removes the lit condition from the button
- </summary>
- <param name="self">This button state</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ButtonStatesEM.InverseDepression(DotSpatial.Symbology.Forms.ButtonStates)">
- <summary>
- Changes pressed to unpressed or unpressed to pressed
- </summary>
- <param name="self"></param>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.DashControl">
- <summary>
- DashControl
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DashControl.#ctor">
- <summary>
- Creates a new instance of DashControl
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DashControl.GetDashPattern">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DashControl.GetCompoundArray">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DashControl.SetPattern(DotSpatial.Symbology.ICartographicStroke)">
- <summary>
- Sets the pattern of squares for this pen by working with the given dash and compound patterns.
- </summary>
- <param name="stroke">Completely defines the ICartographicStroke that is being used to set the pattern.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DashControl.SetHorizontalPattern(System.Boolean[])">
- <summary>
- Sets the horizontal pattern for this control
- </summary>
- <param name="buttonPattern"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DashControl.SetVerticalPattern(System.Boolean[])">
- <summary>
- Sets the vertical pattern for this control
- </summary>
- <param name="buttonPattern"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DashControl.OnCreateControl">
- <summary>
- Occurs when the dash control needs to calculate the pattern
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DashControl.OnPaintBackground(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Prevent flicker
- </summary>
- <param name="pevent"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DashControl.OnPaint(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Creates a bitmap to draw to instead of drawing directly to the image.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DashControl.OnDraw(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Actually controls the basic drawing control.
- </summary>
- <param name="g"></param>
- <param name="clipRectangle"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DashControl.OnMouseDown(System.Windows.Forms.MouseEventArgs)">
- <summary>
- Handles the mouse down event
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DashControl.OnMouseMove(System.Windows.Forms.MouseEventArgs)">
- <summary>
- Handles mouse movement
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DashControl.OnMouseUp(System.Windows.Forms.MouseEventArgs)">
- <summary>
- Handles the mouse up event
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DashControl.OnPatternChanged">
- <summary>
- Fires the pattern changed event.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DashControl.OnResize(System.EventArgs)">
- <summary>
- Forces a calculation during the resizing that changes the pattern squares.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DashControl.UpdateHighlight(System.Drawing.Point)">
- <summary>
- Updates the highlight based on mouse position.
- </summary>
- <returns></returns>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.DashControl.PatternChanged">
- <summary>
- Occurs any time any action has occured that changes the pattern.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DashControl.DashButtons">
- <summary>
- Gets or sets the boolean pattern for the horizontal patterns that control the custom
- dash style.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DashControl.CompoundButtons">
- <summary>
- Gets or sets the boolean pattern for the vertical patterns that control the custom
- compound array.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DashControl.ButtonDownDarkColor">
- <summary>
- Gets or sets the color for all the buttons when they are pressed and inactive
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DashControl.ButtonDownLitColor">
- <summary>
- Gets or sets the base color for all the buttons when they are pressed and active
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DashControl.ButtonUpDarkColor">
- <summary>
- Gets or sets the base color for all the buttons when they are not pressed and not active.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DashControl.ButtonUpLitColor">
- <summary>
- Gets or sets the base color for all the buttons when they are not pressed but are active.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DashControl.LineWidth">
- <summary>
- Gets or sets the line width for the actual line being described, regardless of scale mode.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DashControl.SquareWidth">
- <summary>
- Gets the width of a square in the same units used for the line width.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DashControl.SquareHeight">
- <summary>
- Gets the height of the square
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DashControl.HorizontalSlider">
- <summary>
- Gets or sets the position of the sliders. The X describes the horizontal placement
- of the horizontal slider, while the Y describes the vertical placement of the vertical slider.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DashControl.BlockSize">
- <summary>
- Gets or sets the floating point size of each block in pixels.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DashControl.LineColor">
- <summary>
- Gets or sets the color of the line
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DashControl.VerticalSlider">
- <summary>
- Gets or sets the vertical Slider
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.DashSlider">
- <summary>
- DashSlider
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DashSlider.#ctor(System.Windows.Forms.Orientation)">
- <summary>
- Creates a new instance of DashSlider
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DashSlider.Draw(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Draws the current control
- </summary>
- <param name="g"></param>
- <param name="clipRectangle"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DashSlider.CreateGradientBrush(System.Drawing.Color,System.Drawing.PointF,System.Drawing.PointF)">
- <summary>
- Creates a Gradient Brush
- </summary>
- <param name="color"></param>
- <param name="topLeft"></param>
- <param name="bottomRight"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DashSlider.Image">
- <summary>
- Gets or sets an image that can be used instead of the default triangular drawing
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DashSlider.Orientation">
- <summary>
- Gets or sets whether this control is vertical or horizontal
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DashSlider.Bounds">
- <summary>
- Gets the bounds of this slider.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DashSlider.Color">
- <summary>
- Gets or sets the color for this control if it is not using a custom image.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DashSlider.IsDragging">
- <summary>
- Gets or sets whether or not this slider is in the process of being adjusted
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DashSlider.Position">
- <summary>
- Gets or sets the position. Whether the X or Y coordinate is used depends on the orientation.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DashSlider.Size">
- <summary>
- Gets or sets the size of this slider. This is only used when the slider is not based on an image.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DashSlider.Visible">
- <summary>
- Gets or sets a boolean indicating whether this slider will draw itself.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.DashSliderHorizontal">
- <summary>
- DashSliderHorizontal
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DashSliderHorizontal.#ctor">
- <summary>
- Creates a new instance of DashSliderHorizontal
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DashSliderHorizontal.Draw(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Draws the dash slider
- </summary>
- <param name="g"></param>
- <param name="clipRectangle"></param>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DashSliderHorizontal.Bounds">
- <summary>
- Gets the bounding rectangle for this slider.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.DashSliderVertical">
- <summary>
- DashSliderVertical
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DashSliderVertical.#ctor">
- <summary>
- Creates a new instance of DashSliderVertical
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DashSliderVertical.Draw(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Teh Publick method allowing this dash slider to be moved
- </summary>
- <param name="g">The graphics object to draw to</param>
- <param name="clipRectangle">The clip rectangle defining where drawing should take place</param>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DashSliderVertical.Bounds">
- <summary>
- Gets the bounding rectangle for this slider.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.SquareButton">
- <summary>
- SquareButton
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SquareButton.#ctor">
- <summary>
- Creates a new instance of SquareButton
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SquareButton.Draw(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Instructs this button to draw itself.
- </summary>
- <param name="g"></param>
- <param name="clipRectangle"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SquareButton.GetCurrentColor">
- <summary>
- Gets the current color based on the current state.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SquareButton.UpdateLight(System.Drawing.Point)">
- <summary>
- Updates the mouse location and return true if the state had to change.
- </summary>
- <param name="mouseLocation">Updates this button appropriately based on the specified mouse location.</param>
- <returns>Boolean, true if a change was made.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SquareButton.UpdatePressed(System.Drawing.Point)">
- <summary>
- Updates the depressed nature of the button based on a mouse click in the specified location
- </summary>
- <param name="mouseLocation"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SquareButton.OnDraw(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Draws this square button. The graphics object should be in client coordinates.
- </summary>
- <param name="g"></param>
- <param name="clipRectangle"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SquareButton.CreateGradientBrush(System.Drawing.Color,System.Drawing.PointF,System.Drawing.PointF)">
- <summary>
- Creates a Gradient Brush
- </summary>
- <param name="color"></param>
- <param name="topLeft"></param>
- <param name="bottomRight"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SquareButton.Bounds">
- <summary>
- Gets or sets the rectangular bounds for this button
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SquareButton.ColorDownDark">
- <summary>
- Gets or sets the color for this button control when it is pressed but is not
- capturing the mouse.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SquareButton.ColorDownLit">
- <summary>
- Gets or sets the primary color for this button control when it is pressed
- and is capturing the mouse.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SquareButton.ColorUpDark">
- <summary>
- Gets or sets the color for this button control when it is not pressed and is not
- capturing the mouse.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SquareButton.ColorUpLit">
- <summary>
- Gets or sets the color for this button control when it is not pressed, but is
- currently capturing the mouse
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SquareButton.State">
- <summary>
- Gets or sets the state of the button, including whether it is pressed and whether
- it is illuminated.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SquareButton.IsDown">
- <summary>
- Gets or sets a boolean indicating if this button is currently pressed
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SquareButton.IsLit">
- <summary>
- Gets or sets a boolean indicating if this button is currently lit
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.DialogButtons">
- <summary>
- DialogButtons
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DialogButtons.#ctor">
- <summary>
- Creates a new instance of DialogButtons
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DialogButtons.OnOKClicked">
- <summary>
- Fires the ok clicked event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DialogButtons.OnCancelClicked">
- <summary>
- Fires the Cancel Clicked event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DialogButtons.OnApplyClicked">
- <summary>
- Fires the Apply Clicked event
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.DialogButtons.OkClicked">
- <summary>
- The OK button was clicked
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.DialogButtons.ApplyClicked">
- <summary>
- The Apply button was clicked
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.DialogButtons.CancelClicked">
- <summary>
- The Cancel button was clicked
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.DoubleBox">
- <summary>
- A User control for entering double values into text boxes
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Forms.DoubleBox.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DoubleBox.#ctor">
- <summary>
- Creates a new instance of DoubleBox
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DoubleBox.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DoubleBox.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DoubleBox.OnTextChanged">
- <summary>
- Fires TextChanged
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DoubleBox.OnValidChanged">
- <summary>
- Fires ValidChanged
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.DoubleBox.TextChanged">
- <summary>
- Occurs when the user changes values in the text box
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.DoubleBox.ValidChanged">
- <summary>
- Occurs either when changing from valid to invalid or when
- changing from invalid to valid.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DoubleBox.BackColorRegular">
- <summary>
- Gets or sets the normal background color
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DoubleBox.BackColorInvalid">
- <summary>
- Gets or sets the invalid background color
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DoubleBox.Caption">
- <summary>
- Gets or sets the caption
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DoubleBox.NumberFormat">
- <summary>
- Gets or sets the string number format
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DoubleBox.InvalidHelp">
- <summary>
- Gets or sets teh tool tip text help when this
- item has an invalid entry.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DoubleBox.IsValid">
- <summary>
- Gets or sets a boolean indicating if the text in this box can be parsed
- into a double precision value.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DoubleBox.RegularHelp">
- <summary>
- Gets or sets the tool tip text for regular help
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DoubleBox.Text">
- <summary>
- Gets the raw text entered in the textbox
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DoubleBox.Value">
- <summary>
- Gets the currently entered double value.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.DynamicVisibilityControl">
- <summary>
- DynamicVisibilityControl
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DynamicVisibilityControl.#ctor">
- <summary>
- Creates a new instance of DynamicVisibilityControl. Note,
- this default constructor won't be able to grab the extents
- from a layer, but instead will use the "grab extents"
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DynamicVisibilityControl.#ctor(System.Windows.Forms.Design.IWindowsFormsEditorService,DotSpatial.Symbology.ILayer)">
- <summary>
- The true constructor
- </summary>
- <param name="dialogProvider">Service that may have launched this control</param>
- <param name="layer">the layer that this property is being adjusted on</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DynamicVisibilityControl.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DynamicVisibilityControl.DynamicVisibilityWidth">
- <summary>
- Gets or sets the geographic width where the layer content becomes visible again.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DynamicVisibilityControl.GrabExtents">
- <summary>
- If a layer is not provided, the DynamicVisibilityExtents
- will be set to the grab extents instead.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DynamicVisibilityControl.UseDynamicVisibility">
- <summary>
- Gets or sets a boolean corresponding
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.DynamicVisibilityEditor">
- <summary>
- DynamicVisibilityEditor
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DynamicVisibilityEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)">
- <summary>
- Display a drop down when editing instead of the normal control, and allow the user to "grab" a
- new dynamic visibility extent.
- </summary>
- <param name="context"></param>
- <param name="provider"></param>
- <param name="value"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DynamicVisibilityEditor.GetEditStyle(System.ComponentModel.ITypeDescriptorContext)">
- <summary>
- Indicate that we should use a drop-down for controlling dynamic visibility.
- </summary>
- <param name="context"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.DynamicVisibilityModeDialog">
- <summary>
- DynamicVisibilityModeDialog
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Forms.DynamicVisibilityModeDialog.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DynamicVisibilityModeDialog.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DynamicVisibilityModeDialog.#ctor">
- <summary>
- Creates a new instance of DynamicVisibilityModeDialog
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DynamicVisibilityModeDialog.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DynamicVisibilityModeDialog.DynamicVisibilityMode">
- <summary>
- Gets or sets the dynamic visiblity mode for this dialog.
- This stores the result from this dialog.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.DynamicVisibilityTypeConverter">
- <summary>
- DynamicVisibilityTypeConverter
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DynamicVisibilityTypeConverter.CanConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Type)">
- <summary>
- Returns true if we are converting to strings
- </summary>
- <param name="context"></param>
- <param name="destinationType"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DynamicVisibilityTypeConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)">
- <summary>
- Return
- </summary>
- <param name="context"></param>
- <param name="culture"></param>
- <param name="value"></param>
- <param name="destinationType"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DynamicVisibilityTypeConverter.CanConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Type)">
- <summary>
- Returns true if we are converting from boolean
- </summary>
- <param name="context"></param>
- <param name="sourceType"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.ExportFeature">
- <summary>
- ExportFeature
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ExportFeature.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ExportFeature.#ctor">
- <summary>
- Creates a new instance of ExportFeature
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ExportFeature.OnClosing(System.ComponentModel.CancelEventArgs)">
- <summary>
- Occurs when closing, and throws up a message box preventing "ok" with an invalid path.
- </summary>
- <param name="e"></param>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ExportFeature.FeaturesIndex">
- <summary>
- Gets the zero based integer index
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ExportFeature.Filename">
- <summary>
- Gets or sets the string fileName. Setting this will not actually use this value,
- but will make up a new value based on the entered value.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.ExpressionEditor">
- <summary>
- ExpressionEditor
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ExpressionEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)">
- <summary>
- This describes how to launch the form etc.
- </summary>
- <param name="context"></param>
- <param name="provider"></param>
- <param name="value"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ExpressionEditor.GetEditStyle(System.ComponentModel.ITypeDescriptorContext)">
- <summary>
- This tells the editor that it should open a dialog form when editing the value from a ... button
- </summary>
- <param name="context"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.FontBox">
- <summary>
- FontBox
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Forms.FontBox.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FontBox.#ctor">
- <summary>
- Creates a new instance of FontBox
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FontBox.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FontBox.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FontBox.Reset">
- <summary>
- Changes the starting location of the color drop down based on the current text.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.FontBox.Value">
- <summary>
- Gets or sets the font that this control should be using.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.FontBox.LabelText">
- <summary>
- Gets or sets the label text for this control.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.FontFamilyControl">
- <summary>
- A UserControl for specifying the font family.
- </summary>
- <summary>
- A control that is specifically designed to allow choosing a font family name
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FontFamilyControl.#ctor">
- <summary>
- Creates a new instance of the Font Family control, pre-loading a font drop down.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FontFamilyControl.GetSelectedFamily">
- <summary>
- Gets the selected family name as a FontFamily object
- </summary>
- <returns>A FontFamily object</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FontFamilyControl.OnSelectedItemChanged">
- <summary>
- Throws a new event when the selected item changed.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Forms.FontFamilyControl.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FontFamilyControl.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FontFamilyControl.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.FontFamilyControl.SelectedFamily">
- <summary>
- Gets or sets the currently selected font family name.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.FontFamilyControl.SelectedItemChanged">
- <summary>
- Event
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.FontFamilyDropDown">
- <summary>
- This control doesn't actually pre-load items, it merely overrides how the items
- are drawn.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FontFamilyDropDown.OnDrawItem(System.Windows.Forms.DrawItemEventArgs)">
- <summary>
- Occurs during the drawing of an item
- </summary>
- <param name="e"></param>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.FontFamilyNameEditor">
- <summary>
- FontFamilyNameEditor
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FontFamilyNameEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)">
- <summary>
- Edits a value based on some user input which is collected from a character control.
- </summary>
- <param name="context"></param>
- <param name="provider"></param>
- <param name="value"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.FontFamilyNameEditor.GetEditStyle(System.ComponentModel.ITypeDescriptorContext)">
- <summary>
- Gets the UITypeEditorEditStyle, which in this case is drop down.
- </summary>
- <param name="context"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.FontFamilyNameEditor.IsDropDownResizable">
- <summary>
- Overrides the ISDropDownResizable to allow this control to be adjusted.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.ColorLever">
- <summary>
- A Color lever is a control that shows a color on a plate, and has a knob on a lever on the side of the plate for
- controling the opacity, where the up position is opaque and the bottom position is transparent.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ColorLever.#ctor">
- <summary>
- Creates a new instance of ColorLever
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ColorLever.OnPaintBackground(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Prevent flicker
- </summary>
- <param name="pevent"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ColorLever.OnPaint(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Draw the clipped portion
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ColorLever.OnDraw(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Controls the actual drawing for this gradient slider control.
- </summary>
- <param name="g"></param>
- <param name="clipRectangle"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ColorLever.ClientToStandard(System.Drawing.Point)">
- <summary>
- Uses the current transform matrix to calculate the coordinates in terms of the unrotated, unflipped image
- </summary>
- <param name="location"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ColorLever.StandardToClient(System.Drawing.Point)">
- <summary>
- Transforms a point from the standard orientation of the control into client coordinates.
- </summary>
- <param name="location"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ColorLever.OnMouseDown(System.Windows.Forms.MouseEventArgs)">
- <summary>
- Handles the mouse down position for dragging the lever.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ColorLever.OnMouseMove(System.Windows.Forms.MouseEventArgs)">
- <summary>
- Handles the mouse move event to handle when the lever is dragged.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ColorLever.OnMouseUp(System.Windows.Forms.MouseEventArgs)">
- <summary>
- Controls the mouse up for ending the drag movement, or possibly launching the color dialog to change the base color.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ColorLever.OnColorChanged">
- <summary>
- Fires a ColorChanged event whenver the opacity or color have been altered.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ColorLever.OnColorChanging">
- <summary>
- Fires the ColorChanging evetn whenever the color is changing either directly, or by the use of the opacity lever.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ColorLever.OnOpacityChanging">
- <summary>
- Fires the OpacityChanging event when the opacity is being changed
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.ColorLever.ColorChanged">
- <summary>
- Occurs whenever either the color or the opacity for this control is adjusted
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.ColorLever.OpacityChanging">
- <summary>
- Occurs as the opacity is being adjusted by the slider, but while the slider is
- still being dragged.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.ColorLever.ColorChanging">
- <summary>
- Because the color is changed any time the opacity is changed, while the lever is being
- adjusted, the color is being updated as well as the opacity. Therefore, this is fired
- both when the color is changed directly or when the slider is being adjusted.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ColorLever.Angle">
- <summary>
- Gets or sets the double valued angle for this control.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ColorLever.BarLength">
- <summary>
- Gets or sets the bar length
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ColorLever.BarWidth">
- <summary>
- Gets or sets the width of the bar connecting the knob
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ColorLever.BorderWidth">
- <summary>
- Gets or sets the border width
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ColorLever.Color">
- <summary>
- Gets or sets the color being displayed on the color plate.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ColorLever.KnobRadius">
- <summary>
- Gets or sets the radius to use for the knob on the opacity lever.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ColorLever.KnobColor">
- <summary>
- Gets or sets the knob color.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ColorLever.Flip">
- <summary>
- Gets or sets a boolean that can be used to reverse the lever, rather than simply rotating it.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ColorLever.Opacity">
- <summary>
- Gets or sets the opacity for the color lever. This will also
- adjust the knob position.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.GradientControl">
- <summary>
- A Control that can be used to create custom gradients.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.GradientControl.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.GradientControl.#ctor">
- <summary>
- Creates a new instance of a Gradient Control
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.GradientControl.OnGradientChanged">
- <summary>
- Fires the Gradient Changed event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.GradientControl.OnGradientChanging">
- <summary>
- Fires the Gradient Changing event
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.GradientControl.GradientChanged">
- <summary>
- Occurs when the gradient is updated to its final value when the sliders or levers are released.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.GradientControl.GradientChanging">
- <summary>
- Occurs when the gradient changes as the result of a sliding action, either from the dragging of a slider or else
- the dragging of a lever.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.GradientControl.StartValue">
- <summary>
- Gets or sets the position of the minimum handle
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.GradientControl.EndValue">
- <summary>
- Gets or sets the position of the maximum handle
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.GradientControl.MinimumColor">
- <summary>
- Gets or sets the minimum color
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.GradientControl.MaximumColor">
- <summary>
- Gets or sets the maximum color
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.GradientControl.SlidersEnabled">
- <summary>
- Gets or sets a boolean that determine whether the sliders are enabled on the gradient control.
- Disabling the sliders will prevent them from being drawn or changed, and will automatically
- set the values to minimum and maximumum.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.GradientSlider">
- <summary>
- GradientControl
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.GradientSlider.#ctor">
- <summary>
- Creates a new instance of GradientControl
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.GradientSlider.OnPaintBackground(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Prevent flicker
- </summary>
- <param name="pevent"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.GradientSlider.OnPaint(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Draw the clipped portion
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.GradientSlider.OnDraw(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Controls the actual drawing for this gradient slider control.
- </summary>
- <param name="g"></param>
- <param name="clipRectangle"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.GradientSlider.OnMouseDown(System.Windows.Forms.MouseEventArgs)">
- <summary>
- Initiates slider dragging
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.GradientSlider.OnMouseMove(System.Windows.Forms.MouseEventArgs)">
- <summary>
- Handles slider dragging
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.GradientSlider.OnMouseUp(System.Windows.Forms.MouseEventArgs)">
- <summary>
- Handles the mouse up situation
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.GradientSlider.OnPositionChanging">
- <summary>
- Fires the Position Changing event while either slider is being dragged
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.GradientSlider.OnPositionChanged">
- <summary>
- Fires the Position Changed event after sliders are released
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.GradientSlider.PositionChanging">
- <summary>
- Occurs as the user is adjusting the positions on either of the sliders
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.GradientSlider.PositionChanged">
- <summary>
- Occurs after the user has finished adjusting the positions of either of the sliders and has released control
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.GradientSlider.LeftHandle">
- <summary>
- Gets or sets the floating point position of the left slider. This must range
- between 0 and 1, and to the left of the right slider, (therefore with a value lower than the right slider.)
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.GradientSlider.RightHandle">
- <summary>
- Gets or sets the floating point position of the right slider. This must range
- between 0 and 1, and to the right of the left slider.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.GradientSlider.Minimum">
- <summary>
- Gets or sets the minimum allowed value for the slider.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.GradientSlider.MinimumColor">
- <summary>
- Gets or sets the color associated with the minimum color
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.GradientSlider.Maximum">
- <summary>
- Gets or sets the maximum allowed value for the slider.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.GradientSlider.MaximumColor">
- <summary>
- Gets or sets the color associated with the maximum value.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.HueHandle">
- <summary>
- RoundedSlider
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.HueHandle.#ctor">
- <summary>
- Creates a new instance of RoundedSlider
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.HueHandle.#ctor(DotSpatial.Symbology.Forms.HueSlider)">
- <summary>
- Creates a new instance of a rounded handle, specifying the parent gradient slider
- </summary>
- <param name="parent"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.HueHandle.Draw(System.Drawing.Graphics)">
- <summary>
- Draws this slider on the specified graphics object
- </summary>
- <param name="g"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.HueHandle.GetBounds">
- <summary>
- Gets the bounds of this handle in the coordinates of the parent slider.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.HueHandle.IsDragging">
- <summary>
- Gets or sets a boolean indicating whether this is visible or not
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.HueHandle.Parent">
- <summary>
- Gets or sets the parent
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.HueHandle.Position">
- <summary>
- Gets or sets the Position
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.HueHandle.Left">
- <summary>
- Gets or sets whether this handle should behave like a left handle,
- meaning that it reads values from its right side rather than the left.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.HueHandle.Width">
- <summary>
- Gets or sets the integer width of this slider in pixels.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.HueHandle.Color">
- <summary>
- Gets or sets the basic color of the slider
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.HueHandle.RoundingRadius">
- <summary>
- Gets or sets the integer describing the radius of the curves in the corners of the slider
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.HueHandle.Visible">
- <summary>
- Gets or sets a boolean that controls whether or not this handle is drawn and visible.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.HueSlider">
- <summary>
- GradientControl
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.HueSlider.#ctor">
- <summary>
- Creates a new instance of GradientControl
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.HueSlider.SetRange(System.Drawing.Color,System.Drawing.Color)">
- <summary>
- Uses the hue values from the specified start and end color to set the handle positions.
- </summary>
- <param name="startColor">The start color that represents the left hue</param>
- <param name="endColor">The start color that represents the right hue</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.HueSlider.OnPaintBackground(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Prevent flicker
- </summary>
- <param name="pevent"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.HueSlider.OnPaint(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Draw the clipped portion
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.HueSlider.OnDraw(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Controls the actual drawing for this gradient slider control.
- </summary>
- <param name="g"></param>
- <param name="clipRectangle"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.HueSlider.OnMouseDown(System.Windows.Forms.MouseEventArgs)">
- <summary>
- Initiates slider dragging
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.HueSlider.OnMouseMove(System.Windows.Forms.MouseEventArgs)">
- <summary>
- Handles slider dragging
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.HueSlider.OnMouseUp(System.Windows.Forms.MouseEventArgs)">
- <summary>
- Handles the mouse up situation
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.HueSlider.OnPositionChanging">
- <summary>
- Fires the Position Changing event while either slider is being dragged
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.HueSlider.OnPositionChanged">
- <summary>
- Fires the Position Changed event after sliders are released
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.HueSlider.PositionChanging">
- <summary>
- Occurs as the user is adjusting the positions on either of the sliders
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.HueSlider.PositionChanged">
- <summary>
- Occurs after the user has finished adjusting the positions of either of the sliders and has released control
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.HueSlider.Inverted">
- <summary>
- Gets or sets a boolean indicating whether the hue pattern should be flipped.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.HueSlider.HueShift">
- <summary>
- Gets or sets an integer value indicating how much to adjust the hue to change where wrapping occurs.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.HueSlider.LeftHandle">
- <summary>
- Gets or sets the floating point position of the left slider. This must range
- between 0 and 1, and to the left of the right slider, (therefore with a value lower than the right slider.)
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.HueSlider.RightHandle">
- <summary>
- Gets or sets the floating point position of the right slider. This must range
- between 0 and 1, and to the right of the left slider.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.HueSlider.Maximum">
- <summary>
- Gets or sets the maximum allowed value for the slider.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.HueSlider.Minimum">
- <summary>
- Gets or sets the minimum allowed value for the slider.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.HueSlider.LeftValue">
- <summary>
- The value represented by the left handle, taking into account
- whether or not the slider has been reversed.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.HueSlider.RightValue">
- <summary>
- The value represented by the right handle, taking into account
- whether or not the slider has been reversed.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.RoundedHandle">
- <summary>
- RoundedSlider
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.RoundedHandle.#ctor">
- <summary>
- Creates a new instance of RoundedSlider
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.RoundedHandle.#ctor(DotSpatial.Symbology.Forms.GradientSlider)">
- <summary>
- Creates a new instance of a rounded handle, specifying the parent gradient slider
- </summary>
- <param name="parent"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.RoundedHandle.Draw(System.Drawing.Graphics)">
- <summary>
- Draws this slider on the specified graphics object
- </summary>
- <param name="g"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.RoundedHandle.GetBounds">
- <summary>
- Gets the bounds of this handle in the coordinates of the parent slider.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.RoundedHandle.IsDragging">
- <summary>
- Gets or sets a boolean indicating whether this is visible or not
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.RoundedHandle.Parent">
- <summary>
- Gets or sets the parent
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.RoundedHandle.Position">
- <summary>
- Gets or sets the Position
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.RoundedHandle.Width">
- <summary>
- Gets or sets the integer width of this slider in pixels.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.RoundedHandle.Color">
- <summary>
- Gets or sets the basic color of the slider
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.RoundedHandle.RoundingRadius">
- <summary>
- Gets or sets the integer describing the radius of the curves in the corners of the slider
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.RoundedHandle.Visible">
- <summary>
- Gets or sets a boolean that controls whether or not this handle is drawn and visible.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.TwoColorHandle">
- <summary>
- RoundedSlider
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TwoColorHandle.#ctor">
- <summary>
- Creates a new instance of RoundedSlider
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TwoColorHandle.#ctor(DotSpatial.Symbology.Forms.TwoColorSlider)">
- <summary>
- Creates a new instance of a rounded handle, specifying the parent gradient slider
- </summary>
- <param name="parent"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TwoColorHandle.Draw(System.Drawing.Graphics)">
- <summary>
- Draws this slider on the specified graphics object
- </summary>
- <param name="g"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TwoColorHandle.GetBounds">
- <summary>
- Gets the bounds of this handle in the coordinates of the parent slider.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TwoColorHandle.GetColor">
- <summary>
- Gets the color at the handles current position
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.TwoColorHandle.IsLeft">
- <summary>
- Gets or sets a boolean indicating whether this is the left handle or not.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.TwoColorHandle.IsDragging">
- <summary>
- Gets or sets a boolean indicating whether this is visible or not
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.TwoColorHandle.Parent">
- <summary>
- Gets or sets the parent
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.TwoColorHandle.Position">
- <summary>
- Gets or sets the Position
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.TwoColorHandle.Width">
- <summary>
- Gets or sets the integer width of this slider in pixels.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.TwoColorHandle.Color">
- <summary>
- Gets or sets the basic color of the slider
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.TwoColorHandle.RoundingRadius">
- <summary>
- Gets or sets the integer describing the radius of the curves in the corners of the slider
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.TwoColorHandle.Visible">
- <summary>
- Gets or sets a boolean that controls whether or not this handle is drawn and visible.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.TwoColorSlider">
- <summary>
- GradientControl
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TwoColorSlider.#ctor">
- <summary>
- Creates a new instance of GradientControl
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TwoColorSlider.SetSaturation(System.Drawing.Color,System.Drawing.Color)">
- <summary>
- Uses the saturation of the specified values to set the left and right values for this slider.
- </summary>
- <param name="startColor">The color that specifies the left saturation</param>
- <param name="endColor">The color that specifies the right saturation</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TwoColorSlider.SetLightness(System.Drawing.Color,System.Drawing.Color)">
- <summary>
- Uses the lightness of hte specified values ot set the left and right values for this slider
- </summary>
- <param name="startColor">The color that specifies the left lightness</param>
- <param name="endColor">The color that specifies the right lightness</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TwoColorSlider.OnPaintBackground(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Prevent flicker
- </summary>
- <param name="pevent"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TwoColorSlider.OnPaint(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Draw the clipped portion
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TwoColorSlider.OnDraw(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Controls the actual drawing for this gradient slider control.
- </summary>
- <param name="g"></param>
- <param name="clipRectangle"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TwoColorSlider.OnMouseDown(System.Windows.Forms.MouseEventArgs)">
- <summary>
- Initiates slider dragging
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TwoColorSlider.OnMouseMove(System.Windows.Forms.MouseEventArgs)">
- <summary>
- Handles slider dragging
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TwoColorSlider.OnMouseUp(System.Windows.Forms.MouseEventArgs)">
- <summary>
- Handles the mouse up situation
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TwoColorSlider.OnPositionChanging">
- <summary>
- Fires the Position Changing event while either slider is being dragged
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TwoColorSlider.OnPositionChanged">
- <summary>
- Fires the Position Changed event after sliders are released
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.TwoColorSlider.PositionChanging">
- <summary>
- Occurs as the user is adjusting the positions on either of the sliders
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.TwoColorSlider.PositionChanged">
- <summary>
- Occurs after the user has finished adjusting the positions of either of the sliders and has released control
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.TwoColorSlider.Inverted">
- <summary>
- Gets or sets the inverted values.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.TwoColorSlider.LeftHandle">
- <summary>
- Gets or sets the floating point position of the left slider. This must range
- between 0 and 1, and to the left of the right slider, (therefore with a value lower than the right slider.)
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.TwoColorSlider.LeftValue">
- <summary>
- The value represented by the left handle, taking into account
- whether or not the slider has been reversed.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.TwoColorSlider.RightValue">
- <summary>
- The value represented by the right handle, taking into account
- whether or not the slider has been reversed.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.TwoColorSlider.RightHandle">
- <summary>
- Gets or sets the floating point position of the right slider. This must range
- between 0 and 1, and to the right of the left slider.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.TwoColorSlider.MaximumColor">
- <summary>
- Gets or sets the color associated with the maximum value.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.TwoColorSlider.Maximum">
- <summary>
- Gets or sets the maximum allowed value for the slider.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.TwoColorSlider.Minimum">
- <summary>
- Gets or sets the minimum allowed value for the slider.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.TwoColorSlider.MinimumColor">
- <summary>
- Gets or sets the color associated with the minimum color
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.SymbologyFormsImages">
- <summary>
- A strongly-typed resource class, for looking up localized strings, etc.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsImages.ResourceManager">
- <summary>
- Returns the cached ResourceManager instance used by this class.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsImages.Culture">
- <summary>
- Overrides the current thread's CurrentUICulture property for all
- resource lookups using this strongly typed resource class.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsImages.add">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsImages.ArrowDownGreen">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsImages.calculator">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsImages.color_scheme">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsImages.delete">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsImages.Disk">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsImages.down">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsImages.FolderOpen">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsImages.info">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsImages.mnuLayerAdd">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsImages.mnuLayerClear">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsImages.Pan">
- <summary>
- Looks up a localized resource of type System.Drawing.Icon similar to (Icon).
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsImages.redbluearrows">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsImages.refresh">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsImages.RunModel">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsImages.script">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsImages.Table_edit">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsImages.up">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsImages.zoom">
- <summary>
- Looks up a localized resource of type System.Drawing.Bitmap.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.JoinDialog">
- <summary>
- JoinDialog
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Forms.JoinDialog.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.JoinDialog.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.JoinDialog.#ctor(DotSpatial.Data.IFeatureSet)">
- <summary>
- Creates a new instance of JoinDialog
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.JoinDialog.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.JoinDialog.Filename">
- <summary>
- Gets the fileName of the created shapefile.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.LabelAlignmentButton">
- <summary>
- LabelAlignmentButton
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelAlignmentButton.#ctor">
- <summary>
- Creates a new instance of LabelAlignmentButton
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelAlignmentButton.#ctor(System.Drawing.Rectangle,System.Drawing.Color)">
- <summary>
- Creates a new instance of the button with the specified rectangle as the bounds.
- </summary>
- <param name="bounds">The bounds relative to the parent client</param>
- <param name="backColor">The background color</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelAlignmentButton.Draw(System.Drawing.Graphics)">
- <summary>
- Instructs this button to draw itself.
- </summary>
- <param name="g">The graphics surface to draw to.</param>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.LabelAlignmentButton.Bounds">
- <summary>
- Gets or sets the bounds for this button.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.LabelAlignmentButton.BackColor">
- <summary>
- Gets or sets the color used as the background color.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.LabelAlignmentButton.Highlighted">
- <summary>
- Boolean, true if this button is currently highlighted (mouse over)
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.LabelAlignmentButton.Selected">
- <summary>
- Boolean, true if this button is currently selected
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.LabelAlignmentControl">
- <summary>
- LabelAlignmentControl
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelAlignmentControl.#ctor">
- <summary>
- Creates a new instance of LabelAlignmentControl
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelAlignmentControl.OnValueChanged(System.Object,System.EventArgs)">
- <summary>
- Occurs when the value is changed and fires the ValueChanged event
- </summary>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelAlignmentControl.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.LabelAlignmentControl.Value">
- <summary>
- Gets or sets the actual value currently being represented in the control.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.LabelAlignmentControl.ValueChanged">
- <summary>
- Occurs after the drop-down has been used to select a value.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.LabelAlignmentPicker">
- <summary>
- LabelAlignmentControl
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelAlignmentPicker.#ctor">
- <summary>
- Creates a new instance of LabelAlignmentControl
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelAlignmentPicker.OnPaintBackground(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Prevent flicker
- </summary>
- <param name="pevent"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelAlignmentPicker.OnPaint(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Custom drawing
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelAlignmentPicker.OnDraw(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Handles the actual drawing for this control.
- </summary>
- <param name="g"></param>
- <param name="clipRectangle"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelAlignmentPicker.OnMouseUp(System.Windows.Forms.MouseEventArgs)">
- <summary>
- A mouse up event will alter the button that is currently selected
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelAlignmentPicker.OnValueChanged(DotSpatial.Symbology.Forms.LabelAlignmentButton)">
- <summary>
- Fires the Value Changed event
- </summary>
- <param name="sender"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelAlignmentPicker.OnMouseMove(System.Windows.Forms.MouseEventArgs)">
- <summary>
- Handles mouse movements that highlight internal buttons
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LabelAlignmentPicker.OnResize(System.EventArgs)">
- <summary>
- Occurs when this is resized
- </summary>
- <param name="e"></param>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.LabelAlignmentPicker.ValueChanged">
- <summary>
- Occurs when the value has changed
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.LabelAlignmentPicker.Value">
- <summary>
- Gets the content alignment for this control
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.LabelAlignmentPicker.Padding">
- <summary>
- Gets an integer value representing how much to separate the
- interior region of the buttons.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.LineJoinControl">
- <summary>
- LineJoinControl
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LineJoinControl.#ctor">
- <summary>
- Creates a new instance of LineJoinControl
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LineJoinControl.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LineJoinControl.OnValueChanged">
- <summary>
- Fires the on value changed event
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.LineJoinControl.ValueChanged">
- <summary>
- Occurs when one of the radio buttons is clicked, changing the current value.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.LineJoinControl.Text">
- <summary>
- Gets or sets the string text
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.LineJoinControl.Value">
- <summary>
- Gets or sets the current line join type shown by the control.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.LineSchemePropertyGridEditor">
- <summary>
- PropertyGridEditor
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LineSchemePropertyGridEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)">
- <summary>
- This should launch an open file dialog instead of the usual thing.
- </summary>
- <param name="context">ITypeDescriptorContext</param>
- <param name="provider">IServiceProvider</param>
- <param name="value">The object being displayed</param>
- <returns>A new version of the object if the dialog was ok.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LineSchemePropertyGridEditor.GetEditStyle(System.ComponentModel.ITypeDescriptorContext)">
- <summary>
- Either allows the editor to work or else nips it in the butt
- </summary>
- <param name="context">ITypeDescriptorContext</param>
- <returns>UITypeEditorEditStyle</returns>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.LineSymbolizerEditor">
- <summary>
- LineSymbolizerEditor
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LineSymbolizerEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)">
- <summary>
- Launches a form for editing the line symbolizer
- </summary>
- <param name="context"></param>
- <param name="provider"></param>
- <param name="value"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LineSymbolizerEditor.GetEditStyle(System.ComponentModel.ITypeDescriptorContext)">
- <summary>
- Indicates to launch a form, rather than using a drop-down edit style
- </summary>
- <param name="context"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings">
- <summary>
- A strongly-typed resource class, for looking up localized strings, etc.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.ResourceManager">
- <summary>
- Returns the cached ResourceManager instance used by this class.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.Culture">
- <summary>
- Overrides the current thread's CurrentUICulture property for all
- resource lookups using this strongly typed resource class.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.AttributeCalculator_FactGreaterThanZero">
- <summary>
- Looks up a localized string similar to Factorial value should be grater than 0.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.AttributeCalculator_IncompatibleDestinationField">
- <summary>
- Looks up a localized string similar to The destination field data type is incompatible (double or string or integer).
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.AttributeCalculator_NonStandardFunction">
- <summary>
- Looks up a localized string similar to The function name was not recognized as one of the standard function names..
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.AttributeCalculator_ParameterInvalid">
- <summary>
- Looks up a localized string similar to The parameter is invalid.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.AttributeCalculator_RootNthRootIncorrect">
- <summary>
- Looks up a localized string similar to The root n-th root is incorrect.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.AttributeCalculator_TooManyClosingBrackets">
- <summary>
- Looks up a localized string similar to There were too many closing brackets in the string expression..
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.DoubleBox_DoubleError">
- <summary>
- Looks up a localized string similar to The value entered could not be correctly parsed into a valid double precision floating point value..
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.DoubleBox_DoubleHelp">
- <summary>
- Looks up a localized string similar to Enter a double precision floating point value..
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.ExportFeature_FeaturesAll">
- <summary>
- Looks up a localized string similar to All Features.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.ExportFeature_FeaturesExtent">
- <summary>
- Looks up a localized string similar to All Features in View Extent.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.ExportFeature_FeaturesSelected">
- <summary>
- Looks up a localized string similar to Selected features.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.ExpressionControl_EmptyExpression">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die The expression is empty. ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.FeatureCategoryControl_CustomOnly">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die In order to specify a custom filter expression, the custom mode must be selected first. ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.FeatureLayerActions_FeaturesExported">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die The layer was exported. ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.FeatureLayerActions_LoadFeatures">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die Do you want to load the shapefile? ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.LabelSetup_Help1">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die Each symbol group can define a separate string expression that includes attribute values. Double click fields to add it to the expression. ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.LabelSetup_Help2">
- <summary>
- Looks up a localized string similar to Use the Members tab to design a filter expression that restricts which features will be assigned to a specific label..
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.LabelSetup_Help3">
- <summary>
- Looks up a localized string similar to Use the Expression Tab to design the text that should appear in a label. Fields indicated with brackets will be substituted with real values..
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.LabelSetup_Help4">
- <summary>
- Looks up a localized string similar to Each group can specify its own basic design characteristics..
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.LabelSetup_Help5">
- <summary>
- Looks up a localized string similar to Each group can specify its advanced characteristics..
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.LabelSetup_OneCategoryNeededErr">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die Categories must contain at least one category! ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.LabelSetup_OneCategoryNeededErrCaption">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die Unable to delete category ähnelt.
- </summary>
- </member>
- <!-- Badly formed XML comment ignored for member "P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.LargeEditsNotSupported" -->
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.TableEditorControl_Confirm">
- <summary>
- Looks up a localized string similar to Confirm.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.TableEditorControl_CopyFid_Could_not_copy_FID">
- <summary>
- Looks up a localized string similar to Could not copy FID.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.TableEditorControl_CopyFid_Couldnt_find_field">
- <summary>
- Looks up a localized string similar to Could not find the field in the attribute Table colums.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.TableEditorControl_CouldNotExecuteQuery">
- <summary>
- Looks up a localized string similar to Could not execute the query..
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.TableEditorControl_CouldNotFindReplace">
- <summary>
- Looks up a localized string similar to Could not find or replace items..
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.TableEditorControl_DisplaySelectedRowNumberLable__of_">
- <summary>
- Looks up a localized string similar to of .
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.TableEditorControl_DisplaySelectedRowNumberLable__Selected">
- <summary>
- Looks up a localized string similar to Selected.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.TableEditorControl_EnterFindString">
- <summary>
- Looks up a localized string similar to Enter Find String.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.TableEditorControl_exportSelectedFeaturesToolStripMenuItem_Click_Shapefiles____shp_____SHP">
- <summary>
- Looks up a localized string similar to Shapefiles (*.shp) |*.shp.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.TableEditorControl_FieldImportFailed">
- <summary>
- Looks up a localized string similar to Could not import column fields..
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.TableEditorControl_Find">
- <summary>
- Looks up a localized string similar to Find.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.TableEditorControl_ImportFieldsFromDbf_Could_not_import_column_fields">
- <summary>
- Looks up a localized string similar to Could not import column fields.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.TableEditorControl_ImportFieldsFromDbf_DBase_Files____dbf____DBF">
- <summary>
- Looks up a localized string similar to DBase Files (*.dbf)|*.dbf.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.TableEditorControl_NewFieldFail">
- <summary>
- Looks up a localized string similar to Could not create new field.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.TableEditorControl_NoMatch">
- <summary>
- Looks up a localized string similar to None of the rows contain a value that matches the specified value..
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.TableEditorControl_RemoveFields">
- <summary>
- Looks up a localized string similar to Are you sure you want to remove the fields?.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.TableEditorControl_removeFieldToolStripMenuItem_Click_Column_edits_are_not_yet_supported_for_datasets_with_more_than_50_000_attributes">
- <summary>
- Looks up a localized string similar to Column edits are not yet supported for datasets with more than 50, 000 attributes.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.TableEditorControl_renameFieldToolStripMenuItem_Click_This_feature_is_not_yet_supported_for_datasets_with_larger_than_50_000_rows_">
- <summary>
- Looks up a localized string similar to This feature is not yet supported for datasets with larger than 50, 000 rows..
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.TableEditorControl_ReplaceString_Unfamilar_data_type_to_replace">
- <summary>
- Looks up a localized string similar to Unfamilar data type to replace.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.TableEditorControl_Row">
- <summary>
- Looks up a localized string similar to row.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.TableEditorControl_RowPlural">
- <summary>
- Looks up a localized string similar to rows.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.TableEditorControl_SaveEdits_Unable_to_save_edits__">
- <summary>
- Looks up a localized string similar to Unable to save edits. .
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.TableEditorControl_SelectedRowCountPluralization">
- <summary>
- Looks up a localized string similar to s.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyFormsMessageStrings.TableEditorControl_SelectedRowCountStringFormat">
- <summary>
- Looks up a localized string similar to {0} of {1} selected..
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.OpacityEditor">
- <summary>
- OpacityEditor
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.OpacityEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)">
- <summary>
- Edits the value by showing a slider control in the drop down.
- </summary>
- <param name="context"></param>
- <param name="provider"></param>
- <param name="value"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.OpacityEditor.GetEditStyle(System.ComponentModel.ITypeDescriptorContext)">
- <summary>
- Sets the behavior to drop-down
- </summary>
- <param name="context"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.OpacityEditor.IsDropDownResizable">
- <summary>
- Ensures that we can widen the drop-down without having to close the drop down,
- widen the control, and re-open it again.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.OpenFileEditor">
- <summary>
- UIOpenFileEditor
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.OpenFileEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)">
- <summary>
- This should launch an open file dialog instead of the usual thing.
- </summary>
- <param name="context"></param>
- <param name="provider"></param>
- <param name="value"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.OpenFileEditor.GetEditStyle(System.ComponentModel.ITypeDescriptorContext)">
- <summary>
- Either allows the editor to work or else nips it in the butt
- </summary>
- <param name="context">ITypeDescriptorContext</param>
- <returns>UITypeEditorEditStyle</returns>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.OutlineControl">
- <summary>
- A collection of controls that are specifically designed to work with the outline on a polygon.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.OutlineControl.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.OutlineControl.#ctor">
- <summary>
- Creates a new, blank instanceo of the outline control
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.OutlineControl.#ctor(DotSpatial.Symbology.IPattern)">
- <summary>
- Creates an outline control that uses the specified pattern to define its configuration.
- </summary>
- <param name="pattern">The pattern that will be modified during changes.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.OutlineControl.#ctor(DotSpatial.Symbology.IPattern,DotSpatial.Symbology.IPattern)">
- <summary>
- Creates an outline control that uses the specified pattern to define its configuration.
- </summary>
- <param name="original">When apply changes are clicked, the map will be updated when these changes are copied over.</param>
- <param name="display">The pattern that will be modified during changes.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.OutlineControl.OnOutlineChanged">
- <summary>
- Fires the OutlineChanged event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.OutlineControl.OnChangesApplied">
- <summary>
- Fires the OutlineChanged event
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.OutlineControl.OutlineChanged">
- <summary>
- Occurs when any of the symbolic aspects of this control are changed.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.OutlineControl.ChangesApplied">
- <summary>
- Occurs specifically when changes are applied from the line symbolizer editor
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.OutlineControl.Pattern">
- <summary>
- Gets or sets the pattern for this control
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.PointFConverter">
- <summary>
- PointFConverter
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.PointFConverter.CanConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Type)">
- <summary>
- Boolean, true if the source type is a string
- </summary>
- <param name="context"></param>
- <param name="sourceType"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.PointFConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)">
- <summary>
- Converts the specified string into a PointF
- </summary>
- <param name="context"></param>
- <param name="culture"></param>
- <param name="value"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.PointFConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)">
- <summary>
- Converts the PointF into a string
- </summary>
- <param name="context"></param>
- <param name="culture"></param>
- <param name="value"></param>
- <param name="destinationType"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.PointSchemePropertyGridEditor">
- <summary>
- PropertyGridEditor
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.PointSchemePropertyGridEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)">
- <summary>
- This should launch an open file dialog instead of the usual thing.
- </summary>
- <param name="context">ITypeDescriptorContext</param>
- <param name="provider">IServiceProvider</param>
- <param name="value">The object being displayed</param>
- <returns>A new version of the object if the dialog was ok.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.PointSchemePropertyGridEditor.GetEditStyle(System.ComponentModel.ITypeDescriptorContext)">
- <summary>
- Either allows the editor to work or else nips it in the butt
- </summary>
- <param name="context">ITypeDescriptorContext</param>
- <returns>UITypeEditorEditStyle</returns>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.PointSymbolizerEditor">
- <summary>
- LineSymbolizerEditor
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.PointSymbolizerEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)">
- <summary>
- Launches a form for editing the line symbolizer
- </summary>
- <param name="context"></param>
- <param name="provider"></param>
- <param name="value"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.PointSymbolizerEditor.GetEditStyle(System.ComponentModel.ITypeDescriptorContext)">
- <summary>
- Specifies that this should open a form and work using a modal behavior.
- </summary>
- <param name="context"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.PolygonSchemePropertyGridEditor">
- <summary>
- PropertyGridEditor
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.PolygonSchemePropertyGridEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)">
- <summary>
- This should launch an open file dialog instead of the usual thing.
- </summary>
- <param name="context">ITypeDescriptorContext</param>
- <param name="provider">IServiceProvider</param>
- <param name="value">The object being displayed</param>
- <returns>A new version of the object if the dialog was ok.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.PolygonSchemePropertyGridEditor.GetEditStyle(System.ComponentModel.ITypeDescriptorContext)">
- <summary>
- Either allows the editor to work or else nips it in the butt
- </summary>
- <param name="context">ITypeDescriptorContext</param>
- <returns>UITypeEditorEditStyle</returns>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.PolygonSymbolizerEditor">
- <summary>
- LineSymbolizerEditor
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.PolygonSymbolizerEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)">
- <summary>
- Launches a form for editing the line symbolizer
- </summary>
- <param name="context"></param>
- <param name="provider"></param>
- <param name="value"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.PolygonSymbolizerEditor.GetEditStyle(System.ComponentModel.ITypeDescriptorContext)">
- <summary>
- Indicates to launch a form, rather than using a drop-down edit style
- </summary>
- <param name="context"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.PredefinedLineSymbolControl">
- <summary>
- This control shows a list of predefined symbols with their names and preview.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.PredefinedLineSymbolControl.#ctor">
- <summary>
- Creates a new instance of the predefined symbol control.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.PredefinedLineSymbolControl.#ctor(DotSpatial.Symbology.CustomLineSymbolProvider)">
- <summary>
- Creates a new instance of the predefined symbol control that uses the specific symbol provider
- </summary>
- <param name="prov">The provider class that is used to retrieve the predefined custom symbols from
- the XML file or another data source</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.PredefinedLineSymbolControl.#ctor(System.Windows.Forms.Design.IWindowsFormsEditorService,System.Collections.Generic.List{DotSpatial.Symbology.CustomLineSymbolizer})">
- <summary>
- Creates a new instance of a Predefined symbol control designed to display a list of specific symbolizer
- </summary>
- <param name="editorService"></param>
- <param name="symbols"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.PredefinedLineSymbolControl.AddSymbolizer(DotSpatial.Symbology.CustomLineSymbolizer)">
- <summary>
- Adds a new symbolizer to the control. The added symbolizer will be selected
- by default
- </summary>
- <param name="newSymbolizer">The added custom symbolizer</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.PredefinedLineSymbolControl.ContainsSymbolizer(DotSpatial.Symbology.ILineSymbolizer)">
- <summary>
- Checks if the control contains the specified symbolizer
- </summary>
- <param name="symbolizer">the line symbolizer to be checked</param>
- <returns>true if found, false otherwise</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.PredefinedLineSymbolControl.Save(System.String)">
- <summary>
- Saves the list of symbolizers to a file using serialization
- (not yet implemented)
- </summary>
- <param name="fileName"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.PredefinedLineSymbolControl.Load(System.String)">
- <summary>
- Loads the list of symbolizers from the serialized file
- (not yet implemented)
- </summary>
- <param name="fileName">The file name from which to load</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.PredefinedLineSymbolControl.OnMouseUp(System.Windows.Forms.MouseEventArgs)">
- <summary>
- Handles the situation where a mouse up should show a magnified version of the character.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.PredefinedLineSymbolControl.OnSymbolSelected">
- <summary>
- Fires the SymbolSelected event args, and closes a drop down editor if it exists.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.PredefinedLineSymbolControl.OnInitialize(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Takes place when the control is initialized or invalidated
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.PredefinedLineSymbolControl.OnResize(System.EventArgs)">
- <summary>
- Occurs whenever this control is resized, and forces invalidation of the entire control because
- we are completely changing how the paging works.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.PredefinedLineSymbolControl.DrawSymbolizer(System.Drawing.Graphics,System.Drawing.Rectangle,DotSpatial.Symbology.ICustomSymbolizer)">
- <summary>
- Draws a symbolizer inside the specified rectangle including margins
- </summary>
- <param name="g">The graphics device to draw to</param>
- <param name="rect">The Rectangle describing where to draw</param>
- <param name="sym">The IFeatureSymbolizer to draw</param>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.PredefinedLineSymbolControl.SymbolSelected">
- <summary>
- Occurs when a symbol is selected
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.PredefinedLineSymbolControl.CellSize">
- <summary>
- Gets or sets the cell size in pixels.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.PredefinedLineSymbolControl.CellMargin">
- <summary>
- Gets or sets the margin of each symbolizer preview cell in pixels
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.PredefinedLineSymbolControl.DocumentRectangle">
- <summary>
- Overrides underlying behavior to hide it in the properties list for this control from serialization
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.PredefinedLineSymbolControl.SymbolizerList">
- <summary>
- Gets the list of custom symbolizers displayed in this control
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.PredefinedLineSymbolControl.DefaultCategoryFilter">
- <summary>
- When the 'Category Filter' is set to this value then
- all available custom symbols are displayed
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.PredefinedLineSymbolControl.ShowSymbolNames">
- <summary>
- Indicates whether the custom symbolizer names should be shown
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.PredefinedLineSymbolControl.TextFont">
- <summary>
- Gets or sets the font to use for the text that describes the predifined symbol control
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.PredefinedLineSymbolControl.DynamicColumns">
- <summary>
- Gets or sets a boolean that, if true, indicates that this form should restructure the columns
- as it is resized so that all the columns are visible.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.PredefinedLineSymbolControl.IsSelected">
- <summary>
- Gets or sets whether or not a feature symbolizer is selected
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.PredefinedLineSymbolControl.SelectedIndex">
- <summary>
- Gets or sets the index of the selected symbolizer item
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.PredefinedLineSymbolControl.NumColumns">
- <summary>
- Gets or sets the number of columns
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.PredefinedLineSymbolControl.NumRows">
- <summary>
- Gets the number of rows, which is controlled by having to show 256 cells
- in the given number of columns.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.PredefinedLineSymbolControl.SelectionBackColor">
- <summary>
- Gets or sets the background color for the selection
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.PredefinedLineSymbolControl.SelectionForeColor">
- <summary>
- The Font Color for the selection
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.PredefinedLineSymbolControl.SelectedSymbolizer">
- <summary>
- Gets or sets the selected symbolizer
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.PredefinedLineSymbolControl.CategoryFilter">
- <summary>
- The category of symbol displayed in the control
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.SymbolPreview">
- <summary>
- This component displays the preview of a feature symbolizer
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbolPreview.#ctor">
- <summary>
- Creates a new instance of SymbolPreview control
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbolPreview.UpdatePreview(DotSpatial.Symbology.IFeatureSymbolizer)">
- <summary>
- Updates the preview display using the specified symbolizer
- </summary>
- <param name="symbolizer">The symbolizer displayed in the preview</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbolPreview.OnPaintBackground(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Cancels the on paint background event to prevent flicker
- </summary>
- <param name="pevent"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbolPreview.OnPaint(System.Windows.Forms.PaintEventArgs)">
- <summary>
-
- </summary>
- <param name="e"></param>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbolPreview.Symbolizer">
- <summary>
- The feature symbolizer displayed in the preview
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.ProgressCancelDialog">
- <summary>
- ProgressCancelDialog
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Forms.ProgressCancelDialog.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ProgressCancelDialog.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ProgressCancelDialog.#ctor">
- <summary>
- Creates a new instance of ProgressCancelDialog
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ProgressCancelDialog.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ProgressCancelDialog.Progress(System.String,System.Int32,System.String)">
- <inheritdoc />
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ProgressCancelDialog.Cancel">
- <inheritdoc />
- </member>
- <member name="E:DotSpatial.Symbology.Forms.ProgressCancelDialog.Cancelled">
- <summary>
- Fires the canceled event.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.PropertyDialog">
- <summary>
- A Dialog that can be useful for showing properties
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.PropertyDialog.#ctor">
- <summary>
- This creates a new instance of the Dialog
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.PropertyDialog.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.PropertyDialog.OnChangesApplied">
- <summary>
- Fires the ChangesApplied event. If an original object IDescriptor has been set,
- then this directly handles the update.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.PropertyDialog.OriginalObject">
- <summary>
- An original object place holder to allow outside handlers, but still track
- the object and its copy in a tightly correlated way.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.PropertyDialog.PropertyGrid">
- <summary>
- This provides access to the property grid on this dialog
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.PropertyDialog.ChangesApplied">
- <summary>
- This event occurs when someone presses the apply button
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.PropertyDialogProvider">
- <summary>
- PropertyDialogProvider
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.PropertyDialogProvider.ShowDialog(System.Object)">
- <summary>
- Shows a PropertyGrid Dialog and uses the specified object as the edit copy.
- </summary>
- <param name="editCopy"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.PropertyDialogProvider.OnChangesApplied(System.Object)">
- <summary>
- Fires a the ChangesApplied event
- </summary>
- <param name="changedItem"></param>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.PropertyDialogProvider.ChangesApplied">
- <summary>
- Fires an event signifying that the item has been updated
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.PropertyDialogProvider.ChangeItem">
- <summary>
- Gets the item that was changed by this operation.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.PropertyGridEditor">
- <summary>
- PropertyGridEditor
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.PropertyGridEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)">
- <summary>
- This should launch an open file dialog instead of the usual thing.
- </summary>
- <param name="context">ITypeDescriptorContext</param>
- <param name="provider">IServiceProvider</param>
- <param name="value">The object being displayed</param>
- <returns>A new version of the object if the dialog was ok.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.PropertyGridEditor.GetEditStyle(System.ComponentModel.ITypeDescriptorContext)">
- <summary>
- Either allows the editor to work or else nips it in the butt
- </summary>
- <param name="context">ITypeDescriptorContext</param>
- <returns>UITypeEditorEditStyle</returns>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.RampSlider">
- <summary>
- RampSlider
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.RampSlider.#ctor">
- <summary>
- Creates a new instance of RampSlider
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.RampSlider.OnDraw(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Does the actual drawing in client coordinates
- </summary>
- <param name="g"></param>
- <param name="clipRectangle"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.RampSlider.OnDrawTicks(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Draws the tick marks on this slider
- </summary>
- <param name="g"></param>
- <param name="clipRectangle"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.RampSlider.OnDrawRampText(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Draws the text that appears inside the ramp.
- </summary>
- <param name="g"></param>
- <param name="clipRectangle"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.RampSlider.OnDrawRamp(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Draws the ramp itself.
- </summary>
- <param name="g"></param>
- <param name="clipRectangle"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.RampSlider.OnDrawSlider(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Draws the slider itself in client coordinates
- </summary>
- <param name="g"></param>
- <param name="clipRectangle"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.RampSlider.OnDrawText(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Draws the text for Minimum and Maximum
- </summary>
- <param name="g"></param>
- <param name="clipRectangle"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.RampSlider.OnMouseDown(System.Windows.Forms.MouseEventArgs)">
- <summary>
- Fires the MouseDown event
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.RampSlider.OnMouseUp(System.Windows.Forms.MouseEventArgs)">
- <summary>
- Handles the Mouse up scenario to stop dragging
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.RampSlider.OnValueChanged">
- <summary>
- Fires the Value Changed event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.RampSlider.OnMouseMove(System.Windows.Forms.MouseEventArgs)">
- <summary>
- Handles the dragging code
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.RampSlider.OnPaintBackground(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Prevent flicker
- </summary>
- <param name="pevent"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.RampSlider.OnPaint(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Draw the clipped portion
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.RampSlider.OnResize(System.EventArgs)">
- <summary>
- Occurs on the resize event
- </summary>
- <param name="e"></param>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.RampSlider.ValueChanged">
- <summary>
- Occurs when the slider has been controlled to alter the value.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.RampSlider.ColorButton">
- <summary>
- Gets or sets a color button. In this case, the ramp slider will display the opacity range for
- the color specified by the color button. The color button may become transparent, but the
- opacity range will always show transparent to opaque, matching the RGB signature of the color
- from the color button.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.RampSlider.FlipRamp">
- <summary>
- Gets or sets a boolean indicating whether the minimum and maximum should exchange places
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.RampSlider.InvertRamp">
- <summary>
- Gets or sets a boolean that represents whether to mirror the shape of the ramp.
- If the ramp is horizontal, this will change whether the top or the bottom of the
- ramp changes.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.RampSlider.FlipText">
- <summary>
- Gets or sets a value indicating whether to draw any labeled values on the opposite side of the ramp.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.RampSlider.Maximum">
- <summary>
- Gets or sets the maximum value of this slider.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.RampSlider.MaximumColor">
- <summary>
- Gets or sets the color at the maximum of the ramp
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.RampSlider.Minimum">
- <summary>
- Gets or sets the minimum allowed value, and therefore the minimum position of the slider.
- If this is set above value or maximum, those values will be set equal to this value.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.RampSlider.MinimumColor">
- <summary>
- Gets or sets the color of the minimum of the ramp.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.RampSlider.NumberFormat">
- <summary>
- Gets or sets the Number format to use for the min, max and value.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.RampSlider.Orientation">
- <summary>
- Gets or sets whether the ramp and text should be organized horizontally or vertically.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.RampSlider.RampRadius">
- <summary>
- Gets or sets the numeric radius that controls the rounding on the ramp.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.RampSlider.RampText">
- <summary>
- Gets or sets the text that appears behind the ramp, if any.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.RampSlider.RampTextBehindRamp">
- <summary>
- Gets or sets a boolean that, if ture, will cause the text to be drawn behind the ramp instead of in front of the ramp.
- This can be useful if attempting to illustrate opacity by using some text.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.RampSlider.RampTextFont">
- <summary>
- Controls the actual text of the ramp
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.RampSlider.RampTextColor">
- <summary>
- Gets or sets the color of the text that appears in the ramp
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.RampSlider.RampTextAlignment">
- <summary>
- Gets or sets the positioning of ramp text in relative to the ramp itself.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.RampSlider.ShowMaximum">
- <summary>
- Gets or sets a boolean, that if true will label the maximum value.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.RampSlider.ShowMinimum">
- <summary>
- Gets or sets a boolean, that if true will label the minimum value.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.RampSlider.ShowValue">
- <summary>
- Gets or sets a boolean, that if true will label the chosen value.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.RampSlider.ShowTicks">
- <summary>
- Gets or sets a boolean indicating whether to draw tickmarks along the straight axis of the ramp.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.RampSlider.SliderColor">
- <summary>
- Gets or sets the basic color of the slider.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.RampSlider.SliderRadius">
- <summary>
- Gets or sets the numeric radius that controls the rounding on the ramp.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.RampSlider.TickColor">
- <summary>
- Gets or sets the color that will be used to draw the ticks.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.RampSlider.TickSpacing">
- <summary>
- Gets or sets the spacing to use for the ticks. These will be drawn between
- the minimum and maximum values.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.RampSlider.Value">
- <summary>
- Gets or sets a value ranging from Min to Max.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.RasterColorSchemeEditor">
- <summary>
- RasterColorSchemeEditor
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.RasterColorSchemeEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)">
- <summary>
- This should launch a frmRasterSymbolizer
- </summary>
- <param name="context">ITypeDescriptorContext context</param>
- <param name="provider">IServiceProvider provider</param>
- <param name="value">object value</param>
- <returns>A new RasterSymbolizer</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.RasterColorSchemeEditor.GetEditStyle(System.ComponentModel.ITypeDescriptorContext)">
- <summary>
- This controls the editor style and sets up a backup copy of the symbolizer
- </summary>
- <param name="context">ITypeDescriptorContext</param>
- <returns>UITypeEditorEditStyle</returns>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.LayerDialog">
- <summary>
- This is a basic form which is displayed when the user double-clicks on a layer name
- in the legend
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LayerDialog.#ctor">
- <summary>
- Creates a new instance of LayerDialog
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LayerDialog.#ctor(DotSpatial.Symbology.ILayer,DotSpatial.Symbology.Forms.ICategoryControl)">
- <summary>
- Creates a new instance of LayerDialog form to display the symbology and
- other properties of the specified feature layer
- </summary>
- <param name="selectedLayer">the specified feature layer that is
- modified using this form</param>
- <param name="control">The control.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LayerDialog.ApplyChanges">
- <summary>
- Forces changes to be written from the copy symbology to
- the original, updating the map display.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LayerDialog.OnApplyChanges">
- <summary>
- Occurs during apply changes operations and is overrideable in subclasses
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.LayerDialog.ChangesApplied">
- <summary>
- Occurs when the apply changes situation forces the symbology to become updated.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.StrokesEditor">
- <summary>
- LineSymbolizerEditor
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.StrokesEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)">
- <summary>
- Launches a form for editing the line symbolizer
- </summary>
- <param name="context"></param>
- <param name="provider"></param>
- <param name="value"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.StrokesEditor.GetEditStyle(System.ComponentModel.ITypeDescriptorContext)">
- <summary>
- Specifies that a form will be used for editing (a Modal form behaves like a dialog)
- </summary>
- <param name="context"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.SymbologyProgressBar">
- <summary>
- mwProgressBar
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbologyProgressBar.#ctor">
- <summary>
- Initializes a new instance of the Symbology Progress Bar.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbologyProgressBar.Progress(System.String,System.Int32,System.String)">
- <summary>
- This method is thread safe so that people calling this method don't cause a cross-thread violation
- by updating the progress indicator from a different thread
- </summary>
- <param name="key">A string message with just a description of what is happening, but no percent completion information</param>
- <param name="percent">The integer percent from 0 to 100</param>
- <param name="message">A message</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbologyProgressBar.OnPaintBackground(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Prevent flicker
- </summary>
- <param name="pevent"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbologyProgressBar.OnPaint(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Controls the drawing of this bar.
- </summary>
- <param name="e">The PaintEventArgs for this paint action</param>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyProgressBar.Message">
- <summary>
- Gets or sets the progress message.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyProgressBar.ShowMessage">
- <summary>
- Gets or sets a boolean indicating whether or not to draw the status message on the progress bar.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyProgressBar.FontColor">
- <summary>
- Gets or sets the font color.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.SQLExpressionDialog">
- <summary>
- SQLExpressionDialog
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SQLExpressionDialog.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SQLExpressionDialog.#ctor">
- <summary>
- Creates a new instance of CollectionPropertyGrid
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SQLExpressionDialog.OnApplyChanges">
- <summary>
- Fires the ChangesApplied event
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.SQLExpressionDialog.ChangesApplied">
- <summary>
- Occurs whenever the apply changes button is clicked, or else when the ok button is clicked.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SQLExpressionDialog.Expression">
- <summary>
- Gets or sets the string expression. Setting this will set the initial
- text content in the dialog.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SQLExpressionDialog.Table">
- <summary>
- Gets or sets the DataTable that the expression dialog uses.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SQLExpressionDialog.AttributeSource">
- <summary>
- Gets or sets the Attribute source instead of the table
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.SymbologyStatusStrip">
- <summary>
- A pre-configured status strip with a thread safe Progress function
- </summary>
- <summary>
- The designer for the symbology status strip.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbologyStatusStrip.#ctor">
- <summary>
- Creates a new instance of the StatusStrip which has a built in, thread safe Progress handler
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbologyStatusStrip.Progress(System.String,System.Int32,System.String)">
- <summary>
- This method is thread safe so that people calling this method don't cause a cross-thread violation
- by updating the progress indicator from a different thread
- </summary>
- <param name="key">A string message with just a description of what is happening, but no percent completion information</param>
- <param name="percent">The integer percent from 0 to 100</param>
- <param name="message">A message</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbologyStatusStrip.OnItemAdded(System.Windows.Forms.ToolStripItemEventArgs)">
- <summary>
- Raises the <see cref="E:System.Windows.Forms.ToolStrip.ItemAdded"/> event.
- </summary>
- <param name="e">A <see cref="T:System.Windows.Forms.ToolStripItemEventArgs"/> that contains the event data.</param>
- </member>
- <member name="F:DotSpatial.Symbology.Forms.SymbologyStatusStrip.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbologyStatusStrip.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbologyStatusStrip.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyStatusStrip.ProgressBar">
- <summary>
- Gets or sets the progress bar. By default, the first ToolStripProgressBar that is added to the tool strip.
- </summary>
- <value>
- The progress bar.
- </value>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyStatusStrip.ProgressLabel">
- <summary>
- Gets or sets the progress label. By default, the first ToolStripStatusLabel that is added to the tool strip.
- </summary>
- <value>
- The progress label.
- </value>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.BreakSlider">
- <summary>
- BreakSlider
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.BreakSlider.#ctor(System.Drawing.Rectangle,System.Double,System.Double,DotSpatial.Symbology.Forms.ColorRange)">
- <summary>
- Creates a new instance of BreakSlider
- </summary>
- <param name="graphBounds">The bounds of the graph to draw in relative to the control.</param>
- <param name="minimum">The minimum value currently in view</param>
- <param name="maximum">The maximum value currently in view</param>
- <param name="range">The color range to connect to this slider.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.BreakSlider.CompareTo(DotSpatial.Symbology.Forms.BreakSlider)">
- <summary>
- Compares this value to the other value.
- </summary>
- <param name="other"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.BreakSlider.Setup(System.Drawing.Rectangle,System.Double,System.Double)">
- <summary>
- This sets the values for the parental bounds, as well as the double
- values for the maximum and minimum values visible on the graph.
- </summary>
- <param name="graphBounds"></param>
- <param name="min"></param>
- <param name="max"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.BreakSlider.Draw(System.Drawing.Graphics)">
- <summary>
- Causes this slider to draw itself to the specified graphics surface.
- </summary>
- <param name="g"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.BreakSlider.OnDraw(System.Drawing.Graphics)">
- <summary>
- Custom drawing
- </summary>
- <param name="g">The Graphics surface to draw to</param>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BreakSlider.Range">
- <summary>
- Gets or sets the color range that this break is the maximum value for.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BreakSlider.HandleBounds">
- <summary>
- Gets the bounds of the handle that extends above the graph
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BreakSlider.Bounds">
- <summary>
- Gets a bounding rectangle in coordinates relative to the parent
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BreakSlider.Category">
- <summary>
- Gets or sets the category that has a maximum value equal to this break.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BreakSlider.Color">
- <summary>
- Gets or sets the color of this slider
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BreakSlider.Count">
- <summary>
- Gets or sets the integer count representing the number of members in the class.
- (Technically represented left of the line.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BreakSlider.NextCategory">
- <summary>
- Gets or sets the next category, which should have a minimum corresponding to this break.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BreakSlider.Position">
- <summary>
- Gets or sets the position of this slider
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BreakSlider.Selected">
- <summary>
- Gets or sets whether or not this slider is selected.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BreakSlider.SelectColor">
- <summary>
- Gets or sets the selected color
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BreakSlider.Value">
- <summary>
- Gets or sets the double value where this break should occur.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.BreakSliderEventArgs">
- <summary>
- BreakSliderEventArgs
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.BreakSliderEventArgs.#ctor(DotSpatial.Symbology.Forms.BreakSlider)">
- <summary>
- Creates a new instance of BreakSliderEventArgs
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BreakSliderEventArgs.Slider">
- <summary>
- Gets or sets the protected break slider
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.BreakSliderGraph">
- <summary>
- BreakSliderGraph
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.BreakSliderGraph.ResetExtents">
- <summary>
- Given a scheme, this resets the graph extents to the statistical bounds.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.BreakSliderGraph.UpdateRasterBreaks">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.BreakSliderGraph.UpdateBreaks">
- <summary>
- Given a scheme, this will build the break list to match approximately. This does not
- force the interval method to build a new scheme.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.BreakSliderGraph.OnStatisticsUpdated">
- <summary>
- Fires the statistics updated event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.BreakSliderGraph.OnSliderSelected(DotSpatial.Symbology.Forms.BreakSlider)">
- <summary>
- Fires the SliderSelected event
- </summary>
- <param name="slider"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.BreakSliderGraph.Dispose(System.Boolean)">
- <summary>
- Handles disposing to release unmanaged memory
- </summary>
- <param name="disposing"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.BreakSliderGraph.#ctor">
- <summary>
- Creates a new instance of BreakSliderGraph
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.BreakSliderGraph.ZoomToCategoryRange">
- <summary>
- Zooms so that the minimum is the minimum of the lowest category or else the
- minimum of the extents, and the maximum is the maximum of the largest category
- or else the maximum of the statistics.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.BreakSliderGraph.ResetBreaks(DotSpatial.Data.ICancelProgressHandler)">
- <summary>
- resets the breaks using the current settings, and generates a new set of
- categories using the given interval method.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.BreakSliderGraph.SelectBreak(DotSpatial.Symbology.Forms.BreakSlider)">
- <summary>
- Selects one of the specific breaks.
- </summary>
- <param name="slider"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.BreakSliderGraph.OnResize(System.EventArgs)">
- <summary>
- occurs during a resize
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.BreakSliderGraph.DoMouseWheel(System.Int32,System.Single)">
- <summary>
- When the mouse wheel event occurs, this forwards the event to this contro.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.BreakSliderGraph.OnMouseDown(System.Windows.Forms.MouseEventArgs)">
- <summary>
- Occurs when the mose down occurs
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.BreakSliderGraph.OnSliderMoving">
- <summary>
- Occurs when the slider moves
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.BreakSliderGraph.OnMouseMove(System.Windows.Forms.MouseEventArgs)">
- <summary>
- Handles the mouse move event
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.BreakSliderGraph.OnMouseUp(System.Windows.Forms.MouseEventArgs)">
- <summary>
- Handles the mouse up event
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.BreakSliderGraph.UpdateCategory(DotSpatial.Symbology.Forms.BreakSlider)">
- <summary>
- Given a break slider's new position, this will update the category related to that
- break.
- </summary>
- <param name="slider"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.BreakSliderGraph.GetBreakAt(System.Drawing.Point)">
- <summary>
- Returns the BreakSlider that corresponds to the specified mouse position, where
- the actual handle and divider represent the maximum of that range.
- </summary>
- <param name="location">The location, which can be anywhere to the left of the slider but to the
- right of any other sliders.</param>
- <returns>The BreakSlider that covers the range that contains the location, or null.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.BreakSliderGraph.OnSliderMoved">
- <summary>
- Fires the slider moved event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.BreakSliderGraph.OnDraw(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Occurs during drawing
- </summary>
- <param name="g"></param>
- <param name="clip"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.BreakSliderGraph.OnPaintBackground(System.Windows.Forms.PaintEventArgs)">
- <summary>
- prevents flicker by preventing the white background being drawn here
- </summary>
- <param name="pevent"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.BreakSliderGraph.OnPaint(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Custom drawing
- </summary>
- <param name="e"></param>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.BreakSliderGraph.SliderMoving">
- <summary>
- Occurs when manual break sliding begins so that the mode can be
- switched to manual, rather than showing equal breaks or something.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.BreakSliderGraph.SliderSelected">
- <summary>
- Occurs when a click in a range changes the slider that is selected.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.BreakSliderGraph.SliderMoved">
- <summary>
- Occurs after the slider has been completely repositioned.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.BreakSliderGraph.StatisticsUpdated">
- <summary>
- Occurs after the statistics have been re-calculated.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BreakSliderGraph.AttributeSource">
- <summary>
- Gets or sets the attribute source.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BreakSliderGraph.BorderStyle">
- <summary>
- Gets or sets the border style for this control
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BreakSliderGraph.Breaks">
- <summary>
- Gets the list of breaks that are currently part of this graph.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BreakSliderGraph.BreakColor">
- <summary>
- Gets or sets the color to use for the moveable breaks.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BreakSliderGraph.BreakSelectedColor">
- <summary>
- Gets or sets the color to use when a break is selected
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BreakSliderGraph.FontColor">
- <summary>
- Gets or sets the font color
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BreakSliderGraph.NumColumns">
- <summary>
- Gets or sets the number of columns. Setting this will recalculate the bins.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BreakSliderGraph.IntervalMethod">
- <summary>
- The method to use when breaks are calculated or reset
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BreakSliderGraph.ShowMean">
- <summary>
- Boolean, if this is true, the mean will be shown as a blue dotted line.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BreakSliderGraph.ShowStandardDeviation">
- <summary>
- Boolean, if this is true, the integral standard deviations from the mean will be drawn
- as red dotted lines.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BreakSliderGraph.Table">
- <summary>
- Gets or sets the data Table for which the statistics should be applied
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BreakSliderGraph.Title">
- <summary>
- Gets or sets the title of the graph.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BreakSliderGraph.TitleColor">
- <summary>
- Gets or sets the color to use for the graph title
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BreakSliderGraph.TitleFont">
- <summary>
- Gets or sets the font to use for the graph title
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BreakSliderGraph.Fieldname">
- <summary>
- Gets or sets the string field name
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BreakSliderGraph.NormalizationField">
- <summary>
- Gets or sets the string normalization field
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BreakSliderGraph.MinHeight">
- <summary>
- Very small counts frequently dissappear next to big counts. One strategey is to use a
- minimum height, so that the difference between 0 and 1 is magnified on the columns.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BreakSliderGraph.MaximumSampleSize">
- <summary>
- Gets or sets the maximum sample size to use when calculating statistics.
- The default is 10000.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BreakSliderGraph.Statistics">
- <summary>
- Gets the statistics that have been currently calculated for this graph.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BreakSliderGraph.Scheme">
- <summary>
- Gets or sets the scheme that is currently being used to symbolize the values.
- Setting this automatically updates the graph extents to the statistical bounds
- of the scheme.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BreakSliderGraph.RasterLayer">
- <summary>
- Gets or sets the raster layer. This will also force this control to use
- the raster for calculations, rather than the dataset.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.BreakSliderGraph.LogY">
- <summary>
- Gets or sets a boolean that indicates whether or not count values should be drawn with
- heights that are proportional to the logarithm of the count, instead of the count itself.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.StatisticalEventArgs">
- <summary>
- StatisticalEventArgs
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.StatisticalEventArgs.#ctor(DotSpatial.Symbology.Statistics)">
- <summary>
- Creates a new instance of StatisticalEventArgs
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.StatisticalEventArgs.Statistics">
- <summary>
- Gets the set of statistics related to this event.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.SymbologyEventManager">
- <summary>
- This class is the System.Windows.Forms interpretor of symbology events being fired.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbologyEventManager.#ctor">
- <summary>
- The symbology event manager.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyEventManager.Owner">
- <summary>
- Allows setting the owner for any dialogs that need to be launched.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyEventManager.ColorCategoryActions">
- <summary>
- Gets or sets the custom actions for ColorCategory
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyEventManager.FeatureLayerActions">
- <summary>
- Gets or sets the custom actions for FeatureLayer
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyEventManager.RasterLayerActions">
- <summary>
- Gets or sets the custom actions for RasterLayer
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyEventManager.ImageLayerActions">
- <summary>
- Gets or sets the actions for ImageLayers
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbologyEventManager.LayerActions">
- <summary>
- Gets or sets the custom actions for Layer
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.DetailedLineSymbolDialog">
- <summary>
- DetailedLineSymbolDialog
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Forms.DetailedLineSymbolDialog.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DetailedLineSymbolDialog.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DetailedLineSymbolDialog.#ctor">
- <summary>
- Creates a new instance of CollectionPropertyGrid
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DetailedLineSymbolDialog.#ctor(DotSpatial.Symbology.ILineSymbolizer)">
- <summary>
- Creates a new line symbol dialog where only the original is specified and the
- duplicate is created.
- </summary>
- <param name="original"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DetailedLineSymbolDialog.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DetailedLineSymbolDialog.OnApplyChanges">
- <summary>
- Fires the ChangesApplied event
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.DetailedLineSymbolDialog.ChangesApplied">
- <summary>
- Occurs whenever the apply changes button is clicked, or else when the ok button is clicked.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DetailedLineSymbolDialog.Symbolizer">
- <summary>
- Gets or sets the symbolizer being used by this control.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.DetailedPointSymbolControl">
- <summary>
- DetailedPointSymbolDialog
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DetailedPointSymbolControl.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DetailedPointSymbolControl.#ctor">
- <summary>
- Creates a new instance of CollectionPropertyGrid
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DetailedPointSymbolControl.#ctor(DotSpatial.Symbology.IPointSymbolizer)">
- <summary>
- Creates a new DetailedPointSymbolDialog that will update the specified original symbol
- by copying the new aspects to it only if the Apply Changes, or Ok buttons are used.
- </summary>
- <param name="original">The original IPointSymbolizer to modify.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DetailedPointSymbolControl.Initialize(DotSpatial.Symbology.IPointSymbolizer)">
- <summary>
- Resets the existing control with the new symbolizer
- </summary>
- <param name="original"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DetailedPointSymbolControl.ApplyChanges">
- <summary>
- Applies the specified changes
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DetailedPointSymbolControl.OnApplyChanges">
- <summary>
- Fires the ChangesApplied event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DetailedPointSymbolControl.OnAddToCustomSymbols">
- <summary>
- Fires the AddtoCustomSymbols event
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.DetailedPointSymbolControl.ChangesApplied">
- <summary>
- Occurs whenever the apply changes button is clicked, or else when the ok button is clicked.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.DetailedPointSymbolControl.AddToCustomSymbols">
- <summary>
- Occurs when the add to custom symbols button is pressed.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DetailedPointSymbolControl.Symbolizer">
- <summary>
- Gets the current (copied) symbolizer or initializes this control to work with the
- specified symbolizer as the original.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.DetailedPointSymbolDialog">
- <summary>
- DetailedPointSymbolDialog
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Forms.DetailedPointSymbolDialog.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DetailedPointSymbolDialog.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DetailedPointSymbolDialog.#ctor">
- <summary>
- Creates a new instance of CollectionPropertyGrid
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DetailedPointSymbolDialog.#ctor(DotSpatial.Symbology.IPointSymbolizer)">
- <summary>
-
- </summary>
- <param name="original"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DetailedPointSymbolDialog.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DetailedPointSymbolDialog.OnApplyChanges">
- <summary>
- Fires the ChangesApplied event
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.DetailedPointSymbolDialog.ChangesApplied">
- <summary>
- Occurs whenever the apply changes button is clicked, or else when the ok button is clicked.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DetailedPointSymbolDialog.Symbolizer">
- <summary>
- Gets or sets the symbolizer being used by this control.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.DetailedPolygonSymbolControl">
- <summary>
- DetailedPolygonSymbolDialog
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DetailedPolygonSymbolControl.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DetailedPolygonSymbolControl.#ctor">
- <summary>
- Creates a new instance of CollectionPropertyGrid
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DetailedPolygonSymbolControl.#ctor(DotSpatial.Symbology.IPolygonSymbolizer)">
- <summary>
- Creates a new dialog where the properties displayed on the form are a duplicate of the original properties,
- and those properties will be copied back to the original on an apply changes or an ok click.
- </summary>
- <param name="original"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DetailedPolygonSymbolControl.Initialize(DotSpatial.Symbology.IPolygonSymbolizer)">
- <summary>
- Assigns the original symbolizer to this control
- </summary>
- <param name="original">The polygon symbolizer to modify.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DetailedPolygonSymbolControl.ApplyChanges">
- <summary>
- Forces the current settings to be written back to the original symbolizer
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DetailedPolygonSymbolControl.OnApplyChanges">
- <summary>
- Fires the ChangesApplied event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DetailedPolygonSymbolControl.OnAddToCustomSymbols">
- <summary>
- Fires the AddToCustomSymbols event
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.DetailedPolygonSymbolControl.ChangesApplied">
- <summary>
- Occurs whenever the apply changes button is clicked, or else when the ok button is clicked.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.DetailedPolygonSymbolControl.AddToCustomSymbols">
- <summary>
- Occurs when the the Add To Custom Symbols button is clicked
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DetailedPolygonSymbolControl.Symbolizer">
- <summary>
- Gets the current (copied) symbolizer or initializes this control to work with the
- specified symbolizer as the original.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.DetailedPolygonSymbolDialog">
- <summary>
- DetailedPolygonSymbolDialog
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DetailedPolygonSymbolDialog.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DetailedPolygonSymbolDialog.#ctor">
- <summary>
- Creates a new instance of CollectionPropertyGrid
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DetailedPolygonSymbolDialog.#ctor(DotSpatial.Symbology.IPolygonSymbolizer)">
- <summary>
- Creates a new DetailedPolygonSymbolControl using the specified
- </summary>
- <param name="original"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.DetailedPolygonSymbolDialog.OnApplyChanges">
- <summary>
- Fires the ChangesApplied event
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.DetailedPolygonSymbolDialog.ChangesApplied">
- <summary>
- Occurs whenever the apply changes button is clicked, or else when the ok button is clicked.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.DetailedPolygonSymbolDialog.Symbolizer">
- <summary>
- Gets or sets the symbolizer being used by this control.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.LineSymbolDialog">
- <summary>
- Initial dialog for selecting a predefined line symbol
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Forms.LineSymbolDialog.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LineSymbolDialog.#ctor">
- <summary>
- Creates a new instance of DetailedLineSymbolDialog
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LineSymbolDialog.#ctor(DotSpatial.Symbology.ILineSymbolizer)">
- <summary>
- Creates a new Detailed Line Symbol Dialog
- </summary>
- <param name="symbolizer"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LineSymbolDialog.ShowDetailsDialog">
- <summary>
- Shows the 'Symbol Details' dialog
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LineSymbolDialog.OnApplyChanges">
- <summary>
- Fires the ChangesApplied event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.LineSymbolDialog.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.LineSymbolDialog.ChangesApplied">
- <summary>
- Fires an event indicating that changes should be applied.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.StatisticalBreaksDialog">
- <summary>
- StatisticalBreaksDialog
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.StatisticalBreaksDialog.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.StatisticalBreaksDialog.#ctor">
- <summary>
- Creates a new instance of CollectionPropertyGrid
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.StatisticalBreaksDialog.FieldName">
- <summary>
- Gets or sets the string field name to apply statistics to
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.StatisticalBreaksDialog.NormalizationField">
- <summary>
- Gets or sets the normalization field to apply statistics to.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.StatisticalBreaksDialog.Table">
- <summary>
- Gets or sets the Table that has the data row values to use for statistics.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.StatisticalBreaksDialog.Scheme">
- <summary>
- Gets or sets the feature scheme to use for coloring and existing break positions
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.StatisticalBreaksDialog.Title">
- <summary>
- Gets or sets the title for the graph
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.Size2DDialog">
- <summary>
- Size2DDialog
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.Size2DDialog.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.Size2DDialog.#ctor">
- <summary>
- Creates a new instance of CollectionPropertyGrid
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.Size2DDialog.#ctor(DotSpatial.Symbology.ISymbol)">
- <summary>
- Creates a Size2DDialog with a specific symbol to edit when "Apply Changes" is clicked
- </summary>
- <param name="symbol"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.Size2DDialog.OnApplyChanges">
- <summary>
- Fires the ChangesApplied event
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.Size2DDialog.ChangesApplied">
- <summary>
- Occurs whenever the apply changes button is clicked, or else when the ok button is clicked.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.Size2DDialog.Symbol">
- <summary>
- Gets or sets the symbol that should be edited whenever apply changes is clicked.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.SizeBox">
- <summary>
- This represents a single box inside of a symbol size chooser.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SizeBox.Draw(System.Drawing.Graphics,System.Drawing.Rectangle,DotSpatial.Symbology.ISymbol)">
- <summary>
- The graphics device and clip rectangle are in the parent coordinates.
- </summary>
- <param name="g"></param>
- <param name="clipRectangle"></param>
- <param name="symbol">The symbol to use for drawing.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SizeBox.OnDrawSymbol(System.Drawing.Graphics,DotSpatial.Symbology.ISymbol)">
- <summary>
- This draws the specified symbol using the "Size" property from this box rather than the real size.
- The transform has been zeroed on the center of this box.
- </summary>
- <param name="g"></param>
- <param name="symbol"></param>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SizeBox.BackColor">
- <summary>
- Gets or sets the base color for the normal background color for this box.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SizeBox.Bounds">
- <summary>
- Gets or sets the rectangular bounds for this size box.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SizeBox.Size">
- <summary>
- Gets or sets the size
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SizeBox.IsSelected">
- <summary>
- Gets or sets whether or not this item should draw itself as though it has been selected.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SizeBox.SelectionColor">
- <summary>
- Gets or sets the selection color for this selection.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SizeBox.RoundingRadius">
- <summary>
- Gets or sets the rouding radius for this box.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.SizeControl">
- <summary>
- A user control that is specifically designed to control the point sizes
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Forms.SizeControl._components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SizeControl.#ctor">
- <summary>
- Creates a new instance of the size control
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SizeControl.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SizeControl.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SizeControl.OnSelectedSizeChanged">
- <summary>
- Fires the SizeChanged event
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.SizeControl.SelectedSizeChanged">
- <summary>
- Occurs when the size changes on this control, ether through applying changes in the dialog or else
- by selecting one of the pre-configured sizes.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SizeControl.Symbol">
- <summary>
- Gets or sets the symbol to use when drawing the various sizes
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.SymbolSizeChooser">
- <summary>
- SymbolSizeChooser
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbolSizeChooser.BeginInit">
- <summary>
- Prevent redundant updates to the boxes every time a property is changed
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbolSizeChooser.EndInit">
- <summary>
- Enable live updating so that from now on, changes rebuild boxes.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbolSizeChooser.#ctor">
- <summary>
- Creates a new instance of SymbolSizeChooser
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbolSizeChooser.#ctor(DotSpatial.Symbology.ISymbol)">
- <summary>
- Gets or sets a new SymbolSize chooser, specifying the symbol as part of the constructor.
- </summary>
- <param name="symbol">The symbol to draw.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbolSizeChooser.RefreshBoxes">
- <summary>
- Forces the box sub-categories to refresh given the new content.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbolSizeChooser.OnSelectedSizeChanged">
- <summary>
- Fires the selected size changed event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbolSizeChooser.OnMouseUp(System.Windows.Forms.MouseEventArgs)">
- <summary>
- Handles the mouse up situation
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbolSizeChooser.OnDraw(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Occurs durring drawing but is overridable by subclasses
- </summary>
- <param name="g"></param>
- <param name="clip"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbolSizeChooser.OnPaintBackground(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Prevent flicker
- </summary>
- <param name="pevent"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.SymbolSizeChooser.OnPaint(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Occurs as the SymbolSizeChooser control is being drawn.
- </summary>
- <param name="e"></param>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.SymbolSizeChooser.SelectedSizeChanged">
- <summary>
- Occurs when the selected size has changed
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbolSizeChooser.BoxBackColor">
- <summary>
- Gets or sets the normal background color for the boxes.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbolSizeChooser.BoxSelectionColor">
- <summary>
- Gets or sets the box selection color
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbolSizeChooser.BoxSize">
- <summary>
- Gets or sets the rectangular extent for all the boxes. This is not the size of the symbol.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbolSizeChooser.MaximumSymbolSize">
- <summary>
- Gets or sets the maximum symbol size.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbolSizeChooser.MinimumSymbolSize">
- <summary>
- Gets or sets the minimum symbol size
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbolSizeChooser.Orientation">
- <summary>
- Gets or sets whether the boxes are drawn horizontally or vertically.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbolSizeChooser.NumBoxes">
- <summary>
- Gets or sets the number of boxes
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbolSizeChooser.Symbol">
- <summary>
- Gets or sets the symbol to use for this control.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbolSizeChooser.RoundingRadius">
- <summary>
- Gets or sets the rounding radius for the boxes
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.SymbolSizeChooser.SelectedSize">
- <summary>
- Gets or sets the currently selected size.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.TabColorDialog">
- <summary>
- TabColorDialog
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Forms.TabColorDialog.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TabColorDialog.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TabColorDialog.#ctor">
- <summary>
- Creates a new instance of CollectionPropertyGrid
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TabColorDialog.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.TabColorDialog.OnApplyChanges">
- <summary>
- Fires the ChangesApplied event
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Forms.TabColorDialog.ChangesApplied">
- <summary>
- Occurs whenever the apply changes button is clicked, or else when the ok button is clicked.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.TabColorDialog.StartColor">
- <summary>
- Gets or sets the start color for this control
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.TabColorDialog.EndColor">
- <summary>
- Gets or sets the end color for this control.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Forms.ZenithEditor">
- <summary>
- OpacityEditor
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ZenithEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)">
- <summary>
- Edits the value by showing a slider control in the drop down.
- </summary>
- <param name="context"></param>
- <param name="provider"></param>
- <param name="value"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Forms.ZenithEditor.GetEditStyle(System.ComponentModel.ITypeDescriptorContext)">
- <summary>
- Sets the behavior to drop-down
- </summary>
- <param name="context"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Symbology.Forms.ZenithEditor.IsDropDownResizable">
- <summary>
- Ensures that we can widen the drop-down without having to close the drop down,
- widen the control, and re-open it again.
- </summary>
- </member>
- </members>
-</doc>
diff --git a/MES_Wind/bin/Debug/DotSpatial.Symbology.pdb b/MES_Wind/bin/Debug/DotSpatial.Symbology.pdb
deleted file mode 100644
index 6d5d186ae7cd53b0cf49125bdb74eec00cf5ffca..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/DotSpatial.Symbology.pdb and /dev/null differ
diff --git a/MES_Wind/bin/Debug/DotSpatial.Symbology.xml b/MES_Wind/bin/Debug/DotSpatial.Symbology.xml
deleted file mode 100644
index ecce5f55e996c8e54554d9163d998724a947ceca..0000000000000000000000000000000000000000
--- a/MES_Wind/bin/Debug/DotSpatial.Symbology.xml
+++ /dev/null
@@ -1,15974 +0,0 @@
-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>DotSpatial.Symbology</name>
- </assembly>
- <members>
- <member name="T:DotSpatial.Symbology.BackBuffer">
- <summary>
- This class contains two separate layers. The first is the BackImage where features that don't change
- over time are drawn. This way if heavy calculations are required to draw the background, you don't
- have to re-draw the background over and over again every time a sprite moves. The Front image is
- for small sprites that change rapidly, but
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.BackBuffer._extents">
- <summary>
- The real world extents for the entire buffer
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.BackBuffer._image">
- <summary>
- The image being shown
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.BackBuffer.#ctor(System.Int32,System.Int32)">
- <summary>
- Creates a new BackBuffer bitmap that is the specified size.
- </summary>
- <param name="width">The width of the bitmap</param>
- <param name="height">The height of the bitmap</param>
- </member>
- <member name="M:DotSpatial.Symbology.BackBuffer.Clear">
- <summary>
- Clears the back buffer.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.BackBuffer.PixelToProj(System.Drawing.PointF)">
- <summary>
-
- </summary>
- <param name="testPoint"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.BackBuffer.PixelToProj(System.Drawing.RectangleF)">
- <summary>
-
- </summary>
- <param name="testExtents"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.BackBuffer.ProjToPixel(DotSpatial.Data.Extent)">
- <summary>
- Calculates a system.Drawing rectangle that corresponds to the specified real world
- envelope if it were drawn in pixels on the background image.
- </summary>
- <param name="testExtents"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.BackBuffer.ProjToPixel(DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="coord"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.BackBuffer.OnExtentsChanged">
- <summary>
- Fires the ExtentsChanged event
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.BackBuffer.ExtentsChanged">
- <summary>
- Occurs after something changes the geographic extents. This refers to the outer
- geographic extents, not the view extents.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.BackBuffer.Extents">
- <summary>
- Gets or sets the geographic extents for the entire back buffer.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.BackBuffer.Graphics">
- <summary>
- Gets the graphics drawing surface for the BackBuffer
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.BackBuffer.Height">
- <summary>
- Gets or sets the height of this backbuffer in pixels
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.BackBuffer.Image">
- <summary>
- Gets or sets the actual Bitmap being used as the back buffer.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.BackBuffer.InvokeRequired">
- <summary>
- Boolean, true if the current thread is different from the original thread, indicating
- that cross-threading is taking place.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.BackBuffer.Width">
- <summary>
- Gets or sets the width of the back buffer in pixels. This will copy
- the old back buffer to a new bitmap with the new width/height
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.BackBuffer.WorldGraphics">
- <summary>
- Obtains a graphics object already organized into world coordinates.
- The client rectangle and world coordinates are used in order to determine
- the scale and translation of the transform necessary in the graphics object.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.BackBuffer.Envelope">
- <summary>
- The envelope bounds in geographic coordinates.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.BitmapFormatException">
- <summary>
- BitmapFormatException
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.ColorCategoryEventArgs">
- <summary>
- An EventArgs specifically tailored to ColorCategory.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ColorCategoryEventArgs.#ctor(DotSpatial.Symbology.IColorCategory)">
- <summary>
- Initializes a new instance of the ColorCategoryEventArgs class.
- </summary>
- <param name="colorCategory">The IColorCategory that is involved in this event.</param>
- </member>
- <member name="P:DotSpatial.Symbology.ColorCategoryEventArgs.ColorCategory">
- <summary>
- Gets the ColorCategory associated with this event.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.DynamicVisibilityEventArgs">
- <summary>
- An EventArgs specifically tailored to DynamicVisibilityMode.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.DynamicVisibilityEventArgs.#ctor(DotSpatial.Symbology.IDynamicVisibility)">
- <summary>
- Initializes a new instance of the DynamicVisibilityModeEventArgs class.
- </summary>
- <param name="item">The item that supports IDynamicVisibility.</param>
- </member>
- <member name="P:DotSpatial.Symbology.DynamicVisibilityEventArgs.Item">
- <summary>
- Gets the item that supports dynamic visibility.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Expression.AddField(System.Data.DataColumn)">
- <summary>
- Adds the given DataColumn as Field.
- </summary>
- <param name="col">DataColumn that should be added.</param>
- <returns>False, if DataColumn was null.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Expression.CalculateRowValue(System.Data.DataRow,System.Int32)">
- <summary>Uses the parsed expression to calculate the expression for the given row. If the expression is invalid only the Fields are replaced (This was the default action for expressions before DS 1.8).
- </summary>
- <param name="row">Row the expression gets calculated for.</param>
- <param name="FID">FID value that is used to replace the FID field.</param>
- <returns>The calculated expression.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Expression.ClearFields">
- <summary>
- Clears the fields.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Expression.IsValidOperation(System.String@,System.Data.DataRow)">
- <summary>
- Checks whether the operations are valid.
- </summary>
- <param name="retVal">Example result if operation is valid.</param>
- <param name="row">Datarow that should be used to show as example result if the operation is valid.</param>
- <returns>True, if operations can be calculated.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Expression.ParseExpression(System.String)">
- <summary>
- Parses the given string to Expression.
- </summary>
- <param name="s"></param>
- <returns>True if string can be parsed to expression.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Expression.UpdateFields(System.Data.DataColumnCollection)">
- <summary>
- Replaces the current fields with the given datacolumns.
- </summary>
- <param name="columns">Columns that should be added as fields.</param>
- <returns>False if columns was null.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Expression.Calculate">
- <summary>
- Calculates the whole expression.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Expression.CalculateOperation(DotSpatial.Symbology.Expression.ExpressionPart,DotSpatial.Symbology.Expression.Operation)">
- <summary>
- Calculates the given operation for the values of the given part.
- </summary>
- <param name="part"></param>
- <param name="operation"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Expression.CalculateBoolOperation(DotSpatial.Symbology.Expression.tkOperation,DotSpatial.Symbology.Expression.Element,DotSpatial.Symbology.Expression.Element,DotSpatial.Symbology.Expression.ExpressionValue,DotSpatial.Symbology.Expression.ExpressionValue)">
- <summary> Calculates the operations that are allowed for two boolean values.
- </summary>
- <param name="oper"></param>
- <param name="elLeft"></param>
- <param name="elRight"></param>
- <param name="valLeft"></param>
- <param name="valRight"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Expression.CalculateDoubleOperation(DotSpatial.Symbology.Expression.tkOperation,DotSpatial.Symbology.Expression.Element,DotSpatial.Symbology.Expression.Element,DotSpatial.Symbology.Expression.ExpressionValue,DotSpatial.Symbology.Expression.ExpressionValue)">
- <summary>Calculates the operations that are allowed for two double values.
- </summary>
- <param name="oper"></param>
- <param name="elLeft"></param>
- <param name="elRight"></param>
- <param name="valLeft"></param>
- <param name="valRight"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Expression.CalculateStringOperation(DotSpatial.Symbology.Expression.tkOperation,DotSpatial.Symbology.Expression.Element,DotSpatial.Symbology.Expression.Element,DotSpatial.Symbology.Expression.ExpressionValue,DotSpatial.Symbology.Expression.ExpressionValue)">
- <summary>Calculates the operations that are allowed for two string values.
- </summary>
- <param name="oper"></param>
- <param name="elLeft"></param>
- <param name="elRight"></param>
- <param name="valLeft"></param>
- <param name="valRight"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Expression.FindOperation(DotSpatial.Symbology.Expression.ExpressionPart,DotSpatial.Symbology.Expression.Operation)">
- <summary>
- Seeks operation with the highest priority and operands.
- </summary>
- <param name="part"></param>
- <param name="operation"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Expression.GetBrackets(System.String,System.Int32@,System.Int32@,System.String,System.String)">
- <summary>
- Checks whether opening- and closingSymbol can be found.
- </summary>
- <param name="expression">Expression that is checked.</param>
- <param name="begin">Returns position of openingSymbol if found.</param>
- <param name="end">Returns position of closingSymbol if found.</param>
- <param name="openingSymbol">OpeningSymbol that is searched for.</param>
- <param name="closingSymbol">ClosingSymbol that is searched for.</param>
- <returns>True if opening- and closingSymbol where found.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Expression.GetValue(DotSpatial.Symbology.Expression.ExpressionPart,System.Int32)">
- <summary>Gets the ExpressionValue of the element of the given part.
- </summary>
- <param name="part">Part that contains the element.</param>
- <param name="elementId">Id of the element whose value is returned.</param>
- <returns>Value of the element.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Expression.IsDecimal(System.Char,System.Boolean@)">
- <summary>
- Checks whether the given character could belong to a number.
- </summary>
- <param name="chr">Character that is checked.</param>
- <param name="exponential">Remembers whether last character was exponential to check whether +- are allowed.</param>
- <returns>False if character can't belong to a number.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Expression.IsEmpty">
- <summary>
- Checks whether the ExpressionString is empty.
- </summary>
- <returns>True, if ExpressionString is empty.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Expression.ParseExpressionPart(System.String)">
- <summary>
- Creates elements of the expression parts and checks.
- </summary>
- <param name="s">ExpressionString whose bracketed parts are parsed.</param>
- <returns>True if partsyntax was correct.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Expression.ReadValue(System.String,System.Int32@,DotSpatial.Symbology.Expression.Element)">
- <summary> Checks whether there is a value or unary operator at the given position.</summary>
- <param name="s"></param>
- <param name="position"></param>
- <param name="element"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Expression.ReadOperation(System.String,System.Int32@,DotSpatial.Symbology.Expression.Element)">
- <summary>Checks whether there is an operation at the given position. </summary>
- <param name="s"></param>
- <param name="position"></param>
- <param name="element"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Expression.ReplaceFieldsOnly(System.Data.DataRow,System.Int32)">
- <summary>Replaces only the Fields in invalid expressions. Before DS 1.8 this was the only thing that got replaced in expressions.
- </summary>
- <param name="row">Datarow that contains the data used to replace the fields.</param>
- <param name="FID">FID that is used to replace the FID field.</param>
- <returns>ExpressionString with replaced Fields.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Expression.ReplaceSubString(System.String@,System.Int32,System.Int32,System.String)">
- <summary>Replace the old substring with the new one.</summary>
- <param name="s">String in which the substring gets replaced.</param>
- <param name="begin">Startposition of old substring.</param>
- <param name="length">Length of old substring.</param>
- <param name="replacement">New substring.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Expression.SaveToString(System.Object)">
- <summary>
- Converts the given value to string. Uses _floatingFormat for double.
- </summary>
- <param name="value">Value that gets converted.</param>
- <returns>value as string</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Expression.SetErrorMessage(System.Int32,System.String,System.Boolean)">
- <summary>
- Sets the ErrorMessage according to the given parameters.
- </summary>
- <param name="position">Position that caused the error.</param>
- <param name="s">String that was searched.</param>
- <param name="oper">Indicates whether operator or operand is missing.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Expression.SkipSpaces(System.String,System.Int32@)">
- <summary>Finds the next position that is not a space.</summary>
- <param name="s">String to check.</param>
- <param name="position">Startposition.</param>
- </member>
- <member name="P:DotSpatial.Symbology.Expression.FloatingFormat">
- <summary>
- FloatingFormat that is used to convert double values to string.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Expression.ErrorMessage">
- <summary>
- ErrorMessage that was raised by last method.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.ExtentExt">
- <summary>
- Extension methods for extent that are related to System.Drawing, and not data.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ExtentExt.Reproportion(DotSpatial.Data.Extent,System.Drawing.Rectangle,System.Drawing.Rectangle)">
- <summary>
- This method assumes that there was a direct correlation between this envelope and the original
- rectangle. This reproportions this window to match the specified newRectangle.
- </summary>
- <param name="self">The original envelope</param>
- <param name="original">The original rectangle </param>
- <param name="newRectangle">The new rectangle</param>
- <returns>A new IEnvelope </returns>
- </member>
- <member name="T:DotSpatial.Symbology.FeatureSetApplyEditArgs">
- <summary>
- Feature Set Apply Edit Args.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureSetApplyEditArgs.#ctor(DotSpatial.Data.IFeatureSet,DotSpatial.Symbology.FeatureSetApplyEditArgs.ChangeHandler)">
- <summary>
- Initializes a new instance of the FeatureSetApplyEditArgs class.
- </summary>
- <param name="editCopy">The IFeatureSet edit copy.</param>
- <param name="handler">The delegate should point to a method handler to work with the edit copy.</param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureSetApplyEditArgs.ApplyChanges">
- <summary>
- Invokes the method that will handle changes using the EditCopy.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureSetApplyEditArgs.EditCopy">
- <summary>
- Gets or sets a duplicate of the IFeatureSet being referenced so that
- changes might be applied.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.FeatureSetApplyEditArgs.ChangeHandler">
- <summary>
- Defines the structure of the method that would handle the actual
- changes for an apply changes request.
- </summary>
- <param name="editCopy">The IFeatureSet edit copy being manipulated.</param>
- </member>
- <member name="T:DotSpatial.Symbology.IColorCategoryActions">
- <summary>
- This interface provides ability to use in ColorCategory any custom actions (including GUI-dependent dialogs)
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IColorCategoryActions.ShowEdit(DotSpatial.Symbology.IColorCategory)">
- <summary>
- Show edit dialog
- </summary>
- <param name="e">Instance of ColorCategory</param>
- </member>
- <member name="T:DotSpatial.Symbology.IDynamicVisibility">
- <summary>
- An shared interface for members that wish to set dynamic visiblity.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IDynamicVisibility.DynamicVisibilityWidth">
- <summary>
- Dynamic visibility represents layers that only appear when you zoom in close enough.
- This value represents the geographic width where that happens.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IDynamicVisibility.DynamicVisibilityMode">
- <summary>
- This controls whether the layer is visible when zoomed in closer than the dynamic
- visiblity width or only when further away from the dynamic visibility width
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IDynamicVisibility.UseDynamicVisibility">
- <summary>
- Gets or sets a boolean indicating whether dynamic visibility should be enabled.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IFeatureLayerActions">
- <summary>
- This interface provides ability to use in FeatureLayer any custom actions (including GUI-dependent dialogs)
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureLayerActions.ShowProperties(DotSpatial.Symbology.IFeatureLayer)">
- <summary>
- Show properties
- </summary>
- <param name="e">Feature layer</param>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureLayerActions.ExcelJoin(DotSpatial.Data.IFeatureSet)">
- <summary>
- Show Join Excel
- </summary>
- <param name="e">Feature set</param>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureLayerActions.LabelExtents(DotSpatial.Symbology.IDynamicVisibility)">
- <summary>
- Show dynamic visibility dialog
- </summary>
- <param name="e">Dynamic visibility</param>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureLayerActions.LabelSetup(DotSpatial.Symbology.ILabelLayer)">
- <summary>
- Show label setup dialog
- </summary>
- <param name="e">Label layer</param>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureLayerActions.ShowAttributes(DotSpatial.Symbology.IFeatureLayer)">
- <summary>
- Show attributes dialog
- </summary>
- <param name="e">Feature layer</param>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureLayerActions.ExportData(DotSpatial.Symbology.IFeatureLayer)">
- <summary>
- Show export dialog
- </summary>
- <param name="e">Feature layer</param>
- </member>
- <member name="T:DotSpatial.Symbology.IImageLayerActions">
- <summary>
- This interface provides ability to use in ImageLayer any custom actions (including GUI-dependent dialogs)
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IImageLayerActions.ShowProperties(DotSpatial.Symbology.IImageLayer)">
- <summary>
- Show properties dialog
- </summary>
- <param name="e">Image layer</param>
- </member>
- <member name="M:DotSpatial.Symbology.IImageLayerActions.ExportData(DotSpatial.Data.IImageData)">
- <summary>
- Show export dialog
- </summary>
- <param name="e">Image data</param>
- </member>
- <member name="T:DotSpatial.Symbology.ILayerActions">
- <summary>
- This interface provides ability to use in Layer any custom actions (including GUI-dependent dialogs)
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ILayerActions.DynamicVisibility(DotSpatial.Symbology.IDynamicVisibility,DotSpatial.Symbology.IFrame)">
- <summary>
- Show Dynamic Visibility dialog
- </summary>
- <param name="e">Dynamic Visibility</param>
- </member>
- <member name="T:DotSpatial.Symbology.ImageLayerEventArgs">
- <summary>
- An EventArgs specifically tailored to ImageLayerEventArgs.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ImageLayerEventArgs.#ctor(DotSpatial.Symbology.IImageLayer)">
- <summary>
- Initializes a new instance of the ImageLayerEventArgs class.
- </summary>
- <param name="imageLayer">The IImageLayer that is involved in this event.</param>
- </member>
- <member name="P:DotSpatial.Symbology.ImageLayerEventArgs.ImageLayer">
- <summary>
- Gets the ImageLayer associated with this event.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.FileCantBeDeletedException">
- <summary>
- CantBeDeletedException
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FileCantBeDeletedException.#ctor(System.String)">
- <summary>
- Creates a new instance of CantBeDeletedException
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.LegendItem">
- <summary>
- LegendItem
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Descriptor">
- <summary>
- Descriptors are simple classes that are used for storing symbology or other basic characteristics.
- They are presumed to be made up of value types and other descriptors, and are expected to be serializable.
- This being said, some basic capabilities are supported for randomizing, copying and comparing the
- properties of descriptors.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.CopyBase.#ctor">
- <summary>
- Creates a new instance of CopyBase
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.CopyBase.System#ICloneable#Clone">
- <summary>
- Creates a duplicate of this descriptor using MemberwiseClone
- </summary>
- <returns>A clone of this object as a duplicate</returns>
- </member>
- <member name="M:DotSpatial.Symbology.CopyBase.DistinctNames(System.Collections.Generic.IEnumerable{System.Reflection.PropertyInfo})">
- <summary>
- PropertyInfo returns overridden members as separate entries. We would rather work with each members
- only one time.
- </summary>
- <param name="allProperties">All the properties, including duplicates created by overridden members</param>
- <returns>An Array of PropertyInfo members</returns>
- </member>
- <member name="M:DotSpatial.Symbology.CopyBase.OnCopy(DotSpatial.Symbology.Descriptor)">
- <summary>
- This occurs during the Copy method and is overridable by sub-classes
- </summary>
- <param name="copy">The duplicate descriptor</param>
- </member>
- <member name="T:DotSpatial.Symbology.IDescriptor">
- <summary>
- IDescriptor
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IMatchable">
- <summary>
- Matching is defined as being a different object, but having properties
- that would make it indistinguishable from the comparision property.
- This is an alternative to overriding the equals behavior in cases
- where you might ALSO need to see if the object reference is the same.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IMatchable.Matches(DotSpatial.Symbology.IMatchable,System.Collections.Generic.List{System.String}@)">
- <summary>
- Tests this object against the comparison object. If any of the
- value type members are different, or if any of the properties
- are IMatchable and do not match, then this returns false.
- </summary>
- <param name="other">The other IMatcheable object of the same type</param>
- <param name="mismatchedProperties">The list of property names that do not match</param>
- <returns>Boolean, true if the properties are comparably equal.</returns>
- </member>
- <member name="T:DotSpatial.Symbology.IRandomizable">
- <summary>
- IRandomizable
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IRandomizable.Randomize(System.Random)">
- <summary>
- This method will set the values for this class with random values that are
- within acceptable parameters for this class.
- </summary>
- <param name="generator">An existing random number generator so that the random seed can be controlled</param>
- </member>
- <member name="M:DotSpatial.Symbology.IDescriptor.CopyProperties(System.Object)">
- <summary>
- This copies the public descriptor properties from the specified object to
- this object.
- </summary>
- <param name="other">An object that has properties that match the public properties on this object.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Descriptor.#ctor">
- <summary>
- Creates a new instance of MatchableObject
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Descriptor.CopyProperties(System.Object)">
- <summary>
- For each of the publicly accessible properties found on this object, this attempts
- to copy a public property from the source object of the same name, if it can find it.
- For each matching property name/type, it will attempt to copy the value.
- </summary>
- <param name="source">The</param>
- </member>
- <member name="M:DotSpatial.Symbology.Descriptor.Matches(DotSpatial.Symbology.IMatchable,System.Collections.Generic.List{System.String}@)">
- <summary>
- Compares the properties of this object with the specified IMatchable other.
- This does not test every property of other, but does test every property
- of this item. As long as the other item has corresponding properties
- for every property on this item, the items are said to match.
- The IMatchable interface allows custom definitions of matching.
- For collections to match, all of their sub-members must match.
- </summary>
- <param name="other"></param>
- <param name="mismatchedProperties"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Descriptor.Randomize(System.Random)">
- <summary>
- The default behavior is to cycle through all the properties of this
- object, and call Randomize on any that implement the IRandomizable interface.
- </summary>
- <param name="generator">The Random seed generator for controling how the random content is created</param>
- </member>
- <member name="M:DotSpatial.Symbology.Descriptor.OnCopyProperties(System.Object)">
- <summary>
- This occurs while copying properties from the specified source, and
- is the default handling for subclasses
- </summary>
- <param name="source"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Descriptor.OnMatch(DotSpatial.Symbology.IMatchable,System.Collections.Generic.List{System.String})">
- <summary>
- This gives sub-classes the chance to directly override, control or otherwise tamper
- with the matching process. This is also where normal matching is performed,
- so to replace it, simply don't call the base.OnMatch method. To tweak the results,
- the base method should be performed first, and the results can then be modified.
- </summary>
- <param name="other"></param>
- <param name="mismatchedProperties"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Descriptor.OnRandomize(System.Random)">
- <summary>
- This allows overrideable behavior that can replace or extend the basic behavior,
- which is to call Randomize on any public properties that are listed as randomizeable.
- This does nothing to normal properties or non public members and needs to be overriden
- to provide the special case functionality for sub-classes.
- </summary>
- <param name="generator">The random number generator to be used during randomization</param>
- </member>
- <member name="T:DotSpatial.Symbology.ILegendItem">
- <summary>
- The LegendItem interface controls specifically the
- properties associated with the legend. It is assumed that
- All layers will support one legend item, but this way
- ostensibly we can eventually add things to the legend that
- are not technically layers.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IParentItem`1">
- <summary>
- Any item which can be contained by a parent item
- </summary>
- <typeparam name="T">The type class of the potential parent</typeparam>
- </member>
- <member name="M:DotSpatial.Symbology.IParentItem`1.GetParentItem">
- <summary>
- Gets the parent item relative to this item.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IParentItem`1.SetParentItem(`0)">
- <summary>
- Sets teh parent legend item for this item
- </summary>
- <param name="value"></param>
- </member>
- <member name="M:DotSpatial.Symbology.ILegendItem.CanReceiveItem(DotSpatial.Symbology.ILegendItem)">
- <summary>
- Tests the specified legend item to determine whether or not
- it can be dropped into the current item.
- </summary>
- <param name="item">Any object that implements ILegendItem</param>
- <returns>Boolean that is true if a drag-drop of the specified item will be allowed.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.ILegendItem.LegendSymbol_Painted(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Instructs this legend item to perform custom drawing for any symbols.
- </summary>
- <param name="g">A Graphics surface to draw on</param>
- <param name="box">The rectangular coordinates that confine the symbol.</param>
- </member>
- <member name="M:DotSpatial.Symbology.ILegendItem.PrintLegendItem(System.Drawing.Graphics,System.Drawing.Font,System.Drawing.Color,System.Drawing.SizeF)">
- <summary>
- Prints the formal legend content without any resize boxes or other notations.
- </summary>
- <param name="g">The graphics object to print to</param>
- <param name="font">The system.Drawing.Font to use for the lettering</param>
- <param name="fontColor">The color of the font</param>
- <param name="maxExtent">Assuming 0, 0 is the top left, this is the maximum extent</param>
- </member>
- <member name="M:DotSpatial.Symbology.ILegendItem.GetLegendSymbolSize">
- <summary>
- Gets the size of the symbol to be drawn to the legend
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILegendItem.ContextMenuItems">
- <summary>
- This is a list of menu items that should appear for this layer.
- These are in addition to any that are supported by default.
- Handlers should be added to this list before it is retrieved.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILegendItem.Checked">
- <summary>
- Gets or sets whether or not this legend item should be visible.
- This will not be altered unless the LegendSymbolMode is set
- to CheckBox.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILegendItem.IsExpanded">
- <summary>
- Gets or sets whether this legend item is expanded.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILegendItem.IsSelected">
- <summary>
- Gets or sets whether this legend item is currently selected (and therefore drawn differently)
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILegendItem.LegendItems">
- <summary>
- Gets whatever the child collection is and returns it as an IEnumerable set of legend items
- in order to make it easier to cycle through those values.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILegendItem.LegendItemVisible">
- <summary>
- Gets or sets a boolean, that if false will prevent this item, or any of its child items
- from appearing in the legend when the legend is drawn.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILegendItem.LegendSymbolMode">
- <summary>
- Gets the symbol mode for this legend item.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILegendItem.LegendText">
- <summary>
- The text that will appear in the legend
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILegendItem.LegendType">
- <summary>
- Gets or sets a pre-defined behavior in the legend when referring to drag and drop functionality.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LegendItem.#ctor">
- <summary>
- Creates a new instance of the legend item
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LegendItem.Configure">
- <summary>
- Configures the default settings of the legend item
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LegendItem.CanReceiveItem(DotSpatial.Symbology.ILegendItem)">
- <summary>
- Returns a boolean indicating whether or not this item can have other items dropped on it.
- By default this is false. This can be overridden for more customized behaviors.
- </summary>
- <param name="item">The item to test for dropping.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.LegendItem.LegendSymbol_Painted(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Draws the symbol for this specific category to the legend
- </summary>
- <param name="g"></param>
- <param name="box"></param>
- </member>
- <member name="M:DotSpatial.Symbology.LegendItem.PrintLegendItem(System.Drawing.Graphics,System.Drawing.Font,System.Drawing.Color,System.Drawing.SizeF)">
- <summary>
- Prints the formal legend content without any resize boxes or other notations.
- </summary>
- <param name="g">The graphics object to print to</param>
- <param name="font">The system.Drawing.Font to use for the lettering</param>
- <param name="fontColor">The color of the font</param>
- <param name="maxExtent">Assuming 0, 0 is the top left, this is the maximum extent</param>
- </member>
- <member name="M:DotSpatial.Symbology.LegendItem.GetNearestValue(System.Double,System.Collections.Generic.List{System.Double})">
- <summary>
- Gets the nearest value.
- </summary>
- <param name="value">The value.</param>
- <param name="values">The values.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.LegendItem.ByteRange(System.Double)">
- <summary>
- Bytes the range.
- </summary>
- <param name="value">The value.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.LegendItem.OnCopy(DotSpatial.Symbology.Descriptor)">
- <summary>
- Handles updating event handlers during a copy process
- </summary>
- <param name="copy"></param>
- </member>
- <member name="M:DotSpatial.Symbology.LegendItem.ResumeChangeEvent">
- <summary>
- Allows the ItemChanged event to fire in response to individual changes again.
- This will also fire the event once if there were any changes that warent it
- that were made while the event was suspended.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LegendItem.SuspendChangeEvent">
- <summary>
- Each suspend call increments an integer, essentially keeping track of the depth of
- suspension. When the same number of ResumeChangeEvents methods have been called
- as SuspendChangeEvents have been called, the suspension is aborted and the
- legend item is allowed to broadcast its changes.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LegendItem.GetLegendSymbolSize">
- <summary>
- Gets or sets the size of the symbol to be drawn to the legend
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LegendItem.GetParentItem">
- <summary>
- Gets the Parent Legend item for this category. This should probably be the appropriate layer item.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LegendItem.SetParentItem(DotSpatial.Symbology.ILegendItem)">
- <summary>
- Sets the parent legend item for this category.
- </summary>
- <param name="value"></param>
- </member>
- <member name="M:DotSpatial.Symbology.LegendItem.OnSetParentItem(DotSpatial.Symbology.ILegendItem)">
- <summary>
- Allows for the set behavior for the parent item to be overridden in child classes
- </summary>
- <param name="value"></param>
- </member>
- <member name="M:DotSpatial.Symbology.LegendItem.OnItemChanged">
- <summary>
- Fires the ItemChanged event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LegendItem.OnItemChanged(System.Object)">
- <summary>
- Fires the ItemChanged event, optionally specifying a different
- sender
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LegendItem.OnRemoveItem">
- <summary>
- Instructs the parent legend item to remove this item from the list of legend items.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.LegendItem.ItemChanged">
- <summary>
- Occurs whenever the symbol content has been updated
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.LegendItem.RemoveItem">
- <summary>
- Occurs whenever the item should be removed from the parent collection
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LegendItem.ChangesSuspended">
- <summary>
- Boolean, true if changes are suspended
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LegendItem.IsDragable">
- <summary>
- Gets or sets a boolean that indicates whether or not this legend item can be dragged to a new position in the legend.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LegendItem.LegendItemVisible">
- <summary>
- Gets or sets a boolean, that if false will prevent this item, or any of its child items
- from appearing in the legend when the legend is drawn.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LegendItem.Checked">
- <summary>
- Because these are in symbol mode, this is not used.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LegendItem.ContextMenuItems">
- <summary>
- Gets the MenuItems that should appear in the context menu of the legend for this category
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LegendItem.IsExpanded">
- <summary>
- Gets or sets a boolean that indicates whether or not the legend should draw the child LegendItems for this category.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LegendItem.IsSelected">
- <summary>
- Gets or sets whether this legend item has been selected in the legend
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LegendItem.LegendItems">
- <summary>
- Gets whatever the child collection is and returns it as an IEnumerable set of legend items
- in order to make it easier to cycle through those values. This defaults to null and must
- be overridden in specific cases where child legend items exist.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LegendItem.LegendSymbolMode">
- <summary>
- Gets or sets the symbol mode for the legend. By default this should be "Symbol", but this can be overridden
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LegendItem.LegendText">
- <summary>
- Gets or sets the text for this category to appear in the legend. This might be a category name,
- or a range of values.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LegendItem.LegendType">
- <summary>
- Gets or sets a pre-defined behavior in the legend when referring to drag and drop functionality.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LegendItem.IsLegendGroup">
- <summary>
- If this is true, then "can receive
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Category.#ctor">
- <summary>
- Creates a new instance of Category
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Category.#ctor(System.Nullable{System.Double},System.Nullable{System.Double})">
- <summary>
- Creaates a new instance of this category, and tailors the range to the specifeid values.
- </summary>
- <param name="startValue">The start value</param>
- <param name="endValue">The end value</param>
- </member>
- <member name="M:DotSpatial.Symbology.Category.#ctor(System.Double)">
- <summary>
- Creates a category that has the same value for both minimum and maximum
- </summary>
- <param name="value">The value to use</param>
- </member>
- <member name="M:DotSpatial.Symbology.Category.ApplySnapping(DotSpatial.Symbology.IntervalSnapMethod,System.Int32,System.Collections.Generic.List{System.Double})">
- <summary>
- Applies the snapping rule directly to the categories, instead of the breaks.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Category.NearestValue(System.Double,System.Collections.Generic.List{System.Double})">
- <summary>
- Searches the list and returns the nearest value in the list to the specified value.
- </summary>
- <param name="value"></param>
- <param name="values"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Category.ApplyMinMax(DotSpatial.Symbology.EditorSettings)">
- <summary>
- Since rasters are numeric and not relying on an SQL expression, this allows
- this only sets the legend text using the method and digits to help with
- formatting.
- </summary>
- <param name="settings">An EditorSettings from either a feature scheme or color scheme.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Category.Contains(System.Double)">
- <summary>
- Tests to see if the specified value falls in the range specified by this ColorCategory
- </summary>
- <param name="value">The value of type int to test</param>
- <returns>Boolean, true if the value was found in the range</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Category.ToString">
- <summary>
- Returns this Number as a string. This uses the DotSpatial.Globalization.CulturePreferences and
- Controls the number type using the NumberFormat enumeration plus the DecimalCount to create
- a number format.
- </summary>
- <returns>The string created using the specified number format and precision.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Category.ToString(DotSpatial.Symbology.IntervalSnapMethod,System.Int32)">
- <summary>
- Returns this Number as a string.
- </summary>
- <param name="method">Specifies how the numbers are modified so that the numeric text can be cleaned up.</param>
- <param name="digits">An integer clarifying digits for rounding or significant figure situations.</param>
- <returns>A string with the formatted number.</returns>
- </member>
- <member name="P:DotSpatial.Symbology.Category.Maximum">
- <summary>
- Maximum this is a convenient caching tool only, and doesn't control the filter expression at all.
- Use ApplyMinMax after setting this to update the filter expression.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Category.Minimum">
- <summary>
- Gets or sets the color to be used for this break. For
- BiValued breaks, this only sets one of the colors. If
- this is higher than the high value, both are set to this.
- If this equals the high value, IsBiValue will be false.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Category.Range">
- <summary>
- Gets the numeric Range for this color break.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Category.Status">
- <summary>
- Gets or sets a status message for this string.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Category.Tag">
- <summary>
- This is not used by DotSpatial, but is provided for convenient linking for this object
- in plugins or other applications.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Changeable.ForceChange">
- <summary>
- Forces the Changed event to fire. If events are suspended,
- then this simply will mark the changes so that when
- the ResumeChanges is called it will automatically fire
- the Changed events.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Changeable.ResumeChanges">
- <summary>
- Resumes the events. If any changes occured during the period of time when
- the events were suspended, this will automatically fire the chnaged event.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Changeable.SuspendChanges">
- <summary>
- Causes this filter collection to suspend the Changed event, so that
- it will only be fired once after a series of updates.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Changeable.OnChanged">
- <summary>
- Fires the Changed event as long as ChangesSuspended is not true.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Changeable.Changed">
- <summary>
- Occurs when members are added to or removed from this collection. If SuspendChanges
- is called, this will temporarilly prevent this event from firing, until ResumeEvents
- has been called.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Changeable.ChangesSuspended">
- <summary>
- To suspend events, call SuspendChanges. Then to resume events, call ResumeEvents. If the
- suspension is greater than 0, then events are suspended.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ChangedObjectEventArgs.#ctor(System.Object)">
- <summary>
- Creates a new instance of ChangedObjectEvent
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ChangedObjectEventArgs.Item">
- <summary>
- Gets the item that has been changed
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.ColorExt">
- <summary>
- Misc extensions for <see cref="T:System.Drawing.Color"/> class
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ColorExt.Lighter(System.Drawing.Color,System.Single)">
- <summary>
- Creates a color with the same hue and saturation but that is slightly brighter than this color.
- </summary>
- <param name="self">The starting color</param>
- <param name="brightness">The floating point value of brightness to add to this color.
- If the combined result is greater than 1, the result will equal one.</param>
- <returns>A color lighter than this color</returns>
- </member>
- <member name="M:DotSpatial.Symbology.ColorExt.Darker(System.Drawing.Color,System.Single)">
- <summary>
- Creates a color with the same hue and saturation but that is slightly darker than this color.
- </summary>
- <param name="self">The starting color</param>
- <param name="brightness">The floating point value of brightness to add to this color.</param>
- if the combined result is less than 0, the result will equal 0.
- <returns>A color darker than this color.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.ColorExt.GetOpacity(System.Drawing.Color)">
- <summary>
- Calculates the opacity as a function of the Alpha channel.
- </summary>
- <param name="self">The color to determine the opacity for</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.ColorExt.ToTransparent(System.Drawing.Color,System.Single)">
- <summary>
- Given a floating point opacity, where 0 is fully transparent and 1 is fully opaque,
- this will generate a new color that is the transparent version.
- </summary>
- <param name="self"></param>
- <param name="opacity"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.ColorExt.ToOpaque(System.Drawing.Color)">
- <summary>
- Returns an equivalent version of this color that is fully opaque (having an alpha value of 255)
- </summary>
- <param name="self">The transparent color</param>
- <returns>The new Color</returns>
- </member>
- <member name="M:DotSpatial.Symbology.ColorExt.BlendWith(System.Drawing.Color,System.Drawing.Color)">
- <summary>
- uses a linear ramp to extrapolate the midpoint between the specified color and the new color
- as defined by ARGB values independantly
- </summary>
- <param name="self">This color</param>
- <param name="other">The color to blend with this color</param>
- <returns>A color that is midway between this color and the specified color</returns>
- </member>
- <member name="F:DotSpatial.Symbology.ColorSchemeType.DeadSea">
- <summary>
- DeadSea
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.ColorSchemeType.Desert">
- <summary>
- Desert
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.ColorSchemeType.FallLeaves">
- <summary>
- Fall Leaves
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.ColorSchemeType.Glaciers">
- <summary>
- Glacier
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.ColorSchemeType.Highway">
- <summary>
- Highway
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.ColorSchemeType.Meadow">
- <summary>
- Meadow
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.ColorSchemeType.Summer_Mountains">
- <summary>
- Summer Mountains
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.ColorSchemeType.Valley_Fires">
- <summary>
- Valley Fires
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.ILabel">
- <summary>
- ILabel
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.ILabel.SymbolChanged">
- <summary>
- Occurs when the Symbolizer for this label is changed.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabel.AnchorPoint">
- <summary>
- Gets or sets the geographic position for the anchoring the label. The relationship
- between this and the text depends on the horizontal alignment.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabel.Index">
- <summary>
- Gets the integer index for this label
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabel.Parent">
- <summary>
- Gets the Symbol group that currently contains this label.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabel.Text">
- <summary>
- Gets or sets the text that appears on this layer.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabel.Symbolizer">
- <summary>
- Gets or sets the symbolizer for this specific label. This allows customization for
- individual labels, but at the same time can allow many labels to point to one set
- of symbolic characteristics.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabel.SelectionSymbolizer">
- <summary>
- Gets or sets the symbolizer that is being used. Symbol groups are defined by the
- original symbolizer, and there is only one selection symbolizer per group. This
- simply is a shortcut to accessing the symbolgroup's selection symbolizer.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IRasterLayerActions">
- <summary>
- This interface provides ability to use in RasterLayer any custom actions (including GUI-dependent dialogs)
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IRasterLayerActions.ShowProperties(DotSpatial.Symbology.IRasterLayer)">
- <summary>
- SHow properties dialog
- </summary>
- <param name="e">Raster layer</param>
- </member>
- <member name="M:DotSpatial.Symbology.IRasterLayerActions.ExportData(DotSpatial.Data.IRaster)">
- <summary>
- Show export dialog
- </summary>
- <param name="e">Raster</param>
- </member>
- <member name="T:DotSpatial.Symbology.ITextSymbolGroup">
- <summary>
- ITextSymbolGroup
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ITextSymbolGroup.Add(DotSpatial.Symbology.ILabel)">
- <summary>
- Add a new integer into this group.
- </summary>
- <param name="label">The label to be added to the group.</param>
- <returns>Boolean, false if the integer was already in this group.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.ITextSymbolGroup.Clear">
- <summary>
- Removes all the selected indices and returns them to the regular indices.
- This returns a list of integer indices for the labels that were changed.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ITextSymbolGroup.Select(System.Int32)">
- <summary>
- Selects a single label
- </summary>
- <param name="label">The integer label to select</param>
- </member>
- <member name="M:DotSpatial.Symbology.ITextSymbolGroup.UnSelect(System.Int32)">
- <summary>
- Unselect a single label in this group.
- </summary>
- <param name="label">The integer label</param>
- </member>
- <member name="P:DotSpatial.Symbology.ITextSymbolGroup.Symbolizer">
- <summary>
- Gets or sets the text symbolizer for this group of labels
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ITextSymbolGroup.RegularLabels">
- <summary>
- Gets or sets the list of regular labels based on their index in the actual list of labels
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ITextSymbolGroup.SelectedLabels">
- <summary>
- Gets or sets the list of selected labels based on their index in the actual list of labels
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ITextSymbolGroup.SelectionSymbolizer">
- <summary>
- Gets or sets the set of symbolic characteristics that should be used for drawing selected labels.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.ItemEventArgs`1">
- <summary>
- A generic event argument that also allows sending the strong typed item.
- </summary>
- <typeparam name="T">The generic item associated with the event.</typeparam>
- </member>
- <member name="M:DotSpatial.Symbology.ItemEventArgs`1.#ctor(`0)">
- <summary>
- Creates a new instance of hte LegendItemEventArgs
- </summary>
- <param name="item">The item associated with the event. This is not necessarilly the sender.</param>
- </member>
- <member name="P:DotSpatial.Symbology.ItemEventArgs`1.Item">
- <summary>
- The item associated with this event. This is not necessarilly the sender.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.LabelLayerEventArgs">
- <summary>
- An EventArgs specifically tailored to LabelLayerEventArgs.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LabelLayerEventArgs.#ctor(DotSpatial.Symbology.ILabelLayer)">
- <summary>
- Initializes a new instance of the LabelLayerEventArgs class.
- </summary>
- <param name="labelLayer">The ILabelLayer that is involved in this event.</param>
- </member>
- <member name="P:DotSpatial.Symbology.LabelLayerEventArgs.LabelLayer">
- <summary>
- Gets the LabelLayer associated with this event.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LayerMovedEventArgs.#ctor(DotSpatial.Symbology.ILayer,System.Int32)">
- <summary>
- Creates a new instance of LayerEventArgs
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LayerMovedEventArgs.Layer">
- <summary>
- Layer that was moved.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LayerMovedEventArgs.NewPosition">
- <summary>
- Position the layer was moved to.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Position2DConverter">
- <summary>
- PointFConverter
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Position2DConverter.CanConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Type)">
- <summary>
- True if the source type is a string
- </summary>
- <param name="context"></param>
- <param name="sourceType"></param>
- <returns>Boolean, true if source type is a string</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Position2DConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)">
- <summary>
- Uses a string to return a new Position2D
- </summary>
- <param name="context"></param>
- <param name="culture"></param>
- <param name="value"></param>
- <returns>A String</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Position2DConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)">
- <summary>
- Creates a string from the specified Position2D
- </summary>
- <param name="context"></param>
- <param name="culture"></param>
- <param name="value"></param>
- <param name="destinationType"></param>
- <returns>A Position2D</returns>
- </member>
- <member name="T:DotSpatial.Symbology.RasterLayerEventArgs">
- <summary>
- An EventArgs specifically tailored to RasterLayer.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.RasterLayerEventArgs.#ctor(DotSpatial.Symbology.IRasterLayer)">
- <summary>
- Initializes a new instance of the RasterLayerEventArgs class.
- </summary>
- <param name="rasterLayer">The IRasterLayer that is involved in this event.</param>
- </member>
- <member name="P:DotSpatial.Symbology.RasterLayerEventArgs.RasterLayer">
- <summary>
- Gets the RasterLayer associated with this event.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Size2DConverter">
- <summary>
- The ExpandableSetConverter works by assuming that a pair of
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Size2DConverter.CanConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Type)">
- <summary>
- Returns true if the source type is string
- </summary>
- <param name="context"></param>
- <param name="sourceType"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Size2DConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)">
- <summary>
- Converts a string into a Size2D
- </summary>
- <param name="context"></param>
- <param name="culture"></param>
- <param name="value"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Size2DConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)">
- <summary>
- Converts the Size2D into a string
- </summary>
- <param name="context"></param>
- <param name="culture"></param>
- <param name="value"></param>
- <param name="destinationType"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.DesktopRasterExt.CreateHillShade(DotSpatial.Data.IRaster,DotSpatial.Symbology.IShadedRelief,DotSpatial.Data.IProgressHandler)">
- <summary>
- Create Hillshade of values ranging from 0 to 1, or -1 for no-data regions.
- This should be a little faster since we are accessing the Data field directly instead of working
- through a value parameter.
- </summary>
- <param name="raster">The raster to create the hillshade from.</param>
- <param name="shadedRelief">An implementation of IShadedRelief describing how the hillshade should be created.</param>
- <param name="progressHandler">An implementation of IProgressHandler for progress messages</param>
- </member>
- <member name="M:DotSpatial.Symbology.DesktopRasterExt.CreateHillShadeT``1(DotSpatial.Data.Raster{``0},DotSpatial.Symbology.IShadedRelief,DotSpatial.Data.ProgressMeter)">
- <summary>
- Create Hillshade of values ranging from 0 to 1, or -1 for no-data regions.
- This should be a little faster since we are accessing the Data field directly instead of working
- through a value parameter.
- </summary>
- <param name="raster">The raster to create the hillshade from.</param>
- <param name="shadedRelief">An implementation of IShadedRelief describing how the hillshade should be created.</param>
- <param name="progressMeter">An implementation of IProgressHandler for progress messages</param>
- </member>
- <member name="M:DotSpatial.Symbology.DesktopRasterExt.DrawToBitmap(DotSpatial.Data.IRaster,DotSpatial.Symbology.IRasterSymbolizer,System.Drawing.Bitmap,DotSpatial.Data.IProgressHandler)">
- <summary>
- Creates a bitmap from this raster using the specified rasterSymbolizer
- </summary>
- <param name="raster">The raster to draw to a bitmap</param>
- <param name="rasterSymbolizer">The raster symbolizer to use for assigning colors</param>
- <param name="bitmap">This must be an Format32bbpArgb bitmap that has already been saved to a file so that it exists.</param>
- <param name="progressHandler">The progress handler to use.</param>
- <exception cref="T:System.ArgumentNullException">rasterSymbolizer cannot be null</exception>
- </member>
- <member name="M:DotSpatial.Symbology.DesktopRasterExt.DrawToBitmapT``1(DotSpatial.Data.Raster{``0},DotSpatial.Symbology.IRasterSymbolizer,System.Byte[],System.Int32,DotSpatial.Data.ProgressMeter)">
- <summary>
- Creates a bitmap from this raster using the specified rasterSymbolizer
- </summary>
- <param name="raster">The raster to draw to a bitmap</param>
- <param name="rasterSymbolizer">The raster symbolizer to use for assigning colors</param>
- <param name="rgbData">Byte values representing the ARGB image bytes</param>
- <param name="stride">The stride</param>
- <param name="pm">The progress meter to use.</param>
- <exception cref="T:System.ArgumentNullException">rasterSymbolizer cannot be null</exception>
- </member>
- <member name="M:DotSpatial.Symbology.DesktopRasterExt.PaintColorSchemeToBitmap(DotSpatial.Data.IRaster,DotSpatial.Symbology.IRasterSymbolizer,System.Drawing.Bitmap,DotSpatial.Data.IProgressHandler)">
- <summary>
- Creates a bitmap using only the colorscheme, even if a hillshade was specified.
- </summary>
- <param name="raster">The Raster containing values that need to be drawn to the bitmap as a color scheme.</param>
- <param name="rasterSymbolizer">The raster symbolizer to use.</param>
- <param name="bitmap">The bitmap to edit. Ensure that this has been created and saved at least once.</param>
- <param name="progressHandler">An IProgressHandler implementation to receive progress updates.</param>
- <exception cref="T:System.ArgumentNullException">rasterSymbolizer cannot be null.</exception>
- </member>
- <member name="M:DotSpatial.Symbology.DesktopRasterExt.PaintColorSchemeToBitmapT``1(DotSpatial.Data.Raster{``0},DotSpatial.Symbology.IRasterSymbolizer,System.Drawing.Bitmap,DotSpatial.Data.IProgressHandler)">
- <summary>
- Creates a bitmap using only the colorscheme, even if a hillshade was specified.
- </summary>
- <param name="raster">The Raster containing values that need to be drawn to the bitmap as a color scheme.</param>
- <param name="rasterSymbolizer">The raster symbolizer to use.</param>
- <param name="bitmap">The bitmap to edit. Ensure that this has been created and saved at least once.</param>
- <param name="progressHandler">An IProgressHandler implementation to receive progress updates.</param>
- <exception cref="T:System.ArgumentNullException"><see cref="!:rasterSymbolizer"/> cannot be null, <see cref="!:raster"/> cannot be null, <see cref="!:bitmap"/> cannot be null</exception>
- </member>
- <member name="M:DotSpatial.Symbology.DesktopRasterExt.GetUniqueValues(DotSpatial.Data.IRaster)">
- <summary>
- Obtains a list of unique values from the grid.
- </summary>
- <param name="raster">The IRaster to obtain unique values for</param>
- <returns>A list of double values, where no value is repeated.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.DesktopRasterExt.GetUniqueValues(DotSpatial.Data.IRaster,System.Int32,System.Boolean@)">
- <summary>
- Obtains an set of unique values. If there are more than maxCount values, the process stops and overMaxCount is set to true.
- </summary>
- <param name="raster">the raster to obtain the unique values from.</param>
- <param name="maxCount">An integer specifying the maximum number of values to add to the list of unique values</param>
- <param name="overMaxCount">A boolean that will be true if the process was halted prematurely.</param>
- <returns>A set of doubles representing the independant values.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.DesktopRasterExt.GetRandomValues(DotSpatial.Data.IRaster,System.Int32)">
- <summary>
- This will sample randomly from the raster, preventing duplicates.
- If the sampleSize is larger than this raster, this returns all of the
- values from the raster. If a "Sample" has been prefetched and stored
- in the Sample array, then this will return that.
- </summary>
- <param name="raster"></param>
- <param name="sampleSize"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Symbology.DrawArgs">
- <summary>
- DrawArgs contains the parameters necessary for 2D drawing
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.DrawArgs.#ctor(System.Drawing.Graphics,DotSpatial.Symbology.DrawWindow)">
- <summary>
- Creates a new instance of DrawArgs
- </summary>
- <param name="inGraphics">A System.Windows.Drawing.Graphics object</param>
- <param name="inDrawWindow">A DotSpatial.Drawing.DrawWindow to draw to</param>
- </member>
- <member name="M:DotSpatial.Symbology.DrawArgs.#ctor(System.Drawing.Graphics,DotSpatial.Symbology.DrawWindow,System.Int32)">
- <summary>
- Creates a new instance of DrawArgs
- </summary>
- <param name="inGraphics">A System.Windows.Drawing.Graphics object</param>
- <param name="inDrawWindow">A DotSpatial.Drawing.DrawWindow to draw to</param>
- <param name="inPart">An integer part representing a value from 0 to NumParts being drawn</param>
- </member>
- <member name="M:DotSpatial.Symbology.DrawArgs.#ctor(System.Drawing.Graphics,DotSpatial.Symbology.DrawWindow,System.Int32,System.Int32)">
- <summary>
- Creates a new instance of DrawArgs
- </summary>
- <param name="inGraphics">A System.Windows.Drawing.Graphics object</param>
- <param name="inDrawWindow">A DotSpatial.Drawing.DrawWindow to draw to</param>
- <param name="inPart">An integer part representing a value from 0 to NumParts being drawn</param>
- <param name="inStage">The integer stage representing an object that has several stages, for all of the parts to be passed through</param>
- </member>
- <member name="P:DotSpatial.Symbology.DrawArgs.Graphics">
- <summary>
- Gets the Graphics device to draw to
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.DrawArgs.DrawWindow">
- <summary>
- Gets the geographic extent for the drawing operation
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.DrawArgs.Part">
- <summary>
- Gets the part index being drawn.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.DrawArgs.Stage">
- <summary>
- Gets the integer stage index. As an example, if all the borders are drawn first, and then all the fillings are drawn,
- but each stage has several parts, the stage gives a way to subdivide a larger object into several drawing passes.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.DrawCompletedArgs">
- <summary>
- A set of PaintEventArgs that can be used before a drawing function in order to cancel an event.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.DrawCompletedArgs.#ctor(System.Drawing.Graphics,DotSpatial.Symbology.DrawWindow,System.Boolean,System.Exception)">
- <summary>
- Creates a new instance of the DrawCompleted Event Arguments
- </summary>
- <param name="inGraphics">A Graphics surface</param>
- <param name="inDrawWindow">An implementation of DotSpatial.Geometries.IEnvelope defining the geographic drawing region</param>
- <param name="inCancelled">True if the draw method was cancelled before any rendering took place. A Cancel is different from when an acception is thrown.</param>
- <param name="inException">If an exception occured during rendering, this will not be null.</param>
- </member>
- <member name="M:DotSpatial.Symbology.DrawCompletedArgs.#ctor(DotSpatial.Symbology.DrawArgs,System.Boolean)">
- <summary>
- Creates a default DrawCompleted event for the situation where the drawing was successful, not cancelled and no exception occured
- </summary>
- <param name="args">The DrawArgs being used during the drawing, specifying the Graphics device and geographic envelope</param>
- <param name="inCancelled">A boolean parameter specifying whether or not the drawing was cancelled</param>
- </member>
- <member name="M:DotSpatial.Symbology.DrawCompletedArgs.#ctor(DotSpatial.Symbology.DrawArgs,System.Exception)">
- <summary>
- Creates a new DrawCompleted in the case where an exception was thrown
- </summary>
- <param name="args">The drawing arguments for drawing, specifying the Graphics device and the geographic envelope </param>
- <param name="inException">The Exception being thrown</param>
- </member>
- <member name="P:DotSpatial.Symbology.DrawCompletedArgs.Cancelled">
- <summary>
- Boolean, true if the draw method was cancelled before rendering took place.
- This will not be true if visible was false or an exception was thrown.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.DrawCompletedArgs.Exception">
- <summary>
- An Exception object for situations where the drawing threw an exception.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.DrawVerifyArgs">
- <summary>
- A set of PaintEventArgs that can be used before a drawing function in order to cancel an event.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.DrawVerifyArgs.#ctor(System.Drawing.Graphics,DotSpatial.Symbology.DrawWindow,System.Int32,System.Int32,System.Boolean)">
- <summary>
- Creates a new instance of the CancelPaint Event Arguments.
- </summary>
- <param name="inGraphics">The device that contains the drawing information for the event to determine whether or not to cancel.</param>
- <param name="inDrawWindow">The geographic bounds of the draw event</param>
- <param name="inPart">The part being drawn. This is usually 0, unless NumParts is greater than 1.</param>
- <param name="inStage">The 0-based integer index indicating the stage of the drawing.</param>
- <param name="inCancel">A boolean specifying the default setting for the draw args.</param>
- </member>
- <member name="M:DotSpatial.Symbology.DrawVerifyArgs.#ctor(DotSpatial.Symbology.DrawArgs)">
- <summary>
- Constructs a new instance with cancel set to false using an Existing DrawArgs
- </summary>
- <param name="args"></param>
- </member>
- <member name="P:DotSpatial.Symbology.DrawVerifyArgs.Cancel">
- <summary>
- Returns a boolean specifying whether the action that caused the default drawing
- for this event should be prevented.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.DrawWindow">
- <summary>
- A Draw Window is a special type of envelope that supports some basic transformations
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.DrawWindow.#ctor">
- <summary>
- Creates a new instance of DrawWindow, making the assumption that the map is in Geographic coordinates of decimal degrees
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.DrawWindow.#ctor(System.Double,System.Double,System.Double,System.Double,System.Double,System.Double)">
- <summary>
- Creates a new draw window with the specified coordinates
- </summary>
- <param name="x1">The first x-value.</param>
- <param name="x2">The second x-value.</param>
- <param name="y1">The first y-value.</param>
- <param name="y2">The second y-value.</param>
- <param name="z1">The first z-value.</param>
- <param name="z2">The second z-value.</param>
- </member>
- <member name="M:DotSpatial.Symbology.DrawWindow.#ctor(DotSpatial.Topology.IEnvelope)">
- <summary>
- Constructs a new DrawWindow based on the specified IEnvelope. The envelope becomes
- the GeographicView for this DrawWindow.
- </summary>
- <param name="env"></param>
- </member>
- <member name="M:DotSpatial.Symbology.DrawWindow.Copy">
- <summary>
- Replaces the inherited Envelope copy in order to create a copy of the DrawWindow instead
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.DrawWindow.Clone">
- <summary>
- Replaces the inherited clone in order to make a copy of the DrawWindow
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.DrawWindow.ProjToDrawWindow(System.Double,System.Double)">
- <summary>
- Converts two dimensions of the specified coordinate into a two dimensional PointF
- </summary>
- <param name="inX"></param>
- <param name="inY"></param>
- <returns>A PointF</returns>
- </member>
- <member name="M:DotSpatial.Symbology.DrawWindow.ProjToDrawWindow(DotSpatial.Topology.Coordinate)">
- <summary>
- Converts two dimensions of the specified coordinate into a two dimensional PointF
- </summary>
- <param name="inCoord">Any valid ICoordinate</param>
- <returns>A PointF</returns>
- </member>
- <member name="M:DotSpatial.Symbology.DrawWindow.ProjToDrawWindow(System.Collections.Generic.List{DotSpatial.Topology.Coordinate})">
- <summary>
- Converts two dimensions of the specified coordinate into a two dimensional PointF.
- </summary>
- <param name="inCoords"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.DrawWindow.DrawWindowToProj(System.Drawing.PointF)">
- <summary>
- Converts a PointF from the draw window back into the double precision data coordinate.
- </summary>
- <param name="inPoint"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.DrawWindow.DrawWindowToProj(System.Drawing.PointF[])">
- <summary>
- Converts an Array of PointF values from the draw window back into the double precision data coordinates.
- There will be uncertainty based on how zoomed in you are.
- </summary>
- <param name="inPoints"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.DrawWindow.ProjToDrawWindow(DotSpatial.Topology.IEnvelope)">
- <summary>
-
- </summary>
- <param name="env"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.DrawWindow.DrawWindowToProj(System.Drawing.RectangleF)">
- <summary>
- Calculates a geographic envelope from the specified window in the DrawWindow coordinates.
- </summary>
- <param name="window"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.DrawWindow.GetDrawWindowView">
- <summary>
- This calculates the DrawWindowView from the GeographicView
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.DrawWindow.GeographicView">
- <summary>
- This is the the current extent of the map in geographic coordinates.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.DrawWindow.View">
- <summary>
- Retrieves the MinX value of the GeographicView, in DrawWindow coordinates
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.DrawWindowArgs">
- <summary>
- The main difference here is that tests against the DrawWindow happen before the nested Draw2D methods.
- The DrawWindow is editable at this stage, but will become read-only during drawing.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.DrawWindowArgs.#ctor(System.Drawing.Graphics,DotSpatial.Symbology.DrawWindow)">
- <summary>
- Creates a new instance of DrawArgs
- </summary>
- <param name="inGraphics">A System.Windows.Drawing.Graphics object</param>
- <param name="inDrawWindow">A DotSpatial.Drawing.DrawWindow to draw to</param>
- </member>
- <member name="P:DotSpatial.Symbology.DrawWindowArgs.Graphics">
- <summary>
- Gets the Graphics device to draw to
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.DrawWindowArgs.DrawWindow">
- <summary>
- Gets or sets the geographic extent for the drawing operation
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.DynamicVisibilityMode">
- <summary>
- DynamicVisibilityModes
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.DynamicVisibilityMode.ZoomedIn">
- <summary>
- The layer will only be visible when zoomed in closer than the
- DynamicVisibilityWidth.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.DynamicVisibilityMode.ZoomedOut">
- <summary>
- The layer will only be visible when zoomed out beyond the
- DynamicVisibilityWidth.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.EditorSettings">
- <summary>
- EditorSettings
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.EditorSettings.#ctor">
- <summary>
- Creates a new instance of EditorSettings
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.EditorSettings.EndColor">
- <summary>
- Gets or sets the characteristics of the "right" color.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.EditorSettings.ExcludeExpression">
- <summary>
- Gets or sets a string that allows the user to use any of the
- data fields to eliminate values from being considered as part
- of the histogram for statistical interval calculations.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.EditorSettings.HueSatLight">
- <summary>
- Gets or sets a boolean indicating to display
- the hue, saturation, lightness as bounds
- instead of start-color, end-color.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.EditorSettings.HueShift">
- <summary>
- Gets or sets the hue shift.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.EditorSettings.IntervalMethod">
- <summary>
- Gets or sets the interval method
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.EditorSettings.MaxSampleCount">
- <summary>
- Gets or sets the maximum sample count.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.EditorSettings.NumBreaks">
- <summary>
- Gets or sets the integer count if equal breaks are used
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.EditorSettings.RampColors">
- <summary>
- Gets or sets whether this editor should ramp the colors,
- or use randomly generated colors. The default is random.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.EditorSettings.StartColor">
- <summary>
- Gets or sets the characteristics of the "left" color.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.EditorSettings.UseColorRange">
- <summary>
- Gets or sets whether to use the color specifications
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.EditorSettings.IntervalSnapMethod">
- <summary>
- Gets or sets how intervals like equal breaks choose the
- actual values, and whether they are rounded or snapped.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.EditorSettings.IntervalRoundingDigits">
- <summary>
- Gets or sets the number of digits to preserve when IntervalSnapMethod is set to Rounding
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.GeoReferenceType">
- <summary>
- World or pixel coordinates
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.GeoReferenceType.Empty">
- <summary>
- No referencing was specified so the default will be used
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.GeoReferenceType.GeoReferenced">
- <summary>
- The coordinates are given relative to the geographic locations, rather than pixel coordinates
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.GeoReferenceType.Pixels">
- <summary>
- The coordinates are given in pixels
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.PictureType">
- <summary>
- An enumeration showing whetehr this item should use a picture or an image
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.PictureType.Empty">
- <summary>
- No specification was set, so use the default
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.PictureType.Icon">
- <summary>
- Specifies to use an icon
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.PictureType.Image">
- <summary>
- Specifies to use an image
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.LineStyle">
- <summary>
- Gives an enumeration for several different line styles
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.LineStyle.Empty">
- <summary>
- Specifies that none of the normal options were chosen so a default should be used.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.LineStyle.ClosedCurve">
- <summary>
- This will draw the specified line so that the curve joins itself
- at the ends.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.LineStyle.Curve">
- <summary>
- Draws a cardinal spline through the points of this feature
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.LineStyle.Lines">
- <summary>
- Draws a set of line segments through the points of this feature
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.TrueFalse">
- <summary>
- This is like a boolean, but with a "default" of empty. Empty signifies
- that the value is not specified.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.TrueFalse.Empty">
- <summary>
- Not specified
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.TrueFalse.True">
- <summary>
- Specified as true
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.TrueFalse.False">
- <summary>
- Specified as false
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.LineJoinType">
- <summary>
- Specifies the OGC type of connection that can occur between two segments
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.LineJoinType.Mitre">
- <summary>
- Flat?
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.LineJoinType.Round">
- <summary>
- Rounded
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.LineJoinType.Bevel">
- <summary>
- Beveled
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.LineCapType">
- <summary>
- Specifies the OGC treatment to give the line at the end-points
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.LineCapType.Butt">
- <summary>
- Flat?
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.LineCapType.Round">
- <summary>
- Round
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.LineCapType.Square">
- <summary>
- flat but a little outwards
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.EnvelopeArgs.#ctor(DotSpatial.Topology.IEnvelope)">
- <summary>
- Creates a new instance of EnvelopeArgs
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.EnvelopeArgs.Envelope">
- <summary>
- Gets the envelope specific to this event.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureChangeArgs.#ctor(System.Collections.Generic.List{System.Int32})">
- <summary>
- Creates a new instance of SelectionEventArgs
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureChangeArgs.ChangedFeatures">
- <summary>
- Gets the list of features that were changed by this event.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.FeatureChangeEnvelopeArgs">
- <summary>
- FeatureChangeEnvelopeArgs
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureChangeEnvelopeArgs.#ctor(System.Collections.Generic.List{System.Int32},DotSpatial.Topology.IEnvelope)">
- <summary>
- Creates a new instance of FeatureChangeEnvelopeArgs
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureChangeEnvelopeArgs.Envelope">
- <summary>
- Gets the geographic envelope for the most recent selection event.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FilterCollectionEM.AddRange(DotSpatial.Symbology.IFeatureSelection,System.Collections.Generic.IEnumerable{DotSpatial.Data.IFeature})">
- <summary>
- Adds all the features in the specified range. This will throw an exception if the
- the features are not already in the feature list, since this is simply trying
- to select those features.
- </summary>
- <param name="self">The IFilterCollection to add the range to</param>
- <param name="features">The features being selected.</param>
- </member>
- <member name="M:DotSpatial.Symbology.FilterCollectionEM.AddRegion(DotSpatial.Symbology.IFeatureSelection,DotSpatial.Topology.IEnvelope)">
- <summary>
- This uses extent checking (rather than full polygon intersection checking). It will add
- any members that are either contained by or intersect with the specified region
- depending on the SelectionMode property. The order of operation is the region
- acting on the feature, so Contains, for instance, would work with points.
- </summary>
- <param name="self"></param>
- <param name="region"></param>
- <returns>True if any item was actually added to the collection</returns>
- </member>
- <member name="M:DotSpatial.Symbology.FilterCollectionEM.RemoveRange(DotSpatial.Symbology.IFeatureSelection,System.Collections.Generic.IEnumerable{DotSpatial.Data.IFeature})">
- <summary>
- Removes the entire list of features
- </summary>
- <param name="self">The IFilterCollection to remove the range from</param>
- <param name="features">The enumerable collection of IFeatures.</param>
- </member>
- <member name="M:DotSpatial.Symbology.FilterCollectionEM.RemoveRegion(DotSpatial.Symbology.IFeatureSelection,DotSpatial.Topology.IEnvelope)">
- <summary>
- Tests each member currently in the selected features based on
- the SelectionMode. If it passes, it will remove the feature from
- the selection.
- </summary>
- <param name="self">The IFilterCollection that this should be applied to</param>
- <param name="region">The geographic region to remove</param>
- <returns>Boolean, true if the collection was changed</returns>
- </member>
- <member name="T:DotSpatial.Symbology.GradientModel">
- <summary>
- An enumeration specifying the way that a gradient of color is attributed to the values in the specified range.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.GradientModel.Linear">
- <summary>
- The values are colored in even steps in each of the Red, Green and Blue bands.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.GradientModel.Exponential">
- <summary>
- The even steps between values are used as powers of two, greatly increasing the impact of higher values.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.GradientModel.Logarithmic">
- <summary>
- The log of the values is used, reducing the relative impact of the higher values in the range.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.GraphicsPathExt">
- <summary>
- GraphicsPathEM
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.GraphicsPathExt.AddRoundedRectangle(System.Drawing.Drawing2D.GraphicsPath,System.Drawing.Rectangle,System.Int32)">
- <summary>
- Adds a round rectangle to the graphics path where the integer radius specified determines how rounded the rectangle should become.
- This can be thought of rounded arcs connected by straight lines.
- </summary>
- <param name="self"></param>
- <param name="bounds"></param>
- <param name="radius"></param>
- </member>
- <member name="M:DotSpatial.Symbology.GraphicsPathExt.AddRoundedRectangleTopLeft(System.Drawing.Drawing2D.GraphicsPath,System.Drawing.Rectangle,System.Int32)">
- <summary>
- Adds the unclosed set of lines that are the top and left of the shape
- </summary>
- <param name="self"></param>
- <param name="bounds"></param>
- <param name="radius"></param>
- </member>
- <member name="M:DotSpatial.Symbology.GraphicsPathExt.AddRoundedRectangleBottomRight(System.Drawing.Drawing2D.GraphicsPath,System.Drawing.Rectangle,System.Int32)">
- <summary>
- Adds the unclosed set of lines that are the bottom and right of the shape
- </summary>
- <param name="self"></param>
- <param name="bounds"></param>
- <param name="radius"></param>
- </member>
- <member name="M:DotSpatial.Symbology.GraphicsPathExt.GetBounds(System.Drawing.Drawing2D.GraphicsPath)">
- <summary>
- Tests each of the points in the graphics path, and calculates a RectangleF that completely contains
- all of the points in the graphics path.
- </summary>
- <param name="self">The grpahics path to test.</param>
- <returns>A RectangleF</returns>
- </member>
- <member name="T:DotSpatial.Symbology.Group">
- <summary>
- Group
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.RenderableLegendItem">
- <summary>
- RenderableLegendItem
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IRenderableLegendItem">
- <summary>
- Items with this setup can both be organized as an item,
- and feature the elemental control methods and properties
- around drawing. Layers, MapFrames, groups etc can fall in this
- category.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IRenderable">
- <summary>
- Anything that can draw itself to the map is an IRenderable. This is implemented by RenderBase.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IRenderable.Invalidate">
- <summary>
- Invalidates the drawing methods
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.IRenderable.EnvelopeChanged">
- <summary>
- Occurs whenever the geographic bounds for this renderable object have changed
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.IRenderable.Invalidated">
- <summary>
- Occurs when an outside request is sent to invalidate this object
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.IRenderable.VisibleChanged">
- <summary>
- Occurs immediately after the visible parameter has been adjusted.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IRenderable.Extent">
- <summary>
- Obtains an IEnvelope in world coordinates that contains this object
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Symbology.IRenderable.IsInitialized">
- <summary>
- Gets whether or not the unmanaged drawing structures have been created for this item
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IRenderable.IsVisible">
- <summary>
- If this is false, then the drawing function will not render anything.
- Warning! This will also prevent any execution of calculations that take place
- as part of the drawing methods and will also abort the drawing methods of any
- sub-members to this IRenderable.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.RenderableLegendItem.#ctor">
- <summary>
- Creates a new instance of RenderBase
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.RenderableLegendItem.Invalidate">
- <summary>
- Invalidates the drawing methods
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.RenderableLegendItem.OnEnvelopeChanged(System.Object,DotSpatial.Symbology.EnvelopeArgs)">
- <summary>
- Fires the EnvelopeChanged event.
- </summary>
- <param name="sender">The object sender for this event (this)</param>
- <param name="e">The EnvelopeArgs specifying the envelope</param>
- </member>
- <member name="M:DotSpatial.Symbology.RenderableLegendItem.OnInvalidate(System.Object,System.EventArgs)">
- <summary>
- Fires the Invalidated event
- </summary>
- <param name="sender">The object sender (usually this)</param>
- <param name="e">An EventArgs parameter</param>
- </member>
- <member name="M:DotSpatial.Symbology.RenderableLegendItem.OnVisibleChanged(System.Object,System.EventArgs)">
- <summary>
- Fires the Visible Changed event
- </summary>
- <param name="sender">The object sender (usually this)</param>
- <param name="e">An EventArgs parameter</param>
- </member>
- <member name="E:DotSpatial.Symbology.RenderableLegendItem.EnvelopeChanged">
- <summary>
- Occurs whenever the geographic bounds for this renderable object have changed
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.RenderableLegendItem.Invalidated">
- <summary>
- Occurs when an outside request is sent to invalidate this object
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.RenderableLegendItem.VisibleChanged">
- <summary>
- Occurs immediately after the visible parameter has been adjusted.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RenderableLegendItem.MyExtent">
- <summary>
- The protected extent is a direct, sealed accessor for the extent variable.
- This is safe to use in constructors.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RenderableLegendItem.Extent">
- <summary>
- Obtains an IEnvelope in world coordinates that contains this object. This is virtual, and
- will usually be reconfigured in subclasses to simply show the dataset extent.
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Symbology.RenderableLegendItem.IsInitialized">
- <summary>
- Gets whether or not the unmanaged drawing structures have been created for this item
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RenderableLegendItem.IsVisible">
- <summary>
- If this is false, then the drawing function will not render anything.
- Warning! This will also prevent any execution of calculations that take place
- as part of the drawing methods and will also abort the drawing methods of any
- sub-members to this IRenderable.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.ILayer">
- <summary>
- Just specifies the organization of interfaces that make up a layer.
- It is recommended to create derived classes that inherit from an
- abstract layer that implements the majority of this shared functionality
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.ISelectable">
- <summary>
- This supports the FeatureLayer event SelectionChanged, for both groups and feature layers, or
- any other layer that supports both an ISelection and inherits from IFeatureLayer.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ISelectable.ClearSelection(DotSpatial.Topology.IEnvelope@)">
- <summary>
- Removes any members from existing in the selected state
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ISelectable.InvertSelection(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IEnvelope,DotSpatial.Symbology.SelectionMode,DotSpatial.Topology.IEnvelope@)">
- <summary>
- Inverts the selected state of any members in the specified region.
- </summary>
- <param name="tolerant">The geographic region to invert the selected state of members</param>
- <param name="strict">The geographic region when working with absolutes, without a tolerance</param>
- <param name="mode">The selection mode determining how to test for intersection</param>
- <param name="affectedArea">The geographic region encapsulating the changed members</param>
- <returns>Boolean, true if members were changed by the selection process.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.ISelectable.Select(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IEnvelope,DotSpatial.Symbology.SelectionMode,DotSpatial.Topology.IEnvelope@)">
- <summary>
- Adds any members found in the specified region to the selected state as long as
- SelectionEnabled is set to true.
- </summary>
- <param name="tolerant">The geographic region where selection occurs</param>
- <param name="strict">The geographic region when working with absolutes, without a tolerance</param>
- <param name="mode">The selection mode</param>
- <param name="affectedArea">The envelope affected area</param>
- <returns>Boolean, true if any members were added to the selection</returns>
- </member>
- <member name="M:DotSpatial.Symbology.ISelectable.UnSelect(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IEnvelope,DotSpatial.Symbology.SelectionMode,DotSpatial.Topology.IEnvelope@)">
- <summary>
- Removes any members found in the specified region from the selection
- </summary>
- <param name="tolerant">The geographic region to investigate</param>
- <param name="strict">The geographic region when working with absolutes, without a tolerance</param>
- <param name="mode">The selection mode to use for selecting items</param>
- <param name="affectedArea">The geographic region containing all the shapes that were altered</param>
- <returns>Boolean, true if any members were removed from the selection</returns>
- </member>
- <member name="E:DotSpatial.Symbology.ISelectable.SelectionChanged">
- <summary>
- OCcurs after all of the layers have been updated with new selection content.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ISelectable.SelectionEnabled">
- <summary>
- Gets or sets the Boolean indicating whether this item is actively supporting selection
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ILayer.VisibleAtExtent(DotSpatial.Data.Extent)">
- <summary>
- Given a geographic extent, this tests the "IsVisible", "UseDynamicVisibility",
- "DynamicVisibilityMode" and "DynamicVisibilityWidth"
- In order to determine if this layer is visible.
- </summary>
- <param name="geographicExtent">The geographic extent, where the width will be tested.</param>
- <returns>Boolean, true if this layer should be visible for this extent.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.ILayer.Invalidate(DotSpatial.Data.Extent)">
- <summary>
- Notifies the layer that the next time an area that intersects with this region
- is specified, it must first re-draw content to the image buffer.
- </summary>
- <param name="region">The envelope where content has become invalidated.</param>
- </member>
- <member name="M:DotSpatial.Symbology.ILayer.IsWithinLegendSelection">
- <summary>
- Queries this layer and the entire parental tree up to the map frame to determine if
- this layer is within the selected layers.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.ILayer.ShowProperties">
- <summary>
- Occurs before the properties are actually shown, also allowing the event to be handled.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.ILayer.ZoomToLayer">
- <summary>
- Occurs if the maps should zoom to this layer.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.ILayer.LayerSelected">
- <summary>
- Occurs if this layer was selected
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.ILayer.FinishedLoading">
- <summary>
- Occurs when all aspects of the layer finish loading.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILayer.DataSet">
- <summary>
- Gets or sets the core dataset for this layer.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILayer.InvalidRegion">
- <summary>
- Gets the currently invalidated region.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILayer.MapFrame">
- <summary>
- Gets the MapFrame that contains this layer.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILayer.ProgressHandler">
- <summary>
- Gets or sets the progress handler
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Layer.#ctor">
- <summary>
- Creates a new Layer, but this should be done from the derived classes
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Layer.#ctor(System.Collections.Generic.ICollection{DotSpatial.Symbology.ILayer})">
- <summary>
- Creates a new Layer, but this should be done from the derived classes
- </summary>
- <param name="container">The container this layer should be a member of</param>
- </member>
- <member name="M:DotSpatial.Symbology.Layer.#ctor(DotSpatial.Data.IProgressHandler)">
- <summary>
- Creates a new layer with only a progress handler
- </summary>
- <param name="progressHandler"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Layer.#ctor(System.Collections.Generic.ICollection{DotSpatial.Symbology.ILayer},DotSpatial.Data.IProgressHandler)">
- <summary>
- Creates a new Layer, but this should be done from the derived classes
- </summary>
- <param name="container">The container this layer should be a member of</param>
- <param name="progressHandler">A progress handler for handling progress messages</param>
- </member>
- <member name="M:DotSpatial.Symbology.Layer.VisibleAtExtent(DotSpatial.Data.Extent)">
- <summary>
- Given a geographic extent, this tests the "IsVisible", "UseDynamicVisibility",
- "DynamicVisibilityMode" and "DynamicVisibilityWidth"
- In order to determine if this layer is visible for the specified scale.
- </summary>
- <param name="geographicExtent">The geographic extent, where the width will be tested.</param>
- <returns>Boolean, true if this layer should be visible for this extent.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Layer.CanReceiveItem(DotSpatial.Symbology.ILegendItem)">
- <summary>
- Tests the specified legend item. If the item is another layer or a group or a map-frame, then this
- will return false. Furthermore, if the parent of the item is not also this object, then it will
- also return false. The idea is that layers can have sub-nodes move around, but not transport from
- place to place.
- </summary>
- <param name="item">the legend item to test</param>
- <returns>Boolean that if true means that it is ok to insert the specified item into this layer.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Layer.IsWithinLegendSelection">
- <summary>
- Queries this layer and the entire parental tree up to the map frame to determine if
- this layer is within the selected layers.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Layer.Invalidate(DotSpatial.Data.Extent)">
- <summary>
- Notifies the layer that the next time an area that intersects with this region
- is specified, it must first re-draw content to the image buffer.
- </summary>
- <param name="region">The envelope where content has become invalidated.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Layer.Invalidate">
- <summary>
- Notifies parent layer that this item is invalid and should be redrawn.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Layer.OnZoomToLayer">
- <summary>
- Fires the zoom to layer event.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Layer.OnZoomToLayer(DotSpatial.Topology.IEnvelope)">
- <summary>
- Fires the zoom to layer event, but specifies the extent.
- </summary>
- <param name="env">IEnvelope env</param>
- </member>
- <member name="M:DotSpatial.Symbology.Layer.OnShowProperties(System.ComponentModel.HandledEventArgs)">
- <summary>
- Occurs before showing the properties dialog. If the handled member
- was set to true, then this class will not show the event args.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Layer.OnCopyProperties(System.Object)">
- <summary>
- This should be overridden to copy the symbolizer properties from editCopy
- </summary>
- <param name="editCopy">The version that went into the property dialog</param>
- </member>
- <member name="M:DotSpatial.Symbology.Layer.ZoomToLayerClick(System.Object,System.EventArgs)">
- <summary>
- Zooms to the specific layer
- </summary>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Layer.RemoveLayerClick(System.Object,System.EventArgs)">
- <summary>
- Removes this layer from its parent list
- </summary>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Layer.OnLayerSelected(DotSpatial.Symbology.ILayer,System.Boolean)">
- <summary>
- Fires the LayerSelected event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Layer.OnFinishedLoading">
- <summary>
- Fires the OnFinishedLoading event.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Layer.OnExportData">
- <summary>
- Occurs when instructions are being sent for this layer to export data.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Layer.OnCopy(DotSpatial.Symbology.Descriptor)">
- <summary>
- special treatment for event handlers during a copy event
- </summary>
- <param name="copy"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Layer.OpenFile(System.String)">
- <summary>
- Opens a fileName using the default layer provider and returns a new layer. The layer will not automatically have a container or be added to a map.
- </summary>
- <param name="fileName">The string fileName of the layer to open</param>
- <returns>An ILayer interface</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Layer.OpenFile(System.String,DotSpatial.Data.IProgressHandler)">
- <summary>
- Opens a fileName using the default layer provider and returns a new layer. The layer will not automatically have a container or be added to a map.
- </summary>
- <param name="fileName">The string fileName of the layer to open</param>
- <param name="progressHandler">An IProgresshandler that overrides the Default Layer Manager's progress handler</param>
- <returns>An ILayer interface with the new layer.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Layer.OpenFile(System.String,System.Collections.Generic.ICollection{DotSpatial.Symbology.ILayer})">
- <summary>
- Opens a new layer and automatically adds it to the specified container.
- </summary>
- <param name="fileName">A String fileName to attempt to open.</param>
- <param name="container">The container (usually a LayerCollection) to add to</param>
- <returns>The layer after it has been created and added to the container</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Layer.OpenLayer(System.String,System.Boolean,System.Collections.Generic.ICollection{DotSpatial.Symbology.ILayer},DotSpatial.Data.IProgressHandler)">
- <summary>
- Attempts to call the open fileName method for any ILayerProvider plugin
- that matches the extension on the string.
- </summary>
- <param name="fileName">A String fileName to attempt to open.</param>
- <param name="inRam">A boolean value that if true will attempt to force a load of the data into memory. This value overrides the property on this LayerManager.</param>
- <param name="container">A container to open this layer in</param>
- <param name="progressHandler">Specifies the progressHandler to receive progress messages. This value overrides the property on this LayerManager.</param>
- <returns>An ILayer</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Layer.ClearSelection(DotSpatial.Topology.IEnvelope@)">
- <summary>
- This is overriden in sub-classes
- </summary>
- <param name="affectedArea"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Layer.Select(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IEnvelope,DotSpatial.Symbology.SelectionMode,DotSpatial.Topology.IEnvelope@)">
- <summary>
- This is overriden in sub-classes
- </summary>
- <param name="tolerant">The geographic envelope in cases like cliking near points where tolerance is allowed</param>
- <param name="strict">The geographic region when working with absolutes, without a tolerance</param>
- <param name="mode"></param>
- <param name="affectedArea"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Layer.InvertSelection(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IEnvelope,DotSpatial.Symbology.SelectionMode,DotSpatial.Topology.IEnvelope@)">
- <summary>
- This is overriden in sub-classes
- </summary>
- <param name="tolerant">The geographic envelope in cases like cliking near points where tolerance is allowed</param>
- <param name="strict">The geographic region when working with absolutes, without a tolerance</param>
- <param name="mode"></param>
- <param name="affectedArea"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Layer.UnSelect(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IEnvelope,DotSpatial.Symbology.SelectionMode,DotSpatial.Topology.IEnvelope@)">
- <summary>
- This is overriden in sub-classes
- </summary>
- <param name="tolerant">The geographic envelope in cases like cliking near points where tolerance is allowed</param>
- <param name="strict">The geographic region when working with absolutes, without a tolerance</param>
- <param name="mode"></param>
- <param name="affectedArea"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Layer.Dispose">
- <summary>
- Disposes the memory objects in this layer.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Layer.LockDispose">
- <summary>
- Locks dispose. This typically adds one instance of an internal reference counter.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Layer.UnlockDispose">
- <summary>
- Unlocks dispose. This typically removes one instance of an internal reference counter.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Layer.Reproject(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Reprojects the dataset for this layer.
- </summary>
- <param name="targetProjection">The target projection to use.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Layer.OnSelectionChanged">
- <summary>
- Fires the SelectionChanged event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Layer.Finalize">
- <summary>
- Finalizes an instance of the Layer class.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Layer.Dispose(System.Boolean)">
- <summary>
- This allows overriding layers to handle any memory cleanup.
- </summary>
- <param name="disposeManagedResources">True if managed resources should be set to null.</param>
- </member>
- <member name="E:DotSpatial.Symbology.Layer.LayerSelected">
- <summary>
- Occurs if this layer was selected
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Layer.ZoomToLayer">
- <summary>
- Occurs if the maps should zoom to this layer.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Layer.ShowProperties">
- <summary>
- Occurs before the properties are actually shown, also allowing the event to be handled.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Layer.FinishedLoading">
- <summary>
- Occurs when all aspects of the layer finish loading.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Layer.SelectionChanged">
- <summary>
- Occurs after the selection is changed
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Layer.Disposed">
- <summary>
- Occurs when layer disposed.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Layer.LayerActions">
- <summary>
- Gets or sets custom actions for Layer
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Layer.DataSet">
- <summary>
- Gets or sets the internal data set. This can be null, as in the cases of groups or map-frames.
- Copying a layer should not create a duplicate of the dataset, but rather it should point to the
- original dataset. The ShallowCopy attribute is used so even though the DataSet itself may be cloneable,
- cloning a layer will treat the dataset like a shallow copy.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Layer.DynamicVisibilityWidth">
- <summary>
- Dynamic visibility represents layers that only appear when you zoom in close enough.
- This value represents the geographic width where that happens.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Layer.DynamicVisibilityMode">
- <summary>
- This controls whether the layer is visible when zoomed in closer than the dynamic
- visibility width or only when further away from the dynamic visibility width
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Layer.InvalidRegion">
- <summary>
- Gets the currently invalidated region.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Layer.MapFrame">
- <summary>
- Gets the map frame of the parent LayerCollection.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Layer.ProgressHandler">
- <summary>
- Gets or sets the ProgressHandler for this layer. Setting this overrides the default
- behavior which is to use the
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Layer.UseDynamicVisibility">
- <summary>
- Gets or sets a boolean indicating whether to allow the dynamic visibility
- envelope to control visibility.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Layer.IsSelected">
- <inheritdoc />
- </member>
- <member name="P:DotSpatial.Symbology.Layer.IsVisible">
- <inheritdoc />
- </member>
- <member name="P:DotSpatial.Symbology.Layer.PropertyDialogProvider">
- <summary>
- Layers launch a "Property Grid" by default. However, this can be overridden with a different UIEditor by this
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Layer.ProgressMeter">
- <summary>
- Gets or sets the progress meter being used internally by layer classes.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Layer.IsDisposed">
- <summary>
- Gets or sets a boolean indicating whether the memory objects have already been disposed of.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Layer.SelectionEnabled">
- <summary>
- Gets or sets the boolean that controls whether or not items from the layer can be selected
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Layer.IsDisposeLocked">
- <summary>
- Gets a value indicating whether an existing reference is requesting that the object is not disposed of.
- Automatic disposal, as is the case when a layer is removed from the map, will not take place until
- all the locks on dispose have been removed.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Layer.CanReproject">
- <summary>
- Gets a Boolean indicating if this layer can be reprojected.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Layer.Projection">
- <summary>
- Gets the or sets the projection information for the dataset of this layer.
- This only defines the projection information and does not reproject the dataset or the layer.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Layer.ProjectionString">
- <summary>
- Gets or sets the unmodified projection string that can be used regardless of whether the
- DotSpatial.Projection module is available. This string can be in the Proj4string or in the
- EsriString format. Setting the Projection string only defines projection information.
- Call the Reproject() method to actually reproject the dataset and layer.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IGroup">
- <summary>
- Group
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IGroup.ResumeEvents">
- <summary>
- Resume events will resume events on the layers if all the suspensions are
- canceled out.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IGroup.SuspendEvents">
- <summary>
- Adds one more increment of suspension which will prevent events from firing
- for the layers.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IGroup.GetLayers">
- <summary>
- Gets the layers cast as ILayer without any information about the actual drawing methods.
- This is useful for handling methods that my come from various types of maps.
- </summary>
- <returns>An enumerable collection of ILayer</returns>
- </member>
- <member name="M:DotSpatial.Symbology.IGroup.GetLayerCount(System.Boolean)">
- <summary>
- Returns the number of data layers, not counting groups. If recursive is true, then layers that are within
- groups will be counted, even though the groups themselves are not.
- </summary>
- <param name="recursive">Boolean, if true forces checking even the number of child members.</param>
- <returns>An integer representing the total number of layers in this collection and its children.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.IGroup.LegendSnapShot(System.Int32)">
- <summary>
- Returns a snapshot image of this group
- </summary>
- <param name="imgWidth">Width in pixels of the returned image (height is determined by the number of layers in the group)</param>
- <returns>Bitmap of the group and sublayers (expanded)</returns>
- </member>
- <member name="M:DotSpatial.Symbology.IGroup.LayerHandle(System.Int32)">
- <summary>
- Gets the layer handle of the specified layer
- </summary>
- <param name="positionInGroup">0 based index into list of layers</param>
- <returns>Layer's handle on success, -1 on failure</returns>
- </member>
- <member name="E:DotSpatial.Symbology.IGroup.LayerAdded">
- <summary>
- This occurs when a new layer is added either to this group, or one of the child groups within this group.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.IGroup.LayerRemoved">
- <summary>
- This occurs when a layer is removed from this group.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IGroup.EventsSuspended">
- <summary>
- Gets whether or not the events are suspended on the layer collection
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IGroup.Handle">
- <summary>
- Gets the integer handle for this group
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IGroup.Icon">
- <summary>
- Gets or sets the icon
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IGroup.LayerCount">
- <summary>
- Gets the integer count of layers. This can also be accessed through Layers.Count.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IGroup.LayersVisible">
- <summary>
- Gets or sets the visibility of the layers within this group.
- Note: When reading this property, it returns true if any layer is visible within
- this group
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IGroup.ParentGroup">
- <summary>
- Gets the parent group of this group.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IGroup.StateLocked">
- <summary>
- gets or sets the locked property, which prevents the user from changing the visual state
- except layer by layer
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Group.#ctor">
- <summary>
- Creates a new instance of Group
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Group.#ctor(DotSpatial.Symbology.IFrame,DotSpatial.Data.IProgressHandler)">
- <summary>
- Creates a group that sits in a layer list and uses the specified progress handler
- </summary>
- <param name="frame"></param>
- <param name="progressHandler">the progress handler</param>
- </member>
- <member name="M:DotSpatial.Symbology.Group.#ctor(System.Collections.Generic.ICollection{DotSpatial.Symbology.ILayer},DotSpatial.Symbology.IFrame,DotSpatial.Data.IProgressHandler)">
- <summary>
- Creates a group that sits in a layer list and uses the specified progress handler
- </summary>
- <param name="container">the layer list</param>
- <param name="frame"></param>
- <param name="progressHandler">the progress handler</param>
- </member>
- <member name="M:DotSpatial.Symbology.Group.Add(DotSpatial.Symbology.ILayer)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.Group.Remove(DotSpatial.Symbology.ILayer)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.Group.Insert(System.Int32,DotSpatial.Symbology.ILayer)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.Group.GetLegendSymbolSize">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.Group.CanReceiveItem(DotSpatial.Symbology.ILegendItem)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.Group.LegendSnapShot(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.Group.Invalidate(DotSpatial.Data.Extent)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.Group.Invalidate">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.Group.ClearSelection(DotSpatial.Topology.IEnvelope@)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.Group.Select(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IEnvelope,DotSpatial.Symbology.SelectionMode,DotSpatial.Topology.IEnvelope@)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.Group.GetLayers">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.Group.GetLayerCount(System.Boolean)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.Group.InvertSelection(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IEnvelope,DotSpatial.Symbology.SelectionMode,DotSpatial.Topology.IEnvelope@)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.Group.UnSelect(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IEnvelope,DotSpatial.Symbology.SelectionMode,DotSpatial.Topology.IEnvelope@)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.Group.SuspendEvents">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.Group.ResumeEvents">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.Group.LayerHandle(System.Int32)">
- <summary>
- Gets the layer handle of the specified layer
- </summary>
- <param name="positionInGroup">0 based index into list of layers</param>
- <returns>Layer's handle on success, -1 on failure</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Group.OnCreateGroup">
- <summary>
- Creates a virtual method when sub-groups are being created
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Group.Handle_Layer_Events(DotSpatial.Symbology.ILayerEvents)">
- <summary>
- Given a new LayerCollection, we need to be sensitive to certain events
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Group.OnLayerRemoved(System.Object,DotSpatial.Symbology.LayerEventArgs)">
- <summary>
- Occurs when removing a layer. This also fires the LayerRemoved event.
- </summary>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Group.OnLayerAdded(System.Object,DotSpatial.Symbology.LayerEventArgs)">
- <summary>
- Simply echo this event out to members above this group that might be listening to it.
- </summary>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Group.Ignore_Layer_Events(DotSpatial.Symbology.ILayerEvents)">
- <summary>
- When setting an old layer collection it is advisable to not only add
- new handlers to the new collection, but remove the handlers related
- to the old collection.
- </summary>
- <param name="collection"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Group.Dispose(System.Boolean)">
- <summary>
- Disposes the unmanaged resourced of this group. If disposeManagedResources is true, then this will
- also dispose the resources of the child layers and groups unless they are dispose locked.
- </summary>
- <param name="disposeManagedResources">Boolean, true to dispose child objects and set managed members to null.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Group.IndexOf(DotSpatial.Symbology.ILayer)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.Group.RemoveAt(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.Group.Clear">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.Group.Contains(DotSpatial.Symbology.ILayer)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.Group.CopyTo(DotSpatial.Symbology.ILayer[],System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.Group.GetEnumerator">
- <inheritdoc />
- </member>
- <member name="E:DotSpatial.Symbology.Group.LayerAdded">
- <summary>
- This occurs when a new layer is added either to this group, or one of the child groups within this group.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Group.LayerRemoved">
- <summary>
- This occurs when a layer is removed from this group.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Group.EventsSuspended">
- <inheritdoc />
- </member>
- <member name="P:DotSpatial.Symbology.Group.Layers">
- <summary>
- gets or sets the list of layers.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Group.IsVisible">
- <summary>
- Boolean, true if any sub-layers in the group are visible. Setting this
- will force all the layers in this group to become visible.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Group.Extent">
- <summary>
- The envelope that contains all of the layers for this data frame. Essentially this would be
- the extents to use if you want to zoom to the world view.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Group.Handle">
- <summary>
- Gets the integer handle for this group
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Group.Icon">
- <summary>
- Gets or sets the icon
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Group.InvalidRegion">
- <summary>
- Gets the currently invalidated region as a union of all the
- invalidated regions of individual layers in this group.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Group.LayerCount">
- <summary>
- Returns the count of the layers that are currently stored in this map frame.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Group.LayersVisible">
- <summary>
- Gets a boolean that is true if any of the immediate layers or groups contained within this
- control are visible. Setting this will set the visibility for each of the members of this
- map frame.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Group.LegendItems">
- <summary>
- This is a different view of the layers cast as legend items. This allows
- easier cycling in recursive legend code.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Group.ParentGroup">
- <summary>
- Gets the parent group of this group.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Group.ProgressHandler">
- <summary>
- Gets or sets the progress handler to use. Setting this will set the progress handler for
- each of the layers in this map frame.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Group.StateLocked">
- <summary>
- gets or sets the locked property, which prevents the user from changing the visual state
- except layer by layer
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Group.Item(System.Int32)">
- <inheritdoc />
- </member>
- <member name="P:DotSpatial.Symbology.Group.Count">
- <inheritdoc />
- </member>
- <member name="P:DotSpatial.Symbology.Group.IsReadOnly">
- <inheritdoc />
- </member>
- <member name="T:DotSpatial.Symbology.ICategory">
- <summary>
- ICategory
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ICategory.ApplyMinMax(DotSpatial.Symbology.EditorSettings)">
- <summary>
- Applies the minimum and maximum in order to create the filter expression. This will also
- count the members that match the specified criteria.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ICategory.ApplySnapping(DotSpatial.Symbology.IntervalSnapMethod,System.Int32,System.Collections.Generic.List{System.Double})">
- <summary>
- Applies the snapping rule directly to the categories, instead of the breaks.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ICategory.Contains(System.Double)">
- <summary>
- For quantitative categories, this simply tests to see if the specified value can be
- found between the minimum and maximum range values.
- </summary>
- <param name="value">The double value to check against the minimum and maximum values.</param>
- <returns>Boolean, true if the value is inside the range.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.ICategory.ToString(DotSpatial.Symbology.IntervalSnapMethod,System.Int32)">
- <summary>
- Returns this Number as a string.
- </summary>
- <param name="method">Specifies how the numbers are modified so that the numeric text can be cleaned up.</param>
- <param name="digits">An integer clarifying digits for rounding or significant figure situations.</param>
- <returns>A string with the formatted number.</returns>
- </member>
- <member name="P:DotSpatial.Symbology.ICategory.Minimum">
- <summary>
- Minimum this is a convenient caching tool only, and doesn't control the filter expression at all.
- Use ApplyMinMax after setting this to update the filter expression.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ICategory.Maximum">
- <summary>
- Maximum this is a convenient caching tool only, and doesn't control the filter expression at all.
- Use ApplyMinMax after setting this to update the filter expression.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ICategory.Range">
- <summary>
- Gets or sets the value range, which overrides any existing min/max setup.
- This is only valid for numeric values that can be expressed as doubles.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ICategory.Status">
- <summary>
- Gets or sets a status message for this string.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ICategory.Tag">
- <summary>
- This is not used by DotSpatial, but is provided for convenient linking for this object
- in plugins or other applications.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IChangeable">
- <summary>
- IChangeable
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IChangeable.ResumeChanges">
- <summary>
- Resumes the events. If any changes occured during the period of time when
- the events were suspended, this will automatically fire the chnaged event.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IChangeable.SuspendChanges">
- <summary>
- Causes this filter collection to suspend the Changed event, so that
- it will only be fired once after a series of updates.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.IChangeable.Changed">
- <summary>
- Occurs when members are added to or removed from this collection. If SuspendChanges
- is called, this will temporarilly prevent this event from firing, until ResumeEvents
- has been called.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IChangeable.ChangesSuspended">
- <summary>
- To suspend events, call SuspendChanges. Then to resume events, call ResumeEvents. If the
- suspension is greater than 0, then events are suspended.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IFrame">
- <summary>
- This interface stores a single extent window describing a view, and also contains
- the list of all the layers associated with that view. The layers are ordered.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IFrame.Add(DotSpatial.Data.IFeatureSet)">
- <summary>
- This will create a new layer from the featureset and add it.
- </summary>
- <param name="featureSet">Any valid IFeatureSet that does not yet have drawing characteristics</param>
- </member>
- <member name="E:DotSpatial.Symbology.IFrame.UpdateMap">
- <summary>
- Occurs when some items should no longer render, and the map needs a refresh.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.IFrame.ViewExtentsChanged">
- <summary>
- Occurs after zooming to a specific location on the map and causes a camera recent.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IFrame.ExtentsInitialized">
- <summary>
- Gets or sets a boolean that controls whether or not a newly added layer
- will also force a zoom to that layer. If this is true, then nothing
- will happen. Otherwise, adding layers to this frame or a group in this
- frame will set the extent.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IFrame.DrawingLayers">
- <summary>
- Drawing layers are tracked separately, and do not appear in the legend.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IFrame.SelectedLayer">
- <summary>
- Gets or sets the currently active layer.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IFrame.SmoothingMode">
- <summary>
- Controls the smoothing mode. Default or None will have faster performance
- at the cost of quality.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IFrame.ViewExtents">
- <summary>
- This is the geographic envelope in view.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.ILabelContainer">
- <summary>
- A layer or other object capable of containing
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ILabelContainer.DrawLabels">
- <summary>
- Draws every label in the layer without worrying about any collision testing
- or specific tests outside of this label container. If LabelCollisionTesting
- is set to true, it should still do collision testing for the labels INSIDE
- this label container.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ILabelContainer.DrawLabels(System.Collections.Generic.List{System.Int32})">
- <summary>
- The list of integers corresponds to the integer values that were returned as
- keys to the GetLabelExtents dictionary. The Layer will then draw each of the
- specific lables to draw.
- </summary>
- <param name="labelsToDraw"></param>
- </member>
- <member name="M:DotSpatial.Symbology.ILabelContainer.GetLabelExtents">
- <summary>
- Gets the list of non-rotated extents for labels visible in the current display.
- The integer keys represent the index of the labeled item.
- The envelope values represent the actual rectangles that the labels occupy for
- collision testing. If LabelCollisionTesting is true, then collisions should
- be resolved for the entire layer first based on whatever internal priority
- methods exist. Only the non-colliding visible labels will be returned.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ILabelContainer.GetRotatedLabelBounds">
- <summary>
- Gets the list of possibly rotated label boundaries visible in the current display.
- The integer keys represent the index of the labeled item.
- The envelope values represent the actual rectangles that the labels occupy for
- collision testing. If LabelCollisionTesting is true, then collisions should
- be resolved for the entire layer first based on whatever internal priority
- methods exist. Only the non-colliding visible labels will be returned.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelContainer.Labels">
- <summary>
- The integer indexed list of all the labels in this container.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelContainer.LabelCollisionTesting">
- <summary>
- If this is set to true, then the only labels being sent to GetLabelExtents
- should be the labels that actually need to be drawn.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelContainer.Priority">
- <summary>
- A priority rating for all the labels in this layer. The higher this number,
- the more likely the labels from this layer are to win a collision contest
- between layers.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.ILayerCollection">
- <summary>
- ILayerCollection2
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.ILayerEventList`1">
- <summary>
- Constructor
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.ILayerEvents">
- <summary>
- ILayerEvents
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ILayerEvents.SelectLayer(System.Int32)">
- <summary>
- Selects the layer to use for tools or operations that act on a single layer.
- </summary>
- <param name="index">The integer index indicating the layer to select in this collection.</param>
- </member>
- <member name="E:DotSpatial.Symbology.ILayerEvents.LayerAdded">
- <summary>
- Occurs when a layer is added to this item.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.ILayerEvents.LayerMoved">
- <summary>
- Occurs when a layer is moved.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.ILayerEvents.LayerRemoved">
- <summary>
- Occurs when a layer is removed from this item.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.ILayerEvents.LayerVisibleChanged">
- <summary>
- Occurs when one of the layers in this collection changes visibility.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.ILayerEvents.ZoomToLayer">
- <summary>
- Zooms to a layer
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.ILayerEvents.LayerSelected">
- <summary>
- Occurs immediately after the layer is selected.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.ILayerEvents.SelectionChanging">
- <summary>
- Occurs when the selection on a feature layer changes.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.ILayerEvents.SelectionChanged">
- <summary>
- Occurs after the selection has been updated for all the layers.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ILayerCollection.UnusedName(System.String)">
- <summary>
- Given a base name, this increments a number for appending
- if the name already exists in the collection.
- </summary>
- <param name="baseName">The string base name to start with</param>
- <returns>The base name modified by a number making it unique in the collection</returns>
- </member>
- <member name="P:DotSpatial.Symbology.ILayerCollection.ParentGroup">
- <summary>
- Gets or sets the ParentGroup for this layer collection, even if that parent group
- is not actually a map frame.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILayerCollection.MapFrame">
- <summary>
- Gets or sets the MapFrame for this layer collection.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILayerCollection.SelectedLayer">
- <summary>
- Gets or sets the currently active layer.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.ILayerManager">
- <summary>
- IDataManager
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ILayerManager.OpenLayer">
- <summary>
- This launches an open file dialog and attempts to load the specified file.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ILayerManager.OpenLayer(System.Collections.Generic.ICollection{DotSpatial.Symbology.ILayer})">
- <summary>
- This launches an open file dialog and attempts to load the specified file.
- </summary>
- <param name="container">The layer will be created in the specified collection</param>
- <returns>A Layer</returns>
- </member>
- <member name="M:DotSpatial.Symbology.ILayerManager.OpenLayer(DotSpatial.Data.IProgressHandler)">
- <summary>
- This launches an open file dialog and attempts to load the specified file.
- </summary>
- <param name="progressHandler">Specifies the progressHandler to receive progress messages. This value overrides the property on this DataManager.</param>
- <returns>A Layer</returns>
- </member>
- <member name="M:DotSpatial.Symbology.ILayerManager.OpenLayer(System.String,System.Collections.Generic.ICollection{DotSpatial.Symbology.ILayer})">
- <summary>
- Opens a new layer and automatically adds it to the specified container.
- </summary>
- <param name="fileName">A String fileName to attempt to open.</param>
- <param name="container">The container (usually a LayerCollection) to add to</param>
- <returns>The layer after it has been created and added to the container</returns>
- </member>
- <member name="M:DotSpatial.Symbology.ILayerManager.OpenLayer(System.String,DotSpatial.Data.IProgressHandler)">
- <summary>
- This launches an open file dialog and attempts to load the specified file.
- </summary>
- <param name="fileName">A String fileName to attempt to open.</param>
- <param name="progressHandler">Specifies the progressHandler to receive progress messages. This value overrides the property on this DataManager.</param>
- <returns>A Layer</returns>
- </member>
- <member name="M:DotSpatial.Symbology.ILayerManager.OpenLayer(System.String)">
- <summary>
- Attempts to call the open fileName method for any IDataProvider plugin
- that matches the extension on the string.
- </summary>
- <param name="fileName">A String fileName to attempt to open.</param>
- </member>
- <member name="M:DotSpatial.Symbology.ILayerManager.OpenLayer(System.String,System.Boolean,System.Collections.Generic.ICollection{DotSpatial.Symbology.ILayer},DotSpatial.Data.IProgressHandler)">
- <summary>
- Attempts to call the open fileName method for any IDataProvider plugin
- that matches the extension on the string.
- </summary>
- <param name="fileName">A String fileName to attempt to open.</param>
- <param name="inRam">A boolean value that if true will attempt to force a load of the data into memory. This value overrides the property on this DataManager.</param>
- <param name="container">any valid IContainer that this should be added to</param>
- <param name="progressHandler">Specifies the progressHandler to receive progress messages. This value overrides the property on this DataManager.</param>
- </member>
- <member name="M:DotSpatial.Symbology.ILayerManager.OpenRasterLayer">
- <summary>
- This opens a file, but populates the dialog filter with only raster formats.
- </summary>
- <returns>An IRaster with the data from the file specified in an open file dialog</returns>
- </member>
- <member name="M:DotSpatial.Symbology.ILayerManager.OpenVectorLayer">
- <summary>
- This opens a file, but populates the dialog filter with only raster formats.
- </summary>
- <returns>An IFeatureSet with the data from the file specified in a dialog</returns>
- </member>
- <member name="M:DotSpatial.Symbology.ILayerManager.OpenRasterLayer(System.String)">
- <summary>
- This attempts to open the specified raster file and returns an associated layer
- </summary>
- <param name="fileName">The string fileName to open</param>
- <returns>An IRaster with the data from the file specified in an open file dialog</returns>
- </member>
- <member name="M:DotSpatial.Symbology.ILayerManager.OpenVectorLayer(System.String)">
- <summary>
- This attempts to open the specified vector file and returns an associated layer
- </summary>
- <param name="fileName">the string fileName to open</param>
- <returns>An IFeatureSet with the data from the file specified in a dialog</returns>
- </member>
- <member name="M:DotSpatial.Symbology.ILayerManager.CreateRasterLayer(System.String,System.String,System.Int32,System.Int32,System.Int32,System.Type,System.String[])">
- <summary>
- This create new method implies that this provider has the priority for creating a new file.
- An instance of the dataset should be created and then returned. By this time, the fileName
- will already be checked to see if it exists, and deleted if the user wants to overwrite it.
- </summary>
- <param name="name">The string fileName for the new instance</param>
- <param name="driverCode">The string short name of the driver for creating the raster</param>
- <param name="xSize">The number of columns in the raster</param>
- <param name="ySize">The number of rows in the raster</param>
- <param name="numBands">The number of bands to create in the raster</param>
- <param name="dataType">The data type to use for the raster</param>
- <param name="options">The options to be used.</param>
- <returns>An IRaster</returns>
- </member>
- <member name="M:DotSpatial.Symbology.ILayerManager.GetSupportedExtensions(System.String)">
- <summary>
- Checks a dialog filter and returns a list of just the extensions.
- </summary>
- <param name="dialogFilter">The Dialog Filter to read extensions from</param>
- <returns>A list of extensions</returns>
- </member>
- <member name="M:DotSpatial.Symbology.ILayerManager.LoadProvidersFromAssembly(System.String)">
- <summary>
- Given a string fileName for the "*.dll" file, this will attempt to load any classes that implement the
- IDataProvder interface.
- </summary>
- <param name="fileName">The string path of the assembly to load from.</param>
- <returns>A list that contains only the providers that were just loaded. This may be a list of count 0, but shouldn't return null.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.ILayerManager.LoadProvidersFromDirectories">
- <summary>
- This should be called once all the permitted directories have been set in the code.
- This will not affect the PreferredProviders or the general list of Providers.
- These automatically have the lowest priority and will only be used if nothing
- else works. Use the PreferredProviders to force preferential loading of
- a plugin DataProvider.
- </summary>
- <returns>A list of just the newly added DataProviders from this method.</returns>
- </member>
- <member name="E:DotSpatial.Symbology.ILayerManager.DirectoryProvidersLoaded">
- <summary>
- Occurs after the directory providers have been loaded into the project.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILayerManager.ActiveProjectLayers">
- <summary>
- Gets or sets a temporary list of active project layers. This is designed to house
- the layers from a map frame when the property grids are shown for layers in that
- map frame. This list on the DefaultLayerManager is what is used to create the
- list that populates dropdowns that can take a Layer as a parameter.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILayerManager.LayerProviders">
- <summary>
- Gets or sets the list of IDataProviders that should be used in the project.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILayerManager.LayerProviderDirectories">
- <summary>
- Gets or sets the path (either as a full path or as a path relative to
- the DotSpatial.dll) to search for plugins that implement the IDataProvider interface.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILayerManager.DialogReadFilter">
- <summary>
- Gets or sets the dialog read filter to use for opening data files.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILayerManager.DialogWriteFilter">
- <summary>
- Gets or sets the dialog write filter to use for saving data files.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILayerManager.LoadInRam">
- <summary>
- Sets the default condition for how this data manager should try to load layers.
- This will be overridden if the inRam property is specified as a parameter.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILayerManager.RasterReadFilter">
- <summary>
- Gets or sets the dialog read filter to use for opening data files that are specifically raster formats.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILayerManager.RasterWriteFilter">
- <summary>
- Gets or sets the dialog write filter to use for saving raster files.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILayerManager.VectorReadFilter">
- <summary>
- Gets or sets the dialog read filter to use for opening vector files.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILayerManager.VectorWriteFilter">
- <summary>
- Gets or sets the dialog write filter to use for saving vector files.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILayerManager.PreferredProviders">
- <summary>
- Gets or sets a dictionary of IDataProviders keyed by the extension. The
- standard order is to try to load the data using a PreferredProvider. If that
- fails, then it will check the list of dataProviders, and finally, if that fails,
- it will check the plugin Data Providers in directories.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILayerManager.ProgressHandler">
- <summary>
- Gets or sets a progress handler for any open operations that are intiated by this
- DataManager.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ImageProjection.#ctor(DotSpatial.Data.Extent,System.Drawing.Rectangle)">
- <summary>
- Creates a new instance of the ImageGraphics class for assisting with drawing.
- </summary>
- <param name="inExtent"></param>
- <param name="inDestRectangle"></param>
- </member>
- <member name="P:DotSpatial.Symbology.ImageProjection.ImageRectangle">
- <summary>
- The destination rectangle on the bitmap where drawing should occur.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ImageProjection.GeographicExtents">
- <summary>
- The geographic extents where drawing will take place.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.SymbologyImages">
- <summary>
- A strongly-typed resource class, for looking up localized strings, etc.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyImages.ResourceManager">
- <summary>
- Returns the cached ResourceManager instance used by this class.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyImages.Culture">
- <summary>
- Overrides the current thread's CurrentUICulture property for all
- resource lookups using this strongly typed resource class.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IImageLayer">
- <summary>
- IImageLayer
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IImageLayer.Symbolizer">
- <summary>
- Gets or sets a class that has some basic parameters that control how the image layer
- is drawn.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IImageLayer.DataSet">
- <summary>
- Gets or sets the dataset specifically as an IImageData object
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IImageLayer.Image">
- <summary>
- Gets or sets the image being drawn by this layer
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IImageSymbolizer">
- <summary>
- IImageSymbolizer
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IImageSymbolizer.Opacity">
- <summary>
- Gets or sets a float value from 0 to 1, where 1 is fully opaque while 0 is fully transparent
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.ImageLayer">
- <summary>
- GeoImageLayer
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ImageLayer.#ctor">
- <summary>
- Creates a blank image layer that needs to be configured later.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ImageLayer.#ctor(System.String)">
- <summary>
- Creates a new instance of the ImageLayer by opening the specified fileName
- </summary>
- <param name="fileName"></param>
- </member>
- <member name="M:DotSpatial.Symbology.ImageLayer.#ctor(System.String,DotSpatial.Data.IProgressHandler,System.Collections.Generic.ICollection{DotSpatial.Symbology.ILayer})">
- <summary>
- Creates a new instance of the ImageLayer by opening the specified fileName, relaying progress to the
- specified handler, and automatically adds the new layer to the specified container.
- </summary>
- <param name="fileName">The fileName to open</param>
- <param name="progressHandler">A ProgressHandler that can receive progress updates</param>
- <param name="container">The layer list that should contain this image layer</param>
- </member>
- <member name="M:DotSpatial.Symbology.ImageLayer.#ctor(System.String,DotSpatial.Data.IProgressHandler)">
- <summary>
- Creates a new instance of the image layer by opening the specified fileName and
- relaying progress to the specified handler.
- </summary>
- <param name="fileName">The fileName to open</param>
- <param name="progressHandler">The progressHandler</param>
- </member>
- <member name="M:DotSpatial.Symbology.ImageLayer.#ctor(DotSpatial.Data.IImageData)">
- <summary>
- Creates a new instance of GeoImageLayer
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ImageLayer.#ctor(DotSpatial.Data.IImageData,System.Collections.Generic.ICollection{DotSpatial.Symbology.ILayer})">
- <summary>
- Creates a new instance of a GeoImageLayer
- </summary>
- <param name="baseImage">The image to draw as a layer</param>
- <param name="container">The Layers collection that keeps track of the image layer</param>
- </member>
- <member name="M:DotSpatial.Symbology.ImageLayer.OnShowProperties(System.ComponentModel.HandledEventArgs)">
- <summary>
- Handles when this layer should show its properties by firing the event on the shared event sender
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.ImageLayer.OnExportData">
- <summary>
- Handles export data from this layer.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ImageLayer.Dispose(System.Boolean)">
- <summary>
- Dispose memory objects.
- </summary>
- <param name="disposeManagedResources">True if managed memory objects should be set to null.</param>
- </member>
- <member name="P:DotSpatial.Symbology.ImageLayer.DataSet">
- <summary>
- Gets or sets the underlying data for this object
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ImageLayer.Extent">
- <summary>
- Gets the geographic bounding envelope for the image
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ImageLayer.Symbolizer">
- <summary>
- Gets or sets a class that has some basic parameters that control how the image layer
- is drawn.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ImageLayer.Image">
- <summary>
- Gets or sets the image being drawn by this layer
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ImageLayer.ImageLayerActions">
- <summary>
- Gets or sets custom actions for ImageLayer
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ImageSymbolizer.Opacity">
- <summary>
- Gets or sets a float value from 0 to 1, where 1 is fully opaque while 0 is fully transparent.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.ITiledImageLayer">
- <summary>
- ITiledImageLayer
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ITiledImageLayer.DataSet">
- <summary>
- Gets or sets the TiledImage that supports the tile data for this image.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.TiledImageLayer">
- <summary>
- TiledImageLayer
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.TiledImageLayer.#ctor(DotSpatial.Data.ITiledImage)">
- <summary>
- Creates a new instance of TiledImageLayer
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.TiledImageLayer.Extent">
- <summary>
- The bounding envelope of the image layer
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.TiledImageLayer.DataSet">
- <summary>
- The tiled image dataset
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IPropertyDialogProvider">
- <summary>
- IPropertyDialogProvider
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IPropertyDialogProvider.ShowDialog(System.Object)">
- <summary>
- Shows a PropertyGrid Dialog and uses the specified object as the edit copy.
- </summary>
- <param name="editCopy">A clone of the actual object to be edited. This should not be the original object.</param>
- </member>
- <member name="E:DotSpatial.Symbology.IPropertyDialogProvider.ChangesApplied">
- <summary>
- Fires an event signifying that the item has been updated
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IPropertyDialogProvider.ChangeItem">
- <summary>
- Gets the item that was changed by this operation.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IScheme">
- <summary>
- IScheme
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IScheme.AddCategory(DotSpatial.Symbology.ICategory)">
- <summary>
- Adds a new scheme, assuming that the new scheme is the correct type.
- </summary>
- <param name="category">The category to add</param>
- </member>
- <member name="M:DotSpatial.Symbology.IScheme.ApplySnapping(DotSpatial.Symbology.ICategory)">
- <summary>
- Applies the snapping rule directly to the categories, based on the most recently
- collected set of values, and the current VectorEditorSettings.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IScheme.CreateNewCategory(System.Drawing.Color,System.Double)">
- <summary>
- Creates the category using a random fill color
- </summary>
- <param name="fillColor">The base color to use for creating the category</param>
- <param name="size">For points this is the maximal point size, for lines this is the maximum line width</param>
- <returns>A new IFeatureCategory that matches the type of this scheme</returns>
- </member>
- <member name="M:DotSpatial.Symbology.IScheme.CreateRandomCategory">
- <summary>
- Uses the settings on this scheme to create a random category.
- </summary>
- <returns>A new ICategory</returns>
- </member>
- <member name="M:DotSpatial.Symbology.IScheme.DecreaseCategoryIndex(DotSpatial.Symbology.ICategory)">
- <summary>
- Reduces the index value of the specified category by 1 by
- exchaning it with the category before it. If there is no
- category before it, then this does nothing.
- </summary>
- /// <param name="category">The category to decrease the index of</param>
- </member>
- <member name="M:DotSpatial.Symbology.IScheme.DrawCategory(System.Int32,System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Draws the regular symbolizer for the specified cateogry to the specified graphics
- surface in the specified bounding rectangle.
- </summary>
- <param name="index">The integer index of the feature to draw.</param>
- <param name="g">The Graphics object to draw to</param>
- <param name="bounds">The rectangular bounds to draw in</param>
- </member>
- <member name="M:DotSpatial.Symbology.IScheme.IncreaseCategoryIndex(DotSpatial.Symbology.ICategory)">
- <summary>
- Re-orders the specified member by attempting to exchange it with the next higher
- index category. If there is no higher index, this does nothing.
- </summary>
- <param name="category">The category to increase the index of</param>
- </member>
- <member name="M:DotSpatial.Symbology.IScheme.InsertCategory(System.Int32,DotSpatial.Symbology.ICategory)">
- <summary>
- Inserts the category at the specified index
- </summary>
- <param name="index">The integer index where the category should be inserted</param>
- <param name="category">The category to insert</param>
- </member>
- <member name="M:DotSpatial.Symbology.IScheme.RemoveCategory(DotSpatial.Symbology.ICategory)">
- <summary>
- Removes the specified category
- </summary>
- <param name="category">The category to insert</param>
- </member>
- <member name="M:DotSpatial.Symbology.IScheme.SuspendEvents">
- <summary>
- Suspends the category events
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IScheme.ResumeEvents">
- <summary>
- Resumes the category events
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IScheme.ClearCategories">
- <summary>
- Clears the categories
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IScheme.EditorSettings">
- <summary>
- Gets or sets the editor settings that control how this scheme operates.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IScheme.Statistics">
- <summary>
- This is cached until a GetValues call is made, at which time the statistics will
- be re-calculated from the values.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IScheme.Values">
- <summary>
- Gets the current list of values calculated in the case of numeric breaks.
- This includes only members that are not excluded by the exclude expression,
- and have a valid numeric value.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.ISymbolRange">
- <summary>
- Characterizes
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ISymbolRange.IsInRange(System.IComparable)">
- <summary>
- Boolean Tests a value against the minimum and maximum values.
- If the value is greater than or equal to the MinValue and
- is less than or equal to the MaxValue then it will be included.
- </summary>
- <param name="value">The IComparable value to test. This is usually a numeric value.</param>
- <returns>True if value is between MinValue and MaxValue</returns>
- </member>
- <member name="M:DotSpatial.Symbology.ISymbolRange.MatchesClassification(System.IComparable)">
- <summary>
- The classification must implement IComparable. The normal value types like
- strings, doubles and integers already do this. If the CompareTo method
- on value returns 0 when compared to the Classification property of this
- instance, this method will return true. Otherwise, it returns false.
- </summary>
- <param name="value">Any valid implementation of IComparable. This can be either
- the default value types like integer or string, or else it can be a custom
- implementation of IComparable.</param>
- <returns>Boolean, true if value.CompareTo returns 0 when compared against this classification.</returns>
- </member>
- <member name="P:DotSpatial.Symbology.ISymbolRange.Minimum">
- <summary>
- The minimum value, inclusive, in a range of values. If
- the value being tested is less than this value,
- then these properties should not be applied.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ISymbolRange.Maximum">
- <summary>
- Describes the maximum value, inclusive, in a range of values. If
- the value being tested is greater than this value, then these
- properties should not be applied.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ISymbolRange.Classification">
- <summary>
- The classification for this symbol. This is the same as
- specifying the MinValue and MaxValue to be equal and testing
- the IsInRange property.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IView">
- <summary>
- A smaller interface that just gives the user enough control to draw on a map surface
- without giving them the ability to change the base control.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IView.Pan(System.Int32,System.Int32)">
- <summary>
- Causes the view to shift in geographic coordinates by the specified dX and dY.
- The geographic width and height of the Extents will remain the same, as
- will the aspect ratio.
- </summary>
- <param name="dX">Double specifying the pixel change in X position</param>
- <param name="dY">Double specifying the pixel change in Y position</param>
- </member>
- <member name="M:DotSpatial.Symbology.IView.Zoom(System.Double)">
- <summary>
- Expands or shrinks the envelope so that it's new size is the specified
- percent of the previous size. The aspect ratio will be preserved.
- </summary>
- <param name="percent">The double percentage of the previous size</param>
- <example>
- Zoom in to a geographic extents half as large: Zoom(50);
- Zoom out to a geographic extents twice as large: Zoom(200);
- </example>
- </member>
- <member name="M:DotSpatial.Symbology.IView.PixelToProj(System.Int32,System.Int32,System.Double@,System.Double@)">
- <summary>
- Transforms a valid location on the screen (relative to the upper left corner of
- the map) into world coordinates (like longitude, latitude)
- </summary>
- <param name="pixelX">The integer pixel location relative to the left of the control </param>
- <param name="pixelY">The integer pixel location relative to the top of the control</param>
- <param name="x">The double horizontal or longitude coordinate</param>
- <param name="y">The double vertical or latitude coordinate</param>
- </member>
- <member name="M:DotSpatial.Symbology.IView.PixelToProj(System.Drawing.Point)">
- <summary>
- Transforms a valid location on the screen (relative to the upper left corner of
- the map) into world coordinates (like longitude, latitude)
- </summary>
- <param name="pixelPosition">A Point showing the PixelPosition</param>
- <returns>A Valid ICoordiante showing the location of the point in geographic coordinates</returns>
- </member>
- <member name="M:DotSpatial.Symbology.IView.PixelToProj(System.Drawing.Rectangle)">
- <summary>
- Transforms a valid location on the screen (relative to the upper left corner of
- the map) into world coordinates (like longitude, latitude)
- </summary>
- <param name="window">A Rectangle in pixel coordinates to find the geographic equivalent of</param>
- <returns>A Valid IEnvelope that shows the location on the screen</returns>
- </member>
- <member name="M:DotSpatial.Symbology.IView.ProjToPixel(System.Double,System.Double,System.Int32@,System.Int32@)">
- <summary>
- Transforms the specified world location (like latitude, longitude) into a
- valid screen location (measured in pixels from the upper left corner of the map)
- </summary>
- <param name="x">The double horizontal or longitude coordinate</param>
- <param name="y">The double vertical or latitude coordinate</param>
- <param name="pixelX">The integer pixel location relative to the left of the control </param>
- <param name="pixelY">The integer pixel location relative to the top of the control</param>
- </member>
- <member name="M:DotSpatial.Symbology.IView.ProjToPixel(DotSpatial.Topology.Coordinate)">
- <summary>
- Transforms the specified world location (like latitude, longitude) into a
- valid screen location (measured in pixels from the upper left corner of the map)
- </summary>
- <param name="coord"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.IView.ProjToPixel(DotSpatial.Data.Extent)">
- <summary>
- Transforms the specified world envelope (like latitude, longitude) into a
- valid screen rectangle (measured in pixels from the upper left corner of the map)
- </summary>
- <param name="env">The envelope in geographic coordinates</param>
- <returns>A Rectangle relative to the upper left corner of the control</returns>
- </member>
- <member name="P:DotSpatial.Symbology.IView.Graphics">
- <summary>
- Gets a graphics surface that is essentially the "white box" area of a map to draw on.
- By default the GraphicsUnit should be set to world and the PageScale and PageOffset
- should be set to the appropriate value for world coordinates.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IView.Extents">
- <summary>
- Gets the IEnvelope representing the world coordinate extents of the map
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.IView.ExtentsChanged">
- <summary>
- Occurs when the visible region being displayed on the map changes
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.FastLabelDrawnState">
- <summary>
- FastLabelDrawnState
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.FastLabelDrawnState.Category">
- <summary>
- Gets or sets the category
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.FastLabelDrawnState.Selected">
- <summary>
- Gets or sets whether the label is selected
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FastLabelDrawnState.#ctor(DotSpatial.Symbology.ILabelCategory)">
- <summary>
- Creates a new drawn state with the specified category
- </summary>
- <param name="category">The category</param>
- </member>
- <member name="T:DotSpatial.Symbology.ILabelCategory">
- <summary>
- ILabelCategory
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ILabelCategory.Copy">
- <summary>
- Returns a shallow copy of this object cast as a LabelCategory.
- </summary>
- <returns>A shallow copy of this object.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.ILabelCategory.CalculateExpression(System.Data.DataRow,System.Boolean,System.Int32)">
- <summary>
- Calculates the expression for the given row. The Expression.Columns have to be in sync with the Features columns for calculation to work without error.
- </summary>
- <param name="row">Datarow the expression gets calculated for.</param>
- <param name="selected">Indicates whether the feature is selected.</param>
- <param name="FID">The FID of the feature, the expression gets calculated for.</param>
- <returns>null if there was an error while parsing the expression, else the calculated expression</returns>
- </member>
- <member name="M:DotSpatial.Symbology.ILabelCategory.UpdateExpressionColumns(System.Data.DataColumnCollection)">
- <summary>
- Updates the Expression-Object with the columns that exist inside the features that belong to this category. The will be used for calculating the expression.
- </summary>
- <param name="columns">Columns that should be updated.</param>
- <returns>False if columns were not set.</returns>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelCategory.Expression">
- <summary>
- Gets or sets the string expression that controls the integration of field values into the label text.
- This is the raw text that is used to do calculations and concat fields and strings.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelCategory.FilterExpression">
- <summary>
- Gets or sets the string filter expression that controls which features
- that this should apply itself to.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelCategory.Name">
- <summary>
- Gets or sets the string name
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelCategory.Symbolizer">
- <summary>
- Gets or sets the text symbolizer to use for this category
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelCategory.SelectionSymbolizer">
- <summary>
- Gets or sets the text symbolizer to use for this category
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.ILabelLayer">
- <summary>
- ILabelLayer
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ILabelLayer.ClearSelection">
- <summary>
- Clears the current selection, reverting the geometries back to their
- normal colors.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ILabelLayer.CreateLabels">
- <summary>
- Expression creates the labels based on the given string expression. Field names in
- square brackets will be replaced by the values for those fields in the FeatureSet.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ILabelLayer.Invalidate">
- <summary>
- Invalidates any cached content for this layer.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ILabelLayer.Select(DotSpatial.Data.Extent)">
- <summary>
- Highlights the values from a specified region. This will not unselect any members,
- so if you want to select a new region instead of an old one, first use ClearSelection.
- This is the default selection that only tests the anchor point, not the entire label.
- </summary>
- <param name="region">An IEnvelope showing a 3D selection box for intersection testing.</param>
- <returns>True if any members were added to the current selection.</returns>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelLayer.FeatureSet">
- <summary>
- Gets or sets the featureSet that defines the text for the labels on this layer.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelLayer.FeatureLayer">
- <summary>
- Gets or sets an optional layer to link this layer to. If this is specified, then drawing will
- be associated with this layer.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelLayer.Symbology">
- <summary>
- Gets or sets the symbology
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelLayer.SelectionSymbolizer">
- <summary>
- Gets or sets the selection symbolizer from the first TextSymbol group.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelLayer.Symbolizer">
- <summary>
- Gets or sets the regular symbolizer from the first TextSymbol group.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.ILabelScheme">
- <summary>
- ILabelScheme
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ILabelScheme.AddCategory">
- <summary>
- Adds a category to the scheme, and also names the category with an integer that has not yet been used.
- </summary>
- <returns>A new category with a name that has not yet been used</returns>
- </member>
- <member name="M:DotSpatial.Symbology.ILabelScheme.Copy">
- <summary>
- returns a duplicate scheme, where the categories are copied, but
- the underlying featureset is not duplicated.
- </summary>
- <returns>A copy of this label scheme</returns>
- </member>
- <member name="M:DotSpatial.Symbology.ILabelScheme.Demote(DotSpatial.Symbology.ILabelCategory)">
- <summary>
- Attempts to reduce the integer index representing this categories rank in the
- list. By doing this, it will be drawn sooner, and therefore subsequent
- layers will be drawn on top of this layer, and so it reduces the categories
- priority. If this collection does not contain the category or it is already
- at index 0, this will return false.
- </summary>
- <param name="category">The ILabelCategory to demote</param>
- <returns>Boolean, true if the demotion was successful</returns>
- </member>
- <member name="M:DotSpatial.Symbology.ILabelScheme.Promote(DotSpatial.Symbology.ILabelCategory)">
- <summary>
- This attempts to increase the numeric index, which will cause it to be drawn later,
- or higher up on the cue, which means it will be drawn AFTER the previous layers,
- and therefore is a higher priority. If the category does not exist in the collection
- or the category is already at the highest value, this returns false.
- </summary>
- <param name="category">The category to promote if possible.</param>
- <returns>Boolean, true if the promotion was successful</returns>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelScheme.Categories">
- <summary>
- Gets or sets the list of categories that make up this label scheme
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.ILabelSymbolizer">
- <summary>
- ITextSymbolizer
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ILabelSymbolizer.GetFont">
- <summary>
- Uses the properties defined on this symbolizer to return a font.
- </summary>
- <returns>A new font</returns>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelSymbolizer.LineOrientation">
- <summary>
- Gets or sets the orientation of line labels.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelSymbolizer.UseLineOrientation">
- <summary>
- Gets or sets a boolean indicating whether or not the LineOrientation gets used.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelSymbolizer.LabelPlacementMethod">
- <summary>
- Gets or sets the labeling method
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelSymbolizer.LineLabelPlacementMethod">
- <summary>
- Gets or sets the labeling method
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelSymbolizer.PartsLabelingMethod">
- <summary>
- Gets or sets the way features with multiple parts are labeled
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelSymbolizer.Alignment">
- <summary>
- Gets or sets the the multi-line text alignment in the box.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelSymbolizer.Angle">
- <summary>
- Gets or set the angle that the font should be drawn in
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelSymbolizer.UseAngle">
- <summary>
- Gets or set a boolean indicating whether or not <see cref="P:DotSpatial.Symbology.ILabelSymbolizer.Angle"/> should be used
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelSymbolizer.LabelAngleField">
- <summary>
- Gets or set the field with angle to draw label
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelSymbolizer.UseLabelAngleField">
- <summary>
- Gets or set a boolean indicating whether or not <see cref="P:DotSpatial.Symbology.ILabelSymbolizer.LabelAngleField"/> should be used
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelSymbolizer.BackColor">
- <summary>
- Gets or sets the background color
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelSymbolizer.BackColorEnabled">
- <summary>
- Gets or sets a boolean indicating whether or not a background color should be used
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelSymbolizer.BorderColor">
- <summary>
- Gets or sets the border color
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelSymbolizer.BorderVisible">
- <summary>
- Gets or sets a boolean indicating whether or not a border should be drawn around the label.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelSymbolizer.DropShadowEnabled">
- <summary>
- Gets or sets a boolean that will force a shadow to be drawn if this is true.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelSymbolizer.DropShadowColor">
- <summary>
- Gets or sets the color of the actual shadow. Use the alpha channel to specify opacity.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelSymbolizer.DropShadowGeographicOffset">
- <summary>
- Gets or sets an X and Y geographic offset that is only used if ScaleMode is set to Geographic
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelSymbolizer.DropShadowPixelOffset">
- <summary>
- Gets or sets an X and Y pixel offset that is used if the ScaleMode is set to Symbolic or Simple.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelSymbolizer.FontFamily">
- <summary>
- Gets or sets the string font family name
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelSymbolizer.FontSize">
- <summary>
- gets or sets the font size
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelSymbolizer.FontStyle">
- <summary>
- Gets or sets the font style.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelSymbolizer.FontColor">
- <summary>
- Gets or set the color that the font should be drawn in.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelSymbolizer.HaloEnabled">
- <summary>
- Gets or sets a boolean that governs whether or not to draw a halo.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelSymbolizer.HaloColor">
- <summary>
- Gets or sets the color of the halo that surrounds the text.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelSymbolizer.OffsetX">
- <summary>
- Gets or sets the X offset in pixels from the center of each feature.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelSymbolizer.OffsetY">
- <summary>
- Gets or sets the Y offset in pixels from the center of each feature.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelSymbolizer.PreventCollisions">
- <summary>
- Gets or sets a boolean. If true, as high priority labels are placed, they
- take up space and will not allow low priority labels that conflict for the
- space to be placed.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelSymbolizer.PriorityField">
- <summary>
- Gets or sets the string field name for the field that controls which labels
- get placed first. If collision detection is on, a higher priority means
- will get placed first. If it is off, higher priority will be labeled
- on top of lower priority.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelSymbolizer.PrioritizeLowValues">
- <summary>
- Gets or sets a boolean. Normally high values from the field are given
- a higher priority. If this is true, low values are given priority instead.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelSymbolizer.Orientation">
- <summary>
- Gets or sets the position of the label relative to the placement point
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelSymbolizer.ScaleMode">
- <summary>
- Gets or sets the scaling behavior for the text
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILabelSymbolizer.FloatingFormat">
- <summary>
- Gets or sets format string used to draw float fields. E.g.:
- #.##, 0.000. If empty - then format not used.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LabelCategory.#ctor">
- <summary>
- Creates a new instance of LabelCategory
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LabelCategory.Clone">
- <summary>
- Returns the Copy() method cast as an object.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.LabelCategory.Copy">
- <summary>
- Returns a shallow copy of this category with the exception of
- the TextSymbolizer, which is duplicated. This uses memberwise
- clone, so sublcasses using this method will return an appropriate
- version.
- </summary>
- <returns>A shallow copy of this object.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.LabelCategory.UpdateExpressionColumns(System.Data.DataColumnCollection)">
- <summary>
- Updates the Expression-Object with the columns that exist inside the features that belong to this category. They are used for calculating the expression.
- </summary>
- <param name="columns">Columns that should be updated.</param>
- <returns>False if columns were not set.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.LabelCategory.CalculateExpression(System.Data.DataRow,System.Boolean,System.Int32)">
- <summary>
- Calculates the expression for the given row. The Expression.Columns have to be in sync with the Features columns for calculation to work without error.
- </summary>
- <param name="row">Datarow the expression gets calculated for.</param>
- <param name="selected">Indicates whether the feature is selected.</param>
- <param name="FID">The FID of the feature, the expression gets calculated for.</param>
- <returns>null if there was an error while parsing the expression, else the calculated expression</returns>
- </member>
- <member name="P:DotSpatial.Symbology.LabelCategory.FilterExpression">
- <summary>
- Gets or sets the string filter expression that controls which features
- that this should apply itself to.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelCategory.Expression">
- <summary>
- Gets or sets the string expression that controls the integration of field values into the label text.
- This is the raw text that is used to do calculations and concat fields and strings.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelCategory.Name">
- <summary>
- Gets or sets the string name
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelCategory.Symbolizer">
- <summary>
- Gets or sets the text symbolizer to use for this category
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelCategory.SelectionSymbolizer">
- <summary>
- Gets or sets the text symbolizer to use for this category
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.LabelDrawState">
- <summary>
- LabelDrawState
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.LabelDrawState.Category">
- <summary>
- A LabelCategory interface representing the drawing information for this label.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.LabelDrawState.Selected">
- <summary>
- A boolean indicating whether or not this is selected.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.LabelDrawState.Visible">
- <summary>
- A boolean indicating whether the associated feature should be drawn.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LabelDrawState.#ctor(DotSpatial.Symbology.ILabelCategory)">
- <summary>
- Creates a new instance of the LabelDrawState class where selected is false
- but visible is true.
- </summary>
- <param name="category">The category</param>
- </member>
- <member name="M:DotSpatial.Symbology.LabelDrawState.#ctor(DotSpatial.Symbology.ILabelCategory,System.Boolean,System.Boolean)">
- <summary>
- Creates a new instance of the LabelDrawState based on the specified parameters.
- </summary>
- <param name="category">The category</param>
- <param name="selected">Boolean, true if the label is selected</param>
- <param name="visible">Boolean, true if the label should be visible</param>
- </member>
- <member name="T:DotSpatial.Symbology.LabelLayer">
- <summary>
- LabelLayer
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LabelLayer.#ctor">
- <summary>
- Creates a new instance of LabelLayer
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LabelLayer.#ctor(DotSpatial.Data.IFeatureSet)">
- <summary>
- Creates a new layer that uses the attributes from the given featureSet
- </summary>
- <param name="inFeatureSet"></param>
- </member>
- <member name="M:DotSpatial.Symbology.LabelLayer.#ctor(DotSpatial.Symbology.IFeatureLayer)">
- <summary>
- Creates a new label layer based on the features in the
- </summary>
- <param name="inFeatureLayer"></param>
- </member>
- <member name="M:DotSpatial.Symbology.LabelLayer.ClearSelection">
- <summary>
- Clears the current selection, reverting the geometries back to their
- normal colors.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LabelLayer.CreateLabels">
- <summary>
- This builds the _drawnStates based on the current label scheme.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LabelLayer.Select(DotSpatial.Data.Extent)">
- <summary>
- Highlights the values from a specified region. This will not unselect any members,
- so if you want to select a new region instead of an old one, first use ClearSelection.
- This is the default selection that only tests the anchor point, not the entire label.
- </summary>
- <param name="region">An IEnvelope showing a 3D selection box for intersection testing.</param>
- <returns>True if any members were added to the current selection.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.LabelLayer.CreateIndexedLabels">
- <summary>
- This builds the _drawnStates based on the current label scheme.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LabelLayer.UnSelect(DotSpatial.Data.Extent)">
- <summary>
- Removes the features in the given region
- </summary>
- <param name="region">the geographic region to remove the feature from the selection on this layer</param>
- <returns>Boolean true if any features were removed from the selection.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.LabelLayer.OnSelectionCleared(DotSpatial.Symbology.FeatureChangeArgs)">
- <summary>
- Fires the selection cleared event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LabelLayer.OnSelectionExtended(DotSpatial.Symbology.FeatureChangeEnvelopeArgs)">
- <summary>
- Fires the selection extended event
- </summary>
- <param name="args"></param>
- </member>
- <member name="E:DotSpatial.Symbology.LabelLayer.SelectionCleared">
- <summary>
- Occurs after the selection has been cleared
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.LabelLayer.SelectionExtended">
- <summary>
- Occurs after the selection is updated by the addition of new members
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelLayer.DrawnStates">
- <summary>
- Gets or sets the dictionary that quickly identifies the category for
- each label.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelLayer.FastDrawnStates">
- <summary>
- Gets or sets the indexed collection of drawn states
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelLayer.Labels">
- <summary>
- Gets or sets a valid IList of ILabels. This can just be a List of labels, but allows for
- custom list development later.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelLayer.FeatureSet">
- <summary>
- Gets or sets the featureSet that defines the text for the labels on this layer.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelLayer.FeatureLayer">
- <summary>
- Gets or sets an optional layer to link this layer to. If this is specified, then drawing will
- be associated with this layer. This also updates the FeatureSet property.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelLayer.Symbology">
- <summary>
- Gets or sets the labeling scheme as a collection of categories.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelLayer.SelectionSymbolizer">
- <summary>
- Gets or sets the selection symbolizer from the first TextSymbol group.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelLayer.Symbolizer">
- <summary>
- Gets or sets the regular symbolizer from the first TextSymbol group.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.LabelPlacementMethod">
- <summary>
- Methods used in calculating the placement of a label.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.LabelPlacementMethod.Centroid">
- <summary>
- Use the centroid of the feature.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.LabelPlacementMethod.Center">
- <summary>
- Use the center of the extents of the feature.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.LabelPlacementMethod.InteriorPoint">
- <summary>
- Use the closest point to the centroid that is in the feature.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.LineOrientation.Parallel">
- <summary>
- Orientation of the line label is parallel to the line at the PlacementPosition.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.LineOrientation.Perpendicular">
- <summary>
- Orientation of the line label is perpendicular to the line at the PlacementPosition.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.LineLabelPlacementMethod">
- <summary>
- Methods used to calculate the placement of line labels.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.LineLabelPlacementMethod.LongestSegment">
- <summary>
- Uses the longest segment of the LineString.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.LineLabelPlacementMethod.FirstSegment">
- <summary>
- Uses the first segment of the LineString.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.LineLabelPlacementMethod.MiddleSegment">
- <summary>
- Uses the middle segment of the LineString.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.LineLabelPlacementMethod.LastSegment">
- <summary>
- Uses the last segment of the LineString.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.PartLabelingMethod">
- <summary>
- Determines if all parts should be labeled or just the largest.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.PartLabelingMethod.LabelAllParts">
- <summary>
- Label all parts.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.PartLabelingMethod.LabelLargestPart">
- <summary>
- Only label the largest part.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.LabelScheme">
- <summary>
- LabelScheme
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LabelScheme.#ctor">
- <summary>
- Creates a new instance of LabelScheme
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LabelScheme.AddCategory">
- <summary>
- Adds a category to the scheme, and also names the category with an integer that has not yet been used.
- </summary>
- <returns>A new category with a name that has not yet been used</returns>
- </member>
- <member name="M:DotSpatial.Symbology.LabelScheme.Clone">
- <summary>
- Returns the Copy, but as an object.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.LabelScheme.Demote(DotSpatial.Symbology.ILabelCategory)">
- <summary>
- Attempts to reduce the integer index representing this categories rank in the
- list. By doing this, it will be drawn sooner, and therefore subsequent
- layers will be drawn on top of this layer, and so it reduces the categories
- priority. If this collection does not contain the category or it is already
- at index 0, this will return false.
- </summary>
- <param name="category">The ILabelCategory to demote</param>
- <returns>Boolean, true if the demotion was successful</returns>
- </member>
- <member name="M:DotSpatial.Symbology.LabelScheme.Promote(DotSpatial.Symbology.ILabelCategory)">
- <summary>
- This attempts to increase the numeric index, which will cause it to be drawn later,
- or higher up on the cue, which means it will be drawn AFTER the previous layers,
- and therefore is a higher priority. If the category does not exist in the collection
- or the category is already at the highest value, this returns false.
- </summary>
- <param name="category">The category to promote if possible.</param>
- <returns>Boolean, true if the promotion was successful</returns>
- </member>
- <member name="M:DotSpatial.Symbology.LabelScheme.Copy">
- <summary>
- The individual categories are copied, meaning that the text symbolizers
- will be new, and disconnected from the original text symbolizers of this
- scheme. MemberwiseClone is used so that any subclass members appended
- to this will be shallow copies unless this method is overridden.
- </summary>
- <returns>A Duplicate LabelScheme, but with new, duplicated categories and symbolizers</returns>
- </member>
- <member name="P:DotSpatial.Symbology.LabelScheme.Categories">
- <summary>
- Gets or sets the Categories
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LabelSymbolizer.#ctor">
- <summary>
- Creates a new instance of TextSymbolizer
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LabelSymbolizer.GetFont">
- <summary>
- Uses the properties defined on this symbolizer to return a font.
- </summary>
- <returns>A new font</returns>
- </member>
- <member name="P:DotSpatial.Symbology.LabelSymbolizer.BackColorOpacity">
- <summary>
- Gets or sets the background color
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelSymbolizer.BorderColorOpacity">
- <summary>
- Gets or sets the border color
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelSymbolizer.FontColorOpacity">
- <summary>
- Gets or set the color that the font should be drawn in.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelSymbolizer.Alignment">
- <summary>
- Gets or sets the multi-line text alignment in the box. I.e., Control the positioning of the text within the rectangular bounds.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelSymbolizer.Angle">
- <summary>
- Gets or set the angle that the font should be drawn in
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelSymbolizer.UseAngle">
- <summary>
- Gets or set a boolean indicating whether or not <see cref="P:DotSpatial.Symbology.LabelSymbolizer.Angle"/> should be used
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelSymbolizer.LabelAngleField">
- <summary>
- Gets or set the field with angle to draw label
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelSymbolizer.UseLabelAngleField">
- <summary>
- Gets or set a boolean indicating whether or not <see cref="P:DotSpatial.Symbology.LabelSymbolizer.LabelAngleField"/> should be used
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelSymbolizer.BackColor">
- <summary>
- Gets or sets the background color
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelSymbolizer.BackColorEnabled">
- <summary>
- Gets or sets a boolean indicating whether or not a background color should be used
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelSymbolizer.BorderColor">
- <summary>
- Gets or sets the border color
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelSymbolizer.BorderVisible">
- <summary>
- Gets or sets a boolean indicating whether or not a border should be drawn around the label.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelSymbolizer.DropShadowEnabled">
- <summary>
- Gets or sets a boolean that will force a shadow to be drawn if this is true.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelSymbolizer.DropShadowColor">
- <summary>
- Gets or sets the color of the actual shadow. Use the alpha channel to specify opacity.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelSymbolizer.DropShadowGeographicOffset">
- <summary>
- Gets or sets an X and Y geographic offset that is only used if ScaleMode is set to Geographic
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelSymbolizer.DropShadowPixelOffset">
- <summary>
- Gets or sets an X and Y pixel offset that is used if the ScaleMode is set to Symbolic or Simple.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelSymbolizer.FloatingFormat">
- <summary>
- Gets or sets format string used to draw float fields. E.g.:
- #.##, 0.000. If empty - then format not used.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelSymbolizer.FontFamily">
- <summary>
- Gets or sets the string font family name
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelSymbolizer.FontSize">
- <summary>
- Gets or sets the font size
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelSymbolizer.FontStyle">
- <summary>
- Gets or sets the font style.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelSymbolizer.Orientation">
- <summary>
- Gets or sets the orientation relative to the placement point. I.e., Controls the position of the label relative to the feature.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelSymbolizer.FontColor">
- <summary>
- Gets or set the color that the font should be drawn in.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelSymbolizer.HaloEnabled">
- <summary>
- Gets or sets a boolean that governs whether or not to draw a halo.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelSymbolizer.HaloColor">
- <summary>
- Gets or sets the color of the halo that surrounds the text.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelSymbolizer.LabelPlacementMethod">
- <summary>
- Gets or sets the labeling method
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelSymbolizer.LineLabelPlacementMethod">
- <summary>
- Gets or sets the labeling method for line labels.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelSymbolizer.LineOrientation">
- <summary>
- Gets or sets the orientation of line labels.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelSymbolizer.PartsLabelingMethod">
- <summary>
- Gets or sets the way features with multiple parts are labeled
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelSymbolizer.OffsetX">
- <summary>
- Gets or sets the X offset in pixels from the center of each feature.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelSymbolizer.OffsetY">
- <summary>
- Gets or sets the Y offset in pixels from the center of each feature.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelSymbolizer.PreventCollisions">
- <summary>
- Gets or sets a boolean. If true, as high priority labels are placed, they
- take up space and will not allow low priority labels that conflict for the
- space to be placed.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelSymbolizer.PriorityField">
- <summary>
- Gets or sets the string field name for the field that controls which labels
- get placed first. If collision detection is on, a higher priority means
- will get placed first. If it is off, higher priority will be labeled
- on top of lower priority.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelSymbolizer.PrioritizeLowValues">
- <summary>
- Gets or sets a boolean. Normally high values from the field are given
- a higher priority. If this is true, low values are given priority instead.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelSymbolizer.ScaleMode">
- <summary>
- Gets or sets the scaling behavior for the text
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LabelSymbolizer.UseLineOrientation">
- <summary>
- Gets or sets a boolean indicating whether or not the LineOrientation gets used.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.LayerCollection">
- <summary>
- This extends the ChangeEventList by providing methods that allow access by an object Key, and will pass
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.LayerEventList`1">
- <summary>
- This extends the ChangeEventList by providing methods that allow access by an object Key, and will pass
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LayerEventList`1.SelectLayer(System.Int32)">
- <summary>
- This selects the layer with the specified integer index
- </summary>
- <param name="index">THe zero based integer index</param>
- </member>
- <member name="M:DotSpatial.Symbology.LayerEventList`1.Dispose">
- <summary>
- Standard Dispose implementation since layers are now disposable.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LayerEventList`1.LockDispose">
- <summary>
- Adds one request to prevent disposal of this object and its children.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LayerEventList`1.UnlockDispose">
- <summary>
- Removes one request to prevent disposal of this object and its children.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LayerEventList`1.OnInclude(`0)">
- <summary>
- Extends the event listeners to include events like ZoomToLayer and VisibleChanged
- </summary>
- <param name="item"></param>
- </member>
- <member name="M:DotSpatial.Symbology.LayerEventList`1.SelectableSelectionChanged(System.Object,System.EventArgs)">
- <summary>
-
- </summary>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.LayerEventList`1.OnSelectionChanged">
- <summary>
- Occurs when the selection is changed
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LayerEventList`1.OnIncludeComplete(`0)">
- <summary>
- Ensures that we re-draw the content when inserting new layers
- </summary>
- <param name="item"></param>
- </member>
- <member name="M:DotSpatial.Symbology.LayerEventList`1.OnExclude(`0)">
- <summary>
- Removes the extended event listeners once a layer is removed from this list.
- </summary>
- <param name="item"></param>
- </member>
- <member name="M:DotSpatial.Symbology.LayerEventList`1.OnLayerMoved(System.Object,DotSpatial.Symbology.LayerMovedEventArgs)">
- <summary>
- Fires the LayerMoved event.
- </summary>
- <param name="sender">The layer that was moved.</param>
- <param name="e">LayerEventArgs</param>
- </member>
- <member name="M:DotSpatial.Symbology.LayerEventList`1.OnLayerRemoved(`0)">
- <summary>
- Fires the LayerRemoved event.
- </summary>
- <param name="item"></param>
- </member>
- <member name="M:DotSpatial.Symbology.LayerEventList`1.OnLayerSelected(System.Int32)">
- <summary>
- Handles the default selection behavior and fires the LayerSelected event.
- </summary>
- <param name="index">The integer index of the layer being selected</param>
- </member>
- <member name="M:DotSpatial.Symbology.LayerEventList`1.OnLayerSelected(DotSpatial.Symbology.ILayer,System.Boolean)">
- <summary>
- Fires the LayerSelected event and adjusts the selected state of the layer.
- </summary>
- <param name="layer">The layer to select</param>
- <param name="selected">Boolean, true if the specified layer is selected</param>
- </member>
- <member name="M:DotSpatial.Symbology.LayerEventList`1.OnListChanged">
- <summary>
- Fires the ItemChanged event and the MembersChanged event and resets any cached lists
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LayerEventList`1.OnZoomToLayer(System.Object,DotSpatial.Symbology.EnvelopeArgs)">
- <summary>
- Fires the ZoomToLayer method when one of the layers fires its ZoomTo event
- </summary>
- <param name="sender">The layer to zoom to</param>
- <param name="e">The extent of the layer</param>
- </member>
- <member name="M:DotSpatial.Symbology.LayerEventList`1.OnLayerAdded(System.Object,DotSpatial.Symbology.LayerEventArgs)">
- <summary>
- Fires the LayerAdded event
- </summary>
- <param name="sender">The layer that was added</param>
- <param name="e">LayerEventArgs</param>
- </member>
- <member name="M:DotSpatial.Symbology.LayerEventList`1.OnSelectionChanging(System.Object,DotSpatial.Symbology.FeatureLayerSelectionEventArgs)">
- <summary>
- Fires the selection changed event
- </summary>
- <param name="sender">the object sender of the event</param>
- <param name="args">The FeatureLayerSelectionEventArgs of the layer</param>
- </member>
- <member name="M:DotSpatial.Symbology.LayerEventList`1.Finalize">
- <summary>
- Finalizes an instance of the LayerEventList class.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LayerEventList`1.Dispose(System.Boolean)">
- <summary>
- Overrides the dispose behavior. If disposeManagedMemory objects is true, then managed objects
- should be set to null, effectively removing reference counts. If it is false, then only
- unmanaged memory objects should be removed.
- </summary>
- <param name="disposeManagedMemory">Boolean, true if managed memory objects should be set to null, and
- if the Dispose method should be called on contained objects.</param>
- </member>
- <member name="E:DotSpatial.Symbology.LayerEventList`1.ZoomToLayer">
- <summary>
- Occurs if the maps should zoom to this layer.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.LayerEventList`1.LayerVisibleChanged">
- <summary>
- Occurs when one of the layers in this collection changes visibility.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.LayerEventList`1.LayerAdded">
- <summary>
- Occurs when a layer is added to this item.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.LayerEventList`1.LayerMoved">
- <summary>
- Occurs when a layer is moved.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.LayerEventList`1.LayerRemoved">
- <summary>
- Occurs when a layer is removed from this item.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.LayerEventList`1.LayerSelected">
- <summary>
- Occurs immediately after a layer is selected.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.LayerEventList`1.SelectionChanging">
- <summary>
- Occurs when the selection on a feature layer changes.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.LayerEventList`1.SelectionChanged">
- <summary>
- Occurs after the selection has changed, and all the layers have had their selection information updated.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LayerEventList`1.SelectedLayer">
- <summary>
- Gets the currently selected layer in this collection.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LayerEventList`1.Extent">
- <summary>
- The envelope that contains all of the layers for this data frame. Essentially this would be
- the extents to use if you want to zoom to the world view.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LayerEventList`1.IsDisposed">
- <summary>
- Gets a value indicating whether dispose has already been called on this object.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LayerEventList`1.IsDisposeLocked">
- <summary>
- Gets a value indicating whether there are requests to prevent disposal of this object.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LayerCollection.#ctor(DotSpatial.Symbology.IFrame)">
- <summary>
- Creates a new blank instance of a MapLayer collection. This is especially useful
- for tracking layers that can draw themselves. This does not concern itself with
- view extents like a dataframe, but rather is a grouping of layers that is itself
- also an IMapLayer.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LayerCollection.#ctor(DotSpatial.Symbology.IFrame,DotSpatial.Symbology.IGroup)">
- <summary>
- Creates a new layer collection where the parent group is different from the
- map frame.
- </summary>
- <param name="frame"></param>
- <param name="parent"></param>
- </member>
- <member name="M:DotSpatial.Symbology.LayerCollection.#ctor">
- <summary>
- Creates a LayerCollection that is not confined in a MapFrame
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LayerCollection.OnInclude(DotSpatial.Symbology.ILayer)">
- <summary>
- Occurs when wiring events
- </summary>
- <param name="item"></param>
- </member>
- <member name="M:DotSpatial.Symbology.LayerCollection.OnExclude(DotSpatial.Symbology.ILayer)">
- <summary>
- Occurs when unwiring events
- </summary>
- <param name="item"></param>
- </member>
- <member name="M:DotSpatial.Symbology.LayerCollection.OnMoved(DotSpatial.Symbology.ILayer,System.Int32)">
- <summary>
- Occurs when layer was moved.
- </summary>
- <param name="item">Layer that was moved.</param>
- <param name="newPosition">Position the layer was moved to.</param>
- </member>
- <member name="M:DotSpatial.Symbology.LayerCollection.UnusedName(System.String)">
- <summary>
- Given a base name, this increments a number for appending
- if the name already exists in the collection.
- </summary>
- <param name="baseName">The string base name to start with</param>
- <returns>The base name modified by a number making it unique in the collection</returns>
- </member>
- <member name="M:DotSpatial.Symbology.LayerCollection.IndexOf(DotSpatial.Symbology.ILegendItem)">
- <summary>
- Gets the index of the specified item in this collection if it is a layer
- </summary>
- <param name="item"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.LayerCollection.Insert(System.Int32,DotSpatial.Symbology.ILegendItem)">
- <summary>
- Inserts the specified item into this collection if it is a layer
- </summary>
- <param name="index"></param>
- <param name="item"></param>
- </member>
- <member name="M:DotSpatial.Symbology.LayerCollection.AddRange(System.Collections.Generic.IEnumerable{DotSpatial.Symbology.ILegendItem})">
- <summary>
- Adds a range of values
- </summary>
- <param name="collection"></param>
- </member>
- <member name="P:DotSpatial.Symbology.LayerCollection.Count">
- <summary>
- Gets the current count.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LayerCollection.MapFrame">
- <summary>
- Gets the map frame of this layer collection
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LayerCollection.ParentGroup">
- <summary>
- Gets or sets the ParentGroup for this layer collection, even if that parent group
- is not actually a map frame.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.LayerLegendEnumerator">
- <summary>
- LayerEnumerator
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LayerLegendEnumerator.#ctor(System.Collections.Generic.IEnumerator{DotSpatial.Symbology.ILayer})">
- <summary>
- Creates a new instance of LayerEnumerator
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LayerLegendEnumerator.Dispose">
- <summary>
- Calls the Dispose method
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LayerLegendEnumerator.MoveNext">
- <summary>
- Moves to the next member
- </summary>
- <returns>boolean, true if the enumerator was able to advance</returns>
- </member>
- <member name="M:DotSpatial.Symbology.LayerLegendEnumerator.Reset">
- <summary>
- Resets to before the first member
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LayerLegendEnumerator.Current">
- <summary>
- Retrieves the current member as an ILegendItem
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LayerLegendEnumerator.System#Collections#IEnumerator#Current">
- <summary>
- Returns the current member as an object
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LayerEventArgs.#ctor(DotSpatial.Symbology.ILayer)">
- <summary>
- Creates a new instance of LayerEventArgs
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LayerEventArgs.Layer">
- <summary>
- Gets a layer
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.LayerFrame">
- <summary>
- This is a class that organizes a list of renderable layers into a single "view" which might be
- shared by multiple displays. For instance, if you have a map control and a print preview control,
- you could draw the same data frame property on both, just by passing the graphics object for each.
- Be sure to handle any scaling or translation that you require through the Transform property
- of the graphics object as it will ultimately be that scale which is used to back-calculate the
- appropriate pixel sizes for point-size, line-width and other non-georeferenced characteristics.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LayerFrame.#ctor">
- <summary>
- The Constructor for the MapFrame object
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LayerFrame.#ctor(System.ComponentModel.IContainer)">
- <summary>
-
- </summary>
- <param name="container"></param>
- </member>
- <member name="M:DotSpatial.Symbology.LayerFrame.LegendSymbol_Painted(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Draws the layers icon to the legend
- </summary>
- <param name="g"></param>
- <param name="box"></param>
- </member>
- <member name="M:DotSpatial.Symbology.LayerFrame.SuspendExtentChanged">
- <summary>
- Suspends firing the ExtentsChanges event. It only fires if all suspension is gone.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LayerFrame.ResumeExtentChanged">
- <summary>
- Resumes firing the method, and will fire it automatically if any changes have occurred.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LayerFrame.Add(DotSpatial.Data.IFeatureSet)">
- <summary>
- This will create a new layer from the featureset and add it.
- </summary>
- <param name="featureSet">Any valid IFeatureSet that does not yet have drawing characteristics</param>
- </member>
- <member name="M:DotSpatial.Symbology.LayerFrame.Layers_ZoomToLayer(System.Object,DotSpatial.Symbology.EnvelopeArgs)">
- <summary>
- This adjusts the extents when ZoomToLayer is called in one of the internal layers.
- </summary>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.LayerFrame.Layers_LayerAdded(System.Object,DotSpatial.Symbology.LayerEventArgs)">
- <summary>
- Zooms to the envelope if no envelope has been established for this frame.
- </summary>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.LayerFrame.OnExtentsChanged(DotSpatial.Data.Extent)">
- <summary>
- Fires the ExtentsChanged event
- </summary>
- <param name="ext"></param>
- </member>
- <member name="M:DotSpatial.Symbology.LayerFrame.OnUpdateMap">
- <summary>
- Fires the ExtentsChanged event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LayerFrame.Handle_Layer_Events(DotSpatial.Symbology.ILayerEvents)">
- <summary>
- This is responsible for wiring the ZoomToLayer event from any layers
- in the map frame whenever the layer collection is changed.
- </summary>
- <param name="collection"></param>
- </member>
- <member name="M:DotSpatial.Symbology.LayerFrame.Ignore_Layer_Events(DotSpatial.Symbology.ILayerEvents)">
- <summary>
- This is responsible for unwiring the ZoomToLayer event.
- </summary>
- <param name="collection"></param>
- </member>
- <member name="E:DotSpatial.Symbology.LayerFrame.UpdateMap">
- <summary>
- Occurs when the visible region being displayed on the map should update
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.LayerFrame.ViewExtentsChanged">
- <summary>
- Occurs after zooming to a specific location on the map and causes a camera recent.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LayerFrame.DrawingLayers">
- <summary>
- Drawing layers are tracked separately, and do not appear in the legend.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LayerFrame.Extent">
- <summary>
- Overrides the default behavior for groups, which should return null in the
- event that they have no layers, with a more tolerant, getting started
- behavior where geographic coordinates are assumed.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LayerFrame.Parent">
- <summary>
- Gets the container control that this MapFrame belongs to.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LayerFrame.ExtentsInitialized">
- <inheritdoc />
- </member>
- <member name="P:DotSpatial.Symbology.LayerFrame.IsVisible">
- <summary>
- If this is false, then the drawing function will not render anything.
- Warning! This will also prevent any execution of calculations that take place
- as part of the drawing methods and will also abort the drawing methods of any
- sub-members to this IRenderable.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LayerFrame.SelectedLayer">
- <summary>
- Gets the currently selected layer. This will be an active layer that is used for operations.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LayerFrame.SmoothingMode">
- <summary>
- Controls the smoothing mode. Default or None will have faster performance
- at the cost of quality.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LayerFrame.ViewExtents">
- <summary>
- This should be the geographic extents visible in the map.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.LayerManager">
- <summary>
- This can be used as a component to work as a LayerManager. This also provides the
- very important DefaultLayerManager property, which is where the developer controls
- what LayerManager should be used for their project.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LayerManager.#ctor">
- <summary>
- Creates a new instance of the LayerManager class. A data manager is more or less
- just a list of data providers to use. The very important
- LayerManager.DefaultLayerManager property controls which LayerManager will be used
- to load data. By default, each LayerManager sets itself as the default in its
- constructor.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LayerManager.GetSupportedExtensions(System.String)">
- <summary>
- Checks a dialog filter and returns a list of just the extensions.
- </summary>
- <param name="dialogFilter">The Dialog Filter to read extensions from</param>
- <returns>A list of extensions</returns>
- </member>
- <member name="M:DotSpatial.Symbology.LayerManager.OpenRasterLayer">
- <summary>
- This opens a file, but populates the dialog filter with only raster formats.
- </summary>
- <returns>An IRaster with the data from the file specified in an open file dialog</returns>
- </member>
- <member name="M:DotSpatial.Symbology.LayerManager.OpenVectorLayer">
- <summary>
- This opens a file, but populates the dialog filter with only raster formats.
- </summary>
- <returns>An IFeatureSet with the data from the file specified in a dialog</returns>
- </member>
- <member name="M:DotSpatial.Symbology.LayerManager.OpenRasterLayer(System.String)">
- <summary>
- This attempts to open the specified raster file and returns an associated layer
- </summary>
- <param name="fileName">The string fileName to open</param>
- <returns>An IRaster with the data from the file specified in an open file dialog</returns>
- </member>
- <member name="M:DotSpatial.Symbology.LayerManager.OpenVectorLayer(System.String)">
- <summary>
- This attempts to open the specified vector file and returns an associated layer
- </summary>
- <param name="fileName">the string fileName to open</param>
- <returns>An IFeatureSet with the data from the file specified in a dialog</returns>
- </member>
- <member name="M:DotSpatial.Symbology.LayerManager.OpenLayer(System.Collections.Generic.ICollection{DotSpatial.Symbology.ILayer})">
- <summary>
- Opens a new layer and automatically adds it to the specified container.
- </summary>
- <param name="container">The container (usually a LayerCollection) to add to</param>
- <returns>The layer after it has been created and added to the container</returns>
- </member>
- <member name="M:DotSpatial.Symbology.LayerManager.OpenLayer(DotSpatial.Data.IProgressHandler)">
- <summary>
- This launches an open file dialog and attempts to load the specified file.
- </summary>
- <param name="progressHandler">Specifies the progressHandler to receive progress messages. This value overrides the property on this DataManager.</param>
- <returns>A Layer</returns>
- </member>
- <member name="M:DotSpatial.Symbology.LayerManager.OpenLayer">
- <summary>
- This launches an open file dialog and attempts to load the specified file.
- </summary>
- <returns>A Layer created from the file</returns>
- </member>
- <member name="M:DotSpatial.Symbology.LayerManager.OpenLayer(System.String)">
- <summary>
- Attempts to call the open fileName method for any ILayerProvider plugin
- that matches the extension on the string.
- </summary>
- <param name="fileName">A String fileName to attempt to open.</param>
- </member>
- <member name="M:DotSpatial.Symbology.LayerManager.OpenLayer(System.String,System.Collections.Generic.ICollection{DotSpatial.Symbology.ILayer})">
- <summary>
- Opens a new layer and automatically adds it to the specified container.
- </summary>
- <param name="fileName">A String fileName to attempt to open.</param>
- <param name="container">The container (usually a LayerCollection) to add to</param>
- <returns>The layer after it has been created and added to the container</returns>
- </member>
- <member name="M:DotSpatial.Symbology.LayerManager.OpenLayer(System.String,DotSpatial.Data.IProgressHandler)">
- <summary>
- This launches an open file dialog and attempts to load the specified file.
- </summary>
- <param name="fileName">A String fileName to attempt to open.</param>
- <param name="progressHandler">Specifies the progressHandler to receive progress messages. This value overrides the property on this DataManager.</param>
- <returns>A Layer</returns>
- </member>
- <member name="M:DotSpatial.Symbology.LayerManager.OpenLayer(System.String,System.Boolean,System.Collections.Generic.ICollection{DotSpatial.Symbology.ILayer},DotSpatial.Data.IProgressHandler)">
- <summary>
- Attempts to call the open fileName method for any ILayerProvider plugin
- that matches the extension on the string.
- </summary>
- <param name="fileName">A String fileName to attempt to open.</param>
- <param name="inRam">A boolean value that if true will attempt to force a load of the data into memory. This value overrides the property on this LayerManager.</param>
- <param name="container">A container to open this layer in</param>
- <param name="progressHandler">Specifies the progressHandler to receive progress messages. This value overrides the property on this LayerManager.</param>
- <returns>An ILayer</returns>
- </member>
- <member name="M:DotSpatial.Symbology.LayerManager.CreateRasterLayer(System.String,System.String,System.Int32,System.Int32,System.Int32,System.Type,System.String[])">
- <summary>
- This create new method implies that this provider has the priority for creating a new file.
- An instance of the dataset should be created and then returned. By this time, the fileName
- will already be checked to see if it exists, and deleted if the user wants to overwrite it.
- </summary>
- <param name="name">The string fileName for the new instance.</param>
- <param name="driverCode">The string short name of the driver for creating the raster.</param>
- <param name="xSize">The number of columns in the raster.</param>
- <param name="ySize">The number of rows in the raster.</param>
- <param name="numBands">The number of bands to create in the raster.</param>
- <param name="dataType">The data type to use for the raster.</param>
- <param name="options">The options to be used.</param>
- <returns>A new IRasterLayer.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.LayerManager.OpenImageLayer">
- <summary>
- This opens a file, but populates the dialog filter with only raster formats.
- </summary>
- <returns>for now an ILayerSet</returns>
- </member>
- <member name="M:DotSpatial.Symbology.LayerManager.OnProvidersLoaded(System.Collections.Generic.List{DotSpatial.Symbology.ILayerProvider})">
- <summary>
- Triggers the DirectoryProvidersLoaded event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LayerManager.LoadProvidersFromDirectories">
- <summary>
- This should be called once all the permitted directories have been set in the code.
- This will not affect the PreferredProviders or the general list of Providers.
- These automatically have the lowest priority and will only be used if nothing
- else works. Use the PreferredProviders to force preferential loading of
- a plugin LayerProvider.
- </summary>
- <returns>A list of just the newly added LayerProviders from this method.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.LayerManager.LoadProvidersFromAssembly(System.String)">
- <summary>
- Given a string fileName for the "*.dll" file, this will attempt to load any classes that implement the
- ILayerProvder interface.
- </summary>
- <param name="fileName">The string path of the assembly to load from.</param>
- <returns>A list that contains only the providers that were just loaded. This may be a list of count 0, but shouldn't return null.</returns>
- </member>
- <member name="P:DotSpatial.Symbology.LayerManager.DefaultLayerManager">
- <summary>
- Gets or sets the implemenation of ILayerManager for the project to use when
- accessing data. This is THE place where the LayerManager can be replaced
- by a different data manager. If you add this data manager to your
- project, this will automatically set itself as the DefaultLayerManager.
- However, since each DM will do this, you may have to control this manually
- if you add more than one LayerManager to the project in order to set the
- one that will be chosen.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LayerManager.ActiveProjectLayers">
- <summary>
- Gets or sets a temporary list of active project layers. This is designed to house
- the layers from a map frame when the property grids are shown for layers in that
- map frame. This list on the DefaultLayerManager is what is used to create the
- list that populates dropdowns that can take a Layer as a parameter.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LayerManager.ImageReadFilter">
- <summary>
- Gets or sets the dialog read filter to use for opening data files.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LayerManager.ImageWriteFilter">
- <summary>
- Gets or sets the dialog write filter to use for saving data files.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LayerManager.LayerProviders">
- <summary>
- Gets or sets the list of ILayerProviders that should be used in the project.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LayerManager.LayerProviderDirectories">
- <summary>
- Gets or sets the path (either as a full path or as a path relative to
- the DotSpatial.dll) to search for plugins that implement the ILayerProvider interface.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LayerManager.DialogReadFilter">
- <summary>
- Gets or sets the dialog read filter to use for opening data files.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LayerManager.DialogWriteFilter">
- <summary>
- Gets or sets the dialog write filter to use for saving data files.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LayerManager.RasterReadFilter">
- <summary>
- Gets or sets the dialog read filter to use for opening data files that are specifically raster formats.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LayerManager.RasterWriteFilter">
- <summary>
- Gets or sets the dialog write filter to use for saving data files.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LayerManager.VectorReadFilter">
- <summary>
- Gets or sets the dialog read filter to use for opening data files.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LayerManager.VectorWriteFilter">
- <summary>
- Gets or sets the dialog write filter to use for saving data files.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LayerManager.LoadInRam">
- <summary>
- Sets the default condition for how this data manager should try to load layers.
- This will be overridden if the inRam property is specified as a parameter.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LayerManager.PreferredProviders">
- <summary>
- Gets or sets a dictionary of ILayerProviders with corresponding extensions. The
- standard order is to try to load the data using a PreferredProvider. If that
- fails, then it will check the list of dataProviders, and finally, if that fails,
- it will check the plugin Layer Providers in directories.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LayerManager.ProgressHandler">
- <summary>
- Gets or sets a progress handler for any open operations that are intiated by this
- LayerManager and don't override this value with an IProgressHandler specified in the parameters.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.LayerManager.DirectoryProvidersLoaded">
- <summary>
- Occurs after the directory providers have been loaded into the project.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.LayerProviders">
- <summary>
- DataProviders
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LayerProviders.#ctor(System.Collections.Generic.List{DotSpatial.Symbology.ILayerProvider})">
- <summary>
- Creates a new instance of DataProviders
- </summary>
- <param name="providers">Specifies a list of IDataProviders</param>
- </member>
- <member name="P:DotSpatial.Symbology.LayerProviders.Providers">
- <summary>
- Gets the list of providers for this event.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LayerSelectedEventArgs.#ctor(DotSpatial.Symbology.ILayer,System.Boolean)">
- <summary>
- Creates a new instance of LayerEventArgs
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LayerSelectedEventArgs.IsSelected">
- <summary>
- Gets a boolean that indicates whether or not the layer is selected
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.LegendIcon">
- <summary>
- LegendIcon
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LegendIcon.#ctor">
- <summary>
- Creates a new instance of LegendIcon
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LegendIcon.GetLegendSymbolSize">
- <summary>
- Gets the legend symbol size (as an icon size)
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.LegendIcon.LegendSymbol_Painted(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Draws the icon to the legend
- </summary>
- <param name="g"></param>
- <param name="box"></param>
- </member>
- <member name="P:DotSpatial.Symbology.LegendIcon.Icon">
- <summary>
- The icon to draw for this legend item
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.LegendItemExt">
- <summary>
- Contains extension methods for ILegendItems
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LegendItemExt.GetValidContainerFor(DotSpatial.Symbology.ILegendItem,DotSpatial.Symbology.ILegendItem)">
- <summary>
- This method starts with this legend item and tests to see if it can contain
- the specified target. As it moves up the
- </summary>
- <param name="startItem">This legend item</param>
- <param name="dropItem">The target legend item to test</param>
- <returns>An ILegendItem that is one of the parent items of this item, but that can receive the target.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.LegendItemExt.InsertIndex(DotSpatial.Symbology.ILegendItem,DotSpatial.Symbology.ILegendItem)">
- <summary>
- Given the starting position, which might not be able to contain the drop item,
- determine the index in the valid container where this item should end up.
- </summary>
- <param name="startItem">The legend item that may not be a sibling or be able to contain the drop item</param>
- <param name="dropItem">The item being added to the legend</param>
- <returns>The integer index of the valid container where insertion should occur when dropping onto this item.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.LegendItemExt.BottomMember(DotSpatial.Symbology.ILegendItem)">
- <summary>
- Searches through the LegendItems recursively, looking for the 0 index
- member of the deepest part of the tree.
- </summary>
- <param name="self"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.LegendItemExt.ParentMapFrame(DotSpatial.Symbology.ILegendItem)">
- <summary>
- This method starts with this legend item and searches through the
- parent groups until it finds a valid mapframe.
- </summary>
- <param name="self">The ILegendItem to start from</param>
- <returns>The IMapFrame that contains this item.</returns>
- </member>
- <member name="T:DotSpatial.Symbology.LegendType">
- <summary>
- LegendType
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.LegendType.Scheme">
- <summary>
- Schemes can contain symbols and be contained by layers
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.LegendType.Custom">
- <summary>
- The ability to contain another layer type is controlled by CanReceiveItem instead
- of being specified by these pre-defined criteria.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.LegendType.Group">
- <summary>
- Groups can be contained by groups, and contain groups or layers, but not categories or symbols
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.LegendType.Layer">
- <summary>
- Layers can contain symbols or categories, but not other layers or groups
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.LegendType.Symbol">
- <summary>
- Symbols can't contain anything, but can be contained by layers and categories
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.MatchableEM">
- <summary>
- MatchableEM
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.MatchableEM.Matches(DotSpatial.Symbology.IMatchable,DotSpatial.Symbology.IMatchable)">
- <summary>
- This tests the public properties from the two objects. If any properties implement
- the IMatchable interface, and do not match, this returns false. If any public
- properties are value types, and they are not equal, then this returns false.
- </summary>
- <param name="self">This matchable item </param>
- <param name="other">The other item to compare to this item</param>
- <returns>Boolean, true if there is a match</returns>
- </member>
- <member name="T:DotSpatial.Symbology.SymbologyMenuItem">
- <summary>
- This class simply stores enough information for the appropriate menu item to be
- generated. It is not the Windows Forms MenuItem.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.SymbologyMenuItem.#ctor(System.String,System.Drawing.Image,System.EventHandler)">
- <summary>
- Creates a new instance of the menu item
- </summary>
- <param name="name">The name or text to appear for this item</param>
- <param name="image">The icon to draw for this menu item</param>
- <param name="clickHandler">The click event handler</param>
- </member>
- <member name="M:DotSpatial.Symbology.SymbologyMenuItem.#ctor(System.String,System.Drawing.Icon,System.EventHandler)">
- <summary>
- Creates a new instance of the menu item
- </summary>
- <param name="name">The name or text to appear for this item</param>
- <param name="icon">The icon to draw for this menu item</param>
- <param name="clickHandler">The click event handler</param>
- </member>
- <member name="M:DotSpatial.Symbology.SymbologyMenuItem.#ctor(System.String,System.EventHandler)">
- <summary>
- Creates a new instance of the menu item
- </summary>
- <param name="name">The name or text to appear for this item</param>
- <param name="clickHandler">The click event handler</param>
- </member>
- <member name="M:DotSpatial.Symbology.SymbologyMenuItem.#ctor(System.String)">
- <summary>
- Creates a new instance of the menu item
- </summary>
- <param name="name">The name or text to appear for this item</param>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMenuItem.Name">
- <summary>
- Gets or sets the name for this menu item
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMenuItem.Icon">
- <summary>
- Gets or sets the icon for this menu item
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMenuItem.Image">
- <summary>
- Gets or sets the image for this menu item
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMenuItem.MenuItems">
- <summary>
- Gets or sets the set of sub-menu items.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMenuItem.ClickHandler">
- <summary>
- The handler for the click event.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.SymbologyMessageStrings">
- <summary>
- Eine stark typisierte Ressourcenklasse zum Suchen von lokalisierten Zeichenfolgen usw.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.ResourceManager">
- <summary>
- Gibt die zwischengespeicherte ResourceManager-Instanz zurück, die von dieser Klasse verwendet wird.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.Culture">
- <summary>
- Überschreibt die CurrentUICulture-Eigenschaft des aktuellen Threads für alle
- Ressourcenzuordnungen, die diese stark typisierte Ressourcenklasse verwenden.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.Data">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die Data ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.DesktopRasterExt_CreatingShadedRelief">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die Creating Shaded Relief ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.DesktopRasterExt_PaintingColorScheme">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die Painting color scheme to bitmap. ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.DesktopRasterExt_PaintingHillshade">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die Painting Hillshade To Bitmap ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.ExportData">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die Export Data ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.Expression_ClosingBracket">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die The closing bracket wasn't found. ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.Expression_Empty">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die The expression is empty. ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.Expression_EmptyField">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die The expression contains empty fields. ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.Expression_FieldNotFound">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die The following field wasn't found: ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.Expression_LeftOperandMissing">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die No left operand was found. ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.Expression_NotANumber">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die The value is not a number: ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.Expression_OperandExpected">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die Expected operand. Found character {0} at position {1}. ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.Expression_OperationNotFound">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die Failed to find operation. ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.Expression_OperationNotSupported">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die Operation not supported. ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.Expression_OperatorExprected">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die Expected operator. Found character {0} at position {1}. ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.Expression_OpereratorInsteadOfValue">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die There is an operator in place of a value. ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.Expression_PlusNotAllowed">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die + operation isn't allowed for boolean values. ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.Expression_RightOperandMissing">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die No right operand was found. ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.Expression_UnpairedBracket">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die The expression contains unpaired square brackets. ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.Expression_UnpairedTextquotes">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die The expression contains unpaired text quotes. ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.Expression_ZeroDivision">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die Division by zero. ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.FeatureLayer_Create_Layer_From_Selected_Features">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die Create Layer from Selected Features ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.FeatureLayer_Join_Excel_File">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die Join Excel file 'Data' Label ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.FeatureLayer_Label_Setup">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die Label Setup ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.FeatureLayer_Labeling">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die Labeling ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.FeatureLayer_SelectAll">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die Select All ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.FeatureLayer_Selection">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die Selection ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.FeatureLayer_UnselectAll">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die Unselect All ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.FeatureLayer_Zoom_To_Selected">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die Zoom to Selected Features ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.FileCantBeDeletedException_S">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die The file %S can't be deleted, probably because it is currently in use by another application. ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.Layer_Properties">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die Properties ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.LayerFrame_CreateGroup">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die Create Group ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.LayerFrame_Map_Layers">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die Map Layers ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.LayerFrame_RemoveMapFrame">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die Remove Map Frame ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.LayerFrame_ZoomToMapFrame">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die Zoom to Map Frame ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.LayerManager_FileTypeNotSupported">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die The specified file type is not supported. ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.LineFeatureTypeException">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die An incompatible feature type was supplied and was not of type Line. ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.NullLogException_S">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die The argument %S cannot be null. ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.PointFeatureTypeException">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die An incompatible feature type was supplied and was not of type Point. ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.PolygonFeatureTypeException">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die An incompatible feature type was supplied and was not of type polygon. ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.Properties">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die Properties ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.RemoveLayer">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die Remove Layer ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.SetDynamicVisibilityScale">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die Set Dynamic Visibility Scale ähnelt.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SymbologyMessageStrings.ZoomToLayer">
- <summary>
- Sucht eine lokalisierte Zeichenfolge, die Zoom to Layer ähnelt.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Opp.RectangleFromPoints(System.Drawing.Point,System.Drawing.Point)">
- <summary>
- Calculates a new rectangle by using the input points to define the far corners.
- The position of the points doesn't matter.
- </summary>
- <param name="pt1">One of the points to form a rectangle with.</param>
- <param name="pt2">The second point to use when drawing a rectangle.</param>
- <returns>A Rectangle created from the points.</returns>
- </member>
- <member name="T:DotSpatial.Symbology.ILayerProvider">
- <summary>
- ILayerProvider
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ILayerProvider.OpenLayer(System.String,System.Boolean,System.Collections.Generic.ICollection{DotSpatial.Symbology.ILayer},DotSpatial.Data.IProgressHandler)">
- <summary>
- This open method is only called if this plugin has been given priority for one
- of the file extensions supported in the DialogReadFilter property supplied by
- this control. Failing to provide a DialogReadFilter will result in this plugin
- being added to the list of DataProviders being supplied under the Add Other Data
- option in the file menu.
- </summary>
- <param name="fileName">A string specifying the complete path and extension of the file to open.</param>
- <param name="inRam">A boolean that, if ture, will request that the data be loaded into memory</param>
- <param name="container">Any valid IContainer that should have the new layer automatically added to it</param>
- <param name="progressHandler">An IProgressHandler interface for status messages</param>
- <returns>A List of IDataSets to be added to the Map. These can also be groups of datasets.</returns>
- </member>
- <member name="P:DotSpatial.Symbology.ILayerProvider.DialogReadFilter">
- <summary>
- Gets a dialog read filter that lists each of the file type descriptions and file extensions, delimeted
- by the | symbol. Each will appear in DotSpatial's open file dialog filter, preceeded by the name provided
- on this object.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILayerProvider.DialogWriteFilter">
- <summary>
- Gets a dialog filter that lists each of the file type descriptions and extensions for a Save File Dialog.
- Each will appear in DotSpatial's open file dialog filter, preceeded by the name provided on this object.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILayerProvider.Name">
- <summary>
- Gets a prefereably short name that identifies this data provider. Example might be GDAL.
- This will be prepended to each of the DialogReadFilter members from this plugin.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILayerProvider.Description">
- <summary>
- This provides a basic description of what your provider does.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IRasterLayerProvider">
- <summary>
- A DataProvider that is specific to raster formats.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IRasterLayerProvider.Create(System.String,System.String,System.Int32,System.Int32,System.Int32,System.Type,System.String[])">
- <summary>
- This create new method implies that this provider has the priority for creating a new file.
- An instance of the dataset should be created and then returned. By this time, the fileName
- will already be checked to see if it exists, and deleted if the user wants to overwrite it.
- </summary>
- <param name="name">The string fileName for the new instance.</param>
- <param name="driverCode">The string short name of the driver for creating the raster.</param>
- <param name="xSize">The number of columns in the raster.</param>
- <param name="ySize">The number of rows in the raster.</param>
- <param name="numBands">The number of bands to create in the raster.</param>
- <param name="dataType">The data type to use for the raster.</param>
- <param name="options">The options to be used.</param>
- <returns>A new IRaster.</returns>
- </member>
- <member name="T:DotSpatial.Symbology.IVectorLayerProvider">
- <summary>
- IFeatureProvider
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IVectorLayerProvider.CreateNew(System.String,DotSpatial.Topology.FeatureType,System.Boolean,System.Collections.Generic.ICollection{DotSpatial.Symbology.ILayer},DotSpatial.Data.IProgressHandler)">
- <summary>
- This create new method implies that this provider has the priority for creating a new file.
- An instance of the dataset should be created and then returned. By this time, the fileName
- will already be checked to see if it exists, and deleted if the user wants to overwrite it.
- </summary>
- <param name="fileName">The string fileName for the new instance</param>
- <param name="featureType">Point, Line, Polygon etc. Sometimes this will be specified, sometimes it will be "Unspecified"</param>
- <param name="inRam">Boolean, true if the dataset should attempt to store data entirely in ram</param>
- <param name="container">The container for this layer. This can be null.</param>
- <param name="progressHandler">An IProgressHandler for status messages.</param>
- <returns>An IRaster</returns>
- </member>
- <member name="T:DotSpatial.Symbology.Position2D">
- <summary>
- Position2D is much simpler than a typical geometric construct, using fields instead of properties to make it work faster.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Position2D.X">
- <summary>
- The position in the X, or horizontal direction
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Position2D.Y">
- <summary>
- The position in the Y or vertical direction
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Position2D.#ctor">
- <summary>
- Creates a new instance of Position2D
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Position2D.#ctor(System.Double,System.Double)">
- <summary>
- Creates a new position2D class using the specified coordinates
- </summary>
- <param name="x">The X or horizontal coordinate</param>
- <param name="y">The Y or vertical coordinate</param>
- </member>
- <member name="M:DotSpatial.Symbology.Position2D.OnRandomize(System.Random)">
- <summary>
- Randomizes the position by selecting a random position from -1000 to 1000 for X and Y
- </summary>
- <param name="generator">The random number generator so that a seed can be chosen.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Position2D.ToCoordinate">
- <summary>
- Creates a valid 2D coordinate using this position2D class
- </summary>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Symbology.CustomSymbolizer">
- <summary>
- This is a custom (predefined) symbolizer which is displayed in the 'Predefined symbol' control.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.ICustomSymbolizer">
- <summary>
- Interface for a predefined symbolizer which can be stored in a xml symbolizer file.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ICustomSymbolizer.SaveToXml(System.String)">
- <summary>
- Jiri's code to save to XML
- </summary>
- <param name="xmlDataSource">The xml data source to load the symbology from</param>
- </member>
- <member name="M:DotSpatial.Symbology.ICustomSymbolizer.LoadFromXml(System.String,System.String)">
- <summary>
- Jiri's code to load from XML
- </summary>
- <param name="xmlDataSource">The xml Data source to load the symbology from</param>
- <param name="uniqueName">A Unique name for the symbology item</param>
- </member>
- <member name="M:DotSpatial.Symbology.ICustomSymbolizer.LoadFromXml(System.String,System.String,System.String)">
- <summary>
- Jiri's code to load from XML
- </summary>
- <param name="xmlDataSource">The xml Data source to load the symbology from</param>
- <param name="group">The organizational group or category</param>
- <param name="name">The string name within the specified group or category</param>
- </member>
- <member name="P:DotSpatial.Symbology.ICustomSymbolizer.Symbolizer">
- <summary>
- Gets or sets the symbolizer for this predifined symbolizer
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ICustomSymbolizer.Name">
- <summary>
- Gets or sets the string name for this predefined symbolizer
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ICustomSymbolizer.Category">
- <summary>
- Gets or sets the string group for this predefined symbolizer
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ICustomSymbolizer.UniqueName">
- <summary>
- Gets or sets the unique name for this predefined symbolizer.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ICustomSymbolizer.SymbolType">
- <summary>
- Gets the symbolizer type of this predefined symbolizer
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.CustomSymbolizer.#ctor">
- <summary>
- Constructs a new instance of a custom symbolizer
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.CustomSymbolizer.#ctor(DotSpatial.Symbology.IFeatureSymbolizer,System.String,System.String,System.String)">
- <summary>
- Creates a new instance of CustomSymbolizer
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.CustomSymbolizer.SaveToXml(System.String)">
- <summary>
- Jiri's code to save to XML
- </summary>
- <param name="xmlDataSource">The xml data source to load the symbology from</param>
- </member>
- <member name="M:DotSpatial.Symbology.CustomSymbolizer.LoadFromXml(System.String,System.String)">
- <summary>
- Jiri's code to load from XML
- </summary>
- <param name="xmlDataSource">The xml Data source to load the symbology from</param>
- <param name="uniqueName">A Unique name for the symbology item</param>
- </member>
- <member name="M:DotSpatial.Symbology.CustomSymbolizer.LoadFromXml(System.String,System.String,System.String)">
- <summary>
- Jiri's code to load from XML
- </summary>
- <param name="xmlDataSource">The xml Data source to load the symbology from</param>
- <param name="group">The organizational group or category</param>
- <param name="name">The string name within the specified group or category</param>
- </member>
- <member name="P:DotSpatial.Symbology.CustomSymbolizer.Symbolizer">
- <summary>
- Gets or sets the symbolizer for this predifined symbolizer
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.CustomSymbolizer.Name">
- <summary>
- Gets or sets the string name for this predefined symbolizer
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.CustomSymbolizer.Category">
- <summary>
- Gets or sets the string group for this predefined symbolizer
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.CustomSymbolizer.UniqueName">
- <summary>
- Gets or sets the unique name for this predefined symbolizer.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.CustomSymbolizer.SymbolType">
- <summary>
- The type of the symbolizer (point, line, polygon)
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.CustomLineSymbolizer.#ctor">
- <summary>
- Creates a new CustomSymbolizer for symbolizing lines
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.CustomLineSymbolizer.#ctor(System.String,System.String,System.String,DotSpatial.Symbology.LineSymbolizer)">
- <summary>
- Creates a new Custom Line symbolizer with the specified properties
- </summary>
- <param name="uniqueName">the unique name</param>
- <param name="name">the name of the custom symbolizer</param>
- <param name="category">the map category of the custom symbolizer</param>
- <param name="symbolizer">the associated line symbolizer</param>
- </member>
- <member name="P:DotSpatial.Symbology.CustomLineSymbolizer.Symbolizer">
- <summary>
- Gets or sets the line symbolizer
- </summary>
- <remarks>//Editor(typeof(LineSymbolizerEditor), typeof(UITypeEditor))</remarks>
- </member>
- <member name="T:DotSpatial.Symbology.CustomLineSymbolProvider">
- <summary>
- This class provides a list of predefined symbolizers.
- In the current implementation the symbolizers are 'hard-coded'.
- In other implementations they will be loaded from a xml resource file.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.ICustomLineSymbolProvider">
- <summary>
- The interface IPredefinedLineSymbolProvider defines methods to save and load predefined
- line symbolizers from a xml file or from another source.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ICustomLineSymbolProvider.Load(System.String)">
- <summary>
- Loads a list of custom line symbolizers from a data file
- </summary>
- <param name="fileName">The file name</param>
- <returns>The list of custom line symbolizers</returns>
- </member>
- <member name="M:DotSpatial.Symbology.ICustomLineSymbolProvider.Save(System.String)">
- <summary>
- Saves a list of custom line symbolizers to a data file
- </summary>
- <param name="fileName"></param>
- </member>
- <member name="M:DotSpatial.Symbology.CustomLineSymbolProvider.#ctor">
- <summary>
- Creates a new instance of PredefinedLineSymbolProvider
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.CustomLineSymbolProvider.GetAvailableCategories">
- <summary>
- Gets a string array of all available categories (groups) of custom predefined symbols
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.CustomLineSymbolProvider.GetAllSymbols">
- <summary>
- Returns all available predefined custom line symbols
- </summary>
- <returns>A list of vailable custom line symbols</returns>
- </member>
- <member name="M:DotSpatial.Symbology.CustomLineSymbolProvider.GetSymbolsByCategory(System.String)">
- <summary>
- Gets a list of all predefined custom symbols that belong to the specific category
- </summary>
- <param name="categoryName">The name of the category group</param>
- <returns>The list of custom symbols</returns>
- </member>
- <member name="M:DotSpatial.Symbology.CustomLineSymbolProvider.Load(System.String)">
- <summary>
- Loads a list of custom line symbolizers from a binary serialized file
- </summary>
- <param name="fileName">The serialized binary file</param>
- <returns>The list of custom line symbolizers</returns>
- </member>
- <member name="M:DotSpatial.Symbology.CustomLineSymbolProvider.Save(System.String)">
- <summary>
- Saves
- </summary>
- <param name="fileName"></param>
- </member>
- <member name="M:DotSpatial.Symbology.CustomPointSymbolizer.#ctor">
- <summary>
- Creates a new CustomSymbolizer for symbolizing Points
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.CustomPointSymbolizer.#ctor(System.String,System.String,System.String,DotSpatial.Symbology.PointSymbolizer)">
- <summary>
- Creates a new Custom Point symbolizer with the specified properties
- </summary>
- <param name="uniqueName">the unique name</param>
- <param name="name">the name of the custom symbolizer</param>
- <param name="category">the map category of the custom symbolizer</param>
- <param name="symbolizer">the associated Point symbolizer</param>
- </member>
- <member name="P:DotSpatial.Symbology.CustomPointSymbolizer.Symbolizer">
- <summary>
- Gets or sets the Point symbolizer
- </summary>
- <remarks>
- [Editor(typeof(PointSymbolizerEditor), typeof(UITypeEditor))]
- </remarks>
- </member>
- <member name="M:DotSpatial.Symbology.CustomPolygonSymbolizer.#ctor">
- <summary>
- Creates a new CustomSymbolizer for symbolizing Polygons
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.CustomPolygonSymbolizer.#ctor(System.String,System.String,System.String,DotSpatial.Symbology.PolygonSymbolizer)">
- <summary>
- Creates a new Custom Polygon symbolizer with the specified properties
- </summary>
- <param name="uniqueName">the unique name</param>
- <param name="name">the name of the custom symbolizer</param>
- <param name="category">the map category of the custom symbolizer</param>
- <param name="symbolizer">the associated Polygon symbolizer</param>
- </member>
- <member name="P:DotSpatial.Symbology.CustomPolygonSymbolizer.Symbolizer">
- <summary>
- Gets or sets the Polygon symbolizer
- </summary>
- <remarks>
- [Editor(typeof(PolygonSymbolizerEditor), typeof(UITypeEditor))]
- </remarks>
- </member>
- <member name="T:DotSpatial.Symbology.CustomSymbolizerCollectionExt">
- <summary>
- Extension methods for a collection of custom symbolizers
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.CustomSymbolizerCollectionExt.Save(System.Collections.Generic.IEnumerable{DotSpatial.Symbology.CustomLineSymbolizer},System.String)">
- <summary>
- Saves a list of custom line symbolizers to a file.
- </summary>
- <param name="self">The list of custom line symbolizers</param>
- <param name="fileName">the file name</param>
- </member>
- <member name="T:DotSpatial.Symbology.CustomSymbolProvider">
- <summary>
- This class returns a list of predefined symbolizers.
- In the current implementation the symbolizers are 'hard-coded'.
- In other implementations they will be loaded from a xml resource file.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.CustomSymbolProvider.#ctor">
- <summary>
- Creates a new instance of PredefinedLineSymbolProvider
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.CustomSymbolProvider.GetAvailableCategories(DotSpatial.Symbology.SymbolizerType)">
- <summary>
- Gets a string array of all available categories (groups) of custom predefined symbols
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.SymbolizerType">
- <summary>
- The available feature symbolizer types
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.SymbolizerType.Point">
- <summary>
- The type is PointSymbolizer
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.SymbolizerType.Line">
- <summary>
- The type is LineSymbolizer
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.SymbolizerType.Polygon">
- <summary>
- The type is PolygonSymbolizer
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.SymbolizerType.Raster">
- <summary>
- The type is RasterSymbolizer
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.SymbolizerType.Unknown">
- <summary>
- The type of the symbolizer is unknown
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.MemberInfoExtensions.GetFirst``1(System.Collections.Generic.IEnumerable{``0},System.String)">
- <summary>
- Gets the first member in the enumerable collection of property info with the specified name.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.MemberInfoExtensions.Contains(System.Collections.Generic.IEnumerable{System.Reflection.MemberInfo},System.String)">
- <summary>
- Determines whether there is a member with the specified name
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.RandomExt">
- <summary>
- Extensions for <see cref="T:System.Random"/> class
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.RandomExt.NextBool(System.Random)">
- <summary>
- Generates a boolean at random from this generator.
- </summary>
- <param name="generator">THe random class that generates the random content.</param>
- <returns>A boolean that has equal probability of being on or off.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.RandomExt.NextColor(System.Random)">
- <summary>
- Extends the Random class to also allow it to generate random colors
- </summary>
- <param name="generator">This random number generator</param>
- </member>
- <member name="M:DotSpatial.Symbology.RandomExt.NextFloat(System.Random)">
- <summary>
- Generates a floating point value from 0 to 1
- </summary>
- <param name="generator">The random class to extend</param>
- <returns>A new randomly created floating point value from 0 to 1</returns>
- </member>
- <member name="M:DotSpatial.Symbology.RandomExt.NextFloat(System.Random,System.Single)">
- <summary>
- Generates a random floating point value from 0 to the specified extremeValue, which can
- be either positive or negative.
- </summary>
- <param name="generator">This random class</param>
- <param name="extremeValue">The floating point maximum for the number being calculated</param>
- <returns>A value ranging from 0 to ma</returns>
- </member>
- <member name="M:DotSpatial.Symbology.RandomExt.NextFloat(System.Random,System.Single,System.Single)">
- <summary>
- Calculates a random floating point value that ranges between (inclusive) the specified minimum and maximum values.
- </summary>
- <param name="generator">The random class to generate the random value</param>
- <param name="minimum">The floating point maximum</param>
- <param name="maximum">The floating point minimum</param>
- <returns>A floating point value that is greater than or equal to the minimum and less than or equal to the maximum</returns>
- </member>
- <member name="M:DotSpatial.Symbology.RandomExt.NextEnum``1(System.Random)">
- <summary>
- Given any enumeration of type T, this will return a random instance of that enumeration
- </summary>
- <typeparam name="T">The type of the enumeration</typeparam>
- <param name="generator">This random generator</param>
- <returns>The T type to generate</returns>
- </member>
- <member name="M:DotSpatial.Symbology.RandomExt.NextBoolArray(System.Random,System.Int32,System.Int32)">
- <summary>
- Generates an array of boolean values that ranges from minLength to maxLength
- </summary>
- <param name="generator">The Random class for generating random values</param>
- <param name="minLength">THe minimum length of the array</param>
- <param name="maxLength">The maximum length of the array</param>
- <returns>An array of boolean values.</returns>
- </member>
- <member name="T:DotSpatial.Symbology.Range">
- <summary>
- Numeric range using doubles
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Range._maxIsInclusive">
- <summary>
- Boolean, true if the upper bounds includes the maximum value.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Range._maximum">
- <summary>
- The maximum value. If this is null, the upper range is unbounded.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Range._minIsInclusive">
- <summary>
- Boolean, true if the the lower bounds includes the minimum value.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Range._minimum">
- <summary>
- The minimum value. If this is null, the lower range is unbounded.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Range.#ctor">
- <summary>
- Creates a new instance of Range (with undefined interval)
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Range.#ctor(System.Nullable{System.Double},System.Nullable{System.Double})">
- <summary>
- Creates a new instance of Range
- </summary>
- <param name="value1">Either bound of the range</param>
- <param name="value2">The other bound of the range</param>
- </member>
- <member name="M:DotSpatial.Symbology.Range.#ctor(System.Double)">
- <summary>
- Creates an equality type range where both the minimum and maximum are the
- same value and both are inclusive.
- </summary>
- <param name="value"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Range.#ctor(System.String)">
- <summary>
- A string expression that can be two separate numbers separated by a dash,
- </summary>
- <param name="expression"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Range.ToString">
- <summary>
- Expresses this range in string form. By default, ranges include the maximum,
- and exclude the minimum. A null value for one expression will result in a
- a semi-unbounded range using the greater than or less than symbols. A null
- expression for both values is completely unbounded and will result in a string
- that reads like [All Values].
- </summary>
- <returns>A string representing the range.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Range.ToString(DotSpatial.Symbology.IntervalSnapMethod,System.Int32)">
- <summary>
- This is a slightly more complex specification where the numeric formatting
- controls how the generated string will appear.
- </summary>
- <param name="method">The interval snap method</param>
- <param name="digits">This is only used for rounding or significant figures, but controls those options</param>
- <returns>A string equivalent of this range, but using a number format.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Range.ToExpression(System.String)">
- <summary>
- Generates a valid SQL query expression for this range, using the field string
- as the member being compared. The field string should already be bound in
- brackets, or put together as a normal composit like "[males]/[pop1990]"
- </summary>
- <param name="field">The field name to build into an expression. This should already be wrapped in square brackets.</param>
- <returns>The string SQL query expression.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Range.Contains(System.Double)">
- <summary>
- Tests to determine if this range contains the specified double value.
- </summary>
- <param name="value">the double value to test</param>
- <returns>Boolean, true if the value is within the current bounds.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Range.FixOrder">
- <summary>
- If the minimum and maximum are out of order, this reverses them.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Range.Minimum">
- <summary>
- Gets or sets teh Minimum value. If this is null, the lower range is unbounded.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Range.Maximum">
- <summary>
- The maximum value. If this is null, the upper range is unbounded.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Range.MinIsInclusive">
- <summary>
- Boolean, true if the the lower bounds includes the minimum value.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Range.MaxIsInclusive">
- <summary>
- Boolean, true if the upper bounds includes the maximum value.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.BinaryLayerProvider">
- <summary>
- BinaryLayerProvider
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.BinaryLayerProvider.Create(System.String,System.String,System.Int32,System.Int32,System.Int32,System.Type,System.String[])">
- <summary>
- Creates a new BinaryRasterLayer
- </summary>
- <returns>IRasterLayer</returns>
- </member>
- <member name="M:DotSpatial.Symbology.BinaryLayerProvider.OpenLayer(System.String,System.Boolean,System.Collections.Generic.ICollection{DotSpatial.Symbology.ILayer},DotSpatial.Data.IProgressHandler)">
- <summary>
- Opens an existing raster and returns a layer containing it
- </summary>
- <param name="fileName">The string fileName to open</param>
- <param name="inRam">Opens in ram</param>
- <param name="container">A container to automatically add this layer to</param>
- <param name="progressHandler">Returns progress</param>
- <returns>An ILayer</returns>
- </member>
- <member name="P:DotSpatial.Symbology.BinaryLayerProvider.DialogReadFilter">
- <summary>
- Gets a dialog read filter that lists each of the file type descriptions and file extensions, delimeted
- by the | symbol. Each will appear in DotSpatial's open file dialog filter, preceeded by the name provided
- on this object.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.BinaryLayerProvider.DialogWriteFilter">
- <summary>
- Gets a dialog filter that lists each of the file type descriptions and extensions for a Save File Dialog.
- Each will appear in DotSpatial's open file dialog filter, preceeded by the name provided on this object.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.BinaryLayerProvider.Name">
- <summary>
- Gets a prefereably short name that identifies this data provider. Example might be GDAL.
- This will be prepended to each of the DialogReadFilter members from this plugin.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.BinaryLayerProvider.Description">
- <summary>
- This is a basic description that will fall next to your plugin in the Add Other Data dialog.
- This will only be shown if your plugin does not supply a DialogReadFilter.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.ColorCategory">
- <summary>
- ColorCategory
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IColorCategory">
- <summary>
- IColorCategory
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IColorCategory.CalculateColor(System.Double)">
- <summary>
- This is primarilly used in the BiValue situation where a color needs to be generated
- somewhere between the startvalue and the endvalue.
- </summary>
- <param name="value">The integer value to be converted into a color from the range on this colorbreak</param>
- <returns>A color that is selected from the range values.</returns>
- </member>
- <member name="P:DotSpatial.Symbology.IColorCategory.GradientModel">
- <summary>
- Gets or sets how the color changes are distributed across the
- BiValued range. If IsBiValue is false, this does nothing.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IColorCategory.HighColor">
- <summary>
- Gets or sets the second of two colors to be used.
- This is only used for BiValued breaks.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IColorCategory.IsBiValue">
- <summary>
- This not only indicates that there are two values,
- but that the values are also different from one another.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IColorCategory.LowColor">
- <summary>
- Gets or sets the color to be used for this break. For
- BiValued breaks, this only sets one of the colors. If
- this is higher than the high value, both are set to this.
- If this equals the high value, IsBiValue will be false.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ColorCategory.#ctor">
- <summary>
- Creates a new instance of ColorCategory
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ColorCategory.#ctor(System.Double)">
- <summary>
- Creates a ColorBreak that has a single value, which can be an object of any type.
- The LowValue field will contain this single value.
- </summary>
- <param name="value">The value to test.</param>
- </member>
- <member name="M:DotSpatial.Symbology.ColorCategory.#ctor(System.Double,System.Drawing.Color)">
- <summary>
- Creates a ColorBreak that has a single value, which can be an object of any type.
- The LowValue field will contain this single value.
- </summary>
- <param name="value">The value to test.</param>
- <param name="color">The color to use as the low value.</param>
- </member>
- <member name="M:DotSpatial.Symbology.ColorCategory.#ctor(System.Nullable{System.Double},System.Nullable{System.Double})">
- <summary>
- Creates a new color category, but doesn't specify the colors themselves.
- </summary>
- <param name="startValue">The start value</param>
- <param name="endValue">The end value</param>
- </member>
- <member name="M:DotSpatial.Symbology.ColorCategory.#ctor(System.Nullable{System.Double},System.Nullable{System.Double},System.Drawing.Color,System.Drawing.Color)">
- <summary>
- Creates a bi-valued colorbreak that will automatically test which of the specified values is higher
- and use that as the high value. The other will become the low value. This will be set to a
- bi-value colorbreak.
- </summary>
- <param name="startValue">One of the values to use in this colorbreak.</param>
- <param name="endValue">The other value to use in this colorbreak.</param>
- <param name="lowColor">The color to assign to the higher of the two values</param>
- <param name="highColor">The color to assign to the lower of the two values</param>
- </member>
- <member name="M:DotSpatial.Symbology.ColorCategory.OnEditItem(System.ComponentModel.HandledEventArgs)">
- <summary>
- Fires the EditItem event. If e returns handled, then this will not launch the default editor
- </summary>
- <param name="e">The HandledEventArgs</param>
- </member>
- <member name="M:DotSpatial.Symbology.ColorCategory.OnCopyProperties(System.Object)">
- <inheritdocs/>
- </member>
- <member name="M:DotSpatial.Symbology.ColorCategory.CalculateColor(System.Double)">
- <summary>
- This is primarily used in the BiValue situation where a color needs to be generated
- somewhere between the start value and the end value.
- </summary>
- <param name="value">The value to be converted into a color from the range on this color break</param>
- <returns>A color that is selected from the range values.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.ColorCategory.LegendSymbol_Painted(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Paints legend symbol
- </summary>
- <param name="g"></param>
- <param name="box"></param>
- </member>
- <member name="E:DotSpatial.Symbology.ColorCategory.EditItem">
- <summary>
- Occurs when this ColorBreak received instructions to show an editor. If this is
- handled, then no action will be taken.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ColorCategory.ColorCategoryActions">
- <summary>
- Gets or sets custom actions for ColorCategory
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ColorCategory.GradientModel">
- <summary>
- Gets or sets how the color changes are distributed across the
- BiValued range. If IsBiValue is false, this does nothing.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ColorCategory.HighColor">
- <summary>
- Gets or sets the second of two colors to be used.
- This is only used for BiValued breaks.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ColorCategory.IsBiValue">
- <summary>
- This not only indicates that there are two values,
- but that the values are also different from one another.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ColorCategory.LowColor">
- <summary>
- Gets or sets the color to be used for this break. For
- BiValued breaks, this only sets one of the colors. If
- this is higher than the high value, both are set to this.
- If this equals the high value, IsBiValue will be false.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ColorCategory.LowColorOpacity">
- <summary>
- Gets or sets the opacity for the low color. This was added to save opacity to dspx.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ColorCategory.HighColorOpacity">
- <summary>
- Gets or sets the opacity for the high color. This was added to save opacity to dspx.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.ColorCategoryCollection">
- <summary>
- ColorCategoryCollection
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ColorCategoryCollection.#ctor">
- <summary>
- Default constructor for the PolygonCategoryCollection class.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ColorCategoryCollection.#ctor(DotSpatial.Symbology.IColorScheme)">
- <summary>
- Initializes a new PolygonCategoryCollection instance with the supplied scheme.
- </summary>
- <param name="scheme">The scheme to use ofr this collection.</param>
- </member>
- <member name="M:DotSpatial.Symbology.ColorCategoryCollection.OnInclude(DotSpatial.Symbology.IColorCategory)">
- <summary>
- Ensures that newly added categories can navigate to higher legend items.
- </summary>
- <param name="item">The newly added legend item.</param>
- </member>
- <member name="M:DotSpatial.Symbology.ColorCategoryCollection.OnExclude(DotSpatial.Symbology.IColorCategory)">
- <summary>
- Changes the parent item of the specified category
- </summary>
- <param name="item"></param>
- </member>
- <member name="M:DotSpatial.Symbology.ColorCategoryCollection.UpdateItemParentPointers">
- <summary>
- Updates all of the categories so that they have a parent item that matches the
- schemes parent item.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ColorCategoryCollection.Scheme">
- <summary>
- Gets or sets the parent scheme for this collection
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Scheme">
- <summary>
- DrawingScheme
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Scheme.#ctor">
- <summary>
- Creates a new instance of DrawingScheme
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Scheme.CreateNewCategory(System.Drawing.Color,System.Double)">
- <summary>
- Creates the category using a random fill color
- </summary>
- <param name="fillColor">The base color to use for creating the category</param>
- <param name="size">For points this is the larger dimension, for lines this is the largest width</param>
- <returns>A new IFeatureCategory that matches the type of this scheme</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Scheme.DrawCategory(System.Int32,System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Draws the regular symbolizer for the specified cateogry to the specified graphics
- surface in the specified bounding rectangle.
- </summary>
- <param name="index">The integer index of the feature to draw.</param>
- <param name="g">The Graphics object to draw to</param>
- <param name="bounds">The rectangular bounds to draw in</param>
- </member>
- <member name="M:DotSpatial.Symbology.Scheme.AddCategory(DotSpatial.Symbology.ICategory)">
- <summary>
- Adds a new scheme, assuming that the new scheme is the correct type.
- </summary>
- <param name="category">The category to add</param>
- </member>
- <member name="M:DotSpatial.Symbology.Scheme.DecreaseCategoryIndex(DotSpatial.Symbology.ICategory)">
- <summary>
- Reduces the index value of the specified category by 1 by
- exchaning it with the category before it. If there is no
- category before it, then this does nothing.
- </summary>
- <param name="category">The category to decrease the index of</param>
- </member>
- <member name="M:DotSpatial.Symbology.Scheme.RemoveCategory(DotSpatial.Symbology.ICategory)">
- <summary>
- Removes the specified category
- </summary>
- <param name="category">The category to insert</param>
- </member>
- <member name="M:DotSpatial.Symbology.Scheme.InsertCategory(System.Int32,DotSpatial.Symbology.ICategory)">
- <summary>
- Inserts the category at the specified index
- </summary>
- <param name="index">The integer index where the category should be inserted</param>
- <param name="category">The category to insert</param>
- </member>
- <member name="M:DotSpatial.Symbology.Scheme.IncreaseCategoryIndex(DotSpatial.Symbology.ICategory)">
- <summary>
- Re-orders the specified member by attempting to exchange it with the next higher
- index category. If there is no higher index, this does nothing.
- </summary>
- <param name="category">The category to increase the index of</param>
- </member>
- <member name="M:DotSpatial.Symbology.Scheme.SuspendEvents">
- <summary>
- Suspends the category events
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Scheme.ResumeEvents">
- <summary>
- Resumes the category events
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Scheme.ClearCategories">
- <summary>
- Clears the categories
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Scheme.CreateBreakCategories">
- <summary>
- Generates the break categories for this scheme
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Scheme.GetSizeSet(System.Int32)">
- <summary>
- THe defaul
- </summary>
- <param name="count"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Scheme.GetColorSet(System.Int32)">
- <summary>
- Creates a list of generated colors according to the convention
- specified in the EditorSettings.
- </summary>
- <param name="count">The integer count of the number of colors to create.</param>
- <returns>The list of colors created.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Scheme.CreateRandomCategory">
- <summary>
- Uses the settings on this scheme to create a random category.
- </summary>
- <returns>A new ICategory</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Scheme.GetDefaultColors(System.Int32)">
- <summary>
- Creates the colors in the case where the color range controls are not being used.
- This can be overriddend for handling special cases like ponit and line symbolizers
- that should be using the template colors.
- </summary>
- <param name="count">The integer count to use</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Scheme.CreateUnboundedRampColors(System.Int32)">
- <summary>
- The default behavior for creating ramp colors is to create colors in the mid-range for
- both lightness and saturation, but to have the full range of hue
- </summary>
- <param name="numColors"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Scheme.CreateRandomColor(System.Random)">
- <summary>
- Creates a random color, but accepts a given random class instead of creating a new one.
- </summary>
- <param name="rnd"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Scheme.ApplySnapping(DotSpatial.Symbology.ICategory)">
- <summary>
- Applies the snapping rule directly to the categories, based on the most recently
- collected set of values, and the current VectorEditorSettings.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Scheme.GetEqualBreaks(System.Int32)">
- <summary>
- Uses the currently calculated Values in order to calculate a list of breaks
- that have equal separations.
- </summary>
- <param name="count"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Scheme.ApplyBreakSnapping">
- <summary>
- Applies the snapping type to the given breaks
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Scheme.NearestValue(System.Double,System.Collections.Generic.List{System.Double})">
- <summary>
- Searches the list and returns the nearest value in the list to the specified value.
- </summary>
- <param name="value"></param>
- <param name="values"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Scheme.GetQuantileBreaks(System.Int32)">
- <summary>
- Attempts to create the specified number of breaks with equal numbers of members in each.
- </summary>
- <param name="count">The integer count.</param>
- <returns>A list of breaks.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Scheme.SetBreakNames(System.Collections.Generic.IList{DotSpatial.Symbology.Scheme.Break})">
- <summary>
- Sets the names for the break categories
- </summary>
- <param name="breaks"></param>
- </member>
- <member name="P:DotSpatial.Symbology.Scheme.EditorSettings">
- <summary>
- Gets or sets the editor settings that control how this scheme operates.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Scheme.Statistics">
- <summary>
- This is cached until a GetValues call is made, at which time the statistics will
- be re-calculated from the values.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Scheme.Breaks">
- <summary>
- Gets or sets the list of breaks for this scheme
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Scheme.Values">
- <summary>
- Gets the current list of values calculated in the case of numeric breaks.
- This includes only members that are not excluded by the exclude expression,
- and have a valid numeric value.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Scheme.Break">
- <summary>
- Breaks for value ranges
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Scheme.Break.Maximum">
- <summary>
- A double value for the maximum value for the break
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Scheme.Break.Name">
- <summary>
- The string name
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Scheme.Break.#ctor">
- <summary>
- Creates a new instance of a break
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Scheme.Break.#ctor(System.String)">
- <summary>
- Creates a new instance of a break with a given name
- </summary>
- <param name="name">The string name for the break</param>
- </member>
- <member name="T:DotSpatial.Symbology.IColorScheme">
- <summary>
- IColorScheme
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IColorScheme.ApplyScheme(DotSpatial.Symbology.ColorSchemeType,DotSpatial.Data.IRaster)">
- <summary>
- Applies the specified color scheme from a list of predefined scheme options.
- </summary>
- <param name="schemeType">The predefined color scheme</param>
- <param name="raster">The raster that provides values to govern symbolizing</param>
- </member>
- <member name="M:DotSpatial.Symbology.IColorScheme.CreateCategories(DotSpatial.Data.IRaster)">
- <summary>
- Creates the categories for this scheme based on statistics and values
- sampled from the specified raster.
- </summary>
- <param name="raster">The raster to use when creating categories</param>
- </member>
- <member name="M:DotSpatial.Symbology.IColorScheme.GetValues(DotSpatial.Data.IRaster)">
- <summary>
- Gets the values from the raster. If MaxSampleCount is less than the
- number of cells, then it randomly samples the raster with MaxSampleCount
- values. Otherwise it gets all the values in the raster.
- </summary>
- <param name="raster">The raster to sample</param>
- </member>
- <member name="P:DotSpatial.Symbology.IColorScheme.Opacity">
- <summary>
- Gets or sets the floating point value for the opacity
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IColorScheme.Categories">
- <summary>
- Gets or sets the collection of color scheme categories to use.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IColorScheme.EditorSettings">
- <summary>
- gets or sets the editor settings for controls that affect the color scheme.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ColorScheme.#ctor">
- <summary>
- Creates a new instance of ColorScheme
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ColorScheme.#ctor(DotSpatial.Symbology.ColorSchemeType,DotSpatial.Data.IRaster)">
- <summary>
- Creates a new instance of a color scheme using a predefined color scheme and the minimum and maximum specified
- from the raster itself
- </summary>
- <param name="schemeType">The predefined scheme to use</param>
- <param name="raster">The raster to obtain the minimum and maximum settings from</param>
- </member>
- <member name="M:DotSpatial.Symbology.ColorScheme.#ctor(DotSpatial.Symbology.ColorSchemeType,System.Double,System.Double)">
- <summary>
- This creates a new scheme, applying the specified color scheme, and using the minimum and maximum values indicated.
- </summary>
- <param name="schemeType">The predefined color scheme</param>
- <param name="min">The minimum</param>
- <param name="max">The maximum</param>
- </member>
- <member name="M:DotSpatial.Symbology.ColorScheme.ApplyScheme(DotSpatial.Symbology.ColorSchemeType,DotSpatial.Data.IRaster)">
- <summary>
- Applies the specified color scheme and uses the specified raster to define the
- minimum and maximum to use for the scheme.
- </summary>
- <param name="schemeType"></param>
- <param name="raster"></param>
- </member>
- <member name="M:DotSpatial.Symbology.ColorScheme.CreateNewCategory(System.Drawing.Color,System.Double)">
- <summary>
- Creates the category using a random fill color
- </summary>
- <param name="fillColor">The base color to use for creating the category</param>
- <param name="size">For points this is the larger dimension, for lines this is the largest width</param>
- <returns>A new IFeatureCategory that matches the type of this scheme</returns>
- </member>
- <member name="M:DotSpatial.Symbology.ColorScheme.CreateCategories(DotSpatial.Data.IRaster)">
- <summary>
- Creates the categories for this scheme based on statistics and values
- sampled from the specified raster.
- </summary>
- <param name="raster">The raster to use when creating categories</param>
- </member>
- <member name="M:DotSpatial.Symbology.ColorScheme.GetValues(DotSpatial.Data.IRaster)">
- <summary>
- Gets the values from the raster. If MaxSampleCount is less than the
- number of cells, then it randomly samples the raster with MaxSampleCount
- values. Otherwise it gets all the values in the raster.
- </summary>
- <param name="raster">The raster to sample</param>
- </member>
- <member name="M:DotSpatial.Symbology.ColorScheme.ApplyScheme(DotSpatial.Symbology.ColorSchemeType,System.Double,System.Double)">
- <summary>
- Applies the specified color scheme and uses the specified raster to define the
- minimum and maximum to use for the scheme.
- </summary>
- <param name="schemeType">ColorSchemeType</param>
- <param name="min">THe minimum value to use for the scheme</param>
- <param name="max">THe maximum value to use for the scheme</param>
- </member>
- <member name="M:DotSpatial.Symbology.ColorScheme.CreateRandomCategory">
- <summary>
- Uses the settings on this scheme to create a random category.
- </summary>
- <returns>A new IFeatureCategory</returns>
- </member>
- <member name="M:DotSpatial.Symbology.ColorScheme.OnSetParentItem(DotSpatial.Symbology.ILegendItem)">
- <summary>
- Occurs when setting the parent item and updates the parent item pointers
- </summary>
- <param name="value"></param>
- </member>
- <member name="M:DotSpatial.Symbology.ColorScheme.DrawCategory(System.Int32,System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Draws the category in the specified location.
- </summary>
- <param name="index"></param>
- <param name="g"></param>
- <param name="bounds"></param>
- </member>
- <member name="M:DotSpatial.Symbology.ColorScheme.AddCategory(DotSpatial.Symbology.ICategory)">
- <summary>
- Adds the specified category
- </summary>
- <param name="category"></param>
- </member>
- <member name="M:DotSpatial.Symbology.ColorScheme.DecreaseCategoryIndex(DotSpatial.Symbology.ICategory)">
- <summary>
- Attempts to decrease the index value of the specified category, and returns
- true if the move was successful.
- </summary>
- <param name="category">The category to decrease the index of</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.ColorScheme.RemoveCategory(DotSpatial.Symbology.ICategory)">
- <summary>
- Removes the specified category
- </summary>
- <param name="category"></param>
- </member>
- <member name="M:DotSpatial.Symbology.ColorScheme.InsertCategory(System.Int32,DotSpatial.Symbology.ICategory)">
- <summary>
- Inserts the item at the specified index
- </summary>
- <param name="index"></param>
- <param name="category"></param>
- </member>
- <member name="M:DotSpatial.Symbology.ColorScheme.IncreaseCategoryIndex(DotSpatial.Symbology.ICategory)">
- <summary>
- Attempts to increase the position of the specified category, and returns true
- if the index increase was successful.
- </summary>
- <param name="category">The category to increase the position of</param>
- <returns>Boolean, true if the item's position was increased</returns>
- </member>
- <member name="M:DotSpatial.Symbology.ColorScheme.SuspendEvents">
- <summary>
- Suspends the change item event from firing as the list is being changed
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ColorScheme.ResumeEvents">
- <summary>
- Allows the ChangeItem event to get passed on when changes are made
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ColorScheme.ClearCategories">
- <summary>
- Clears the categories
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ColorScheme.Opacity">
- <summary>
- Gets or sets the floating point value for the opacity
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ColorScheme.Categories">
- <summary>
- Gets or sets the raster categories
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ColorScheme.EditorSettings">
- <summary>
- Gets or sets the raster editor settings associated with this scheme.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.ElevationScenario">
- <summary>
- Some of the more common relationships between elevation and geographic coordinates
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.ElevationScenario.ElevationCentiMeters_ProjectionDegrees">
- <summary>
- The elevation values are in centimeters, but the geographic projection uses decimal degrees
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.ElevationScenario.ElevationCentiMeters_ProjectionMeters">
- <summary>
- The elevation values are in centimeters, but the geographic projection uses Meters
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.ElevationScenario.ElevationCentiMeters_ProjectionFeet">
- <summary>
- The elevation values are in centimeters, but the geographic projection uses Feet
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.ElevationScenario.ElevationFeet_ProjectionDegrees">
- <summary>
- The elevation values are in feet, but the geographic projection uses decimal degrees
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.ElevationScenario.ElevationFeet_ProjectionMeters">
- <summary>
- The elevation values are in feet, but the geographic projection uses meters
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.ElevationScenario.ElevationFeet_ProjectionFeet">
- <summary>
- The elevation values are in feet, but the geographic projection uses feet
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.ElevationScenario.ElevationMeters_ProjectionDegrees">
- <summary>
- The elevation values are in meters, but the geographic projection uses decimal degrees
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.ElevationScenario.ElevationMeters_ProjectionMeters">
- <summary>
- The elevation values are in meters, but the geographic projection uses meters
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.ElevationScenario.ElevationMeters_ProjectionFeet">
- <summary>
- The elevation values are in meters, but the geographic projection uses feet
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IRasterLayer">
- <summary>
- A raster layer describes using a single raster, and the primary application will be using this as a texture.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IRasterLayer.WriteBitmap">
- <summary>
- Creates a bmp texture and saves it to the same fileName as the raster, but with a bmp ending.
- This also generates a bpw world file for the texture.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IRasterLayer.WriteBitmap(DotSpatial.Data.IProgressHandler)">
- <summary>
- Creates a bmp texture and saves it to the same fileName as the raster but with a bmp ending.
- This also generates a bpw world file for the texture.
- </summary>
- <param name="progressHandler">An implementation of IProgressHandler to recieve status messages</param>
- </member>
- <member name="M:DotSpatial.Symbology.IRasterLayer.ExportBitmap(System.String,DotSpatial.Data.ImageBandType)">
- <summary>
- Creates a bmp texture and saves it to the specified fileName. The fileName should end in bmp.
- This also generates a bpw world file for the texture.
- </summary>
- <param name="fileName">The string fileName to write to</param>
- <param name="bandType">The image band type.</param>
- </member>
- <member name="M:DotSpatial.Symbology.IRasterLayer.ExportBitmap(System.String,DotSpatial.Data.IProgressHandler,DotSpatial.Data.ImageBandType)">
- <summary>
- Creates a bmp texture and saves it to the specified fileName. The fileName should end in bmp.
- This also generates a bpw world file for the texture.
- </summary>
- <param name="fileName">The string fileName to write to</param>
- <param name="progressHandler">The progress handler for creating a new bitmap.</param>
- <param name="bandType">The image band type.</param>
- </member>
- <member name="P:DotSpatial.Symbology.IRasterLayer.Bounds">
- <summary>
- Gets or sets the boundaries of the raster.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IRasterLayer.BitmapGetter">
- <summary>
- Gets or sets the item that controls rendering this raster as a bitmap.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IRasterLayer.CellWidth">
- <summary>
- Gets the geographic width of the cells for this raster (East-West)
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IRasterLayer.CellHeight">
- <summary>
- Gets the geographic height of the cells for this raster (North-South)
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IRasterLayer.DataSet">
- <summary>
- Gets or sets the underlying dataset raster for this object
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IRasterLayer.DataType">
- <summary>
- Gets the data type of the values in this raster.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IRasterLayer.East">
- <summary>
- Gets the eastern boundary of this raster.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IRasterLayer.ElevationFactor">
- <summary>
- This is a conversion factor that is required in order to convert the elevation units into the same units as the geospatial projection for the latitude and logitude values of the grid.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IRasterLayer.Extrusion">
- <summary>
- Gets the exaggeration beyond normal elevation values. A value of 1 is normal elevation, a vlaue of 0 would be flat,
- while a value of 2 would be twice the normal elevation. This applies to the three-dimensional rendering and is
- not related to the shaded relief pattern created by the texture.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IRasterLayer.Filename">
- <summary>
- Gets the fileName where this raster is saved.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IRasterLayer.Maximum">
- <summary>
- Gets the maximum value of this raster. If this is an elevation raster, this is also the top.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IRasterLayer.Minimum">
- <summary>
- Gets the minimum value of this raster. If this is an elevation raster, this is also the bottom.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IRasterLayer.NoDataValue">
- <summary>
- Gets the value that is used when no actual data exists for the specified location.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IRasterLayer.North">
- <summary>
- Gets the northern boundary of this raster.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IRasterLayer.NumBands">
- <summary>
- Gets the number of bands in this raster.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IRasterLayer.NumColumns">
- <summary>
- Gets the number of columns in this raster.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IRasterLayer.NumRows">
- <summary>
- Gets the number of rows in this raster.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IRasterLayer.South">
- <summary>
- Gets the southern boundary of this raster.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IRasterLayer.Symbolizer">
- <summary>
- Gets or sets the collection of symbolizer properties to use for this raster.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IRasterLayer.West">
- <summary>
- Gets the western boundary of this raster.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IRasterSymbolizer">
- <summary>
- IRasterSymbolizer
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IRasterSymbolizer.CreateBitmap">
- <summary>
- Creates a bmp from the in-memory portion of the raster.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.IRasterSymbolizer.CreateHillShade">
- <summary>
- Causes the raster to calculate a hillshade based on this symbolizer
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IRasterSymbolizer.CreateHillShade(DotSpatial.Data.IProgressHandler)">
- <summary>
- Causes the raster to calculate a hillshade using the specified progress handler
- </summary>
- <param name="progressHandler">The progress handler to use</param>
- </member>
- <member name="M:DotSpatial.Symbology.IRasterSymbolizer.GetColor(System.Double)">
- <summary>
- Gets the color for a specific row and column. This does not include any hillshade information.
- </summary>
- <param name="value">The double value to find in the colorbreaks.</param>
- <returns>A Color</returns>
- </member>
- <member name="M:DotSpatial.Symbology.IRasterSymbolizer.PaintShadingToBitmap(System.Drawing.Bitmap,DotSpatial.Data.IProgressHandler)">
- <summary>
- Creates a bitmap based on the specified RasterSymbolizer
- </summary>
- <param name="bitmap"> the bitmap to paint to</param>
- <param name="progressHandler">The progress handler</param>
- </member>
- <member name="M:DotSpatial.Symbology.IRasterSymbolizer.Refresh">
- <summary>
- Sends a symbology updated event, which should cause the layer to be refreshed.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IRasterSymbolizer.Validate">
- <summary>
- Indicates that the bitmap has been updated and that the colorscheme is currently
- synchronized with the characteristics of this symbolizer. This also fires the
- ColorSchemeChanged event.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.IRasterSymbolizer.ColorSchemeUpdated">
- <summary>
- This event occurs after a new bitmap has been created to act as a texture.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IRasterSymbolizer.DrapeVectorLayers">
- <summary>
- If this value is true, whenever a texture is created, the vector layers are drawn onto the texture.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IRasterSymbolizer.EditorSettings">
- <summary>
- Gets or sets the editor settings class to help setup up the symbology controls appropriately.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IRasterSymbolizer.ElevationFactor">
- <summary>
- This is kept separate from extrusion to reduce confusion. This is a conversion factor that will
- convert the units of elevation into the same units that the latitude and longitude are stored in.
- To convert feet to decimal degrees is around a factor of .00000274. This is used only in the
- 3D-context and does not affect ShadedRelief.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IRasterSymbolizer.Extrusion">
- <summary>
- A float value expression that modifies the "height" of the apparent shaded relief. A value
- of 1 should show the mountains at their true elevations, presuming the ElevationFactor is
- correct. A value of 0 would be totally flat, while 2 would be twice the value. This controls
- the 3D effects and has nothing to do with the creation of shaded releif on the texture.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IRasterSymbolizer.HillShade">
- <summary>
- Gets the calculated hillshade map, or re-calculates it if something has changed
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IRasterSymbolizer.ImageOutline">
- <summary>
- Gets or sets the symbol characteristics for the border of this raster
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IRasterSymbolizer.IsElevation">
- <summary>
- Gets or sets a boolean that determines whether to treat the values as if they are elevation
- in the 3-D context. If this is true, then it will automatically use this grid for
- calculating elevation values.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IRasterSymbolizer.IsVisible">
- <summary>
- Gets or sets whether or not this raster should render itself
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IRasterSymbolizer.IsSmoothed">
- <summary>
- Gets or sets whether or not htis raster should be anti-alliased
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IRasterSymbolizer.NoDataColor">
- <summary>
- Gets or sets the color to use if the value of the cell corresponds to a No-Data value
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IRasterSymbolizer.Opacity">
- <summary>
- Gets or sets a float value from 0 to 1, where 1 is fully opaque while 0 is fully transparent
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IRasterSymbolizer.Raster">
- <summary>
- Gets or sets the raster that should provide elevation values, but only if "IsElevation" is false.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IRasterSymbolizer.MeshHasChanged">
- <summary>
- This should be set to true if the elevation values have changed
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IRasterSymbolizer.ParentLayer">
- <summary>
- Gets or sets the parent layer. This is not always used, but can be useful for symbolic editing
- that may require a bitmap to be drawn with draped vector layers.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IRasterSymbolizer.Scheme">
- <summary>
- Gets or sets the coloring scheme for the raster.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IRasterSymbolizer.ShadedRelief">
- <summary>
- Gets or sets the characteristics of the shaded relief. This only affects the coloring,
- and will not control any 3-D properties.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IRasterSymbolizer.ColorSchemeHasUpdated">
- <summary>
- This should be set to true if the texture needs to be reloaded from a file
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IShadedRelief">
- <summary>
- IShadedRelief
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IShadedRelief.GetLightDirection">
- <summary>
- Returns the normalized light direction in X, Y, Z format
- </summary>
- <returns></returns>
- </member>
- <member name="E:DotSpatial.Symbology.IShadedRelief.ShadingChanged">
- <summary>
- Occurs when the shading for this object has been altered.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IShadedRelief.AmbientIntensity">
- <summary>
- Gets or sets a float specifying how strong the ambient directional light is. This should probably be about 1.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IShadedRelief.ElevationFactor">
- <summary>
- This is kept separate from extrusion to reduce confusion. This is a conversion factor that will
- convert the units of elevation into the same units that the latitude and longitude are stored in.
- To convert feet to decimal degrees is around a factor of .00000274
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IShadedRelief.Extrusion">
- <summary>
- A float value expression that modifies the "height" of the apparent shaded relief. A value
- of 1 should show the mountains at their true elevations, presuming the ElevationFactor is
- correct. A value of 0 would be totally flat, while 2 would be twice the value.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IShadedRelief.IsUsed">
- <summary>
- Gets or sets a boolean value indicating whether the ShadedRelief should be used or not.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IShadedRelief.LightIntensity">
- <summary>
- This specifies a float that should probably be around 1, which controls the light intensity.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IShadedRelief.ZenithAngle">
- <summary>
- Gets the zenith angle in degrees measured with 0 at the horizon and 90 vertically up
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IShadedRelief.LightDirection">
- <summary>
- The Azimuth light direction in degrees measured clockwise from North
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IShadedRelief.HasChanged">
- <summary>
- Gets whether or not the values have been changed on this ShadedRelief more recently than
- a HillShade map has been calculated from it.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.RasterEditorSettings.#ctor">
- <summary>
- Creates a new instance of VectorEditorSettings
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterEditorSettings.Min">
- <summary>
- Gets or sets the minimum value that will contribute to statistics
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterEditorSettings.Max">
- <summary>
- Gets or sets the maximum value that will contribute to statistics.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.RasterLayer">
- <summary>
- A raster layer describes using a single raster, and the primary application will be using this as a texture.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.RasterLayer.MaxCellsInMemory">
- <summary>
- Gets or sets maximum number of cells which can be stored in memory.
- By default it is 8000 * 8000.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.RasterLayer.#ctor(System.String,DotSpatial.Symbology.IRasterSymbolizer)">
- <summary>
- Opens the specified fileName using the layer manager.
- </summary>
- <param name="fileName"></param>
- <param name="symbolizer"></param>
- </member>
- <member name="M:DotSpatial.Symbology.RasterLayer.#ctor(System.String,DotSpatial.Data.IProgressHandler)">
- <summary>
- Opens the specified fileName and automatically creates a raster that can be used by this raster layer.
- </summary>
- <param name="fileName">The string fileName to use in order to open the file</param>
- <param name="inProgressHandler">The progress handler to show progress messages</param>
- </member>
- <member name="M:DotSpatial.Symbology.RasterLayer.#ctor(DotSpatial.Data.IRaster)">
- <summary>
- Creates a new raster layer using the progress handler defined on the DefaultLayerManager
- </summary>
- <param name="raster">The raster to create this layer for</param>
- </member>
- <member name="M:DotSpatial.Symbology.RasterLayer.#ctor(DotSpatial.Data.IRaster,DotSpatial.Data.IProgressHandler)">
- <summary>
- Creates a new instance of RasterLayer
- </summary>
- <param name="raster">The Raster</param>
- <param name="inProgressHandler">The Progress handler for any status updates</param>
- </member>
- <member name="M:DotSpatial.Symbology.RasterLayer.WriteBitmap">
- <summary>
- This only updates the bitmap representation of the raster. It does not write to a file unless
- the file is too large to fit in memory, in which case it will update the pyramid image.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.RasterLayer.WriteBitmap(DotSpatial.Data.IProgressHandler)">
- <summary>
- This only updates the bitmap representation of this raster. This can be overridden, but currently
- uses the default implementation.
- </summary>
- <param name="progressHandler">An implementation of IProgressHandler to receive status messages</param>
- </member>
- <member name="M:DotSpatial.Symbology.RasterLayer.ExportBitmap(System.String,DotSpatial.Data.ImageBandType)">
- <summary>
- Creates a bmp texture and saves it to the specified fileName.
- </summary>
- <param name="fileName">The string fileName to write to</param>
- <param name="bandType">The color band type.</param>
- </member>
- <member name="M:DotSpatial.Symbology.RasterLayer.ExportBitmap(System.String,DotSpatial.Data.IProgressHandler,DotSpatial.Data.ImageBandType)">
- <summary>
- Creates a new filename and saves the content from the current BitmapGetter to the
- file format. This relies on the DataManager and will only be successful for
- formats supported by the write format possibility. This will not update this raster
- </summary>
- <param name="fileName">The string fileName to write to</param>
- <param name="progressHandler">The progress handler for creating a new bitmap.</param>
- <param name="bandType">The band type ot use.</param>
- </member>
- <member name="M:DotSpatial.Symbology.RasterLayer.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:DotSpatial.Symbology.RasterLayer.CreatePyramidImage(System.String,DotSpatial.Data.IProgressHandler)">
- <summary>
- Render the full raster block by block, and then save the values to the pyramid raster.
- This will probably be nasty and time consuming, but what can you do.
- </summary>
- <param name="pyrFile"></param>
- <param name="progressHandler"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.RasterLayer.DefaultWriteBitmap(DotSpatial.Data.IProgressHandler)">
- <summary>
- This does not have to be used to work, but provides a default implementation for writing bitmap,
- and will be used by the MapRasterLayer class during file creation.
- </summary>
- <param name="progressHandler"></param>
- </member>
- <member name="M:DotSpatial.Symbology.RasterLayer.OnExportData">
- <summary>
- Handles the situation for exporting the layer as a new source.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.RasterLayer.OnShowProperties(System.ComponentModel.HandledEventArgs)">
- <summary>
- Occurs when this member should raise the shared event to show the property dialog for this raster layer.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Symbology.RasterLayer.Reproject(DotSpatial.Projections.ProjectionInfo)">
- <summary>
- Reprojects the dataset for this layer.
- </summary>
- <param name="targetProjection">The target projection to use.</param>
- </member>
- <member name="P:DotSpatial.Symbology.RasterLayer.RasterLayerActions">
- <summary>
- Gets or sets custom actions for RasterLayer
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterLayer.Bounds">
- <summary>
- Gets or sets the boundaries of the raster.
- </summary>
- <remarks>
- [Editor(typeof(Forms.PropertyGridEditor), typeof(UITypeEditor))]
- [TypeConverter(typeof(Forms.GeneralTypeConverter))]
- </remarks>
- </member>
- <member name="P:DotSpatial.Symbology.RasterLayer.BitmapGetter">
- <summary>
- This is what the raster layer uses to retrieve a bitmap representing the specified
- extent. This could later be redesigned to generate the bitmap on the fly, but I think
- that that would be slow, so caching is probably better.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterLayer.CellHeight">
- <summary>
- Gets the geographic height of the cells for this raster (North-South)
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterLayer.CellWidth">
- <summary>
- Gets the geographic width of the cells for this raster (East-West)
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterLayer.Checked">
- <summary>
- Gets or sets whether this should appear as checked in the legend. This is also how the
- layer will
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterLayer.DataType">
- <summary>
- Gets the data type of the values in this raster.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterLayer.East">
- <summary>
- Gets the eastern boundary of this raster.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterLayer.ElevationFactor">
- <summary>
- This is a conversion factor that is required in order to convert the elevation units into the same units as the geospatial projection for the latitude and logitude values of the grid.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterLayer.Extent">
- <summary>
- Obtains an envelope
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Symbology.RasterLayer.Extrusion">
- <summary>
- Gets the exaggeration beyond normal elevation values. A value of 1 is normal elevation,
- a value of 0 would be flat, while a value of 2 would be twice the normal elevation.
- This applies to the three-dimensional rendering and is not related to the shaded relief pattern
- created by the texture.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterLayer.Filename">
- <summary>
- Gets the fileName where this raster is saved.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterLayer.IsVisible">
- <summary>
- If this is false, then the drawing function will not render anything.
- Warning! This will also prevent any execution of calculations that take place
- as part of the drawing methods and will also abort the drawing methods of any
- sub-members to this IRenderable.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterLayer.LegendItems">
- <summary>
- Gets or sets the complete list of legend items contained within this legend item
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterLayer.LegendText">
- <summary>
- The text that will appear in the legend
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterLayer.Maximum">
- <summary>
- Gets the maximum value of this raster. If this is an elevation raster, this is also the top.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterLayer.Minimum">
- <summary>
- Gets the minimum value of this raster. If this is an elevation raster, this is also the bottom.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterLayer.NoDataValue">
- <summary>
- Gets the value that is used when no actual data exists for the specified location.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterLayer.North">
- <summary>
- Gets the northern boundary of this raster.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterLayer.NumBands">
- <summary>
- Gets the number of bands in this raster.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterLayer.NumColumns">
- <summary>
- Gets the number of columns in this raster.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterLayer.NumRows">
- <summary>
- Gets the number of rows in this raster.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterLayer.DataSet">
- <summary>
- Gets or sets the underlying dataset
- </summary>
- <remarks>
- [TypeConverter(typeof(Forms.GeneralTypeConverter))]
- [Editor(typeof(Forms.PropertyGridEditor), typeof(UITypeEditor))]
- </remarks>
- </member>
- <member name="P:DotSpatial.Symbology.RasterLayer.Symbolizer">
- <summary>
- Gets or sets the collection of symbolzier properties to use for this raster.
- [Editor(typeof(Forms.RasterColorSchemeEditor), typeof(UITypeEditor))]
- [TypeConverter(typeof(Forms.GeneralTypeConverter))]
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterLayer.South">
- <summary>
- Gets the southern boundary of this raster.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterLayer.West">
- <summary>
- Gets the western boundary of this raster.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.RasterLayer.ProjectionHelper.#ctor(DotSpatial.Data.Extent,System.Drawing.Rectangle)">
- <summary>
- Initializes a new instance of the ProjectionHelper class.
- </summary>
- <param name="geographicExtents">The geographic extents to project to and from.</param>
- <param name="viewRectangle">The view rectangle in pixels to transform with.</param>
- </member>
- <member name="P:DotSpatial.Symbology.RasterLayer.ProjectionHelper.GeographicExtents">
- <summary>
- Gets or sets the geographic extent to use.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterLayer.ProjectionHelper.ImageRectangle">
- <summary>
- Gets or sets the rectangular pixel region to use.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.RasterSymbolizer">
- <summary>
- RasterSymbolizer
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.RasterSymbolizer.#ctor(DotSpatial.Symbology.IRasterLayer)">
- <summary>
- Creates a new instance of the raster symbolizer
- </summary>
- <param name="layer">The parent item</param>
- </member>
- <member name="M:DotSpatial.Symbology.RasterSymbolizer.#ctor">
- <summary>
- Creates a new instance of Raste
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.RasterSymbolizer.CreateHillShade">
- <summary>
- Causes the raster to calculate a hillshade based on this symbolizer
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.RasterSymbolizer.CreateHillShade(DotSpatial.Data.IProgressHandler)">
- <summary>
- Causes the raster to calculate a hillshade using the specified progress handler
- </summary>
- <param name="progressHandler">The progress handler to use</param>
- </member>
- <member name="M:DotSpatial.Symbology.RasterSymbolizer.CreateBitmap">
- <summary>
- Creates a bmp from the in-memory portion of the raster. This will be stored as a
- fileName with the same name as the current raster, but ends in bmp.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.RasterSymbolizer.GetColor(System.Double)">
- <summary>
- Gets the color information for a specific value. This does not include any hillshade information.
- </summary>
- <param name="value">Specifies the value to obtain a color for.</param>
- <returns>A Color</returns>
- </member>
- <member name="M:DotSpatial.Symbology.RasterSymbolizer.Refresh">
- <summary>
- Sends a symbology updated event, which should cause the layer to be refreshed.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.RasterSymbolizer.PaintShadingToBitmap(System.Drawing.Bitmap,DotSpatial.Data.IProgressHandler)">
- <summary>
- Creates a bitmap based on the specified RasterSymbolizer
- </summary>
- <param name="bitmap"> the bitmap to paint to</param>
- <param name="progressHandler">The progress handler</param>
- </member>
- <member name="M:DotSpatial.Symbology.RasterSymbolizer.Validate">
- <summary>
- Indicates that the bitmap has been updated and that the colorscheme is currently
- synchronized with the characteristics of this symbolizer. This also fires the
- ColorSchemeChanged event.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.RasterSymbolizer.OnColorSchemeUpdated">
- <summary>
- Fires the SymbologyUpdated event, which should happen after symbology choices are finalized,
- a new texture has been created and we are ready for an update.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.RasterSymbolizer.OnColorSchemeChanged">
- <summary>
- Fires the on color scheme changed event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.RasterSymbolizer.OnSymbologyChange">
- <summary>
- Fires the SymbologyChanged event
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.RasterSymbolizer.ColorSchemeUpdated">
- <summary>
- This event occurs after a new bitmap has been created to act as a texture.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.RasterSymbolizer.SymbologyChanged">
- <summary>
- Occurs when the symbology has been changed
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.RasterSymbolizer.ColorSchemeChanged">
- <summary>
- Occurs if any of the properties that would contribute to bitmap construction have changed
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterSymbolizer.ColorSchemeHasUpdated">
- <summary>
- This should be set to true if the texture needs to be reloaded from a file
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterSymbolizer.MeshHasChanged">
- <summary>
- This should be set to true if the elevation values have changed
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterSymbolizer.ColorSchemeHasChanged">
- <summary>
- Gets or sets a boolean that indicates if the color has changed.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterSymbolizer.DrapeVectorLayers">
- <summary>
- If this value is true, whenever a texture is created, the vector layers are drawn onto the texture.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterSymbolizer.EditorSettings">
- <summary>
- Gets or sets the editor settings class to help setup up the symbology controls appropriately.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterSymbolizer.ElevationFactor">
- <summary>
- This is kept separate from extrusion to reduce confusion. This is a conversion factor that will
- convert the units of elevation into the same units that the latitude and longitude are stored in.
- To convert feet to decimal degrees is around a factor of .00000274. This is used only in the
- 3D-context and does not affect ShadedRelief.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterSymbolizer.Extrusion">
- <summary>
- A float value expression that modifies the "height" of the apparent shaded relief. A value
- of 1 should show the mountains at their true elevations, presuming the ElevationFactor is
- correct. A value of 0 would be totally flat, while 2 would be twice the value. This controls
- the 3D effects and has nothing to do with the creation of shaded releif on the texture.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterSymbolizer.HillShade">
- <summary>
- Gets the calculated hillshade map, or re-calculates it if something has changed
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterSymbolizer.ImageOutline">
- <summary>
- Gets or sets the symbol characteristics for the border of this raster
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterSymbolizer.IsElevation">
- <summary>
- Gets or sets a boolean that determines whether to treat the values as if they are elevation
- in the 3-D context. If this is true, then it will automatically use this grid for
- calculating elevation values. This does not affect ShadedRelief texture creation.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterSymbolizer.IsVisible">
- <summary>
- Gets or sets whether or not this raster should render itself
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterSymbolizer.NoDataColor">
- <summary>
- Gets or sets the color to use if the value of the cell corresponds to a No-Data value
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterSymbolizer.Raster">
- <summary>
- Gets or sets the raster that should provide elevation values, but only if "IsElevation" is false.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterSymbolizer.ParentLayer">
- <summary>
- Gets or sets the parent layer. This is not always used, but can be useful for symbolic editing
- that may require a bitmap to be drawn with draped vector layers.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterSymbolizer.Opacity">
- <summary>
- Gets or sets a float value from 0 to 1, where 1 is fully opaque while 0 is fully transparent
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterSymbolizer.ShadedRelief">
- <summary>
- Gets or sets the characteristics of the shaded relief. This is specifically used
- to control HillShade characteristics of the BitMap texture creation.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterSymbolizer.IsSmoothed">
- <summary>
- Gets or sets whether or not htis raster should be anti-alliased
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.RasterSymbolizer.Scheme">
- <summary>
- Gets or sets the raster coloring scheme.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.ShadedRelief">
- <summary>
- ShadedRelief
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ShadedRelief.#ctor">
- <summary>
- Creates a new instance of the ShadedRelief preset for elevation in feet and coordinates in decimal degrees
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ShadedRelief.#ctor(DotSpatial.Symbology.ElevationScenario)">
- <summary>
- Creates a new instance of ShadedRelief based on some more common
- elevation to goegraphic coordinate sysetem scenarios
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ShadedRelief.GetLightDirection">
- <summary>
- Returns a normalized vector in 3 dimensions representing the angle
- of the light source.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.ShadedRelief.OnShadingChanged">
- <summary>
- Fires the ShadingChanged event
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.ShadedRelief.ShadingChanged">
- <summary>
- Occurs when the shading for this object has been altered.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ShadedRelief.AmbientIntensity">
- <summary>
- Gets or sets a float specifying how strong the ambient directional light is. This should probably be about 1.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ShadedRelief.ElevationFactor">
- <summary>
- This is kept separate from extrusion to reduce confusion. This is a conversion factor that will
- convert the units of elevation into the same units that the latitude and longitude are stored in.
- To convert feet to decimal degrees is around a factor of .00000274
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ShadedRelief.Extrusion">
- <summary>
- A float value expression that modifies the "height" of the apparent shaded relief. A value
- of 1 should show the mountains at their true elevations, presuming the ElevationFactor is
- correct. A value of 0 would be totally flat, while 2 would be twice the value.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ShadedRelief.IsUsed">
- <summary>
- Gets or sets a boolean value indicating whether the ShadedRelief should be used or not.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ShadedRelief.ZenithAngle">
- <summary>
- Gets or sets the zenith angle for the light direction in degrees from 0 (at the horizon) to 90 (straight up).
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ShadedRelief.LightDirection">
- <summary>
- Gets or sets a double that represents the light direction in degrees clockwise from North
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ShadedRelief.LightIntensity">
- <summary>
- This specifies a float that should probably be around 1, which controls the light intensity.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ShadedRelief.HasChanged">
- <summary>
- Gets whether or not the values have been changed on this ShadedRelief more recently than
- a HillShade map has been calculated from it.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.ScaleMode">
- <summary>
- Specifies whether non-coordinate drawing properties like width or size
- use pixels or map coordinates. If pixels are used, a "back transform"
- to approximate pixel sizes.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.ScaleMode.Simple">
- <summary>
- Uses the simplest symbology possible, but can draw quickly
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.ScaleMode.Geographic">
- <summary>
- Symbol sizing parameters are based in world coordinates and will get smaller when zooming out like a real object.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.ScaleMode.Symbolic">
- <summary>
- The symbols approximately preserve their size as you zoom
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.SelectableExt">
- <summary>
- Extends the ISelectable interface with some overloads that ignore the output affected areas
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.SelectableExt.ClearSelection(DotSpatial.Symbology.ISelectable)">
- <summary>
- Clears the selection, and ignores the affected area.
- </summary>
- <param name="self">This selectable item</param>
- <returns>Boolean, true if members were removed from the selection</returns>
- </member>
- <member name="M:DotSpatial.Symbology.SelectableExt.InvertSelection(DotSpatial.Symbology.ISelectable,DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IEnvelope)">
- <summary>
- This ignores the affected region and assumes that you want to use a selection based on
- the Intersects selection mode.
- </summary>
- <param name="self">The ISelectable object</param>
- <param name="tolerant">The region where selection should take place</param>
- <param name="strict">The region in cases where tolerance is not used</param>
- <returns>Boolean, true if the selected state of any members of this item were altered</returns>
- </member>
- <member name="M:DotSpatial.Symbology.SelectableExt.InvertSelection(DotSpatial.Symbology.IFeatureLayer,DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IEnvelope@)">
- <summary>
- Inverts the selection state of members that intersect the specified region.
- The affected area will be returned.
- </summary>
- <param name="self">The IFeatureLayer to modify the selection for</param>
- <param name="tolerant">The geographic envelope in cases like cliking near points where tolerance is allowed</param>
- <param name="strict">The geographic region when working with absolutes, without a tolerance</param>
- <param name="affectedArea">The affected area to modify</param>
- <returns>Boolean, true if the selection state was modified by this action</returns>
- </member>
- <member name="M:DotSpatial.Symbology.SelectableExt.Select(DotSpatial.Symbology.ISelectable,DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IEnvelope)">
- <summary>
- This ignores the affected region and assumes that you want to use a selection based on
- the Intersects selection mode.
- </summary>
- <param name="self">This ISelectable</param>
- <param name="tolerant">The geographic envelope in cases like cliking near points where tolerance is allowed</param>
- <param name="strict">The geographic region when working with absolutes, without a tolerance</param>
- <returns>Boolean, true if any items were added to the selection</returns>
- </member>
- <member name="M:DotSpatial.Symbology.SelectableExt.Select(DotSpatial.Symbology.IFeatureLayer,DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IEnvelope@)">
- <summary>
- Highlights the values in the specified region, and returns the affected area from the selection,
- which should allow for slightly faster drawing in cases where only a small area is changed.
- </summary>
- <param name="self">The IFeatureLayer from which to select features</param>
- <param name="tolerant">The geographic envelope in cases like cliking near points where tolerance is allowed</param>
- <param name="strict">The geographic region when working with absolutes, without a tolerance</param>
- <param name="affectedArea">The geographic envelope of the region impacted by the selection.</param>
- <returns>True if any members were added to the current selection.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.SelectableExt.UnSelect(DotSpatial.Symbology.ISelectable,DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IEnvelope)">
- <summary>
- This ignores the affected region and assumes that you want to use a selection based on
- the Intersects selection mode.
- </summary>
- <param name="self">This ISelectable</param>
- <param name="tolerant">The geographic envelope in cases like cliking near points where tolerance is allowed</param>
- <param name="strict">The geographic region when working with absolutes, without a tolerance</param>
- <returns>Boolean, true if any items were added to the selection</returns>
- </member>
- <member name="M:DotSpatial.Symbology.SelectableExt.UnSelect(DotSpatial.Symbology.IFeatureLayer,DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IEnvelope@)">
- <summary>
- Un-highlights or returns the features that intersect with the specified region.
- </summary>
- <param name="self">The IFeatureLayer from which to unselect features.</param>
- <param name="tolerant">The geographic envelope in cases like cliking near points where tolerance is allowed.</param>
- <param name="strict">The geographic region when working with absolutes, without a tolerance.</param>
- <param name="affectedArea">The geographic envelope that will be visibly impacted by the change.</param>
- <returns>Boolean, true if members were removed from the selection.</returns>
- </member>
- <member name="T:DotSpatial.Symbology.ShallowCopy">
- <summary>
- Normally, cloning an object starts with MemberwiseClone, which
- creates a shallow copy of the object. For any members that
- derive from the Descriptor, however, any public properties
- or fields that implement ICloneable are copied (deep copy behavior).
- This is not always desirable, even if the member CAN be copied.
- This attribute causes the deep copy behavior to skip over
- properties marked with this attribute.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.SimpleLayerEventArgs">
- <summary>
- LayerEventArgs
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.SimpleLayerEventArgs.#ctor(DotSpatial.Symbology.ILayer)">
- <summary>
- Creates a new instance of LayerEventArgs
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SimpleLayerEventArgs.Layer">
- <summary>
- Gets a layer
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Size2D">
- <summary>
- Size2D
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Size2D.Height">
- <summary>
- Gets or sets the height
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.Size2D.Width">
- <summary>
- Gets or sets the width
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Size2D.#ctor">
- <summary>
- Creates a new instance of Size2D
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Size2D.#ctor(System.Double,System.Double)">
- <summary>
- Creates a new instance of a Size2D
- </summary>
- <param name="width">The double width</param>
- <param name="height">The double height</param>
- </member>
- <member name="M:DotSpatial.Symbology.Size2D.Equals(System.Object)">
- <summary>
- Tests for equality against an object.
- </summary>
- <param name="obj"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Size2D.Equals(DotSpatial.Symbology.Size2D)">
- <summary>
- Tests for equality against another size.
- </summary>
- <param name="size">the size to compare this size to</param>
- <returns>boolean, true if the height and width are the same in each case.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Size2D.ToString">
- <summary>
- Gets the string equivalent of this object
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Size2D.op_Equality(DotSpatial.Symbology.Size2D,DotSpatial.Symbology.Size2D)">
- <summary>
- Determines if the height and width are both equal
- </summary>
- <param name="a"></param>
- <param name="b"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Size2D.op_Inequality(DotSpatial.Symbology.Size2D,DotSpatial.Symbology.Size2D)">
- <summary>
- Determiens if the height and width are not equal
- </summary>
- <param name="a"></param>
- <param name="b"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Size2D.GetHashCode">
- <summary>
- Returns the basic hash code for the object.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Size2D.OnRandomize(System.Random)">
- <summary>
- Generates random doubles for the size from 1 to 100 for both the width and height
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.SnapShotEventArgs">
- <summary>
- SnapShotEventArgs
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.SnapShotEventArgs.#ctor(System.Drawing.Bitmap)">
- <summary>
- Creates a new instance of SnapShotEventArgs
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SnapShotEventArgs.Picture">
- <summary>
- Gets the picture that was taken by the snapshot
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.SymbolMode">
- <summary>
- This describes the three permitted states for legend items.
- Items can have a checkbox or a symbol, but not both.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.SymbolMode.Checkbox">
- <summary>
- Display a checkbox next to the legend item
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.SymbolMode.GroupSymbol">
- <summary>
- Draws a symbol, but also allows collapsing.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.SymbolMode.Symbol">
- <summary>
- Display a symbol next to the legend item
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.SymbolMode.None">
- <summary>
- Display only legend text
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.SymbologyGlobal">
- <summary>
- Global has some basic methods that may be useful in lots of places.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.SymbologyGlobal._defaultRandom">
- <summary>
- An instance of Random that is created when needed and sits around so we don't keep creating new ones.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.SymbologyGlobal.HighlightBrush(System.Drawing.Rectangle,System.Drawing.Color)">
- <summary>
- Gets a cool Highlight brush for highlighting things
- </summary>
- <param name="box">The rectangle in the box</param>
- <param name="selectionHighlight">The color to use for the higlight</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.SymbologyGlobal.DrawRoundedRectangle(System.Drawing.Graphics,System.Drawing.Pen,System.Drawing.Rectangle)">
- <summary>
- Draws a rectangle with ever so slightly rounded edges. Good for selection borders.
- </summary>
- <param name="g">The Graphics object</param>
- <param name="pen">The pen to draw with</param>
- <param name="rect">The rectangle to draw to.</param>
- </member>
- <member name="M:DotSpatial.Symbology.SymbologyGlobal.GetRectangle(System.Drawing.Point,System.Drawing.Point)">
- <summary>
- Obtains a system.Drawing.Rectangle based on the two points, using them as
- opposite extremes for the rectangle.
- </summary>
- <param name="a">one corner point of the rectangle.</param>
- <param name="b">The opposing corner of the rectangle.</param>
- <returns>A System.Draing.Rectangle</returns>
- </member>
- <member name="M:DotSpatial.Symbology.SymbologyGlobal.RandomColor">
- <summary>
- Returns a completely random opaque color.
- </summary>
- <returns>A random color.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.SymbologyGlobal.RandomTranslucent(System.Single)">
- <summary>
- This allows the creation of a transparent color with the specified opacity.
- </summary>
- <param name="opacity">A float ranging from 0 for transparent to 1 for opaque</param>
- <returns>A Color</returns>
- </member>
- <member name="M:DotSpatial.Symbology.SymbologyGlobal.RandomLightColor(System.Single)">
- <summary>
- This allows the creation of a transparent color with the specified opacity.
- </summary>
- <param name="opacity">A float ranging from 0 for transparent to 1 for opaque</param>
- <returns>A Color</returns>
- </member>
- <member name="M:DotSpatial.Symbology.SymbologyGlobal.RandomDarkColor(System.Single)">
- <summary>
- This allows the creation of a transparent color with the specified opacity.
- </summary>
- <param name="opacity">A float ranging from 0 for transparent to 1 for opaque</param>
- <returns>A Color</returns>
- </member>
- <member name="M:DotSpatial.Symbology.SymbologyGlobal.ColorFromHsl(System.Double,System.Double,System.Double)">
- <summary>
- Converts a colour from HSL to RGB
- </summary>
- <remarks>Adapted from the algoritm in Foley and Van-Dam</remarks>
- <param name="hue">A double representing degrees ranging from 0 to 360 and is equal to the GetHue() on a Color structure.</param>
- <param name="saturation">A double value ranging from 0 to 1, where 0 is gray and 1 is fully saturated with color.</param>
- <param name="brightness">A double value ranging from 0 to 1, where 0 is black and 1 is white.</param>
- <returns>A Color structure with the equivalent hue saturation and brightness</returns>
- </member>
- <member name="M:DotSpatial.Symbology.TextSymbolChangedEventArgs.#ctor(DotSpatial.Symbology.ILabel,DotSpatial.Symbology.ILabelSymbolizer,DotSpatial.Symbology.ILabelSymbolizer)">
- <summary>
- Creates a new instance of MemberChangedEventArgs
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.TextSymbolChangedEventArgs.Label">
- <summary>
- Gets the Label that was updated
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.TextSymbolChangedEventArgs.OldSymbolizer">
- <summary>
- Gets the previous symbolizer that this label no longer uses.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.TextSymbolChangedEventArgs.NewSymbolizer">
- <summary>
- Gets the new symbolizer that this label now uses.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.ClassificationType">
- <summary>
- ClassificationTypes
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.ClassificationType.Custom">
- <summary>
- Each category is designed with a custom expression
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.ClassificationType.UniqueValues">
- <summary>
- Unique values are added
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.ClassificationType.Quantities">
- <summary>
- A Quantile scheme is applied, which forces the behavior of continuous categories.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IDrawingFilter">
- <summary>
- IDrawingFilter
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IDrawingFilter.ApplyScheme(DotSpatial.Symbology.IFeatureScheme)">
- <summary>
- This will set all values to the default (0) category. Then, it will use the filter
- expressions on the remaining categories to change the categories for those members.
- This means that an item will be classified as the last filter that it qualifies for.
- </summary>
- <param name="scheme">The scheme of categories to apply to the drawing states</param>
- </member>
- <member name="M:DotSpatial.Symbology.IDrawingFilter.Invalidate">
- <summary>
- Invalidates this drawing filter, forcing a re-creation
- of the entire dictionary from the source featureset.
- This should only be done if changes are made to the
- feature list while SuspendChanges on the list is true.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IDrawingFilter.GetDefaultState(System.Int32)">
- <summary>
- If UseChunks is true, this uses the index value combined with the chunk size
- to calculate the chunk, and also sets the category to the [0] category and the
- selection state to unselected. This can be overridden in sub-classes to come up
- with a different default state.
- </summary>
- <param name="index">The integer index to get the default state of</param>
- <returns>An IDrawnState</returns>
- </member>
- <member name="E:DotSpatial.Symbology.IDrawingFilter.Initialized">
- <summary>
- Occurs after this filter has built its internal list of items.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IDrawingFilter.Category">
- <summary>
- Gets or sets the scheme category to use
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IDrawingFilter.Chunk">
- <summary>
- Gets the integer chunk that the filter should use
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IDrawingFilter.ChunkSize">
- <summary>
- Gets or sets the integer size of each chunk. Setting this to
- a new value will cycle through and update the chunk on all
- the features.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IDrawingFilter.Count">
- <summary>
- If the drawing state for any features has changed, or else if
- the state of any members has changed, this will cycle through
- the filter members and cache a new count. If nothing has
- changed, then this will simply return the cached value.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IDrawingFilter.DefaultCategory">
- <summary>
- Gets the default category for the scheme.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IDrawingFilter.DrawnStates">
- <summary>
- Gets the dictionary of drawn states that this drawing filter uses.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IDrawingFilter.FeatureList">
- <summary>
- Gets the underlying list of features that this drawing filter
- is ultimately based upon.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IDrawingFilter.NumChunks">
- <summary>
- If chunks are being used, then this indicates the total count of chunks.
- Otherwise, this returns 1 as everything is effectively in one chunk.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IDrawingFilter.Selected">
- <summary>
- If UseSelection is true, this will get or set the boolean selection state
- that will be used to select values.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IDrawingFilter.Item(DotSpatial.Data.IFeature)">
- <summary>
- This uses the feature as the key and attempts to find the specified drawn state
- that describes selection, chunk and category.
- </summary>
- <param name="key">The feature</param>
- <remarks>The strength is that if someone inserts a new member or re-orders
- the features in the featureset, we don't forget which ones are selected.
- The disadvantage is that duplicate features in the same featureset
- will cause an exception.</remarks>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Symbology.IDrawingFilter.Item(System.Int32)">
- <summary>
- This is less direct as it requires searching two indices rather than one, but
- allows access to the drawn state based on the feature ID.
- </summary>
- <param name="index">The integer index in the underlying featureSet.</param>
- <returns>The current IDrawnState for the current feature.</returns>
- </member>
- <member name="P:DotSpatial.Symbology.IDrawingFilter.UseChunks">
- <summary>
- Gets or sets a boolean that indicates whether we should use the chunk
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IDrawingFilter.UseSelection">
- <summary>
- Gets or sets a boolean that indicates whether this filter should use the Selected
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IDrawingFilter.UseCategory">
- <summary>
- Gets or sets a boolean that indicates whether the filter should subdivide based on category.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IDrawingFilter.UseVisibility">
- <summary>
- Gets or sets a boolean that indicates whether the filter should consider the IsVisible property
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IDrawingFilter.Visible">
- <summary>
- Gets or sets a boolean that specifies whether to return visible, or hidden features if UseVisibility is true.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.DrawingFilter.#ctor(DotSpatial.Data.IFeatureList,DotSpatial.Symbology.IFeatureScheme)">
- <summary>
- Creates a new instance of DrawingFilter without using any chunks. The use chunks
- value will be false, and sub-categories will not be selected based on the chunk.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.DrawingFilter.#ctor(DotSpatial.Data.IFeatureList,DotSpatial.Symbology.IFeatureScheme,System.Int32)">
- <summary>
- Creates a new instance of DrawingFilter, sub-dividing the features into chunks.
- regardless of selection or category, chunks simply subdivide the filter
- into chunks of equal size.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.DrawingFilter.Clone">
- <summary>
- Creates a shallow copy
- </summary>
- <returns>Returns a shallow copy of this object.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.DrawingFilter.ApplyScheme(DotSpatial.Symbology.IFeatureScheme)">
- <summary>
- This will use the filter expressions on the categories to change the categories for those members.
- This means that an item will be classified as the last filter that it qualifies for.
- </summary>
- <param name="scheme">The scheme of categories to apply to the drawing states</param>
- </member>
- <member name="M:DotSpatial.Symbology.DrawingFilter.GetDefaultState(System.Int32)">
- <summary>
- If UseChunks is true, this uses the index value combined with the chunk size
- to calculate the chunk, and also sets the category to the [0] category and the
- selection state to unselected. This can be overridden in sub-classes to come up
- with a different default state.
- </summary>
- <param name="index">The integer index to get the default state of</param>
- <returns>An IDrawnState</returns>
- </member>
- <member name="M:DotSpatial.Symbology.DrawingFilter.GetEnumerator">
- <summary>
- Gets an enumator for cycling through exclusively the features that satisfy all the listed criteria,
- including chunk index, selected state, and scheme category.
- </summary>
- <returns>An Enumerator for cycling through the values</returns>
- </member>
- <member name="M:DotSpatial.Symbology.DrawingFilter.Invalidate">
- <summary>
- Invalidates this drawing filter, effectively eliminating all the original
- categories, selection statuses, and only keeps the basic chunk size.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.DrawingFilter.OnInitialize">
- <summary>
- Fires the Initialized Event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.DrawingFilter.DoInitialize">
- <summary>
- This block of code actually cycles through the source features, and assigns a default
- drawing state to each feature. I thought duplicate features would be less of a problem
- then people re-ordering an indexed list at some point, so for now we are using
- features to index the values.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.DrawingFilter.Initialized">
- <summary>
- Occurs after this filter has built its internal list of items.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.DrawingFilter.Category">
- <summary>
- Gets or sets the scheme category to use
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.DrawingFilter.Chunk">
- <summary>
- Gets the integer chunk that the filter should use
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.DrawingFilter.ChunkSize">
- <summary>
- Gets or sets the integer size of each chunk. Setting this to
- a new value will cycle through and update the chunk on all
- the features.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.DrawingFilter.Count">
- <summary>
- If the drawing state for any features has changed, or else if
- the state of any members has changed, this will cycle through
- the filter members and cache a new count. If nothing has
- changed, then this will simply return the cached value.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.DrawingFilter.DefaultCategory">
- <summary>
- Gets the default category for the scheme.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.DrawingFilter.DrawnStates">
- <summary>
- Gets the dictionary of drawn states that this drawing filter uses.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.DrawingFilter.FeatureList">
- <summary>
- Gets the underlying list of features that this drawing filter
- is ultimately based upon.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.DrawingFilter.NumChunks">
- <summary>
- If chunks are being used, then this indicates the total count of chunks.
- Otherwise, this returns 1 as everything is effectively in one chunk.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.DrawingFilter.Selected">
- <summary>
- If UseSelection is true, this will get or set the boolean selection state
- that will be used to select values.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.DrawingFilter.Item(DotSpatial.Data.IFeature)">
- <summary>
- This uses the feature as the key and attempts to find the specified drawn state
- that describes selection, chunk and category.
- </summary>
- <param name="key">The feature</param>
- <remarks>The strength is that if someone inserts a new member or re-orders
- the features in the featureset, we don't forget which ones are selected.
- The disadvantage is that duplicate features in the same featureset
- will cause an exception.</remarks>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Symbology.DrawingFilter.Item(System.Int32)">
- <summary>
- This is less direct as it requires searching two indices rather than one, but
- allows access to the drawn state based on the feature ID.
- </summary>
- <param name="index">The integer index in the underlying featureSet.</param>
- <returns>The current IDrawnState for the current feature.</returns>
- </member>
- <member name="P:DotSpatial.Symbology.DrawingFilter.UseCategory">
- <summary>
- Gets or sets a boolean that indicates whether the filter should subdivide based on category.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.DrawingFilter.UseChunks">
- <summary>
- Gets or sets a boolean that indicates whether we should use the chunk
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.DrawingFilter.UseSelection">
- <summary>
- Gets or sets a boolean that indicates whether this filter should use the Selected
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.DrawingFilter.UseVisibility">
- <summary>
- Gets or sets the boolean indicating whether or not this feature should be drawn.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.DrawingFilter.Visible">
- <summary>
- Gets or sets a boolean that specifies whether to return visible, or hidden features if UseVisibility is true.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.DrawnState">
- <summary>
- DrawFeatures simply group the feature with characteristics like selected and category for easier tracking.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IDrawnState">
- <summary>
- IDrawnFeature
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IDrawnState.Chunk">
- <summary>
- Gets or sets the integer chunk that this item belongs to.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IDrawnState.SchemeCategory">
- <summary>
- Gets or sets the scheme category
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IDrawnState.IsSelected">
- <summary>
- Gets or sets a boolean, true if this feature is currently selected
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IDrawnState.IsVisible">
- <summary>
- Gets or sets whether this feature is currently being drawn.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.DrawnState.#ctor">
- <summary>
- Creates a new instance of DrawnState class that helps to narrow down the features to be drawn.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.DrawnState.#ctor(DotSpatial.Symbology.IFeatureCategory,System.Boolean,System.Int32,System.Boolean)">
- <summary>
- Creates a new instance of a DrawnState class for subdividing features.
- </summary>
- <param name="category">A category that the feature belongs to</param>
- <param name="selected">Boolean, true if the feature is currently selected</param>
- <param name="chunk">An integer chunk that this feature should belong to</param>
- <param name="visible">A boolean indicating whether this feature is visible or not</param>
- </member>
- <member name="M:DotSpatial.Symbology.DrawnState.GetHashCode">
- <summary>
- Not entirely sure about using these features this way. It might not work well with interfaces.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.DrawnState.Equals(System.Object)">
- <summary>
- Takes any object, but attempts to compare it with values as an IDrawnState. If it can satisfy
- the IDrawnState interface and all the values are the same then this returns true.
- </summary>
- <param name="obj"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.DrawnState.op_Equality(DotSpatial.Symbology.DrawnState,DotSpatial.Symbology.IDrawnState)">
- <summary>
- Overrides the standard equal operator
- </summary>
- <param name="u"></param>
- <param name="v"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.DrawnState.op_Inequality(DotSpatial.Symbology.DrawnState,DotSpatial.Symbology.IDrawnState)">
- <summary>
- Overrides the not-equal to operator
- </summary>
- <param name="u"></param>
- <param name="v"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Symbology.DrawnState.SchemeCategory">
- <summary>
- Gets or sets the scheme category
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.DrawnState.IsSelected">
- <summary>
- Gets or sets a boolean, true if this feature is currently selected
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.DrawnState.IsVisible">
- <summary>
- Gets or sets whether this feature is currently being drawn.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.DrawnState.Chunk">
- <summary>
- Gets or sets the integer chunk that this item belongs to.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ExpressionEventArgs.#ctor(System.String)">
- <summary>
- Creates a new instance of StringEventArgs
- </summary>
- <param name="expression">The string expression for this event args</param>
- </member>
- <member name="P:DotSpatial.Symbology.ExpressionEventArgs.Expression">
- <summary>
- The string expression for this event.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.FastDrawnState">
- <summary>
- FastDrawnState uses fields, not properties.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.FastDrawnState.Category">
- <summary>
- The category that describes the symbolic drawing for this item.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.FastDrawnState.Selected">
- <summary>
- Boolean, true if this item should be drawn as being selected
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.FastDrawnState.Visible">
- <summary>
- A Boolean that indicates whether or not this feature should be drawn at all.
- This should default to true.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FastDrawnState.#ctor">
- <summary>
- Creates a blank fast drawn state
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FastDrawnState.#ctor(System.Boolean,DotSpatial.Symbology.IFeatureCategory)">
- <summary>
- Creates a new FastDrawnState with the specified parameters
- </summary>
- <param name="sel"></param>
- <param name="cat"></param>
- </member>
- <member name="M:DotSpatial.Symbology.FastDrawnState.ToString">
- <summary>
- Overrides ToString to give a description of the FastDrawnState.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.FastDrawnState.Equals(System.Object)">
- <summary>
- Equality based on the Boolean and category settings
- </summary>
- <param name="obj">The fast drawn state to compare with</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.FastDrawnState.GetHashCode">
- <summary>
- For ordering in a dictionary, if get hash code is the same, then equals is used to test equality.
- For performance, try to make sure that hash codes are different enough for organizing in the
- dictionary, but are the same in cases where Category and Selected are the same.
- </summary>
- <returns>An integer hash code for this item.</returns>
- </member>
- <member name="T:DotSpatial.Symbology.FeatureCategory">
- <summary>
- A Scheme category does not reference individual members or indices, but simply describes a symbolic representation that
- can be used by an actual category.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IFeatureCategory">
- <summary>
- IFeatureCategory
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureCategory.IsWithinLegendSelection">
- <summary>
- Queries this layer and the entire parental tree up to the map frame to determine if
- this layer is within the selected layers.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureCategory.GetColor">
- <summary>
- This gets a single color that attempts to represent the specified
- category. For polygons, for example, this is the fill color (or central fill color)
- of the top pattern. If an image is being used, the color will be gray.
- </summary>
- <returns>The System.Color that can be used as an approximation to represent this category.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureCategory.SetColor(System.Drawing.Color)">
- <summary>
- This applies the color to the top symbol stroke or pattern.
- </summary>
- <param name="color">The Color to apply</param>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureCategory.DisplayExpression">
- <summary>
- In some cases, it is useful to simply be able to show an approximation of the actual expression.
- This also removes brackets from the field names to make it slightly cleaner.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.IFeatureCategory.SelectFeatures">
- <summary>
- Occurs when the select features context menu is clicked.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.IFeatureCategory.DeselectFeatures">
- <summary>
- Occurs when the deselect features context menu is clicked.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IFeatureCategory.Symbolizer">
- <summary>
- Gets or sets the symbolizer used for this category.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IFeatureCategory.SelectionSymbolizer">
- <summary>
- Gets or sets the symbolizer used for this category
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IFeatureCategory.FilterExpression">
- <summary>
- Gets or set the filter expression that is used to add members to generate a category based on this scheme.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureCategory.#ctor">
- <summary>
- Creates a new instance of FeatureSchemeCategory
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureCategory.ApplyMinMax(DotSpatial.Symbology.EditorSettings)">
- <summary>
- Applies the minimum and maximum in order to create the filter expression. This will also
- count the members that match the specified criteria.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureCategory.LegendSymbol_Painted(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Controls what happens in the legend when this item is instructed to draw a symbol.
- </summary>
- <param name="g"></param>
- <param name="box"></param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureCategory.IsWithinLegendSelection">
- <summary>
- Queries this layer and the entire parental tree up to the map frame to determine if
- this layer is within the selected layers.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureCategory.GetColor">
- <summary>
- This gets a single color that attempts to represent the specified
- category. For polygons, for example, this is the fill color (or central fill color)
- of the top pattern. If an image is being used, the color will be gray.
- </summary>
- <returns>The System.Color that can be used as an approximation to represent this category.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureCategory.SetColor(System.Drawing.Color)">
- <summary>
- This applies the color to the top symbol stroke or pattern.
- </summary>
- <param name="color">The Color to apply</param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureCategory.DisplayExpression">
- <summary>
- In some cases, it is useful to simply be able to show an approximation of the actual expression.
- This also removes brackets from the field names to make it slightly cleaner.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureCategory.OnCopy(DotSpatial.Symbology.Descriptor)">
- <summary>
- Makes it so that if there are any pre-existing listeners to the SelectFeatuers
- event when creating a clone of this object, those listeners are removed.
- They should be added correctly when the cloned item is added to the collection,
- after being cloned.
- </summary>
- <param name="copy"></param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureCategory.CreateContextMenuItems">
- <summary>
- Forces the creation of an entirely new context menu list. That way, we are not
- pointing to an event handler in the previous parent.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureCategory.OnSelectFeatures">
- <summary>
- Fires the SelectFeatures event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureCategory.OnDeselectFeatures">
- <summary>
- Triggers the DeselectFeatures event.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.FeatureCategory.SelectFeatures">
- <summary>
- Occurs when the select features context menu is clicked.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.FeatureCategory.DeselectFeatures">
- <summary>
- Occurs when the deselect features context menu is clicked.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureCategory.Symbolizer">
- <summary>
- Gets or sets the symbolizer used for this category.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureCategory.SelectionSymbolizer">
- <summary>
- Gets or sets the symbolizer used for this category
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureCategory.FilterExpression">
- <summary>
- Gets or set the filter expression that is used to add members to generate a category based on this scheme.
- </summary>
- <remarks>[Editor(typeof(ExpressionEditor), typeof(UITypeEditor))]</remarks>
- </member>
- <member name="T:DotSpatial.Symbology.FeatureCategoryCollection">
- <summary>
- FeatureSchemeCategoryCollection
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureCategoryCollection.#ctor">
- <summary>
- Creates a new instance of the FeatureSchemeCategoryCollection
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureCategoryCollection.OnInclude(DotSpatial.Symbology.IFeatureCategory)">
- <summary>
- Occurs when including legend items
- </summary>
- <param name="item"></param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureCategoryCollection.OnExclude(DotSpatial.Symbology.IFeatureCategory)">
- <summary>
- Occurs when excluding legend items
- </summary>
- <param name="item"></param>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureCategoryCollection.Scheme">
- <summary>
- Optionally allows the scheme to identify itself for future reference.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureEditorSettings.#ctor">
- <summary>
- Creates a new instance of VectorEditorSettings
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureEditorSettings.ClassificationType">
- <summary>
- Gets or sets the unique values.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureEditorSettings.EndSize">
- <summary>
- Gets or sets the double size for the last item in the range
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureEditorSettings.FieldName">
- <summary>
- Gets or sets the field name that categories are based on
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureEditorSettings.NormField">
- <summary>
- Gets or sets the normalization field
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureEditorSettings.GradientAngle">
- <summary>
- Gets or sets the gradient angle if use gradient is true
- and the shape is a polygon shape.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureEditorSettings.StartSize">
- <summary>
- Gets or sets the double start size for point or line size ranges
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureEditorSettings.TemplateSymbolizer">
- <summary>
- Gets or sets the feature symbolizer that acts as a template for
- any characteristics not covered by the size and color ranges.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureEditorSettings.UseGradient">
- <summary>
- Gets or sets a boolean indicating whether or not to
- use a gradient when randomly calculating polygon
- forms.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureEditorSettings.UseSizeRange">
- <summary>
- Gets or sets a boolean indicating whether the size range should be used instead of
- the size specified by the template.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.FeatureLayer">
- <summary>
- This is should not be instantiated because it cannot in itself perform the necessary functions.
- Instead, most of the specified functionality must be implemented in the more specific classes.
- This is also why there is no direct constructor for this class. You can use the static
- "FromFile" or "FromFeatureLayer" to create FeatureLayers from a file.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IFeatureLayer">
- <summary>
- This is should not be instantiated because it cannot in itself perform the necessary functions.
- Instead, most of the specified functionality must be implemented in the more specific classes.
- This is also why there is no direct constructor for this class. You can use the static
- "FromFile" or "FromFeatureLayer" to create FeatureLayers from a file.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureLayer.ApplyScheme(DotSpatial.Symbology.IFeatureScheme)">
- <summary>
- Applies the specified scheme to this layer, applying the filter constraints in the scheme.
- It is at this time when features are grouped as a one-time operation into their symbol
- categories, so that this doesn't have to happen independently each drawing cycle.
- </summary>
- <param name="inScheme">
- The scheme to be applied to this layer.
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureLayer.AssignFastDrawnStates">
- <summary>
- Assigns the fast drawn states based on the latest feature setup.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureLayer.DrawSnapShot(System.Drawing.Graphics,DotSpatial.Data.IProj)">
- <summary>
- This method actually draws the image to the snapshot using the graphics object. This should be
- overridden in sub-classes because the drawing methods are very different.
- </summary>
- <param name="g">
- A graphics object to draw to
- </param>
- <param name="p">
- A projection handling interface designed to translate geographic coordinates to screen
- coordinates
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureLayer.ExportSelection(System.String)">
- <summary>
- Saves a featureset with only the selected features to the specified fileName.
- </summary>
- <param name="fileName">
- The string fileName to export features to.
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureLayer.GetCategory(System.Int32)">
- <summary>
- Gets the visible characteristic for an individual feature, regardless of whether
- this layer is in edit mode.
- </summary>
- <param name="index">
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureLayer.GetCategory(DotSpatial.Data.IFeature)">
- <summary>
- Gets the visible characteristic for a given feature, rather than using the index,
- regardless of whether this layer is in edit mode.
- </summary>
- <param name="feature">
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureLayer.GetVisible(System.Int32)">
- <summary>
- Gets the visible characteristic for an individual feature
- </summary>
- <param name="index">
- </param>
- <returns>
- The get visible.
- </returns>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureLayer.GetVisible(DotSpatial.Data.IFeature)">
- <summary>
- Gets the visible characteristic for a given feature, rather than using the index.
- </summary>
- <param name="feature">
- </param>
- <returns>
- The get visible.
- </returns>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureLayer.RemoveFeaturesAt(System.Collections.Generic.IEnumerable{System.Int32})">
- <summary>
- This method will remove the in ram features from the underlying dataset.
- This will not affect the data source. Beware! Removing features
- without populating the DataTable first will almost assuredly mean
- indexing failures if you choose to load it later.
- </summary>
- <param name="indexValues">The list or array of integer index values.</param>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureLayer.RemoveSelectedFeatures">
- <summary>
- This forces the removal of all the selected features.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureLayer.Select(System.Collections.Generic.IEnumerable{System.Int32})">
- <summary>
- Selects the specified list of features. If the specified feature is already selected,
- this method will not alter it.
- </summary>
- <param name="featureIndices">
- A List of integers representing the zero-based feature index values
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureLayer.Select(System.Int32)">
- <summary>
- Selects a single feature specified by the integer index in the Features list.
- </summary>
- <param name="featureIndex">
- The zero-based integer index of the feature.
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureLayer.Select(DotSpatial.Data.IFeature)">
- <summary>
- Selects the specified feature.
- </summary>
- <param name="feature">
- The feature.
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureLayer.SelectAll">
- <summary>
- Cycles through all the features and selects them
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureLayer.SelectByAttribute(System.String)">
- <summary>
- Selects all the features in this layer that are associated
- with the specified attribute, clearing the selection first.
- </summary>
- <param name="filterExpression">
- The string expression to
- identify based on attributes the features to select.
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureLayer.SelectByAttribute(System.String,DotSpatial.Symbology.ModifySelectionMode)">
- <summary>
- Modifies the features with a new selection based on the modifyMode.
- </summary>
- <param name="filterExpression">
- The string filter expression to use
- </param>
- <param name="modifyMode">
- Determines how the newly chosen features should interact with the existing
- selection
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureLayer.SetCategory(System.Int32,DotSpatial.Symbology.IFeatureCategory)">
- <summary>
- Sets the category for the specified shape index regardless of whether this layer is in edit mode.
- </summary>
- <param name="index">
- The 0 based integer shape index
- </param>
- <param name="category">
- The category for this feature. The exact kind of category depends on the
- feature type.
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureLayer.SetCategory(DotSpatial.Data.IFeature,DotSpatial.Symbology.IFeatureCategory)">
- <summary>
- Sets the visible characteristic for a given feature, rather than using the index
- regardless of whether this layer is in edit mode.
- </summary>
- <param name="feature">
- The actual reference to the feature object to update
- </param>
- <param name="category">
- The new category to use for the specified feature
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureLayer.SetShapeSymbolizer(System.Int32,DotSpatial.Symbology.IFeatureSymbolizer)">
- <summary>
- This forces the creation of a category for the specified symbolizer, if it doesn't exist.
- This will add the specified feature to the category. Be sure that the symbolizer type
- matches the feature type.
- </summary>
- <param name="index">
- The integer index of the shape to control.
- </param>
- <param name="symbolizer">
- The symbolizer to assign.
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureLayer.SetVisible(System.Int32,System.Boolean)">
- <summary>
- Sets the visible characteristic for an individual feature
- </summary>
- <param name="index">
- </param>
- <param name="visible">
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureLayer.SetVisible(DotSpatial.Data.IFeature,System.Boolean)">
- <summary>
- Sets the visible characteristic for a given feature, rather than using the index.
- </summary>
- <param name="feature">
- </param>
- <param name="visible">
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureLayer.ShowAttributes">
- <summary>
- Displays a form with the attributes for this shapefile.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureLayer.SnapShot(DotSpatial.Data.Extent,System.Int32)">
- <summary>
- Creates a bitmap of the requested size that covers the specified geographic extent using
- the current symbolizer for this layer. This does not have any drawing optimizations,
- or techniques to speed up performance and should only be used in special cases like
- draping of vector content onto a texture. It also doesn't worry about selections.
- </summary>
- <param name="geographicExtent">
- The extent to use when computing the snapshot.
- </param>
- <param name="width">
- The integer height of the bitmap
- </param>
- <returns>
- A Bitmap object
- </returns>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureLayer.UnSelect(System.Collections.Generic.IEnumerable{System.Int32})">
- <summary>
- Unselects the specified features. If any features already unselected, they are ignored.
- </summary>
- <param name="featureIndices">
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureLayer.UnSelect(System.Int32)">
- <summary>
- Unselects the specified feature.
- </summary>
- <param name="featureIndex">
- The integer representing the feature to unselect.
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureLayer.UnSelect(DotSpatial.Data.IFeature)">
- <summary>
- Removes the specified feature from the selection
- </summary>
- <param name="feature">
- The feature to remove
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureLayer.UnSelectAll">
- <summary>
- Unselects all the features that are currently selected
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureLayer.ZoomToSelectedFeatures">
- <summary>
- Zooms to the envelope of the selected features.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.IFeatureLayer.ViewAttributes">
- <summary>
- Occurs before the attribute Table is displayed, also allowing this event to be handled.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.IFeatureLayer.SnapShotTaken">
- <summary>
- Occurs after a snapshot is taken, and contains an event argument with the bitmap
- to be displayed.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.IFeatureLayer.SchemeApplied">
- <summary>
- Occurs after a new symbolic scheme has been applied to the layer.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IFeatureLayer.DataSet">
- <summary>
- Gets or sets the base FeatureSet
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IFeatureLayer.DrawnStates">
- <summary>
- Controls the drawn states according to a feature index. This is used if the EditMode is
- false. When EditMode is true, then drawn states are tied to the features instead.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IFeatureLayer.DrawnStatesNeeded">
- <summary>
- Gets or sets the Boolean flag that controls whether the DrawnStates are needed. If nothing is selected,
- and there is only one category, and there is no filter expression on that category, then this should be false.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IFeatureLayer.EditMode">
- <summary>
- Gets or sets a Boolean. If edit mode is true, feature index is ignored, and features
- are assumed to be entirely loaded into ram. If edit mode is false, then index
- is used instead and features are not assumed to be loaded into ram.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IFeatureLayer.LabelLayer">
- <summary>
- Gets or sets the label layer
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IFeatureLayer.Selection">
- <summary>
- Gets a Selection class that is allows the user to cycle through all the unselected features with
- a for each method, even if the features are in many categories.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IFeatureLayer.SelectionSymbolizer">
- <summary>
- Gets or sets the shared characteristics to use with the selected features.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IFeatureLayer.ShowLabels">
- <summary>
- Gets or sets whether labels should be drawn.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IFeatureLayer.Symbolizer">
- <summary>
- Gets or sets and interface for the shared symbol characteristics between point, line and polygon features
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IFeatureLayer.Symbology">
- <summary>
- Gets the current feature scheme, but to change it ApplyScheme should be called, so that
- feature categories are updated as well.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.FeatureLayer._categoryExtents">
- <summary>
- The _category extents.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.FeatureLayer._drawingFilter">
- <summary>
- The _drawing filter.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.FeatureLayer._drawnStates">
- <summary>
- The _drawn states.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.FeatureLayer._drawnStatesNeeded">
- <summary>
- The _drawn states needed.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.FeatureLayer._editMode">
- <summary>
- The _edit mode.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.FeatureLayer._featureSymbolizer">
- <summary>
- The _feature symbolizer.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.FeatureLayer._labelLayer">
- <summary>
- The _label layer.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.FeatureLayer._scheme">
- <summary>
- The _scheme.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.FeatureLayer._selection">
- <summary>
- The _selection.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.FeatureLayer._selectionFeatureSymbolizer">
- <summary>
- The _selection feature symbolizer.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.FeatureLayer._showLabels">
- <summary>
- The _show labels.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.#ctor(DotSpatial.Data.IFeatureSet)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Symbology.FeatureLayer"/> class.
- Constructor
- </summary>
- <param name="featureSet">
- The data bearing layer to apply new drawing characteristics to
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.#ctor(DotSpatial.Data.IFeatureSet,System.Collections.Generic.ICollection{DotSpatial.Symbology.ILayer})">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Symbology.FeatureLayer"/> class.
- Constructor
- </summary>
- <param name="featureSet">
- The data bearing layer to apply new drawing characteristics to
- </param>
- <param name="container">
- The container this layer should be added to
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.#ctor(DotSpatial.Data.IFeatureSet,System.Collections.Generic.ICollection{DotSpatial.Symbology.ILayer},DotSpatial.Data.IProgressHandler)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Symbology.FeatureLayer"/> class.
- Constructor
- </summary>
- <param name="featureSet">
- The data bearing layer to apply new drawing characteristics to
- </param>
- <param name="container">
- The container this layer should be added to
- </param>
- <param name="progressHandler">
- A progress handler for receiving status messages
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.ZoomToSelectedFeatures">
- <summary>
- Zooms to the envelope of the selected features.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.ZoomToSelectedFeatures(System.Double,System.Double)">
- <summary>
- Zooms to the envelope of the selected features, adding a border of the size specified.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.Configure(DotSpatial.Data.IFeatureSet)">
- <summary>
- The configure.
- </summary>
- <param name="featureSet">
- The feature set.
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.ApplyScheme(DotSpatial.Symbology.IFeatureScheme)">
- <summary>
- Applies the specified scheme to this layer, applying the filter constraints in the scheme.
- It is at this time when features are grouped as a one-time operation into their symbol
- categories, so that this doesn't have to happen independently each drawing cycle.
- </summary>
- <param name="inScheme">
- The scheme to be applied to this layer.
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.ClearSelection(DotSpatial.Topology.IEnvelope@)">
- <summary>
- Clears the current selection, reverting the geometries back to their
- normal colors.
- </summary>
- <param name="affectedArea">
- An out value that represents the envelope that was modified by the clear selection instruction
- </param>
- <returns>
- The clear selection.
- </returns>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.DrawSnapShot(System.Drawing.Graphics,DotSpatial.Data.IProj)">
- <summary>
- This method actually draws the image to the snapshot using the graphics object. This should be
- overridden in sub-classes because the drawing methods are very different.
- </summary>
- <param name="g">
- A graphics object to draw to
- </param>
- <param name="p">
- A projection handling interface designed to translate
- geographic coordinates to screen coordinates
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.ExportSelection(System.String)">
- <summary>
- Saves a featureset with only the selected features to the specified fileName.
- </summary>
- <param name="fileName">
- The string fileName to export features to.
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.GetCategory(System.Int32)">
- <summary>
- Gets the visible characteristic for an individual feature, regardless of whether
- this layer is in edit mode.
- </summary>
- <param name="index">
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.GetCategory(DotSpatial.Data.IFeature)">
- <summary>
- Gets the visible characteristic for a given feature, rather than using the index,
- regardless of whether this layer is in edit mode.
- </summary>
- <param name="feature">
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.GetVisible(System.Int32)">
- <summary>
- Gets the visible characteristic for an individual feature
- </summary>
- <param name="index">
- </param>
- <returns>
- The get visible.
- </returns>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.GetVisible(DotSpatial.Data.IFeature)">
- <summary>
- Gets the visible characteristic for a given feature, rather than using the index.
- </summary>
- <param name="feature">
- </param>
- <returns>
- The get visible.
- </returns>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.InvertSelection(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IEnvelope,DotSpatial.Symbology.SelectionMode,DotSpatial.Topology.IEnvelope@)">
- <summary>
- This method inverts the selection for the specified region. Members already a part of the selection
- will be removed from the selection, while members that are not a part of the selection will be added
- to the selection.
- </summary>
- <param name="tolerant">
- The region specifying where features should be added or removed from the
- selection.
- </param>
- <param name="strict">
- With polygon selection it is better not to allow any tolerance since the
- polygons already contain it.
- </param>
- <param name="selectionMode">
- The SelectionModes enumeration that clarifies how the features should
- interact with the region.
- </param>
- <param name="affectedArea">
- The geographic region that will be impacted by the changes.
- </param>
- <returns>
- The invert selection.
- </returns>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.Select(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IEnvelope,DotSpatial.Symbology.SelectionMode,DotSpatial.Topology.IEnvelope@)">
- <summary>
- Highlights the values in the specified region, and returns the affected area from the selection,
- which should allow for slightly faster drawing in cases where only a small area is changed.
- This will also specify the method by which members should be selected.
- </summary>
- <param name="tolerant">
- The envelope to change.
- </param>
- <param name="strict">
- The envelope to use in cases like polygons where the geometry has no tolerance.
- </param>
- <param name="selectionMode">
- The selection mode that clarifies the rules to use for selection.
- </param>
- <param name="affectedArea">
- The geographic envelope of the region impacted by the selection.
- </param>
- <returns>
- Boolean, true if items were selected.
- </returns>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.Select(System.Collections.Generic.IEnumerable{System.Int32})">
- <summary>
- Selects the specified list of features. If the specified feature is already selected,
- this method will not alter it. This will only fire a single SelectionExtended event,
- rather than firing it for each member selected.
- </summary>
- <param name="featureIndices">
- A List of integers representing the zero-based feature index values
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.Select(System.Int32)">
- <summary>
- Selects a single feature specified by the integer index in the Features list.
- </summary>
- <param name="featureIndex">
- The zero-based integer index of the feature.
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.Select(DotSpatial.Data.IFeature)">
- <summary>
- Selects the specified feature
- </summary>
- <param name="feature">
- The feature to select
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.SelectAll">
- <summary>
- Cycles through all the features and selects them
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.SelectByAttribute(System.String)">
- <summary>
- Selects all the features in this layer that are associated
- with the specified attribute. This automatically replaces the existing selection.
- </summary>
- <param name="filterExpression">
- The string expression to
- identify based on attributes the features to select.
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.UnselectByAttribute(System.String)">
- <summary>
- Unselects the features by attribute.
- </summary>
- <param name="filterExpression">The filter expression.</param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.SelectByAttribute(System.String,DotSpatial.Symbology.ModifySelectionMode)">
- <summary>
- Modifies the features with a new selection based on the modifyMode.
- </summary>
- <param name="filterExpression">
- The string filter expression to use
- </param>
- <param name="modifyMode">
- Determines how the newly chosen features should interact with the existing
- selection
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.SetCategory(System.Int32,DotSpatial.Symbology.IFeatureCategory)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.SetCategory(DotSpatial.Data.IFeature,DotSpatial.Symbology.IFeatureCategory)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.SetShapeSymbolizer(System.Int32,DotSpatial.Symbology.IFeatureSymbolizer)">
- <summary>
- This forces the creation of a category for the specified symbolizer, if it doesn't exist.
- This will add the specified feature to the category. Be sure that the symbolizer type
- matches the feature type.
- </summary>
- <param name="index">
- The integer index of the shape to control.
- </param>
- <param name="symbolizer">
- The symbolizer to assign.
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.SetVisible(System.Int32,System.Boolean)">
- <summary>
- Sets the visible characteristic for an individual feature regardless of
- whether this layer is in edit mode.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.SetVisible(DotSpatial.Data.IFeature,System.Boolean)">
- <summary>
- Sets the visible characteristic for a given feature, rather than using the index
- regardless of whether this layer is in edit mode.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.ShowAttributes">
- <summary>
- Displays a form with the attributes for this shapefile.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.SnapShot(DotSpatial.Data.Extent,System.Int32)">
- <summary>
- Creates a bitmap of the requested size that covers the specified geographic extent using
- the current symbolizer for this layer. This does not have any drawing optimizations,
- or techniques to speed up performance and should only be used in special cases like
- draping of vector content onto a texture. It also doesn't worry about selections.
- </summary>
- <param name="geographicExtent">
- The extent to use when computing the snapshot.
- </param>
- <param name="width">
- The integer height of the bitmap. The height is calculated based on
- the aspect ratio of the specified geographic extent.
- </param>
- <returns>
- A Bitmap object
- </returns>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.UnSelect(System.Collections.Generic.IEnumerable{System.Int32})">
- <summary>
- Unselects the specified features. If any features already unselected, they are ignored.
- This will only fire a single Selection
- </summary>
- <param name="featureIndices">
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.UnSelect(System.Int32)">
- <summary>
- Unselects the specified feature.
- </summary>
- <param name="featureIndex">
- The integer representing the feature to unselect.
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.UnSelect(DotSpatial.Data.IFeature)">
- <summary>
- Removes the specified feature from the selection.
- </summary>
- <param name="feature">
- The feature to unselect.
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.UnSelect(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IEnvelope,DotSpatial.Symbology.SelectionMode,DotSpatial.Topology.IEnvelope@)">
- <summary>
- Un-highlights or returns the features from the specified region. The specified selectionMode
- will be used to determine how to choose features.
- </summary>
- <param name="tolerant">
- The geographic envelope in cases like clicking near points where tolerance
- is allowed.
- </param>
- <param name="strict">
- The geographic region when working with absolutes, without a tolerance.
- </param>
- <param name="selectionMode">
- The selection mode that controls how to choose members relative to the
- region.
- </param>
- <param name="affectedArea">
- The geographic envelope that will be visibly impacted by the change.
- </param>
- <returns>
- Boolean, true if members were removed from the selection.
- </returns>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.UnSelectAll">
- <summary>
- Unselects all the features that are currently selected
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.CreateLayerFromSelectedFeatures(DotSpatial.Symbology.IFeatureLayer@)">
- <summary>
- This is testing the idea of using an input parameter type that is marked as out
- instead of a return type.
- </summary>
- <param name="result">
- The result of the creation
- </param>
- <returns>
- Boolean, true if a layer can be created
- </returns>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.OnShowProperties(System.ComponentModel.HandledEventArgs)">
- <summary>
- Occurs when the properties should be shown, and launches a layer dialog.
- </summary>
- <param name="e">
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.OnExcludeScheme(DotSpatial.Symbology.IFeatureScheme)">
- <summary>
- Occurs when setting the symbology to a new scheme and allows removing event handlers
- </summary>
- <param name="scheme">
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.OnHandleFeaturesetEvents(DotSpatial.Data.IFeatureSet)">
- <summary>
- Occurs as a new featureset is being assigned to this layer
- </summary>
- <param name="featureSet">
- The feature Set.
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.OnIgnoreFeaturesetEvents(DotSpatial.Data.IFeatureSet)">
- <summary>
- Unwires event handlers for the specified featureset.
- </summary>
- <param name="featureSet">
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.OnIncludeScheme(DotSpatial.Symbology.IFeatureScheme)">
- <summary>
- Occurs when setting symbology to a new scheme and allows adding event handlers
- </summary>
- <param name="scheme">
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.OnSelectFeatures(System.Object,DotSpatial.Symbology.ExpressionEventArgs)">
- <summary>
- Occurs when selecting features and fires the SelectByAttribute event with
- the expression used as the filter expression
- </summary>
- <param name="sender">
- </param>
- <param name="e">
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.OnDeselectFeatures(System.Object,DotSpatial.Symbology.ExpressionEventArgs)">
- <summary>
- Occurs when selecting features and fires the SelectByAttribute event with
- the expression used as the filter expression
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.AssignFastDrawnStates">
- <summary>
- Assigns the fast drawn states
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.RemoveFeaturesAt(System.Collections.Generic.IEnumerable{System.Int32})">
- <summary>
- This method will remove the in ram features from the underlying dataset.
- This will not affect the data source.
- </summary>
- <param name="indexValues">The list or array of integer index values.</param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.RemoveSelectedFeatures">
- <summary>
- This forces the removal of all the selected features.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.RemoveDrawnStates(System.Collections.Generic.IEnumerable{System.Int32})">
- <summary>
- This does more than remove an index key. This also shifts down the category
- and selection state for every drawn state with a higher index than the
- given index value. Call this only in index mode, and only if the shape
- is being removed from the FeatureSet. in practice, this should really
- only be called internally, but is here just in case.
- </summary>
- <param name="indexValues">
- The list or array of index values to remove.
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.CalculateCategoryExtent(DotSpatial.Symbology.IFeatureCategory)">
- <summary>
- This calculates the extent for the category and caches it in the extents collection
- </summary>
- <param name="category">
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.OnApplyScheme(DotSpatial.Symbology.IFeatureScheme)">
- <summary>
- This method cycles through all the Categories in the scheme and creates a new
- category.
- </summary>
- <param name="scheme">
- The scheme to apply
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.OnCopy(DotSpatial.Symbology.Descriptor)">
- <summary>
- Occurs during a copy operation and handles removing surplus event handlers
- </summary>
- <param name="copy">
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.OnCreateLabels">
- <summary>
- A default method to generate a label layer.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.OnExportData">
- <summary>
- Handles the situation for exporting the layer as a new source.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.OnLabelSetup(System.ComponentModel.HandledEventArgs)">
- <summary>
- Occurs before the label setup dialog is shown. If handled is set to true,
- then the dialog will not be shown.
- </summary>
- <param name="e">
- A HandledEventArgs parameter
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.OnSchemeApplied">
- <summary>
- This fires the scheme applied event after the scheme has been altered
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.OnSnapShotTaken(System.Drawing.Bitmap)">
- <summary>
- Fires the SnapShotTaken event. This can be overridden in order to modify the bitmap returned etc.
- </summary>
- <param name="e">
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.OnViewAttributes(System.ComponentModel.HandledEventArgs)">
- <summary>
- Occurs before attributes are about to be viewed. Overriding this
- allows that to be handled, and if e.Handled is true, this class
- won't show the attributes.
- </summary>
- <param name="e">
- A HandledEventArgs
- </param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayer.DistinctFieldsInExpression(System.String)">
- <summary>
- The distinct fields in expression.
- </summary>
- <param name="expression">
- The expression.
- </param>
- <returns>
- </returns>
- </member>
- <member name="E:DotSpatial.Symbology.FeatureLayer.SchemeApplied">
- <summary>
- Occurs after a new symbolic scheme has been applied to the layer.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.FeatureLayer.SnapShotTaken">
- <summary>
- Occurs after a snapshot is taken, and contains an event argument with the bitmap
- to be displayed.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.FeatureLayer.ViewAttributes">
- <summary>
- Occurs before the attribute Table is displayed, also allowing this event to be handled.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.FeatureLayer.LabelSetup">
- <summary>
- Occurs before the label setup dialog is displayed, allowing the event to be handled.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureLayer.DrawnStatesNeeded">
- <summary>
- Gets or sets the Boolean flag that controls whether the DrawnStates are needed. If nothing is selected,
- and there is only one category, and there is no filter expression on that category, then this should be false.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureLayer.FeatureLayerActions">
- <summary>
- Gets or sets custom actions for FeatureLayer
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureLayer.CategoryExtents">
- <summary>
- Gets the dictionary of extents that is calculated from the categories. This is calculated one time,
- when the scheme is applied, and then the cached value is used to help drawing symbols that
- are modified by the categorical boundaries.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureLayer.DrawingBounds">
- <summary>
- Gets or sets a rectangle that gives the maximal extent for 2D GDI+ drawing in pixels.
- Coordinates outside this range will cause overflow exceptions to occur.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureLayer.DrawingFilter">
- <summary>
- Gets or sets the drawing filter that can be used to narrow the list of features and then
- cycle through those features. Using a for-each expression on the filter will automatically
- apply the constraints specified by the characteristics.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureLayer.Name">
- <summary>
- Gets or sets a string name for this layer. This is not necessarily the same as the legend text.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureLayer.ChunkSize">
- <summary>
- Gets or sets the chunk size on the drawing filter. This should be controlled
- by drawing layers.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureLayer.DataSet">
- <summary>
- Gets or sets the underlying dataset for this layer, specifically as an IFeatureSet
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureLayer.FeatureSet">
- <summary>
- Gets underlying dataset for this layer
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureLayer.DrawnStates">
- <summary>
- Controls the drawn states according to a feature index. This is used if the EditMode is
- false. When EditMode is true, then drawn states are tied to the features instead.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureLayer.EditMode">
- <summary>
- Gets or sets a boolean. If edit mode is true, feature index is ignored, and features
- are assumed to be entirely loaded into ram. If edit mode is false, then index
- is used instead and features are not assumed to be loaded into ram.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureLayer.Extent">
- <summary>
- Gets the envelope of the DataSet supporting this FeatureLayer
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureLayer.LabelLayer">
- <summary>
- Gets or sets the label layer
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureLayer.LegendItems">
- <summary>
- Restructures the LegendItems based on whether or not the symbology makes use
- of schemes.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureLayer.Selection">
- <summary>
- Gets a Selection class that is allows the user to cycle through all the selected features with
- a foreach method. This can be null.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureLayer.SelectionSymbolizer">
- <summary>
- Gets or sets the shared characteristics to use with the selected features.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureLayer.ShowLabels">
- <summary>
- Gets or sets whether labels should be drawn.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureLayer.Symbolizer">
- <summary>
- Gets or sets and interface for the shared symbol characteristics between point, line and polygon features
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureLayer.Symbology">
- <summary>
- Gets the current feature scheme, but to change it ApplyScheme should be called, so that
- feature categories are updated as well.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayerExt.InvertSelection(DotSpatial.Symbology.IFeatureLayer)">
- <summary>
- Inverts the selection
- </summary>
- <param name="featureLayer"></param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayerEventArgs.#ctor(DotSpatial.Symbology.IFeatureLayer)">
- <summary>
- Creates a new instance of FeatureLayerEventArgs
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureLayerEventArgs.FeatureLayer">
- <summary>
- Gets or sets the feature layer for this event
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureLayerSelectionEventArgs.#ctor(DotSpatial.Symbology.IFeatureLayer,DotSpatial.Symbology.ISelection)">
- <summary>
- Creates a new instance of FeatureLayerSelectionEventArgs
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureLayerSelectionEventArgs.Selection">
- <summary>
- Gets the list of changed features
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.FeatureScheme">
- <summary>
- FeatureScheme
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IFeatureScheme">
- <summary>
- IFeatureScheme
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureScheme.CreateCategories(DotSpatial.Data.IAttributeSource,DotSpatial.Data.ICancelProgressHandler)">
- <summary>
- Creates a list of all 'unique value' categories. This will use the "VectorEditorSettings"
- to determine how to create the values, so ensure that you update that property first.
- </summary>
- <param name="source">The attribute source that can provide the attribute information.</param>
- <param name="progressHandler">The progress handler for showing progress on what is likely a slow process</param>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureScheme.CreateCategories(System.Data.DataTable)">
- <summary>
- Creates the categories using the specified data table
- </summary>
- <param name="table"></param>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureScheme.CreateRandomCategory(System.String)">
- <summary>
- Uses the settings on this scheme to create a random category.
- </summary>
- <returns>A new IFeatureCategory</returns>
- <param name="filterExpression">The filter expression to use</param>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureScheme.RegenerateColors">
- <summary>
- This keeps the existing categories, but uses the current scheme settings to apply
- a new color to each of the symbols.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureScheme.GetCategories">
- <summary>
- When using this scheme to define the symbology, these individual categories will be referenced in order to
- create genuine categories (that will be cached).
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureScheme.IsWithinLegendSelection">
- <summary>
- Queries this layer and the entire parental tree up to the map frame to determine if
- this layer is within the selected layers.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.IFeatureScheme.SelectFeatures">
- <summary>
- Occurs when a category indicates that its filter expression should be used
- to select its members.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.IFeatureScheme.DeselectFeatures">
- <summary>
- Occurs when the deselect features context menu is clicked.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IFeatureScheme.EditorSettings">
- <summary>
- Gets or sets the dialog settings
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IFeatureScheme.AppearsInLegend">
- <summary>
- Gets or sets a boolean that indicates whether or not the legend should draw this item as a categorical
- tier in the legend. If so, it will allow the LegendText to be visible as a kind of group for the
- categories. If not, the categories will appear directly below the layer.C:\dev\Mapwindow6Dev\DotSpatial\DotSpatial\Drawing\Vectors\Points\PointCategoryCollection.cs
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IFeatureScheme.NumCategories">
- <summary>
- Gets the number of categories of this scheme.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IFeatureScheme.PropertyEditor">
- <summary>
- Gets or sets the UITypeEditor to use for editing this FeatureScheme
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureScheme.#ctor">
- <summary>
- Creates a new instance of FeatureScheme
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureScheme.GetCategories">
- <summary>
- When using this scheme to define the symbology, these individual categories will be referenced in order to
- create genuine categories (that will be cached).
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureScheme.IsWithinLegendSelection">
- <summary>
- Queries this layer and the entire parental tree up to the map frame to determine if
- this layer is within the selected layers.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureScheme.OnCopy(DotSpatial.Symbology.Descriptor)">
- <summary>
- Special handling of not copying the parent during a copy operation
- </summary>
- <param name="copy"></param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureScheme.OnCopyProperties(System.Object)">
- <summary>
- Handles the special case of not copying the parent during an on copy properties operation
- </summary>
- <param name="source"></param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureScheme.OnSetParentItem(DotSpatial.Symbology.ILegendItem)">
- <summary>
- Ensures that the parentage gets set properly in the event that
- this scheme is not appearing in the legend.
- </summary>
- <param name="value"></param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureScheme.RegenerateColors">
- <summary>
- This keeps the existing categories, but uses the current scheme settings to apply
- a new color to each of the symbols.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureScheme.CreateCategories(System.Data.DataTable)">
- <summary>
- Creates categories either based on unique values, or classification method.
- If the method is
- </summary>
- <param name="table">The System.DataTable to that has the data values to use</param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureScheme.CreateCategories(DotSpatial.Data.IAttributeSource,DotSpatial.Data.ICancelProgressHandler)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.FeatureScheme.CreateRandomCategory(System.String)">
- <summary>
- Uses the settings on this scheme to create a random category.
- </summary>
- <returns>A new IFeatureCategory</returns>
- <param name="filterExpression">The filter expression to use</param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureScheme.CreateRandomCategory">
- <summary>
- This simply ensures that we are creating the appropriate empty filter expression version
- of create random category.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureScheme.GetValues(DotSpatial.Data.IAttributeSource,DotSpatial.Data.ICancelProgressHandler)">
- <summary>
- Gets the values from a file based data source rather than an in memory object.
- </summary>
- <param name="source"></param>
- <param name="progressHandler"></param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureScheme.GetValues(System.Data.DataTable)">
- <summary>
- Before attempting to create categories using a color ramp, this must be calculated
- to updated the cache of values that govern statistics and break placement.
- </summary>
- <param name="table">The data Table to use.</param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureScheme.SufficientValues(System.String,DotSpatial.Data.IAttributeSource,System.Int32)">
- <summary>
- Returns
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureScheme.GetUniqueValues(System.String,DotSpatial.Data.IAttributeSource,DotSpatial.Data.ICancelProgressHandler)">
- <summary>
- Gets a list of all unique values of the attribute field.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureScheme.GetUniqueValues(System.String,System.Data.DataTable)">
- <summary>
- Gets a list of all unique values of the attribute field.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureScheme.CheckFieldType(System.String,System.Data.DataTable)">
- <summary>
- This checks the type of the specified field whether it's a string field
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureScheme.CheckFieldType(System.String,DotSpatial.Data.IAttributeSource)">
- <summary>
- This checks the type of the specified field whether it's a string field
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureScheme.OnSelectFeatures(System.Object,DotSpatial.Symbology.ExpressionEventArgs)">
- <summary>
- Instructs the parent layer to select features matching the specified expression.
- </summary>
- <param name="sender">The object sender.</param>
- <param name="e">The event args.</param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureScheme.OnDeselectFeatures(System.Object,DotSpatial.Symbology.ExpressionEventArgs)">
- <summary>
- Instructs the parent layer to select features matching the specified expression.
- </summary>
- <param name="sender">The object sender.</param>
- <param name="e">The event args.</param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureScheme.CreateRandomColor">
- <summary>
- Uses the current settings to generate a random color between the start and end color.
- </summary>
- <returns>A Randomly created color that is within the bounds of this scheme.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureScheme.GetSizeSet(System.Int32)">
- <summary>
- This replaces the constant size calculation with a size
- calculation that is appropriate for features.
- </summary>
- <param name="count">The integer count of the number of sizes to create.</param>
- <returns>A list of double valued sizes.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureScheme.GenerateUniqueColors(DotSpatial.Data.IFeatureSet,System.String,System.Func{System.Drawing.Color,DotSpatial.Symbology.IFeatureCategory})">
- <summary>
- Calculates the unique colors as a scheme
- </summary>
- <param name="fs">The featureset with the data Table definition</param>
- <param name="uniqueField">The unique field</param>
- <param name="categoryFunc">Func for creating category</param>
- </member>
- <member name="E:DotSpatial.Symbology.FeatureScheme.SelectFeatures">
- <summary>
- Occurs when a category indicates that its filter expression should be used
- to select its members.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.FeatureScheme.DeselectFeatures">
- <summary>
- Occurs when the deselect features context menu is clicked.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.FeatureScheme.TooManyCategories">
- <summary>
- Occurs when there are more than 1000 unique categories. If the "Cancel"
- is set to true, then only the first 1000 categories are returned. Otherwise
- it may allow the application to lock up, but will return all of them.
- If this event is not handled, cancle is assumed to be true.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.FeatureScheme.NonNumericField">
- <summary>
- Occurs
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureScheme.AppearsInLegend">
- <summary>
- Gets or sets a boolean that indicates whether or not the legend should draw this item as a categorical
- tier in the legend. If so, it will allow the LegendText to be visible as a kind of group for the
- categories. If not, the categories will appear directly below the layer.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureScheme.EditorSettings">
- <summary>
- Gets or sets the dialog settings
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureScheme.PropertyEditor">
- <summary>
- Gets or sets the UITypeEditor to use for editing this FeatureScheme
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureScheme.NumCategories">
- <summary>
- Gets the number of categories in this scheme
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureScheme.LegendItems">
- <summary>
- An enumerable of LegendItems allowing the true members to be cycled through.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IFeatureSelection">
- <summary>
- IFilterCollection
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.ISelection">
- <summary>
- ISelection
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ISelection.Clear">
- <summary>
- Clears the selection
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ISelection.AddRegion(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IEnvelope@)">
- <summary>
- Add REgion
- </summary>
- <param name="region"></param>
- <param name="affectedArea"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.ISelection.InvertSelection(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IEnvelope@)">
- <summary>
-
- </summary>
- <param name="region"></param>
- <param name="affectedArea"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.ISelection.RemoveRegion(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IEnvelope@)">
- <summary>
-
- </summary>
- <param name="region"></param>
- <param name="affectedArea"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.ISelection.ToFeatureSet">
- <summary>
- Returns a new featureset based on the features in this collection
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.ISelection.ToFeatureList">
- <summary>
- Generates a list of the features that match this collection
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Symbology.ISelection.Count">
- <summary>
- Gets the integer count of the members in the collection
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ISelection.Envelope">
- <summary>
- Calculates the envelope of this collection
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ISelection.ProgressHandler">
- <summary>
- Gets or sets the handler to use for progress messages during selection.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ISelection.SelectionMode">
- <summary>
- Selection Mode controls how envelopes are treated when working with geometries.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ISelection.SelectionState">
- <summary>
- Gets or sets whether this should work as "Selected" indices (true) or
- "UnSelected" indices (false).
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ISelection.RegionCategory">
- <summary>
- Setting this to a specific category will only allow selection by
- region to affect the features that are within the specified category.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureSelection.Clear">
- <summary>
- Clears the selection
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IFeatureSelection.Count">
- <summary>
- Gets the integer count of the members in the collection
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IFeatureSelection.Filter">
- <summary>
- Gets the drawing filter used by this collection.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureSelection.#ctor(DotSpatial.Data.IFeatureSet,DotSpatial.Symbology.IDrawingFilter,DotSpatial.Symbology.FilterType)">
- <summary>
- Creates a new instance of FilterCollection, where the current state of the filter is
- recorded as the kind of "collection" that this item belongs to. The filter can be
- altered later, and this will retain the original state.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureSelection.#ctor(DotSpatial.Data.IFeatureSet,DotSpatial.Symbology.IDrawingFilter,DotSpatial.Symbology.FilterType,System.Boolean)">
- <summary>
-
- </summary>
- <param name="featureSet"></param>
- <param name="inFilter"></param>
- <param name="activeType"></param>
- <param name="isReadOnly"></param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureSelection.Add(DotSpatial.Data.IFeature)">
- <summary>
- Adding a feature state sets the drawing state of the item to be
- </summary>
- <param name="item">The item to add to this category</param>
- <exception cref="T:DotSpatial.Serialization.ReadOnlyException">Occurs if this list is set to read-only in the constructor</exception>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureSelection.AddRegion(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IEnvelope@)">
- <summary>
- This uses extent checking (rather than full polygon intersection checking). It will add
- any members that are either contained by or intersect with the specified region
- depending on the SelectionMode property. The order of operation is the region
- acting on the feature, so Contains, for instance, would work with points.
- </summary>
- <param name="region"></param>
- <param name="affectedArea">The affected area of this addition</param>
- <returns>True if any item was actually added to the collection</returns>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureSelection.InvertSelection(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IEnvelope@)">
- <summary>
- Inverts the selection based on the current SelectionMode
- </summary>
- <param name="region">The geographic region to reverse the selected state</param>
- <param name="affectedArea">The affected area to invert</param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureSelection.Clear">
- <summary>
- This cycles through all the members in the current grouping and re-sets the current category
- back to the default setting. In other words, if the active type is selection, then this
- will unselect all the features, but won't adjust any of the other categories.
- </summary>
- <exception cref="T:System.Data.ReadOnlyException">Occurs if this list is set to read-only in the constructor</exception>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureSelection.Contains(DotSpatial.Data.IFeature)">
- <summary>
- Tests to see if the item is contained in this collection.
- </summary>
- <param name="item"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureSelection.CopyTo(DotSpatial.Data.IFeature[],System.Int32)">
- <summary>
- Copies each of the members of this group to the specified array
- </summary>
- <param name="array"></param>
- <param name="arrayIndex"></param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureSelection.GetEnumerator">
- <summary>
- Gets the enumerator for this collection.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureSelection.Remove(DotSpatial.Data.IFeature)">
- <summary>
- Removes the specified item from the subset of this classification if that category is used.
- Selected -> !Selected
- Category[>0] -> Category[0]
- Category[0] -> Null
- Visible -> !Visible
- Chunk -> -1 or basically a chunk index that is never drawn.
- </summary>
- <param name="item">The item to change the drawing state of</param>
- <returns>Boolean, false if the item does not match the current grouping</returns>
- <exception cref="T:System.Data.ReadOnlyException">Occurs if this list is set to read-only in the constructor</exception>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureSelection.RemoveRegion(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IEnvelope@)">
- <summary>
- Tests each member currently in the selected features based on
- the SelectionMode. If it passes, it will remove the feature from
- the selection.
- </summary>
- <param name="region">The geographic region to remove</param>
- <param name="affectedArea">A geographic area that was affected by this change.</param>
- <returns>Boolean, true if the collection was changed</returns>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureSelection.ToFeatureSet">
- <summary>
- As an example, choosing myFeatureLayer.SelectedFeatures.ToFeatureSet creates a new set.
- </summary>
- <returns>An in memory featureset that has not yet been saved to a file in any way.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureSelection.ToFeatureList">
- <summary>
- Exports the members of this collection as a list of IFeature.
- </summary>
- <returns>A List of IFeature</returns>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureSelection.GetAttributes(System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.FeatureSelection.GetAttributes(System.Int32,System.Int32,System.Collections.Generic.IEnumerable{System.String})">
- <inheritdoc/>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureSelection.SetAttributes(System.Int32,System.Data.DataTable)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.FeatureSelection.NumRows">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.FeatureSelection.GetColumn(System.String)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.FeatureSelection.GetColumns">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.FeatureSelection.AddRow(System.Collections.Generic.Dictionary{System.String,System.Object})">
- <summary>
- The new row will be added to the underlying featureset, and this selection will not be updated
- in any way, as that row is not associated with a featureset here.
- </summary>
- <param name="values"></param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureSelection.AddRow(System.Data.DataRow)">
- <summary>
- The new row will be added to the underlying featureset, and this selection will not be updated
- in any way, as that row is not associated with a featureset here.
- </summary>
- <param name="values"></param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureSelection.Edit(System.Int32,System.Collections.Generic.Dictionary{System.String,System.Object})">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.FeatureSelection.Edit(System.Int32,System.Data.DataRow)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.FeatureSelection.GetCounts(System.String[],DotSpatial.Data.ICancelProgressHandler,System.Int32)">
- <inheritdoc />
- </member>
- <member name="P:DotSpatial.Symbology.FeatureSelection.ActiveType">
- <summary>
- Collections can be nested, but for instance if you have gone into category[2].SelectedFeatures and want to
- remove an item, then we would expect it to show up in Category[2].UnSelectedFeatures, not in
- Category[0].UnselectedFeatures. So while add necessarilly acts on every filter constraint, remove or clear only
- operates on the most intimate. The ActiveType records which criteria that is.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureSelection.FeatureList">
- <summary>
- Gets the feature list of underlying features that the filter is using
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureSelection.Count">
- <summary>
- This cycles through the entire enumeration, so don't access this in every loop.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureSelection.Envelope">
- <summary>
- Gets the envelope that represents the features in this collection.
- If the collection changes, this will be invalidated automatically,
- and the next envelope request will re-calcualte the envelope.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureSelection.Filter">
- <summary>
- Gets the drawing filter used by this collection.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureSelection.IsReadOnly">
- <summary>
- Gets whether or not this collection can be edited with add, remove, or clear.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureSelection.ProgressHandler">
- <summary>
- Gets or sets the handler to use for progress messages during selection.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureSelection.RegionCategory">
- <summary>
- Setting this to a specific category will only allow selection by
- region to affect the features that are within the specified category.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureSelection.Category">
- <summary>
- Gets or sets the scheme category to use
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureSelection.Chunk">
- <summary>
- Gets the integer chunk that the filter should use
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureSelection.Selected">
- <summary>
- If UseSelection is true, this will get or set the boolean selection state
- that will be used to select values.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureSelection.UseCategory">
- <summary>
- Gets or sets a boolean that indicates whether the filter should subdivide based on category.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureSelection.UseChunks">
- <summary>
- Gets or sets a boolean that indicates whether we should use the chunk
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureSelection.UseSelection">
- <summary>
- Gets or sets a boolean that indicates whether this filter should use the Selected
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureSelection.UseVisibility">
- <summary>
- Gets or sets the boolean indicating whether or not this feature should be drawn.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureSelection.Visible">
- <summary>
- Gets or sets a boolean that specifies whether to return visible, or hidden features if UseVisibility is true.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureSelection.SelectionState">
- <summary>
- True if members of this collection are considered selected, false otherwise.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureSelection.SelectionMode">
- <summary>
- Gets or sets the selection mode to use when Adding or Removing features
- from a specified envelope region.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.FeatureSymbolizer">
- <summary>
- FeatureSymbolizer
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IFeatureSymbolizer">
- <summary>
- IFeatureSymbolizer
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureSymbolizer.Draw(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Draws a simple rectangle in the specified location.
- </summary>
- <param name="g"></param>
- <param name="target"></param>
- </member>
- <member name="M:DotSpatial.Symbology.IFeatureSymbolizer.SetOutline(System.Drawing.Color,System.Double)">
- <summary>
- Sets the outline, assuming that the symbolizer either supports outlines, or
- else by using a second symbol layer.
- </summary>
- <param name="outlineColor">The color of the outline</param>
- <param name="width">The width of the outline in pixels</param>
- </member>
- <member name="P:DotSpatial.Symbology.IFeatureSymbolizer.IsVisible">
- <summary>
- Gets or sets a boolean indicating whether or not this specific feature should be drawn.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IFeatureSymbolizer.ScaleMode">
- <summary>
- Gets or Sets a ScaleModes enumeration that determines whether non-coordinate drawing
- properties like width or size use pixels or world coordinates. If pixels are
- specified, a back transform is used to approximate pixel sizes.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IFeatureSymbolizer.Smoothing">
- <summary>
- Gets or sets the smoothing mode to use that controls advanced features like
- anti-aliasing. By default this is set to antialias.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IFeatureSymbolizer.Units">
- <summary>
- Gets or sets the graphics unit to work with.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureSymbolizer.#ctor">
- <summary>
- Creates a new instance of FeatureSymbolizer
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureSymbolizer.SetOutline(System.Drawing.Color,System.Double)">
- <summary>
- Sets the outline, assuming that the symbolizer either supports outlines, or
- else by using a second symbol layer.
- </summary>
- <param name="outlineColor">The color of the outline</param>
- <param name="width">The width of the outline in pixels</param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureSymbolizer.Draw(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Draws a simple rectangle in the specified location.
- </summary>
- <param name="g"></param>
- <param name="target"></param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureSymbolizer.OnCopyProperties(System.Object)">
- <summary>
- Occurs during the copy properties method, when copying properties from the source symbolizer
- to this symbolizer.
- </summary>
- <param name="source">The source symbolizer to copy properties from.</param>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureSymbolizer.IsVisible">
- <summary>
- Gets or sets a boolean indicating whether or not this specific feature should be drawn.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureSymbolizer.ScaleMode">
- <summary>
- Gets or Sets a ScaleModes enumeration that determines whether non-coordinate drawing
- properties like width or size use pixels or world coordinates. If pixels are
- specified, a back transform is used to approximate pixel sizes.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureSymbolizer.Smoothing">
- <summary>
- Gets or sets the smoothing mode to use that controls advanced features like
- anti-aliasing. By default this is set to antialias.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureSymbolizer.Units">
- <summary>
- Gets or sets the graphics unit to work with.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureSymbolizerEventArgs.#ctor(DotSpatial.Symbology.IFeatureSymbolizer)">
- <summary>
- Creates a new instance of FeatureSymbolizerEventArgs
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureSymbolizerEventArgs.Symbolizer">
- <summary>
- Gets or sets the feature symbolizer for this event
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.FeatureSymbolizerOld">
- <summary>
- This contains the shared symbolizer properties between Points, Lines and Polygons.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IFeatureSymbolizerOld">
- <summary>
- This contains the set of symbology members that are shared
- between points, lines and polygons.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IFeatureSymbolizerOld.FillColor">
- <summary>
- Gets or sets the color of the brush used to fill the shape.
- Setting this will change the brush to a new SolidBrush.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IFeatureSymbolizerOld.FillBrush">
- <summary>
- Gets or sets the brush used to fill the shape.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IFeatureSymbolizerOld.IsTextured">
- <summary>
- Gets or sets whether or not to use a texture when drawing these lines. By default, this either
- checks the DefaultLineProvider or else it is false.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IFeatureSymbolizerOld.Name">
- <summary>
- Gets or sets a string name to help identify this Symbolizer
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IFeatureSymbolizerOld.Opacity">
- <summary>
- Gets or sets a float value from 0 to 1 where 0 is completely transparent
- and 1 is completely solid. Setting an alpha of a specific feature, like
- FillColor, to something less than 255 will control that feature's transparency
- without affecting the others. The final transparency of the feature will
- be that alpha multiplied by this value and rounded to the nearest byte.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IFeatureSymbolizerOld.TextureFile">
- <summary>
- Gets or sets the string TextureFile to define the fill texture
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IFeatureSymbolizerOld.TextureImage">
- <summary>
- Gets or sets the actual bitmap to use for the texture.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IFeatureSymbolizerOld.ScaleMode">
- <summary>
- Gets or Sets a ScaleModes enumeration that determines whether non-coordinate drawing
- properties like width or size use pixels or world coordinates. If pixels are
- specified, a back transform is used to approximate pixel sizes.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IFeatureSymbolizerOld.Smoothing">
- <summary>
- Gets or sets the smoothing mode to use that controls advanced features like
- anti-aliasing. By default this is set to antialias.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureSymbolizerOld.#ctor">
- <summary>
- This constructor takes on some default values, and assumes that it
- has no other underlying symblizer to reference.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureSymbolizerOld.GetLegendSymbolSize">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.FeatureSymbolizerOld.Draw(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Draws a basic symbol to the specified rectangle
- </summary>
- <param name="g">The graphics surface to draw on</param>
- <param name="target">The target to draw the symbol to</param>
- </member>
- <member name="M:DotSpatial.Symbology.FeatureSymbolizerOld.LegendSymbol_Painted(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Occurs in response to the legend symbol being painted
- </summary>
- <param name="g">The Graphics surface to draw on</param>
- <param name="box">The box to draw to</param>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureSymbolizerOld.IsVisible">
- <summary>
- Gets or sets a boolean indicating whether or not this specific feature should be drawn.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureSymbolizerOld.FillColor">
- <summary>
- Gets or sets the solid color to be used for filling the symbol.
- This will also change the FillBrush to a solid brush of the specified color.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureSymbolizerOld.FillBrush">
- <summary>
- Gets or sets the Brush to be used when filling this point.
- Setting this value will also change the FillColor property, but only if
- the brush is a SolidBrush.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureSymbolizerOld.IsTextured">
- <summary>
- Gets or sets whether to use the specified TextureImage during drawing
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureSymbolizerOld.Name">
- <summary>
- Gets or sets a string name to help identify this Symbolizer
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureSymbolizerOld.Opacity">
- <summary>
- Gets or sets a float value from 0 to 1 where 0 is completely transparent
- and 1 is completely solid. Setting an alpha of a specific feature, like
- FillColor, to something less than 255 will control that feature's transparency
- without affecting the others. The final transparency of the feature will
- be that alpha multiplied by this value and rounded to the nearest byte.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureSymbolizerOld.ScaleMode">
- <summary>
- Gets or Sets a ScaleModes enumeration that determines whether non-coordinate drawing
- properties like width or size use pixels or world coordinates. If pixels are
- specified, a back transform is used to approximate pixel sizes.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureSymbolizerOld.Smoothing">
- <summary>
- Gets or sets the smoothing mode to use that controls advanced features like
- anti-aliasing. By default this is set to antialias.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureSymbolizerOld.TextureFile">
- <summary>
- Gets or sets the string TextureFile to define the fill texture
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.FeatureSymbolizerOld.TextureImage">
- <summary>
- Gets or sets the actual bitmap to use for the texture.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.FilterType">
- <summary>
- Add, remove and clear methods don't work on all the categorical sub-filters, but rather only on the
- most immediate.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.FilterType.Category">
- <summary>
- Categories
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.FilterType.Chunk">
- <summary>
- Chunks
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.FilterType.Selection">
- <summary>
- Selected or unselected
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.FilterType.Visible">
- <summary>
- Visible or not
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IIndexSelection">
- <summary>
- IIndexSelection
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IIndexSelection.Clear">
- <summary>
- Clears the selection
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IIndexSelection.AddRange(System.Collections.Generic.IEnumerable{System.Int32})">
- <summary>
- Adds a range of indices all at once.
- </summary>
- <param name="indices">The indices to add</param>
- </member>
- <member name="M:DotSpatial.Symbology.IIndexSelection.RemoveRange(System.Collections.Generic.IEnumerable{System.Int32})">
- <summary>
- Removes a set of indices all at once
- </summary>
- <param name="indices"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Symbology.IIndexSelection.Count">
- <summary>
- Gets the integer count of the members in the collection
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IndexSelection">
- <summary>
- IndexSelection
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IndexSelection.AddRange(System.Collections.Generic.IEnumerable{System.Int32})">
- <summary>
- Adds all of the specified index values to the selection
- </summary>
- <param name="indices">The indices to add</param>
- </member>
- <member name="M:DotSpatial.Symbology.IndexSelection.AddRegion(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IEnvelope@)">
- <summary>
- Add REgion
- </summary>
- <param name="region"></param>
- <param name="affectedArea"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.IndexSelection.InvertSelection(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IEnvelope@)">
- <summary>
-
- </summary>
- <param name="region"></param>
- <param name="affectedArea"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.IndexSelection.RemoveRange(System.Collections.Generic.IEnumerable{System.Int32})">
- <summary>
- Attempts to remove all the members from the collection. If
- one of the specified indices is outside the range of possible
- values, this returns false, even if others were successfully removed.
- This will also return false if none of the states were changed.
- </summary>
- <param name="indices">The indices to remove</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.IndexSelection.RemoveRegion(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IEnvelope@)">
- <summary>
-
- </summary>
- <param name="region"></param>
- <param name="affectedArea"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.IndexSelection.ToFeatureSet">
- <summary>
- Returns a new featureset based on the features in this collection
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.IndexSelection.ToFeatureList">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.IndexSelection.GetAttributes(System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.IndexSelection.GetAttributes(System.Int32,System.Int32,System.Collections.Generic.IEnumerable{System.String})">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.IndexSelection.SetAttributes(System.Int32,System.Data.DataTable)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.IndexSelection.NumRows">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.IndexSelection.GetColumns">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.IndexSelection.GetColumn(System.String)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.IndexSelection.Add(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.IndexSelection.Clear">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.IndexSelection.Contains(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.IndexSelection.CopyTo(System.Int32[],System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.IndexSelection.Remove(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.IndexSelection.GetEnumerator">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.IndexSelection.AddRow(System.Collections.Generic.Dictionary{System.String,System.Object})">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.IndexSelection.AddRow(System.Data.DataRow)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.IndexSelection.Edit(System.Int32,System.Collections.Generic.Dictionary{System.String,System.Object})">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.IndexSelection.Edit(System.Int32,System.Data.DataRow)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.IndexSelection.GetCounts(System.String[],DotSpatial.Data.ICancelProgressHandler,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.IndexSelection.#ctor(DotSpatial.Symbology.IFeatureLayer)">
- <summary>
- Creates a new instance of IndexSelection
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IndexSelection.Envelope">
- <summary>
- Calculates the envelope of this collection
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IndexSelection.SelectionMode">
- <summary>
- Selection Mode controls how envelopes are treated when working with geometries.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IndexSelection.SelectionState">
- <summary>
- Gets or sets whether this should work as "Selected" indices (true) or
- "UnSelected" indices (false).
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IndexSelection.ProgressHandler">
- <summary>
- Gets or sets the handler to use for progress messages during selection.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IndexSelection.Count">
- <inheritdoc />
- </member>
- <member name="P:DotSpatial.Symbology.IndexSelection.IsReadOnly">
- <inheritdoc />
- </member>
- <member name="P:DotSpatial.Symbology.IndexSelection.RegionCategory">
- <summary>
- Setting this to a specific category will only allow selection by
- region to affect the features that are within the specified category.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IndexSelection.IndexSelectionEnumerator">
- <summary>
- This class cycles through the members
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IndexSelection.IndexSelectionEnumerator.#ctor(DotSpatial.Symbology.FastDrawnState[],System.Boolean)">
- <summary>
- Creates a new instance of IndexSelectionEnumerator
- </summary>
- <param name="states"></param>
- <param name="selectionState"></param>
- </member>
- <member name="M:DotSpatial.Symbology.IndexSelection.IndexSelectionEnumerator.Dispose">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.IndexSelection.IndexSelectionEnumerator.MoveNext">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.IndexSelection.IndexSelectionEnumerator.Reset">
- <inheritdoc />
- </member>
- <member name="P:DotSpatial.Symbology.IndexSelection.IndexSelectionEnumerator.Current">
- <inheritdoc />
- </member>
- <member name="T:DotSpatial.Symbology.IntervalMethod">
- <summary>
- IntervalMethods
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.IntervalMethod.DefinedInterval">
- <summary>
- A numeric value fixes a constant separation between breaks.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.IntervalMethod.EqualInterval">
- <summary>
- The breaks are set to being evenly spaced.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.IntervalMethod.Geometrical">
- <summary>
- Breaks are calculated according to the following restrictions:
- 1) break sizes follow a geometric progression
- 2) the number of breaks is specified
- 3) the sum of squares of the counts per bin is minimized
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.IntervalMethod.Manual">
- <summary>
- Breaks start equally placed, but can be positioned manually instead.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.IntervalMethod.NaturalBreaks">
- <summary>
- Jenks natural breaks looks for "clumping" in the data and
- attempts to group according to the clumps.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.IntervalMethod.Quantile">
- <summary>
- The breaks are positioned to ensure close to equal quantities
- in each break.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.IntervalMethod.StandardDeviation">
- <summary>
- Not sure how this works yet. Something to do with standard deviations.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IntervalSnapMethod">
- <summary>
- IntervalSnapMethods
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.IntervalSnapMethod.DataValue">
- <summary>
- Snap the chosen values to the nearest data value.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.IntervalSnapMethod.None">
- <summary>
- No snapping at all is used
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.IntervalSnapMethod.Rounding">
- <summary>
- Snaps to the nearest integer value.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.IntervalSnapMethod.SignificantFigures">
- <summary>
- Disregards scale, and preserves a fixed number of figures.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.ILineCategory">
- <summary>
- IPointSchemeCategory
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILineCategory.Symbolizer">
- <summary>
- Gets or sets the symbolizer for this category
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILineCategory.SelectionSymbolizer">
- <summary>
- Gets or sets the symbolizer to use to draw selected features from this category.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.ILineLayer">
- <summary>
- A layer with drawing characteristics for LineStrings
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILineLayer.Symbolizer">
- <summary>
- Gets or sets the drawing characteristics to use for this layer.
- </summary>
- <exception cref="T:System.InvalidOperationException">Unable to assign a non-point symbolizer to a PointLayer</exception>
- </member>
- <member name="P:DotSpatial.Symbology.ILineLayer.SelectionSymbolizer">
- <summary>
- Gets or sets the LineSymbolizer to use for selected properties.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILineLayer.Symbology">
- <summary>
- Gets or sets the categorical scheme for categorical drawing.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.ILineScheme">
- <summary>
- IPointScheme
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILineScheme.Categories">
- <summary>
- Gets the list of scheme categories belonging to this scheme.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.ILineSymbolizer">
- <summary>
- ILineSymbolizer
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ILineSymbolizer.DrawLegendSymbol(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Draws the line that is needed to show this lines legend symbol.
- </summary>
- <param name="g">The graphics device to draw to.</param>
- <param name="target">The rectangle that is used to calculate the lines position and size.</param>
- </member>
- <member name="M:DotSpatial.Symbology.ILineSymbolizer.DrawPath(System.Drawing.Graphics,System.Drawing.Drawing2D.GraphicsPath,System.Double)">
- <summary>
- Sequentially draws all of the strokes using the specified graphics path.
- </summary>
- <param name="g">The graphics device to draw to</param>
- <param name="gp">The graphics path that describes the pathway to draw</param>
- <param name="scaleWidth">The double scale width that when multiplied by the width gives a measure in pixels</param>
- </member>
- <member name="M:DotSpatial.Symbology.ILineSymbolizer.GetFillColor">
- <summary>
- Gets the color of the top-most stroke.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ILineSymbolizer.SetFillColor(System.Drawing.Color)">
- <summary>
- Sets the fill color fo the top-most stroke, and forces the top-most stroke
- to be a type of stroke that can accept a fill color if necessary.
- </summary>
- <param name="fillColor"></param>
- </member>
- <member name="M:DotSpatial.Symbology.ILineSymbolizer.GetWidth">
- <summary>
- This gets the largest width of all the strokes.
- Setting this will change the width of all the strokes to the specified width, and is not recommended
- if you are using thin lines drawn over thicker lines.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ILineSymbolizer.SetWidth(System.Double)">
- <summary>
- This forces the width to exist across all the strokes in this symbolizer.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILineSymbolizer.Strokes">
- <summary>
- Gets or sets the list of strokes that will be combined to make up a single drawing pass for this line.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.LineCategory">
- <summary>
- PointSchemeCategory
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LineCategory.#ctor">
- <summary>
- Creates a new instance of PointSchemeCategory
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LineCategory.#ctor(System.Drawing.Color,System.Drawing.Color,System.Double,System.Drawing.Drawing2D.DashStyle,System.Drawing.Drawing2D.LineCap)">
- <summary>
- Creates a new set of cartographic lines that together form a line with a border. Since a compound
- pen is used, it is possible to use this to create a transparent line with just two border parts.
- The selection symbolizer will be dark cyan bordering light cyan, but use the same dash and cap
- patterns.
- </summary>
- <param name="fillColor">The fill color for the line</param>
- <param name="borderColor">The border color of the line</param>
- <param name="width">The width of the entire line</param>
- <param name="dash">The dash pattern to use</param>
- <param name="caps">The style of the start and end caps</param>
- </member>
- <member name="M:DotSpatial.Symbology.LineCategory.#ctor(System.Drawing.Color,System.Double)">
- <summary>
- Creates a new line category with the specified color and width
- </summary>
- <param name="color">The color of the unselected line</param>
- <param name="width">The width of both the selected and unselected lines.</param>
- </member>
- <member name="M:DotSpatial.Symbology.LineCategory.#ctor(DotSpatial.Topology.IEnvelope)">
- <summary>
- Creates a new instanec of a default point scheme category where the geographic symbol size has been
- scaled to the specified extent.
- </summary>
- <param name="extent">The geographic extent that is 100 times wider than the geographic size of the points.</param>
- </member>
- <member name="M:DotSpatial.Symbology.LineCategory.#ctor(DotSpatial.Symbology.ILineSymbolizer)">
- <summary>
- Creates a new category based on a symbolizer, and uses the same symbolizer, but with a fill and border color of light cyan
- for the selection symbolizer
- </summary>
- <param name="lineSymbolizer">The symbolizer to use in order to create a category</param>
- </member>
- <member name="M:DotSpatial.Symbology.LineCategory.GetColor">
- <summary>
- This gets a single color that attempts to represent the specified
- category. For polygons, for example, this is the fill color (or central fill color)
- of the top pattern. If an image is being used, the color will be gray.
- </summary>
- <returns>The System.Color that can be used as an approximation to represent this category.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.LineCategory.GetLegendSymbolSize">
- <summary>
- Gets the legend symbol size of the symbolizer for this category.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LineCategory.LegendSymbol_Painted(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Controls what happens in the legend when this item is instructed to draw a symbol.
- </summary>
- <param name="g"></param>
- <param name="box"></param>
- </member>
- <member name="M:DotSpatial.Symbology.LineCategory.SetColor(System.Drawing.Color)">
- <summary>
- Sets the specified color as the color for the top most stroke.
- </summary>
- <param name="color">The color to apply</param>
- </member>
- <member name="P:DotSpatial.Symbology.LineCategory.Symbolizer">
- <summary>
- Gets or sets the symbolizer for this category
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LineCategory.SelectionSymbolizer">
- <summary>
- Gets or sets the symbolizer to use to draw selected features from this category.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.LineCategoryCollection">
- <summary>
- This is simply an alias to make things a tad (though not much) more understandable
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LineCategoryCollection.OnSelectFeatures(System.Object,DotSpatial.Symbology.ExpressionEventArgs)">
- <summary>
- Instructs the parent layer to select features matching the specified expression.
- </summary>
- <param name="sender">The object sender.</param>
- <param name="e">The event args.</param>
- </member>
- <member name="M:DotSpatial.Symbology.LineCategoryCollection.OnDeselectFeatures(System.Object,DotSpatial.Symbology.ExpressionEventArgs)">
- <summary>
- Instructs the parent layer to select features matching the specified expression.
- </summary>
- <param name="sender">The object sender where features were selected.</param>
- <param name="e">The event args describing which expression was used.</param>
- </member>
- <member name="M:DotSpatial.Symbology.LineCategoryCollection.OnInclude(DotSpatial.Symbology.ILineCategory)">
- <summary>
- Ensures that newly added categories can navigate to higher legend items.
- </summary>
- <param name="item">The newly added legend item.</param>
- </member>
- <member name="M:DotSpatial.Symbology.LineCategoryCollection.OnCopy(DotSpatial.Data.CopyList{DotSpatial.Symbology.ILineCategory})">
- <summary>
- Overrides the default OnCopy behavior to remove the duplicte SelectFeatures event handler
- </summary>
- <param name="copy"></param>
- </member>
- <member name="M:DotSpatial.Symbology.LineCategoryCollection.OnExclude(DotSpatial.Symbology.ILineCategory)">
- <summary>
-
- </summary>
- <param name="item"></param>
- </member>
- <member name="M:DotSpatial.Symbology.LineCategoryCollection.UpdateItemParentPointers">
- <summary>
- Cycles through all the categories and resets the parent item.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LineCategoryCollection.Scheme">
- <summary>
- Gets or sets the parent line scheme
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.LineCategoryCollection.SelectFeatures">
- <summary>
- Occurs when a category indicates that its filter expression should be used
- to select its members.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.LineCategoryCollection.DeselectFeatures">
- <summary>
- Occurs when the deselect features context menu is clicked.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.LineFeatureTypeException">
- <summary>
- LineFeatureTypeException
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LineFeatureTypeException.#ctor">
- <summary>
- Creates a new instance of LineFeatureTypeException
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LineFeatureTypeException.#ctor(System.String)">
- <summary>
- Creates a new instance of LineFeatureTypeException
- </summary>
- <param name="message">The custom error message for this exception</param>
- </member>
- <member name="T:DotSpatial.Symbology.LineLayer">
- <summary>
- A layer with drawing characteristics for LineStrings
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LineLayer.#ctor(DotSpatial.Data.IFeatureSet)">
- <summary>
- Constructor
- </summary>
- <param name="inFeatureSet"></param>
- <exception cref="T:DotSpatial.Symbology.LineFeatureTypeException">Thrown if a non-line featureSet is supplied</exception>
- </member>
- <member name="M:DotSpatial.Symbology.LineLayer.#ctor(DotSpatial.Data.IFeatureSet,DotSpatial.Data.IProgressHandler)">
- <summary>
- Constructor that also shows progress
- </summary>
- <param name="inFeatureSet">A featureset that contains lines</param>
- <param name="progressHandler">An IProgressHandler for receiving status messages</param>
- <exception cref="T:DotSpatial.Symbology.LineFeatureTypeException">Thrown if a non-line featureSet is supplied</exception>
- </member>
- <member name="M:DotSpatial.Symbology.LineLayer.#ctor(DotSpatial.Data.IFeatureSet,System.Collections.Generic.ICollection{DotSpatial.Symbology.ILayer},DotSpatial.Data.IProgressHandler)">
- <summary>
- Constructor that also shows progress.
- </summary>
- <param name="inFeatureSet">A featureset that contains lines.</param>
- <param name="container">An IContainer that the line layer should be created in.</param>
- <param name="progressHandler">An IProgressHandler for receiving status messages.</param>
- <exception cref="T:DotSpatial.Symbology.LineFeatureTypeException">Thrown if a non-line featureSet is supplied.</exception>
- </member>
- <member name="M:DotSpatial.Symbology.LineLayer.DrawSnapShot(System.Drawing.Graphics,DotSpatial.Data.IProj)">
- <summary>
- Draws some section of the extent to the specified graphics object.
- </summary>
- <param name="g">The graphics object to draw to.</param>
- <param name="p">The projection interface that specifies how to transform geographic coordinates to an image.</param>
- </member>
- <member name="P:DotSpatial.Symbology.LineLayer.SelectionSymbolizer">
- <summary>
- Gets or sets the line symbolizer to use for the selection
- </summary>
- <remarks>
- [TypeConverter(typeof(GeneralTypeConverter))]
- [Editor(typeof(LineSymbolizerEditor), typeof(UITypeEditor))]
- </remarks>
- </member>
- <member name="P:DotSpatial.Symbology.LineLayer.Symbolizer">
- <summary>
- Gets or sets the FeatureSymbolizerOld determining the shared properties. This is actually still the PointSymbolizerOld
- and should not be used directly on Polygons or Lines.
- </summary>
- <remarks>
- [TypeConverter(typeof(GeneralTypeConverter))]
- [Editor(typeof(LineSymbolizerEditor), typeof(UITypeEditor))]
- </remarks>
- <exception cref="T:System.InvalidOperationException">Unable to assign a non-point symbolizer to a PointLayer</exception>
- </member>
- <member name="P:DotSpatial.Symbology.LineLayer.Symbology">
- <summary>
- Gets or sets the line scheme subdividing the layer into categories.
- </summary>
- <remarks>
- [TypeConverter(typeof(GeneralTypeConverter))]
- [Editor(typeof(LineSchemePropertyGridEditor), typeof(UITypeEditor))]
- </remarks>
- </member>
- <member name="T:DotSpatial.Symbology.LineScheme">
- <summary>
- PointScheme
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LineScheme.#ctor">
- <summary>
- Creates a new instance of PointScheme with no categories added to the list yet.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LineScheme.DrawCategory(System.Int32,System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Draws the regular symbolizer for the specified cateogry to the specified graphics
- surface in the specified bounding rectangle.
- </summary>
- <param name="index">The integer index of the feature to draw.</param>
- <param name="g">The Graphics object to draw to</param>
- <param name="bounds">The rectangular bounds to draw in</param>
- </member>
- <member name="M:DotSpatial.Symbology.LineScheme.DecreaseCategoryIndex(DotSpatial.Symbology.ICategory)">
- <summary>
- Reduces the index value of the specified category by 1 by
- exchaning it with the category before it. If there is no
- category before it, then this does nothing.
- </summary>
- <param name="category">The category to decrease the index of</param>
- </member>
- <member name="M:DotSpatial.Symbology.LineScheme.IncreaseCategoryIndex(DotSpatial.Symbology.ICategory)">
- <summary>
- Re-orders the specified member by attempting to exchange it with the next higher
- index category. If there is no higher index, this does nothing.
- </summary>
- <param name="category">The category to increase the index of</param>
- </member>
- <member name="M:DotSpatial.Symbology.LineScheme.AddCategory(DotSpatial.Symbology.ICategory)">
- <summary>
- Adds a new scheme, assuming that the new scheme is the correct type.
- </summary>
- <param name="category">The category to add</param>
- </member>
- <member name="M:DotSpatial.Symbology.LineScheme.RemoveCategory(DotSpatial.Symbology.ICategory)">
- <summary>
- Removes the specified category
- </summary>
- <param name="category">The category to insert</param>
- </member>
- <member name="M:DotSpatial.Symbology.LineScheme.InsertCategory(System.Int32,DotSpatial.Symbology.ICategory)">
- <summary>
- Inserts the category at the specified index
- </summary>
- <param name="index">The integer index where the category should be inserted</param>
- <param name="category">The category to insert</param>
- </member>
- <member name="M:DotSpatial.Symbology.LineScheme.SuspendEvents">
- <summary>
- Suspends the category events
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LineScheme.ResumeEvents">
- <summary>
- Resumes the category events
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LineScheme.ClearCategories">
- <summary>
- Clears the categories
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LineScheme.CreateRandomCategory(System.String)">
- <summary>
- Uses the settings on this scheme to create a random category.
- </summary>
- <returns>A new IFeatureCategory</returns>
- </member>
- <member name="M:DotSpatial.Symbology.LineScheme.GetDefaultColors(System.Int32)">
- <summary>
- If possible, use the template to control the colors. Otherwise, just use the default
- settings for creating "unbounded" colors.
- </summary>
- <param name="count">The integer count.</param>
- <returns>The List of colors</returns>
- </member>
- <member name="M:DotSpatial.Symbology.LineScheme.GenerateUniqueColors(DotSpatial.Data.IFeatureSet,System.String)">
- <summary>
- Calculates the unique colors as a scheme
- </summary>
- <param name="fs">The featureset with the data Table definition</param>
- <param name="uniqueField">The unique field</param>
- </member>
- <member name="M:DotSpatial.Symbology.LineScheme.GetCategories">
- <summary>
- Returns the line scheme as a feature categories collection
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.LineScheme.CreateNewCategory(System.Drawing.Color,System.Double)">
- <summary>
- Creates the category using a random fill color
- </summary>
- <param name="fillColor">The base color to use for creating the category</param>
- <param name="size">Creates the size</param>
- <returns>A new polygon category</returns>
- </member>
- <member name="M:DotSpatial.Symbology.LineScheme.OnExcludeCategories(DotSpatial.Symbology.LineCategoryCollection)">
- <summary>
- Handle the event un-wiring and scheme update for the old categories
- </summary>
- <param name="categories">The category collection to update.</param>
- </member>
- <member name="M:DotSpatial.Symbology.LineScheme.OnIncludeCategories(DotSpatial.Symbology.LineCategoryCollection)">
- <summary>
- Handle the event wiring and scheme update for the new categories.
- </summary>
- <param name="categories">The category collection to update</param>
- </member>
- <member name="P:DotSpatial.Symbology.LineScheme.Categories">
- <summary>
- Gets or sets the symbolic categories as a valid IPointSchemeCategoryCollection.
- </summary>
- <remarks>
- [TypeConverter(typeof(CategoryCollectionConverter))]
- </remarks>
- </member>
- <member name="P:DotSpatial.Symbology.LineScheme.NumCategories">
- <summary>
- Gets the number of categories in this scheme
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.LineSymbolizer">
- <summary>
- LineSymbolizer
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LineSymbolizer.#ctor">
- <summary>
- Creates a new instance of LineSymbolizer
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LineSymbolizer.#ctor(System.Drawing.Color,System.Drawing.Color,System.Double,System.Drawing.Drawing2D.DashStyle,System.Drawing.Drawing2D.LineCap)">
- <summary>
- Creates a new set of cartographic lines that together form a line with a border. Since a compound
- pen is used, it is possible to use this to create a transparent line with just two border parts.
- </summary>
- <param name="fillColor">The fill color for the line</param>
- <param name="borderColor">The border color of the line</param>
- <param name="width">The width of the entire line</param>
- <param name="dash">The dash pattern to use</param>
- <param name="caps">The style of the start and end caps</param>
- </member>
- <member name="M:DotSpatial.Symbology.LineSymbolizer.#ctor(System.Drawing.Color,System.Drawing.Color,System.Double,System.Drawing.Drawing2D.DashStyle,System.Drawing.Drawing2D.LineCap,System.Drawing.Drawing2D.LineCap)">
- <summary>
- Creates a new set of cartographic lines that together form a line with a border. Since a compound
- pen is used, it is possible to use this to create a transparent line with just two border parts.
- </summary>
- <param name="fillColor">The fill color for the line</param>
- <param name="borderColor">The border color of the line</param>
- <param name="width">The width of the entire line</param>
- <param name="dash">The dash pattern to use</param>
- <param name="startCap">The style of the start cap</param>
- <param name="endCap">The style of the end cap</param>
- </member>
- <member name="M:DotSpatial.Symbology.LineSymbolizer.#ctor(System.Collections.Generic.IEnumerable{DotSpatial.Symbology.IStroke})">
- <summary>
- Creates a new instance of a LineSymbolizer using the various strokes to form a
- composit symbol.
- </summary>
- <param name="strokes"></param>
- </member>
- <member name="M:DotSpatial.Symbology.LineSymbolizer.#ctor(System.Boolean)">
- <summary>
- Creates a new instance of LineSymbolizer for handling selections.
- </summary>
- <param name="selected">Boolean, true if this should be symbolized like a selected line.</param>
- </member>
- <member name="M:DotSpatial.Symbology.LineSymbolizer.#ctor(System.Drawing.Color,System.Double)">
- <summary>
- Creates a new LineSymbolizer with a single layer with the specified color and width.
- </summary>
- <param name="color">The color</param>
- <param name="width">The line width</param>
- </member>
- <member name="M:DotSpatial.Symbology.LineSymbolizer.#ctor(DotSpatial.Topology.IEnvelope,System.Boolean)">
- <summary>
- Creates a line symbolizer that has a width that is scaled in proportion to the specified envelope as 1/100th of the
- width of the envelope.
- </summary>
- <param name="env"></param>
- <param name="selected"></param>
- </member>
- <member name="M:DotSpatial.Symbology.LineSymbolizer.Draw(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Draws a line instead of a rectangle.
- </summary>
- <param name="g">The graphics device to draw to.</param>
- <param name="target">The rectangle that is used to calculate the lines position and size.</param>
- </member>
- <member name="M:DotSpatial.Symbology.LineSymbolizer.DrawLegendSymbol(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Draws the line that is needed to show this lines legend symbol.
- </summary>
- <param name="g">The graphics device to draw to.</param>
- <param name="target">The rectangle that is used to calculate the lines position and size.</param>
- </member>
- <member name="M:DotSpatial.Symbology.LineSymbolizer.DrawPath(System.Drawing.Graphics,System.Drawing.Drawing2D.GraphicsPath,System.Double)">
- <summary>
- Sequentially draws all of the strokes using the specified graphics path.
- </summary>
- <param name="g">The graphics device to draw to.</param>
- <param name="gp">The graphics path that describes the pathway to draw</param>
- <param name="scaleWidth">The double scale width that when multiplied by the width gives a measure in pixels</param>
- </member>
- <member name="M:DotSpatial.Symbology.LineSymbolizer.GetFillColor">
- <summary>
- Gets the color of the top-most stroke.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LineSymbolizer.SetFillColor(System.Drawing.Color)">
- <summary>
- Sets the fill color fo the top-most stroke, and forces the top-most stroke
- to be a type of stroke that can accept a fill color if necessary.
- </summary>
- <param name="fillColor"></param>
- </member>
- <member name="M:DotSpatial.Symbology.LineSymbolizer.GetLegendSymbolSize">
- <summary>
- Gets the Size that is needed to show this line in legend with max. 2 decorations.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LineSymbolizer.GetWidth">
- <summary>
- This gets the largest width of all the strokes.
- Setting this will change the width of all the strokes to the specified width, and is not recommended
- if you are using thin lines drawn over thicker lines.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LineSymbolizer.SetWidth(System.Double)">
- <summary>
- This keeps the ratio of the widths the same, but scales the width up for
- all the strokes.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LineSymbolizer.SetOutline(System.Drawing.Color,System.Double)">
- <summary>
- Sets the outline, assuming that the symbolizer either supports outlines, or
- else by using a second symbol layer.
- </summary>
- <param name="outlineColor">The color of the outline</param>
- <param name="width">The width of the outline in pixels</param>
- </member>
- <member name="P:DotSpatial.Symbology.LineSymbolizer.Strokes">
- <summary>
- Gets or sets the list of strokes, which define how the drawing pen should behave.
- </summary>
- <remarks>
- [Editor(typeof(StrokesEditor), typeof(UITypeEditor))]
- [TypeConverter(typeof(GeneralTypeConverter))]
- </remarks>
- </member>
- <member name="T:DotSpatial.Symbology.LineSymbolizerEventArgs">
- <summary>
- LineSymbolizerEventArgs
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LineSymbolizerEventArgs.#ctor(DotSpatial.Symbology.ILineSymbolizer)">
- <summary>
- Creates a new instance of LineSymbolizerEventArgs
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LineSymbolizerEventArgs.Symbolizer">
- <summary>
- Gets or sets the Symbolizer
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.SimpleStroke">
- <summary>
- SimpleStroke
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Stroke">
- <summary>
- Because we plan on making these XML serializable, the stroke allows us to open from
- a serialized situation without having to know in advance what kind of stroke we
- actually have. The main idea is to allow something like:
-
- Stroke myStroke = new Stroke();
- myStroke.FromXml(myStream);
- Pen p = myStroke.ToPen();
-
- This allows loading, saving and creating pens from the sub-types without ever
- knowing exactly what they are. All the basic subtypes can be obtained simply
- by casting this stroke into the appropriate interface.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IStroke">
- <summary>
- IStroke
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IStroke.DrawPath(System.Drawing.Graphics,System.Drawing.Drawing2D.GraphicsPath,System.Double)">
- <summary>
- This is an optional expression that allows drawing to the specified GraphicsPath.
- Overriding this allows for unconventional behavior to be included, such as
- specifying marker decorations, rather than simply returning a pen. A pen
- is also returned publicly for convenience.
- </summary>
- <param name="g">The Graphics device to draw to</param>
- <param name="path">the GraphicsPath to draw</param>
- <param name="scaleWidth">This is 1 for symbolic drawing, but could be
- any number for geographic drawing.</param>
- </member>
- <member name="M:DotSpatial.Symbology.IStroke.ToPen(System.Double)">
- <summary>
- Casts this stroke to the appropriate pen
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.IStroke.GetColor">
- <summary>
- Gets a color to represent this line. If the stroke doesn't work as a color,
- then this color will be gray.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.IStroke.SetColor(System.Drawing.Color)">
- <summary>
- Sets the color of this stroke to the specified color if possible.
- </summary>
- <param name="color">The color to assign to this color.</param>
- </member>
- <member name="P:DotSpatial.Symbology.IStroke.StrokeStyle">
- <summary>
- Gets the stroke style for this stroke
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Stroke.GetColor">
- <summary>
- Gets a color to represent this line. If the stroke doesn't work as a color,
- then this color will be gray.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Stroke.SetColor(System.Drawing.Color)">
- <summary>
- Sets the color of this stroke to the specified color if possible.
- </summary>
- <param name="color">The color to assign to this color.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Stroke.DrawPath(System.Drawing.Graphics,System.Drawing.Drawing2D.GraphicsPath,System.Double)">
- <summary>
- This is an optional expression that allows drawing to the specified GraphicsPath.
- Overriding this allows for unconventional behavior to be included, such as
- specifying marker decorations, rather than simply returning a pen. A pen
- is also returned publicly for convenience.
- </summary>
- <param name="g">The Graphics device to draw to</param>
- <param name="path">the GraphicsPath to draw</param>
- <param name="scaleWidth">This is 1 for symbolic drawing, but could be
- any number for geographic drawing.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Stroke.ToPen(System.Double)">
- <summary>
- Uses the properties specified in this class to generate a pen.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Stroke.CreateNew(DotSpatial.Symbology.StrokeStyle)">
- <summary>
- Defines this stroke as a new kind of stroke.
- </summary>
- <param name="style"></param>
- </member>
- <member name="P:DotSpatial.Symbology.Stroke.StrokeStyle">
- <summary>
- Gets the stroke style of the inner stroke
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.ISimpleStroke">
- <summary>
- ISimpleStroke
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ISimpleStroke.Color">
- <summary>
- Gets or sets the color for this drawing layer
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ISimpleStroke.DashStyle">
- <summary>
- Gets or sets the DashStyle for this stroke. (Custom is just solid for simple strokes)
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ISimpleStroke.Opacity">
- <summary>
- gets or sets the opacity of the color. 1 is fully opaque while 0 is fully transparent.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ISimpleStroke.Width">
- <summary>
- Gets or sets the width of this line. In geographic ScaleMode,
- this width is the actual geographic width of the line. In Symbolic scale mode
- this is the width of the line in pixels.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.SimpleStroke.#ctor">
- <summary>
- Creates a new instance of SimpleStroke
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.SimpleStroke.#ctor(System.Double)">
- <summary>
- Sets the width of the line as part of the constructor
- </summary>
- <param name="width">The double width of the line to set</param>
- </member>
- <member name="M:DotSpatial.Symbology.SimpleStroke.#ctor(System.Drawing.Color)">
- <summary>
- Creates a new simple stroke with the specified color
- </summary>
- <param name="color">The color to use for the stroke</param>
- </member>
- <member name="M:DotSpatial.Symbology.SimpleStroke.#ctor(System.Double,System.Drawing.Color)">
- <summary>
- Creates a new simple stroke with the specified width and color
- </summary>
- <param name="width"></param>
- <param name="color"></param>
- </member>
- <member name="M:DotSpatial.Symbology.SimpleStroke.GetColor">
- <summary>
- Gets a color to represent this line. If the stroke doesn't work as a color,
- then this color will be gray.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.SimpleStroke.SetColor(System.Drawing.Color)">
- <summary>
- Sets the color of this stroke to the specified color if possible.
- </summary>
- <param name="color">The color to assign to this color.</param>
- </member>
- <member name="M:DotSpatial.Symbology.SimpleStroke.ToPen(System.Double)">
- <summary>
- Creates a system drawing pen that has all of the symbolic information
- necessary for this stroke.
- </summary>
- <param name="width">The base width. In symbolic drawing this is 1, but in
- geographic drawing, this will be a number representing the result of a
- transform from projToPixel width.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.SimpleStroke.OnRandomize(System.Random)">
- <summary>
- Handles randomization of simple stroke content
- </summary>
- <param name="generator">The random generator to use for randomizing characteristics.</param>
- </member>
- <member name="P:DotSpatial.Symbology.SimpleStroke.Color">
- <summary>
- Gets or sets the color for this drawing layer
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SimpleStroke.DashStyle">
- <summary>
- Gets or sets the dash style
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SimpleStroke.Opacity">
- <summary>
- gets or sets the opacity of the color. 1 is fully opaque while 0 is fully transparent.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SimpleStroke.Width">
- <summary>
- Gets or sets the width of this line relative to the
- width passed in.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.ICartographicStroke">
- <summary>
- ICartographicStroke
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ICartographicStroke.DrawLegendPath(System.Drawing.Graphics,System.Drawing.Drawing2D.GraphicsPath,System.Double)">
- <summary>
- Draws the line with max. 2 decorations. Otherwise the legend line might show only decorations.
- </summary>
- <param name="g"></param>
- <param name="path"></param>
- <param name="scaleWidth"></param>
- </member>
- <member name="M:DotSpatial.Symbology.ICartographicStroke.GetLegendSymbolSize">
- <summary>
- Gets the width and height that is needed to draw this stroke with max. 2 decorations.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ICartographicStroke.JoinType">
- <summary>
- Gets or sets the OGC line characteristic that controls how connected segments
- are drawn where they come together.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ICartographicStroke.CompoundArray">
- <summary>
- Gets or sets an array of floating point values ranging from 0 to 1 that
- indicate the start and end point for where the line should draw.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ICartographicStroke.DashCap">
- <summary>
- gets or sets the DashCap for both the start and end caps of the dashes
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ICartographicStroke.DashPattern">
- <summary>
- Gets or sets the DashPattern as an array of floating point values from 0 to 1
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ICartographicStroke.Decorations">
- <summary>
- Gets or sets the line decoration that describes symbols that should
- be drawn along the line as decoration.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ICartographicStroke.EndCap">
- <summary>
- Gets or sets the line cap for both the start and end of the line
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ICartographicStroke.StartCap">
- <summary>
- Gets or sets the line cap for both the start and end of the line
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ICartographicStroke.DashButtons">
- <summary>
- This is a cached version of the horizontal pattern that should appear in the custom dash control.
- This is only used if DashStyle is set to custom, and only controls the pattern control,
- and does not directly affect the drawing pen.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ICartographicStroke.CompoundButtons">
- <summary>
- This is a cached version of the vertical pattern that should appear in the custom dash control.
- This is only used if DashStyle is set to custom, and only controls the pattern control,
- and does not directly affect the drawing pen.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ICartographicStroke.Offset">
- <summary>
- Gets or sets the floating poing offset (in pixels) for the line to be drawn to the left of
- the original line. (Internally, this will modify the width and compound array for the
- actual pen being used, as Pens do not support an offset property).
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.CartographicStroke.#ctor">
- <summary>
- Creates a new instance of CartographicStroke
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.CartographicStroke.#ctor(System.Drawing.Color)">
- <summary>
- Getnerates a cartographic stroke of the specified color
- </summary>
- <param name="color"></param>
- </member>
- <member name="M:DotSpatial.Symbology.CartographicStroke.ToPen(System.Double)">
- <summary>
- Creates a pen for drawing the non-decorative portion of the line.
- </summary>
- <param name="scaleWidth">The base width in pixels that is equivalent to a width of 1</param>
- <returns>A new Pen</returns>
- </member>
- <member name="M:DotSpatial.Symbology.CartographicStroke.DrawLegendPath(System.Drawing.Graphics,System.Drawing.Drawing2D.GraphicsPath,System.Double)">
- <summary>
- Draws the line with max. 2 decorations. Otherwise the legend line might show only decorations.
- </summary>
- <param name="g"></param>
- <param name="path"></param>
- <param name="scaleWidth"></param>
- </member>
- <member name="M:DotSpatial.Symbology.CartographicStroke.DrawPath(System.Drawing.Graphics,System.Drawing.Drawing2D.GraphicsPath,System.Double)">
- <summary>
- Draws the actual path, overriding the base behavior to include markers.
- </summary>
- <param name="g"></param>
- <param name="path"></param>
- <param name="scaleWidth"></param>
- </member>
- <member name="M:DotSpatial.Symbology.CartographicStroke.GetLegendSymbolSize">
- <summary>
- Gets the width and height that is needed to draw this stroke with max. 2 decorations.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.CartographicStroke.OnRandomize(System.Random)">
- <summary>
- Handles the randomization of the cartographic properties of this stroke.
- </summary>
- <param name="generator">The random class that generates the random numbers</param>
- </member>
- <member name="P:DotSpatial.Symbology.CartographicStroke.CompoundArray">
- <summary>
- Gets or sets an array of floating point values ranging from 0 to 1 that
- indicate the start and end point for where the line should draw.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.CartographicStroke.DashCap">
- <summary>
- gets or sets the DashCap for both the start and end caps of the dashes
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.CartographicStroke.DashPattern">
- <summary>
- Gets or sets the DashPattern as an array of floating point values from 0 to 1
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.CartographicStroke.Decorations">
- <summary>
- Gets or sets the line decoration that describes symbols that should
- be drawn along the line as decoration.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.CartographicStroke.EndCap">
- <summary>
- Gets or sets the line cap for both the start and end of the line
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.CartographicStroke.JoinType">
- <summary>
- Gets or sets the OGC line characteristic that controls how connected segments
- are drawn where they come together.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.CartographicStroke.StartCap">
- <summary>
- Gets or sets the line cap for both the start and end of the line
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.CartographicStroke.DashButtons">
- <summary>
- This is a cached version of the horizontal pattern that should appear in the custom dash control.
- This is only used if DashStyle is set to custom, and only controls the pattern control,
- and does not directly affect the drawing pen.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.CartographicStroke.CompoundButtons">
- <summary>
- This is a cached version of the vertical pattern that should appear in the custom dash control.
- This is only used if DashStyle is set to custom, and only controls the pattern control,
- and does not directly affect the drawing pen.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.CartographicStroke.Offset">
- <summary>
- Gets or sets the floating poing offset (in pixels) for the line to be drawn to the left of
- the original line. (Internally, this will modify the width and compound array for the
- actual pen being used, as Pens do not support an offset property).
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.ILineDecoration">
- <summary>
- LineDecoration
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ILineDecoration.Draw(System.Drawing.Graphics,System.Drawing.Drawing2D.GraphicsPath,System.Double)">
- <summary>
- Given the points on this line decoration, this will cycle through and handle
- the drawing as dictated by this decoration.
- </summary>
- <param name="g"></param>
- <param name="path"></param>
- <param name="scaleWidth">The double scale width for controling markers</param>
- </member>
- <member name="M:DotSpatial.Symbology.ILineDecoration.GetLegendSymbolSize">
- <summary>
- Gets the size that is needed to draw this decoration with max. 2 symbols.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILineDecoration.Symbol">
- <summary>
- Gets or sets the decorative symbol
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILineDecoration.FlipFirst">
- <summary>
- Gets or sets a boolean that, if true, flips the first symbol in relation
- to the direction of the line.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILineDecoration.FlipAll">
- <summary>
- Gets or sets a boolean that, if true, reverses all of the symbols
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILineDecoration.RotateWithLine">
- <summary>
- Gets or sets a boolean that, if true, will cause the symbol to
- be rotated according to the direction of the line. Arrows
- at the ends, for instance, will point along the direction of
- the line, regardless of the direction of the line.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILineDecoration.NumSymbols">
- <summary>
- Gets or sets the number of symbols that should be drawn on each
- line. (not each segment).
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILineDecoration.PercentualPosition">
- <summary>
- Gets or sets the percentual position between line start and end at which the single decoration gets drawn.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ILineDecoration.Offset">
- <summary>
- Gets or sets the offset distance measured to the left of the line in pixels.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.LineDecoration">
- <summary>
- LineDecoration
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LineDecoration.#ctor">
- <summary>
- Creates a new instance of LineDecoration
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LineDecoration.Draw(System.Drawing.Graphics,System.Drawing.Drawing2D.GraphicsPath,System.Double)">
- <summary>
- Given the points on this line decoration, this will cycle through and handle
- the drawing as dictated by this decoration.
- </summary>
- <param name="g"></param>
- <param name="path"></param>
- <param name="scaleWidth">The double scale width for controling markers</param>
- </member>
- <member name="M:DotSpatial.Symbology.LineDecoration.DrawImage(System.Drawing.Graphics,System.Drawing.PointF,System.Drawing.PointF,System.Drawing.PointF,System.Boolean,System.Drawing.Bitmap,System.Drawing.Drawing2D.Matrix)">
- <summary>
- Draws the given symbol at the position calculated from locationPoint and _offset.
- </summary>
- <param name="g">Graphics-object needed for drawing.</param>
- <param name="startPoint">StartPoint of the line locationPoint belongs to. Needed for caluclating the angle and the offset of the symbol.</param>
- <param name="stopPoint">StopPoint of the line locationPoint belongs to. Needed for caluclating the angle and the offset of the symbol.</param>
- <param name="locationPoint">Position where the center of the image should be drawn.</param>
- <param name="Flip">Indicates whether the symbol should be flipped.</param>
- <param name="symbol">Image that gets drawn.</param>
- <param name="oldMat">Matrix used for rotation.</param>
- </member>
- <member name="M:DotSpatial.Symbology.LineDecoration.FlipAngle(System.Single@)">
- <summary>
- Flips the given angle by 180 degree.
- </summary>
- <param name="angle">Angle, that should be flipped.</param>
- </member>
- <member name="M:DotSpatial.Symbology.LineDecoration.GetAngle(System.Drawing.PointF,System.Drawing.PointF)">
- <summary>
- Gets the angle of the line between StartPoint and EndPoint taking into account the direction of the line.
- </summary>
- <param name="StartPoint">StartPoint of the line.</param>
- <param name="EndPoint">EndPoint of the line.</param>
- <returns>Angle of the given line.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.LineDecoration.GetLegendSymbolSize">
- <summary>
- Gets the size that is needed to draw this decoration with max. 2 symbols.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.LineDecoration.GetLength(System.Drawing.PointF,System.Drawing.PointF)">
- <summary>
- Gets the length of the line between startpoint and endpoint.
- </summary>
- <param name="startPoint">Startpoint of the line.</param>
- <param name="endPoint">Endpoint of the line.</param>
- <returns>Length of the line.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.LineDecoration.GetLength(System.Drawing.PointF[],System.Int32,System.Int32)">
- <summary>
- Gets the length of all the lines between startpoint and endpoint.
- </summary>
- <param name="points">Points of the lines we want to measure.</param>
- <param name="start">Startpoint of measuring.</param>
- <param name="end">Endpoint of measuring.</param>
- <returns>Combined length of all lines between startpoint and endpoint.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.LineDecoration.GetOffset(System.Drawing.PointF,System.Drawing.PointF)">
- <summary>
- Calculates the offset needed to show the decoration spot of each line at the same position as it is shown for the horizontal line in the linesymbol editor window.
- </summary>
- <param name="point">Startpoint of the line the decoration spot belongs to.</param>
- <param name="nextPoint">Endpoint of the line the decoration spot belongs to.</param>
- <returns>Offset that must be added to the decoration spots locationPoint for it to be drawn with the given _offset.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.LineDecoration.GetPosition(System.Drawing.PointF[],System.Double,System.Int32,System.Int32)">
- <summary>
- Get the decoration spots that result from the given line and segLength. The decoration spot needed for the endpoint is not included.
- </summary>
- <param name="points">Point-Array that contains the points of the line.</param>
- <param name="segLength">Distance between two decoration spots.</param>
- <param name="start">Index of the first point that belongs to the line.</param>
- <param name="end">Index of the last point that belongs to the line.</param>
- <returns>List of decoration spots that result from the given points and segLength.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.LineDecoration.OnRandomize(System.Random)">
- <summary>
- Handles the creation of random content for the LineDecoration.
- </summary>
- <param name="generator">The Random class that generates random numbers</param>
- </member>
- <member name="P:DotSpatial.Symbology.LineDecoration.Symbol">
- <summary>
- Gets or sets the decorative symbol.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LineDecoration.FlipFirst">
- <summary>
- Gets or sets a boolean that, if true, flips the first symbol in relation
- to the direction of the line.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LineDecoration.FlipAll">
- <summary>
- Gets or sets a boolean that, if true, reverses all of the symbols.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LineDecoration.RotateWithLine">
- <summary>
- Gets or sets a boolean that, if true, will cause the symbol to
- be rotated according to the direction of the line. Arrows
- at the ends, for instance, will point along the direction of
- the line, regardless of the direction of the line.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LineDecoration.NumSymbols">
- <summary>
- Gets or sets the number of symbols that should be drawn on each
- line. (not each segment).
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LineDecoration.PercentualPosition">
- <summary>
- Gets or sets the percentual position between line start and end at which the single decoration gets drawn.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.LineDecoration.Offset">
- <summary>
- Gets or sets the offset distance measured to the left of the line in pixels.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.StrokeStyle">
- <summary>
- StrokeTypes
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.StrokeStyle.Catographic">
- <summary>
- The most complex form, containing a linear pattern that can have a hash as well as decorations
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.StrokeStyle.Custom">
- <summary>
- This is not directly supported by DotSpatial, but is in fact, some new type that
- will have to be returned.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.StrokeStyle.Marker">
- <summary>
- Draws only the marker symbols where the line occurs, and uses the dash pattern to control placement.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.StrokeStyle.Simple">
- <summary>
- The simplest line, offering the easiest interface to use
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.StrokeStyle.Hash">
- <summary>
- A hash line
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.StrokeStyle.Picture">
- <summary>
- Uses a picture to generate a texture
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.ModifySelectionMode">
- <summary>
- ModifySelectionModes
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.ModifySelectionMode.Append">
- <summary>
- Appends the newly selected features to the existing selection
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.ModifySelectionMode.Subtract">
- <summary>
- Subtracts the newly selected features from the existing features.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.ModifySelectionMode.Replace">
- <summary>
- Clears the current selection and selects the new features
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.ModifySelectionMode.SelectFrom">
- <summary>
- Selects the new features only from the existing selection
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IPointCategory">
- <summary>
- IPointSchemeCategory
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IPointCategory.Symbolizer">
- <summary>
- Gets or sets the symbolizer for this category
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IPointCategory.SelectionSymbolizer">
- <summary>
- Gets or sets the symbolizer to use to draw selected features from this category.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IPointLayer">
- <summary>
- This is a specialized FeatureLayer that specifically handles point drawing
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IPointLayer.Symbolizer">
- <summary>
- Gets or sets the FeatureSymbolizerOld determining the shared properties. This is actually still the PointSymbolizerOld
- and should not be used directly on Polygons or Lines.
- </summary>
- <exception cref="T:System.InvalidOperationException">Unable to assign a non-point symbolizer to a PointLayer</exception>
- </member>
- <member name="P:DotSpatial.Symbology.IPointLayer.SelectionSymbolizer">
- <summary>
- Gets or sets the pointSymbolizer characteristics to use for the selected features.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IPointLayer.Symbology">
- <summary>
- Gets the currently applied scheme. Because setting the scheme requires a processor intensive
- method, we use the ApplyScheme method for assigning a new scheme. This allows access
- to editing the members of an existing scheme directly, however.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IPointScheme">
- <summary>
- IPointScheme
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IPointScheme.Categories">
- <summary>
- Gets the list of scheme categories belonging to this scheme.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IPointSymbolizer">
- <summary>
- IPointSymbolizer
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IPointSymbolizer.Draw(System.Drawing.Graphics,System.Double)">
- <summary>
- Draws the symbol to the specified graphics object.
- </summary>
- <param name="g"></param>
- <param name="scaleSize"></param>
- </member>
- <member name="M:DotSpatial.Symbology.IPointSymbolizer.Scale(System.Double)">
- <summary>
- Multiplies all the linear measurements, like width, height, and offset values by the specified value.
- </summary>
- <param name="value">The double precision value to multiply all of the values against.</param>
- </member>
- <member name="M:DotSpatial.Symbology.IPointSymbolizer.GetSize">
- <summary>
- Gets the maximum size for all of the layers, modified by the offsets. This, in essence, represents the bounds
- for the entire symbol.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IPointSymbolizer.SetSize(DotSpatial.Symbology.Size2D)">
- <summary>
- This assumes that you wish to simply scale the various sizes.
- It will adjust all of the sizes so that the maximum size is
- the same as the specified size.
- </summary>
- <param name="value">The Size2D of the new maximum size</param>
- </member>
- <member name="M:DotSpatial.Symbology.IPointSymbolizer.GetFillColor">
- <summary>
- Gets the color of the top-most symbol
- </summary>
- <returns>The color of the top-most symbol</returns>
- </member>
- <member name="M:DotSpatial.Symbology.IPointSymbolizer.SetFillColor(System.Drawing.Color)">
- <summary>
- Sets the color of the top-most layer symbol
- </summary>
- <param name="color">The color to assign to the top-most layer.</param>
- </member>
- <member name="P:DotSpatial.Symbology.IPointSymbolizer.Symbols">
- <summary>
- Gets or sets the list of symbols.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.PointCategory">
- <summary>
- PointSchemeCategory
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.PointCategory.#ctor">
- <summary>
- Creates a new instance of PointSchemeCategory
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.PointCategory.#ctor(DotSpatial.Topology.IRectangle)">
- <summary>
- Creates a new instanec of a default point scheme category where the geographic symbol size has been
- scaled to the specified extent.
- </summary>
- <param name="extent">The geographic extent that is 100 times wider than the geographic size of the points.</param>
- </member>
- <member name="M:DotSpatial.Symbology.PointCategory.#ctor(DotSpatial.Symbology.IPointSymbolizer)">
- <summary>
- Creates a new category based on a symbolizer, and uses the same symbolizer, but with a fill and border color of light cyan
- for the selection symbolizer
- </summary>
- <param name="pointSymbolizer">The symbolizer to use in order to create a category</param>
- </member>
- <member name="M:DotSpatial.Symbology.PointCategory.#ctor(System.Drawing.Color,DotSpatial.Symbology.PointShape,System.Double)">
- <summary>
- Creates a simple point category where the symbolizer is based on the simple characteristics.
- The selection symbolizer has the same shape and size, but will be colored cyan.
- </summary>
- <param name="color">The color of the regular symbolizer</param>
- <param name="shape">The shape of the regular symbolizer</param>
- <param name="size">the size of the regular symbolizer</param>
- </member>
- <member name="M:DotSpatial.Symbology.PointCategory.#ctor(System.Char,System.String,System.Drawing.Color,System.Double)">
- <summary>
- Creates a new Point Category based on the specified character
- </summary>
- <param name="character">The character to use for the symbol</param>
- <param name="fontFamilyName">The font family name to use as the font</param>
- <param name="color">The color of the character</param>
- <param name="size">The size of the symbol</param>
- </member>
- <member name="M:DotSpatial.Symbology.PointCategory.#ctor(System.Drawing.Image,System.Double)">
- <summary>
- Creates a category where the picture is used for the symbol, and a selected
- symbol is created as the same symbol but with a cyan border.
- </summary>
- <param name="picture">The image to use</param>
- <param name="size">The size of the symbol</param>
- </member>
- <member name="M:DotSpatial.Symbology.PointCategory.#ctor(DotSpatial.Symbology.ISymbol)">
- <summary>
- Creates a category from the single symbol specified. If the symbol is colorable,
- the color of the selection symbol will be duplicated, but set to cyan.
- </summary>
- <param name="symbol"></param>
- </member>
- <member name="M:DotSpatial.Symbology.PointCategory.#ctor(System.Collections.Generic.IEnumerable{DotSpatial.Symbology.ISymbol})">
- <summary>
- Creates a new Point Category from the list of symbols
- </summary>
- <param name="symbols"></param>
- </member>
- <member name="M:DotSpatial.Symbology.PointCategory.GetColor">
- <summary>
- This gets a single color that attempts to represent the specified
- category. For polygons, for example, this is the fill color (or central fill color)
- of the top pattern. If an image is being used, the color will be gray.
- </summary>
- <returns>The System.Color that can be used as an approximation to represent this category.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.PointCategory.SetColor(System.Drawing.Color)">
- <summary>
- Sets the Color of the top symbol in the symbols.
- </summary>
- <param name="color">The color to set the point.</param>
- </member>
- <member name="M:DotSpatial.Symbology.PointCategory.GetLegendSymbolSize">
- <summary>
- Gets the legend symbol size of the symbolizer for this category
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Symbology.PointCategory.Symbolizer">
- <summary>
- Gets or sets the symbolizer for this category
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.PointCategory.SelectionSymbolizer">
- <summary>
- Gets or sets the symbolizer to use to draw selected features from this category.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.PointCategoryCollection">
- <summary>
- This is simply an alias to make things a tad (though not much) more understandable
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.PointCategoryCollection.OnSelectFeatures(System.Object,DotSpatial.Symbology.ExpressionEventArgs)">
- <summary>
- Instructs the parent layer to select features matching the specified expression.
- </summary>
- <param name="sender">The object sender where features were selected.</param>
- <param name="e">The event args describing which expression was used.</param>
- </member>
- <member name="M:DotSpatial.Symbology.PointCategoryCollection.OnDeselectFeatures(System.Object,DotSpatial.Symbology.ExpressionEventArgs)">
- <summary>
- Instructs the parent layer to select features matching the specified expression.
- </summary>
- <param name="sender">The object sender where features were selected.</param>
- <param name="e">The event args describing which expression was used.</param>
- </member>
- <member name="M:DotSpatial.Symbology.PointCategoryCollection.OnInclude(DotSpatial.Symbology.IPointCategory)">
- <summary>
- Ensures that newly added categories can navigate to higher legend items.
- </summary>
- <param name="item">The newly added legend item.</param>
- </member>
- <member name="M:DotSpatial.Symbology.PointCategoryCollection.OnExclude(DotSpatial.Symbology.IPointCategory)">
- <summary>
- Ensures that items are disconnected from parent items when removed from the collection.
- </summary>
- <param name="item"></param>
- </member>
- <member name="M:DotSpatial.Symbology.PointCategoryCollection.OnCopy(DotSpatial.Data.CopyList{DotSpatial.Symbology.IPointCategory})">
- <summary>
- Overrides the OnCopy method to remove the SelectFeatures handler on the copy
- </summary>
- <param name="copy"></param>
- </member>
- <member name="M:DotSpatial.Symbology.PointCategoryCollection.UpdateItemParentPointers">
- <summary>
- Cycles through all the categories and resets the parent item.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.PointCategoryCollection.Scheme">
- <summary>
- Gets or sets the parent scheme.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.PointCategoryCollection.SelectFeatures">
- <summary>
- Occurs when a category indicates that its filter expression should be used
- to select its members.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.PointCategoryCollection.DeselectFeatures">
- <summary>
- Occurs when the deselect features context menu is clicked.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.PointFeatureTypeException">
- <summary>
- PointFeatureException
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.PointFeatureTypeException.#ctor">
- <summary>
- Creates a new instance of PointFeatureTypeException
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.PointFeatureTypeException.#ctor(System.String)">
- <summary>
- Creates a new instance of PointFeatureTypeException, but with a custom error message
- </summary>
- <param name="message">The string error message to include in the exception</param>
- </member>
- <member name="T:DotSpatial.Symbology.PointLayer">
- <summary>
- This is a specialized FeatureLayer that specifically handles point drawing
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.PointLayer.#ctor">
- <summary>
- This creates a new layer with an empty dataset configured to the point feature type.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.PointLayer.#ctor(DotSpatial.Data.IFeatureSet)">
- <summary>
- Creates a new instance of a PointLayer without sending any status messages
- </summary>
- <param name="inFeatureSet">The IFeatureLayer of data values to turn into a graphical PointLayer</param>
- <exception cref="T:DotSpatial.Symbology.PointFeatureTypeException">Thrown if the featureSet FeatureType is not point or multi-point</exception>
- </member>
- <member name="M:DotSpatial.Symbology.PointLayer.#ctor(DotSpatial.Data.IFeatureSet,DotSpatial.Data.IProgressHandler)">
- <summary>
- Creates a new instance of a PointLayer for storing and drawing points
- </summary>
- <param name="inFeatureSet">Any implentation of an IFeatureLayer</param>
- <param name="progressHandler">A valid implementation of the IProgressHandler interface.</param>
- <exception cref="T:DotSpatial.Symbology.PointFeatureTypeException">Thrown if the featureSet FeatureType is not point or multi-point</exception>
- </member>
- <member name="M:DotSpatial.Symbology.PointLayer.#ctor(DotSpatial.Data.IFeatureSet,System.Collections.Generic.ICollection{DotSpatial.Symbology.ILayer},DotSpatial.Data.IProgressHandler)">
- <summary>
- Creates a new instance of a PointLayer for storing and drawing points.
- </summary>
- <param name="inFeatureSet">Any implementation of an IFeatureLayer.</param>
- <param name="container">An IContainer to contain this layer.</param>
- <param name="progressHandler">A valid implementation of the IProgressHandler interface.</param>
- <exception cref="T:DotSpatial.Symbology.PointFeatureTypeException">Thrown if the featureSet FeatureType is
- not point or multi-point.</exception>
- </member>
- <member name="M:DotSpatial.Symbology.PointLayer.OpenFile(System.String,DotSpatial.Data.IProgressHandler)">
- <summary>
- Attempts to create a new PointLayer using the specified file. If the filetype is not
- does not generate a point layer, an exception will be thrown.
- </summary>
- <param name="fileName">A string fileName to create a point layer for.</param>
- <param name="progressHandler">Any valid implementation of IProgressHandler for receiving progress messages</param>
- <returns>A PointLayer created from the specified fileName.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.PointLayer.OpenFile(System.String)">
- <summary>
- Attempts to create a new PointLayer using the specified file. If the filetype is not
- does not generate a point layer, an exception will be thrown.
- </summary>
- <param name="fileName">A string fileName to create a point layer for.</param>
- <returns>A PointLayer created from the specified fileName.</returns>
- </member>
- <member name="P:DotSpatial.Symbology.PointLayer.SelectionSymbolizer">
- <summary>
- Gets or sets the pointSymbolizer characteristics to use for the selected features.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.PointLayer.Symbolizer">
- <summary>
- Gets or sets the symbolic characteristics for this layer.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.PointLayer.Symbology">
- <summary>
- Gets the currently applied scheme. Because setting the scheme requires a processor intensive
- method, we use the ApplyScheme method for assigning a new scheme. This allows access
- to editing the members of an existing scheme directly, however.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.PointScheme">
- <summary>
- PointScheme
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.PointScheme.#ctor">
- <summary>
- Creates a new instance of PointScheme with no categories added to the list yet.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.PointScheme.#ctor(DotSpatial.Topology.IRectangle)">
- <summary>
- creates a new instance of the PointScheme, but assigns the specified symbolizer
- as the symbolizer to use on a single default category.
- </summary>
- <param name="extent">The geographic point size for the default will be 1/100th the specified extent</param>
- </member>
- <member name="M:DotSpatial.Symbology.PointScheme.DrawCategory(System.Int32,System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Draws the regular symbolizer for the specified cateogry to the specified graphics
- surface in the specified bounding rectangle.
- </summary>
- <param name="index">The integer index of the feature to draw.</param>
- <param name="g">The Graphics object to draw to</param>
- <param name="bounds">The rectangular bounds to draw in</param>
- </member>
- <member name="M:DotSpatial.Symbology.PointScheme.AddCategory(DotSpatial.Symbology.ICategory)">
- <summary>
- Adds a new scheme, assuming that the new scheme is the correct type.
- </summary>
- <param name="category">The category to add</param>
- </member>
- <member name="M:DotSpatial.Symbology.PointScheme.DecreaseCategoryIndex(DotSpatial.Symbology.ICategory)">
- <summary>
- Reduces the index value of the specified category by 1 by
- exchaning it with the category before it. If there is no
- category before it, then this does nothing.
- </summary>
- <param name="category">The category to decrease the index of</param>
- </member>
- <member name="M:DotSpatial.Symbology.PointScheme.IncreaseCategoryIndex(DotSpatial.Symbology.ICategory)">
- <summary>
- Re-orders the specified member by attempting to exchange it with the next higher
- index category. If there is no higher index, this does nothing.
- </summary>
- <param name="category">The category to increase the index of</param>
- </member>
- <member name="M:DotSpatial.Symbology.PointScheme.RemoveCategory(DotSpatial.Symbology.ICategory)">
- <summary>
- Removes the specified category
- </summary>
- <param name="category">The category to insert</param>
- </member>
- <member name="M:DotSpatial.Symbology.PointScheme.InsertCategory(System.Int32,DotSpatial.Symbology.ICategory)">
- <summary>
- Inserts the category at the specified index
- </summary>
- <param name="index">The integer index where the category should be inserted</param>
- <param name="category">The category to insert</param>
- </member>
- <member name="M:DotSpatial.Symbology.PointScheme.SuspendEvents">
- <summary>
- Suspends the category events
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.PointScheme.ResumeEvents">
- <summary>
- Resumes the category events
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.PointScheme.ClearCategories">
- <summary>
- Clears the categories
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.PointScheme.CreateRandomCategory(System.String)">
- <summary>
- Uses the settings on this scheme to create a random category.
- </summary>
- <returns>A new IFeatureCategory</returns>
- </member>
- <member name="M:DotSpatial.Symbology.PointScheme.GetDefaultColors(System.Int32)">
- <summary>
- If possible, use the template to control the colors. Otherwise, just use the default
- settings for creating "unbounded" colors.
- </summary>
- <param name="count">The integer count.</param>
- <returns>The List of colors</returns>
- </member>
- <member name="M:DotSpatial.Symbology.PointScheme.GenerateUniqueColors(DotSpatial.Data.IFeatureSet,System.String)">
- <summary>
- Calculates the unique colors as a scheme
- </summary>
- <param name="fs">The featureset with the data Table definition</param>
- <param name="uniqueField">The unique field</param>
- </member>
- <member name="M:DotSpatial.Symbology.PointScheme.GetCategories">
- <summary>
- Gets the point categories cast as FeatureCategories. This is enumerable,
- but should be thought of as a copy of the original, not the original itself.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.PointScheme.CreateNewCategory(System.Drawing.Color,System.Double)">
- <summary>
- Creates the category using a random fill color
- </summary>
- <param name="fillColor">The base color to use for creating the category</param>
- <param name="size">The double size of the larger dimension of the point.</param>
- <returns>A new polygon category</returns>
- </member>
- <member name="M:DotSpatial.Symbology.PointScheme.OnExcludeCategories(DotSpatial.Symbology.PointCategoryCollection)">
- <summary>
- Handle the event un-wiring and scheme update for the old categories
- </summary>
- <param name="categories">The category collection to update.</param>
- </member>
- <member name="M:DotSpatial.Symbology.PointScheme.OnIncludeCategories(DotSpatial.Symbology.PointCategoryCollection)">
- <summary>
- Handle the event wiring and scheme update for the new categories.
- </summary>
- <param name="categories">The category collection to update</param>
- </member>
- <member name="P:DotSpatial.Symbology.PointScheme.Categories">
- <summary>
- Gets or sets the symbolic categories as a valid IPointSchemeCategoryCollection.
- </summary>
- <remarks>
- [TypeConverter(typeof(CategoryCollectionConverter))]
- [Editor(typeof(PointCategoryCollectionEditor), typeof(UITypeEditor))]
- </remarks>
- </member>
- <member name="P:DotSpatial.Symbology.PointScheme.NumCategories">
- <summary>
- Gets the number of categories in this scheme
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.PointSchemeFactory">
- <summary>
- PointSchemeFactory
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.PointSchemeFactory.#ctor(System.Data.DataTable)">
- <summary>
- Creates a new instance of PointSchemeFactory where the data Table is specified.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.PointSchemeFactory.ColorRamp(System.Drawing.Color,System.Drawing.Color,DotSpatial.Symbology.QuickSchemeType)">
- <summary>
- This causes the creation of a PointScheme
- </summary>
- <param name="startColor"></param>
- <param name="endColor"></param>
- <param name="schemeType"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Symbology.PointSchemeFactory.Template">
- <summary>
- Gets or sets the template symbol to use. If using a color gradient, the shape and size will remain the same.
- If using a size gradient, the color and shape will remain the same.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.PointSchemeFactory.Table">
- <summary>
- Gets or sets the data Table that provides necessary information about the attributes for unique values to
- be calculated
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.PointSchemeFactory.ClassificationField">
- <summary>
- Gets or sets the string classification field to use
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.PointSchemeFactory.NormalizationField">
- <summary>
- Gets or sets the string field to use for normalization.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.PointSchemeFactory.NumCategories">
- <summary>
- Gets or sets the number of categories that will be used for classification schemes that don't
- come pre-configured with a given number of categories.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.PointSymbolizer">
- <summary>
- PointSymbolizer
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.PointSymbolizer.#ctor">
- <summary>
- Creates a new instance of PointSymbolizer
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.PointSymbolizer.#ctor(DotSpatial.Symbology.ISymbol)">
- <summary>
- Generates a new symbolizer with only one symbol.
- </summary>
- <param name="symbol">The symbol to use for creating this symbolizer</param>
- </member>
- <member name="M:DotSpatial.Symbology.PointSymbolizer.#ctor(System.Collections.Generic.IEnumerable{DotSpatial.Symbology.ISymbol})">
- <summary>
- Builds the new list of symbols from the symbols in the preset list or array of symbols.
- </summary>
- <param name="presetSymbols"></param>
- </member>
- <member name="M:DotSpatial.Symbology.PointSymbolizer.#ctor(System.Drawing.Color,DotSpatial.Symbology.PointShape,System.Double)">
- <summary>
- Creates a point symbolizer with one member, and that member is constructed
- based on the values specified.
- </summary>
- <param name="color"></param>
- <param name="shape"></param>
- <param name="size"></param>
- </member>
- <member name="M:DotSpatial.Symbology.PointSymbolizer.#ctor(System.Drawing.Image,System.Double)">
- <summary>
- Creates a point symbolizer with one memberw, and that member is constructed
- from the specified image.
- </summary>
- <param name="image">The image to use as a point symbol</param>
- <param name="size">The desired output size of the larger dimension of the image.</param>
- </member>
- <member name="M:DotSpatial.Symbology.PointSymbolizer.#ctor(System.Char,System.String,System.Drawing.Color,System.Double)">
- <summary>
- Creates a new point symbolizer that has a character symbol based on the specified characteristics.
- </summary>
- <param name="character">The character to draw</param>
- <param name="fontFamily">The font family to use for rendering the font</param>
- <param name="color">The font color</param>
- <param name="size">The size of the symbol</param>
- </member>
- <member name="M:DotSpatial.Symbology.PointSymbolizer.#ctor(System.Boolean)">
- <summary>
- Creates a new PointSymbolizer
- </summary>
- <param name="selected"></param>
- </member>
- <member name="M:DotSpatial.Symbology.PointSymbolizer.#ctor(System.Boolean,DotSpatial.Topology.IRectangle)">
- <summary>
- Sets the symbol type to geographic and generates a size that is 1/100 the width of the specified extents.
- </summary>
- <param name="selected"></param>
- <param name="extents"></param>
- </member>
- <member name="M:DotSpatial.Symbology.PointSymbolizer.SetOutline(System.Drawing.Color,System.Double)">
- <summary>
- Sets the outline, assuming that the symbolizer either supports outlines, or
- else by using a second symbol layer.
- </summary>
- <param name="outlineColor">The color of the outline</param>
- <param name="width">The width of the outline in pixels</param>
- </member>
- <member name="M:DotSpatial.Symbology.PointSymbolizer.GetSize">
- <summary>
- Returns the encapsulating size when considering all of the symbol layers that make up this symbolizer.
- </summary>
- <returns>A Size2D</returns>
- </member>
- <member name="M:DotSpatial.Symbology.PointSymbolizer.SetSize(DotSpatial.Symbology.Size2D)">
- <summary>
- This assumes that you wish to simply scale the various sizes.
- It will adjust all of the sizes so that the maximum size is
- the same as the specified size.
- </summary>
- <param name="value">The Size2D of the new maximum size</param>
- </member>
- <member name="M:DotSpatial.Symbology.PointSymbolizer.GetLegendSymbolSize">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.PointSymbolizer.GetFillColor">
- <summary>
- Returns the color of the top-most layer symbol
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.PointSymbolizer.SetFillColor(System.Drawing.Color)">
- <summary>
- Sets the color of the top-most layer symbol
- </summary>
- <param name="color">The color to assign to the top-most layer.</param>
- </member>
- <member name="M:DotSpatial.Symbology.PointSymbolizer.Draw(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Draws the specified value
- </summary>
- <param name="g">The Graphics object to draw to</param>
- <param name="target">The Rectangle defining the bounds to draw in</param>
- </member>
- <member name="M:DotSpatial.Symbology.PointSymbolizer.Draw(System.Drawing.Graphics,System.Double)">
- <summary>
- Draws the point symbol to the specified graphics object by cycling through each of the layers and
- drawing the content. This assumes that the graphics object has been translated to the specified point.
- </summary>
- <param name="g">Graphics object that is used for drawing.</param>
- <param name="scaleSize">Scale size represents the constant to multiply to the geographic measures in order to turn them into pixel coordinates </param>
- </member>
- <member name="M:DotSpatial.Symbology.PointSymbolizer.Scale(System.Double)">
- <summary>
- Multiplies all the linear measurements, like width, height, and offset values by the specified value.
- </summary>
- <param name="value">The double precision value to multiply all of the values against.</param>
- </member>
- <member name="M:DotSpatial.Symbology.PointSymbolizer.OnRandomize(System.Random)">
- <summary>
- This controls randomly creating a single random symbol from the symbol types, and randomizing it.
- </summary>
- <param name="generator"></param>
- </member>
- <member name="P:DotSpatial.Symbology.PointSymbolizer.Symbols">
- <summary>
- Gets or sets the set of layered symbols. The symbol with the highest index is drawn on top.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.PointSymbolizerEventArgs">
- <summary>
- PointSymbolizerEventArgs
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.PointSymbolizerEventArgs.#ctor(DotSpatial.Symbology.IPointSymbolizer)">
- <summary>
- Creates a new instance of PointSymbolizerEventArgs
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.PointSymbolizerEventArgs.Symbolizer">
- <summary>
- Gets the symbolizer cast as an IPointSymbolizer
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.CharacterSubset">
- <summary>
- CharacterSubsets
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Basic_Latin">
- <summary>
- Basic Latin
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Latin1_Supplement">
- <summary>
- Latin-1 Supplement
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Latin_Extended_A">
- <summary>
- Latin Extended-A
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Latin_Extended_B">
- <summary>
- Latin Extended-B
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.IPA_Extensions">
- <summary>
- IPA Extensions
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Spacing_Modifier_Letters">
- <summary>
- Spacing Modifier Letters
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Combining_Diacritical_Marks">
- <summary>
- Combining Diacritical Marks
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Greek_and_Coptic">
- <summary>
- Greek and Coptic
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Cyrillic">
- <summary>
- Cyrillic
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Armenian">
- <summary>
- Armenian
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Hebrew">
- <summary>
- Hebrew
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Arabic">
- <summary>
- Arabic
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Devanagari">
- <summary>
- Devanagari
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Bengali">
- <summary>
- Bengali
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Gumukhi">
- <summary>
- Gumukhi
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Gujarati">
- <summary>
- Gujarati
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Oriya">
- <summary>
- Oriya
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Tamil">
- <summary>
- Tamil
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Teluga">
- <summary>
- Teluga
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Kannada">
- <summary>
- Kanada
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Malayalam">
- <summary>
- Malayalam
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Thai">
- <summary>
- Thai
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Lao">
- <summary>
- Lao
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Tibetan">
- <summary>
- Tibetan
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Georgian">
- <summary>
- Georgian
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Hangul_Jamo">
- <summary>
- Hangul Jamo 4352
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Latin_Extended_Additional">
- <summary>
- Latin Extended Additional
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Greek_Extended">
- <summary>
- Greek Extended
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.General_Punctuation">
- <summary>
- General Punctuation
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Superscripts_and_Subscripts">
- <summary>
- Superscripts and Subscripts
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Currency_Symbols">
- <summary>
- Currency Symbols
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Combining_Diacritical_Marks_for_Symbols">
- <summary>
- Combining Diacritical Marks for Symbols
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Letterlike_Symbols">
- <summary>
- Letterlike Symbols
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Number_Forms">
- <summary>
- Number Forms
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Arrows">
- <summary>
- Arrows
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Mathematical_Operators">
- <summary>
- Mathematical Operators
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Miscellaneous_Technical">
- <summary>
- Miscellaneous Technical
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Control_Pictures">
- <summary>
- Control Pictures
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Optical_Character_Recognition">
- <summary>
- Optical Character Recognition
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Enclosed_Alphanumerics">
- <summary>
- Enclosed Alphanumerics
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Box_Drawing">
- <summary>
- Box Drawing
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Block_Elements">
- <summary>
- Block Elements
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Geometric_Shapes">
- <summary>
- Geometric Shapes
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Miscellaneous_Symbols">
- <summary>
- Miscellaneous Symbols
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Dingbats">
- <summary>
- Dingbats
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.CJK_Symbols_and_Puctuation">
- <summary>
- CJK Symbols and Punctuation
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Hiragana">
- <summary>
- Hiragana
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Katakana">
- <summary>
- Katakana
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Bopomofo">
- <summary>
- Bopomofo
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Hangul_Compatibility">
- <summary>
- Hangul Compatibility
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Kanbun">
- <summary>
- Kanbun
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Enclosed_CJK_Letters_and_Months">
- <summary>
- Enclosed CJK Letters and Months
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.CJK_Compatibility">
- <summary>
- CJK Compatibility
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.CJK_Unified_Ideographs">
- <summary>
- CJK Unified Ideographs
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Hangul_Syllables">
- <summary>
- Hangul Syllables
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Private_Use_Area">
- <summary>
- Private Use Area
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.CJK_Compatibility_Ideographs">
- <summary>
- CJK Compatibility Ideographs
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Alphabetic_Presentation_Forms">
- <summary>
- Alphabetic Presentation Forms
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Arabic_Presentation_Forms">
- <summary>
- Arabic Presentation Forms
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Combining_Half_Marks">
- <summary>
- Combining Half Marks
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.CJK_Compatibility_Forms">
- <summary>
- CJK Compatibility Forms
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Small_Form_Variants">
- <summary>
- Small Form Variants
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Arabic_Presentation_Forms_B">
- <summary>
- Arabic Presentation Forms-B
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Halfwidth_and_fullwidth_Forms">
- <summary>
- Halfwidth and fullwidth Forms
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.CharacterSubset.Specials">
- <summary>
- Specials
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.CharacterSymbol">
- <summary>
- CharacterSymbol
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Symbol">
- <summary>
- A point symbolizer, is comprized of a set of symbols drawn one on top of the other. This represents the base class
- for one of those symbols. The specialized type, like CharacterSymbol, SimpleSymbol, and PictureSymbol.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.ISymbol">
- <summary>
- ISymbol
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ISymbol.CopyPlacement(DotSpatial.Symbology.ISymbol)">
- <summary>
- Only copies the shared placement aspects (Size, Offset, Angle) from the specified symbol.
- </summary>
- <param name="symbol">The symbol to copy values from.</param>
- </member>
- <member name="M:DotSpatial.Symbology.ISymbol.GetBoundingSize">
- <summary>
- Takes into account the size, angle, and offset to calculate a rectangular bounding size that completely
- contains the current symbol.
- </summary>
- <returns>A SizeD representing a size that contains the offset, rotated symbol.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.ISymbol.Draw(System.Drawing.Graphics,System.Double)">
- <summary>
- Draws this symbol to the graphics object given the symbolizer that specifies content
- across the entire set of scales.
- </summary>
- <param name="g">The graphics object should be adjusted so that (0, 0) is the center of the symbol.</param>
- <param name="scaleSize">If this should draw in pixels, this should be 1. Otherwise, this should be
- the constant that you multiply against so that drawing using geographic units will draw in pixel units.</param>
- </member>
- <member name="M:DotSpatial.Symbology.ISymbol.Scale(System.Double)">
- <summary>
- Multiplies all of the linear measurements found in this Symbol by the specified value.
- This is especially useful for changing units.
- </summary>
- <param name="value">The double precision floating point value to scale by.</param>
- </member>
- <member name="M:DotSpatial.Symbology.ISymbol.Select">
- <summary>
- Modifies this symbol in a way that is appropriate for indicating a selected symbol.
- This could mean drawing a cyan outline, or changing the color to cyan.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ISymbol.GetColor">
- <summary>
- Gets a color to represent this point. If the point is using an image,
- then this color will be gray.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.ISymbol.SetColor(System.Drawing.Color)">
- <summary>
- Sets the primary color of this symbol to the specified color if possible
- </summary>
- <param name="color">The Color to assign</param>
- </member>
- <member name="P:DotSpatial.Symbology.ISymbol.Angle">
- <summary>
- Gets or sets the double precision floating point that controls the angle in degrees counter clockwise.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ISymbol.Offset">
- <summary>
- Gets or sets the 2D offset for this particular symbol
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ISymbol.Size">
- <summary>
- Gets or sets the size
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ISymbol.SymbolType">
- <summary>
- Gets the symbol type for this symbol.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Symbol.#ctor">
- <summary>
- Creates a new instance of Symbol
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Symbol.#ctor(DotSpatial.Symbology.SymbolType)">
- <summary>
- This creates a wrapper class encapsulates one of the available subclasses for
- symbol, enumerating the different options.
- </summary>
- <param name="type">The type to use for this symbol.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Symbol.GetColor">
- <summary>
- Gets a color to represent this point. If the point is using an image,
- then this color will be gray.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Symbol.SetColor(System.Drawing.Color)">
- <summary>
- Sets the primary color of this symbol to the specified color if possible
- </summary>
- <param name="color">The Color to assign</param>
- </member>
- <member name="M:DotSpatial.Symbology.Symbol.CopyPlacement(DotSpatial.Symbology.ISymbol)">
- <summary>
- Only copies the shared placement aspects (Size, Offset, Angle) from the specified symbol.
- </summary>
- <param name="symbol">The symbol to copy values from.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Symbol.Draw(System.Drawing.Graphics,System.Double)">
- <summary>
- Draws this symbol to the graphics object given the symbolizer that specifies content
- across the entire set of scales.
- </summary>
- <param name="g">The graphics object should be adjusted so that (0, 0) is the center of the symbol.</param>
- <param name="scaleWidth">If this should draw in pixels, this should be 1. Otherwise, this should be
- the constant that you multiply against so that drawing using geographic units will draw in pixel units.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Symbol.GetBoundingSize">
- <summary>
- Calculates a size that would be necessary to contain the entire symbol, taking rotation and
- offset into account.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.Symbol.Scale(System.Double)">
- <summary>
- Multiplies all of the linear measurements found in this Symbol by the specified value.
- This is especially useful for changing units.
- </summary>
- <param name="value">The double precision floating point value to scale by.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Symbol.Select">
- <summary>
- Modifies this symbol in a way that is appropriate for indicating a selected symbol.
- This could mean drawing a cyan outline, or changing the color to cyan.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Symbol.OnDraw(System.Drawing.Graphics,System.Double)">
- <summary>
- Occurs during drawing. The graphics object will already be rotated by the specified angle and
- adjusted according to the specified offset. The mask will also be drawn before the point.
- </summary>
- <param name="g"></param>
- <param name="scaleSize"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Symbol.OnRandomize(System.Random)">
- <summary>
- An overrideable implementation of randomizing the values for this class.
- This can be useful for generating random symbols or else for unit testing.
- </summary>
- <param name="generator">The random number generator to use.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Symbol.OnScale(System.Double)">
- <summary>
- This occurs when the symbol is being instructed to scale. The linear measurements are all
- multiplied by the specified value. This allows for additional behavior to be programmed,
- or the original behavior to be overridden or replaced.
- </summary>
- <param name="value">The double precision value to scale by.</param>
- </member>
- <member name="P:DotSpatial.Symbology.Symbol.Angle">
- <summary>
- Gets or sets the double precision floating point that controls the angle in degrees counter clockwise.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Symbol.Offset">
- <summary>
- Gets or sets the 2D offset for this particular symbol
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Symbol.Size">
- <summary>
- Gets or sets the size
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Symbol.SymbolType">
- <summary>
- Gets the symbol type for this symbol.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.ICharacterSymbol">
- <summary>
- ICharacterSymbol
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IColorable.Color">
- <summary>
- Gets or sets the Color
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IColorable.Opacity">
- <summary>
- Gets or sets the opacity
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.ICharacterSymbol.ToString">
- <summary>
- Gets the string equivalent of the specified character code.
- </summary>
- <returns>A string version of the character</returns>
- </member>
- <member name="P:DotSpatial.Symbology.ICharacterSymbol.Category">
- <summary>
- Gets the unicode category for this character.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ICharacterSymbol.Character">
- <summary>
- Gets or sets the character that this represents.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ICharacterSymbol.CharacterSet">
- <summary>
- Unicode characters consist of 2 bytes. This represents the first byte,
- which can be thought of as specifying a typeset.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ICharacterSymbol.Code">
- <summary>
- Gets or sets the byte code for the lower 256 values. This represents the
- specific character in a given "typeset" range.
- </summary>
- <remarks>
- [Editor(typeof(CharacterCodeEditor), typeof(UITypeEditor))]
- </remarks>
- </member>
- <member name="P:DotSpatial.Symbology.ICharacterSymbol.FontFamilyName">
- <summary>
- Gets or sets the string font family name to use for this character set.
- </summary>
- <remarks>[Editor(typeof(FontFamilyNameEditor), typeof(UITypeEditor))]</remarks>
- </member>
- <member name="P:DotSpatial.Symbology.ICharacterSymbol.Style">
- <summary>
- Gets or sets the font style to use for this character layer.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.CharacterSymbol.#ctor">
- <summary>
- Creates a new instance of CharacterSymbol
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.CharacterSymbol.#ctor(System.Char)">
- <summary>
- Creates a new instance of CharacterSymbol
- </summary>
- <param name="character">The character to use for the symbol</param>
- </member>
- <member name="M:DotSpatial.Symbology.CharacterSymbol.#ctor(System.Char,System.String)">
- <summary>
- Creates a new instance of CharacterSymbol
- </summary>
- <param name="character">The character to use for the symbol</param>
- <param name="fontFamily">The font family for the character</param>
- </member>
- <member name="M:DotSpatial.Symbology.CharacterSymbol.#ctor(System.Char,System.String,System.Drawing.Color)">
- <summary>
- Creates a new instance of CharacterSymbol
- </summary>
- <param name="character">The character to use for the symbol</param>
- <param name="fontFamily">The font family for the character</param>
- <param name="color">The color for the character</param>
- </member>
- <member name="M:DotSpatial.Symbology.CharacterSymbol.#ctor(System.Char,System.String,System.Drawing.Color,System.Double)">
- <summary>
- Creates a new instance of CharacterSymbol
- </summary>
- <param name="character">The character to use for the symbol</param>
- <param name="fontFamily">The font family for the character</param>
- <param name="color">The color for the character</param>
- <param name="size">The size for the symbol</param>
- </member>
- <member name="M:DotSpatial.Symbology.CharacterSymbol.GetColor">
- <summary>
- Gets the font color of this symbol to represent the color of this symbol
- </summary>
- <returns>The color of this symbol as a font</returns>
- </member>
- <member name="M:DotSpatial.Symbology.CharacterSymbol.SetColor(System.Drawing.Color)">
- <summary>
- Sets the fill color of this symbol to the specified color
- </summary>
- <param name="color">The Color</param>
- </member>
- <member name="M:DotSpatial.Symbology.CharacterSymbol.Select">
- <summary>
- Modifies this symbol in a way that is appropriate for indicating a selected symbol.
- This could mean drawing a cyan outline, or changing the color to cyan.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.CharacterSymbol.ToString">
- <summary>
- Gets the string equivalent of the specified character code.
- </summary>
- <returns>A string version of the character</returns>
- </member>
- <member name="M:DotSpatial.Symbology.CharacterSymbol.GetSupportedSubsets">
- <summary>
- Because there is no easy range calculation supported in dot net
- (as compared to GDI32) that I can find, I assume that the
- unsupported values will come back as an open box, or at least
- identical in glyph form to a known unsupported like Arial 1024.
- (Not to be confused with Arial Unicode MS, which has basically
- everything.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.CharacterSymbol.OnDraw(System.Drawing.Graphics,System.Double)">
- <summary>
- Overrides the default behavior and attempts to draw the specified symbol
- </summary>
- <param name="g"></param>
- <param name="scaleSize"></param>
- </member>
- <member name="M:DotSpatial.Symbology.CharacterSymbol.OnRandomize(System.Random)">
- <summary>
- Extends the randomize code to include the character aspects, creating a random character.
- However, since most fonts don't support full unicode values, a character from 0 to 255 is
- chosen.
- </summary>
- <param name="generator">The random class generator</param>
- </member>
- <member name="P:DotSpatial.Symbology.CharacterSymbol.XmlColor">
- <summary>
- Supports serialization even though Colors can't be serialized
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.CharacterSymbol.Category">
- <summary>
- Gets the unicode category for this character.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.CharacterSymbol.Character">
- <summary>
- Gets or sets the character that this represents.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.CharacterSymbol.CharacterSet">
- <summary>
- Unicode characters consist of 2 bytes. This represents the first byte,
- which can be thought of as specifying a typeset.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.CharacterSymbol.Code">
- <summary>
- Gets or sets the byte code for the lower 256 values. This represents the
- specific character in a given "typeset" range.
- </summary>
- <remarks>
- //Editor(typeof(CharacterCodeEditor), typeof(UITypeEditor))
- </remarks>
- </member>
- <member name="P:DotSpatial.Symbology.CharacterSymbol.Color">
- <summary>
- Gets or sets the color
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.CharacterSymbol.FontFamilyName">
- <summary>
- Gets or sets the string font family name to use for this character set.
- </summary>
- <remarks>
- //Editor(typeof(FontFamilyNameEditor), typeof(UITypeEditor)),
- </remarks>
- </member>
- <member name="P:DotSpatial.Symbology.CharacterSymbol.Opacity">
- <summary>
- Gets or sets the opacity as a floating point value ranging from 0 to 1, where
- 0 is fully transparent and 1 is fully opaque. This actually adjusts the alpha of the color value.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.CharacterSymbol.Style">
- <summary>
- Gets or sets the font style to use for this character layer.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IOutlined">
- <summary>
- IOutlined
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IOutlined.OutlineColor">
- <summary>
- Gets or sets the outline color that surrounds this specific symbol.
- (this will have the same shape as the symbol, but be larger.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IOutlined.OutlineOpacity">
- <summary>
- This redefines the Alpha channel of the color to a floating point opacity
- that ranges from 0 to 1.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IOutlined.OutlineWidth">
- <summary>
- Gets or sets the size of the outline beyond the size of this symbol.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IOutlined.UseOutline">
- <summary>
- Gets or sets the boolean outline
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IOutlinedSymbol">
- <summary>
- IOutlinedSymbol
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IOutlinedSymbol.CopyOutline(DotSpatial.Symbology.IOutlinedSymbol)">
- <summary>
- Copies only the use outline, outline width and outline color properties from the specified symbol.
- </summary>
- <param name="symbol">The symbol to copy from.</param>
- </member>
- <member name="T:DotSpatial.Symbology.IPictureSymbol">
- <summary>
- IPictureSymbol
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IPictureSymbol.Image">
- <summary>
- Gets or sets the image to use when the PictureMode is set to Image
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IPictureSymbol.ImageFilename">
- <summary>
- Gets or sets the string fileName, if any, associated with the image file.
- Setting this will automatically also load the Image.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IPictureSymbol.Opacity">
- <summary>
- Gets or sets the opacity for this image. Setting this will automatically change the image in memory.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.ISimpleSymbol">
- <summary>
- ISimpleSymbol
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ISimpleSymbol.PointShape">
- <summary>
- Gets or sets the PointTypes enumeration that describes how to draw the simple symbol.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.OutlinedSymbol">
- <summary>
- OutlinedSymbol
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.OutlinedSymbol.#ctor">
- <summary>
- Creates a new instance of OutlinedSymbol
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.OutlinedSymbol.CopyOutline(DotSpatial.Symbology.IOutlinedSymbol)">
- <summary>
- Copies only the use outline, outline width and outline color properties from the specified symbol.
- </summary>
- <param name="symbol">The symbol to copy from.</param>
- </member>
- <member name="M:DotSpatial.Symbology.OutlinedSymbol.OnDraw(System.Drawing.Graphics,System.Double)">
- <summary>
- Handles the drawing code, extending it to include some outline content.
- </summary>
- <param name="g"></param>
- <param name="scaleSize"></param>
- </member>
- <member name="M:DotSpatial.Symbology.OutlinedSymbol.OnDrawOutline(System.Drawing.Graphics,System.Double,System.Drawing.Drawing2D.GraphicsPath)">
- <summary>
- Actually handles the rendering of the outline itself.
- </summary>
- <param name="g"></param>
- <param name="scaleSize"></param>
- <param name="gp"></param>
- </member>
- <member name="M:DotSpatial.Symbology.OutlinedSymbol.OnRandomize(System.Random)">
- <summary>
- Occurs during the randomize process and allows future overriding of the process for sub-classes
- </summary>
- <param name="generator"></param>
- </member>
- <member name="P:DotSpatial.Symbology.OutlinedSymbol.XmlOutlineColor">
- <summary>
- Provided for XML serialization
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.OutlinedSymbol.OutlineColor">
- <summary>
- Gets or sets the outline color that surrounds this specific symbol.
- (this will have the same shape as the symbol, but be larger.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.OutlinedSymbol.OutlineOpacity">
- <summary>
- This redefines the Alpha channel of the color to a floating point opacity
- that ranges from 0 to 1.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.OutlinedSymbol.OutlineWidth">
- <summary>
- Gets or sets the size of the outline beyond the size of this symbol.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.OutlinedSymbol.UseOutline">
- <summary>
- Gets or sets the boolean outline
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.PictureMode">
- <summary>
- ImageModes
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.PictureMode.Icon">
- <summary>
- The icon property should be used for storing image data
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.PictureMode.Image">
- <summary>
- The image property should be used for storing image data
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.PictureSymbol">
- <summary>
- PictureSymbol
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.PictureSymbol.#ctor">
- <summary>
- Creates a new instance of PictureSymbol
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.PictureSymbol.#ctor(System.Drawing.Image)">
- <summary>
- Creates a new instance of a PictureSymbol from the specified image
- </summary>
- <param name="image">The image to use when creating the symbol</param>
- </member>
- <member name="M:DotSpatial.Symbology.PictureSymbol.#ctor(System.Drawing.Image,System.Double)">
- <summary>
- Creates a new instance of a PictureSymbol from the specified image.
- The larger dimension from the image will be adjusted to fit the size,
- while the smaller dimension will be kept proportional.
- </summary>
- <param name="image">The image to use for this symbol</param>
- <param name="size">The double size to use for the larger of the two dimensions of the image.</param>
- </member>
- <member name="M:DotSpatial.Symbology.PictureSymbol.#ctor(System.Drawing.Icon)">
- <summary>
- Creates a new instance of a PictureSymbol from the specified icon
- </summary>
- <param name="icon">The icon to use when creating this symbol</param>
- </member>
- <member name="M:DotSpatial.Symbology.PictureSymbol.#ctor(DotSpatial.Data.IImageData)">
- <summary>
- Creates a new PictureSymbol given an existing imageData object.
- </summary>
- <param name="imageData">The imageData object to use.</param>
- </member>
- <member name="M:DotSpatial.Symbology.PictureSymbol.SetColor(System.Drawing.Color)">
- <inheritdoc />
- </member>
- <member name="M:DotSpatial.Symbology.PictureSymbol.Dispose">
- <summary>
- Disposes the current images
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.PictureSymbol.OnCopy(DotSpatial.Symbology.Descriptor)">
- <summary>
- This helps the copy process by preparing the internal variables AFTER memberwiseclone has created this
-
- </summary>
- <param name="copy"></param>
- </member>
- <member name="M:DotSpatial.Symbology.PictureSymbol.OnDraw(System.Drawing.Graphics,System.Double)">
- <summary>
- OnDraw
- </summary>
- <param name="g">Graphics object</param>
- <param name="scaleSize">The double scale Size</param>
- </member>
- <member name="M:DotSpatial.Symbology.PictureSymbol.OnRandomize(System.Random)">
- <summary>
- We can randomize the opacity
- </summary>
- <param name="generator"></param>
- </member>
- <member name="M:DotSpatial.Symbology.PictureSymbol.OnDisposing">
- <summary>
- Overrideable functions for handling the basic disposal of image classes in this object.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.PictureSymbol.IsDisposed">
- <summary>
- This is set to true when the dispose method is called.
- This will be set to false again if the image is set after that.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.PictureSymbol.ImageBase64String">
- <summary>
- Gets or sets the image in 'base64' string format.
- This can be used if the image file name is not set.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.PictureSymbol.Image">
- <summary>
- Gets or sets the image to use when the PictureMode is set to Image
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.PictureSymbol.ImageFilename">
- <summary>
- Gets or sets the string image fileName to use
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.PictureSymbol.Opacity">
- <summary>
- Gets or sets the opacity for this image. Setting this will automatically change the image in memory.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.PointShape">
- <summary>
- Allows the selection of several pre-defined shapes that have built
- in drawing code.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.PointShape.Diamond">
- <summary>
- Like a rectangle, but oriented with the points vertically
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.PointShape.Ellipse">
- <summary>
- An rounded elipse. The Size parameter determines the size of the ellipse before rotation.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.PointShape.Hexagon">
- <summary>
- A hexagon drawn to fit the size specified. Only the smaller dimension is used.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.PointShape.Rectangle">
- <summary>
- A rectangle fit to the Size before any rotation occurs.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.PointShape.Pentagon">
- <summary>
- A pentagon drawn to fit the size specified. Only the smaller dimension is used.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.PointShape.Star">
- <summary>
- A star drawn to fit the size. Only the smaller size dimension is used.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.PointShape.Triangle">
- <summary>
- Triangle with the point facing upwards initially.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.PointShape.Undefined">
- <summary>
- The default value.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.SimpleSymbol">
- <summary>
- SimpleSymbol
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.SimpleSymbol.#ctor">
- <summary>
- Creates a new instance of SimpleSymbol
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.SimpleSymbol.#ctor(System.Drawing.Color)">
- <summary>
- Creates a point symbol with the specified color.
- </summary>
- <param name="color">The color of the symbol.</param>
- </member>
- <member name="M:DotSpatial.Symbology.SimpleSymbol.#ctor(System.Drawing.Color,DotSpatial.Symbology.PointShape)">
- <summary>
- Creates a point symbol with the specified color and shape.
- </summary>
- <param name="color">The color of the symbol.</param>
- <param name="shape">The shape of the symbol.</param>
- </member>
- <member name="M:DotSpatial.Symbology.SimpleSymbol.#ctor(System.Drawing.Color,DotSpatial.Symbology.PointShape,System.Double)">
- <summary>
- Creates a SimpleSymbol with the specified color, shape and size. The size is used for
- both the horizontal and vertical directions.
- </summary>
- <param name="color">The color of the symbol.</param>
- <param name="shape">The shape of the symbol.</param>
- <param name="size">The size of the symbol.</param>
- </member>
- <member name="M:DotSpatial.Symbology.SimpleSymbol.GetColor">
- <summary>
- Gets the font color of this symbol to represent the color of this symbol
- </summary>
- <returns>The color of this symbol as a font</returns>
- </member>
- <member name="M:DotSpatial.Symbology.SimpleSymbol.SetColor(System.Drawing.Color)">
- <summary>
- Sets the fill color of this symbol to the specified color.
- </summary>
- <param name="color">The Color.</param>
- </member>
- <member name="M:DotSpatial.Symbology.SimpleSymbol.OnDraw(System.Drawing.Graphics,System.Double)">
- <summary>
- Handles the specific drawing for this symbol.
- </summary>
- <param name="g">The System.Drawing.Graphics surface to draw with.</param>
- <param name="scaleSize">A double controling the scaling of the symbol.</param>
- </member>
- <member name="M:DotSpatial.Symbology.SimpleSymbol.OnRandomize(System.Random)">
- <summary>
- Occurs during the randomizing process
- </summary>
- <param name="generator"></param>
- </member>
- <member name="M:DotSpatial.Symbology.SimpleSymbol.AddStar(System.Drawing.Drawing2D.GraphicsPath,System.Drawing.SizeF)">
- <summary>
- Draws a 5 pointed star with the points having twice the radius as the bends.
- </summary>
- <param name="gp">The GraphicsPath to add the start to</param>
- <param name="scaledSize">The SizeF size to fit the Start to</param>
- </member>
- <member name="M:DotSpatial.Symbology.SimpleSymbol.DrawStar(System.Drawing.Graphics,System.Drawing.Pen,System.Drawing.Brush,System.Drawing.SizeF)">
- <summary>
- Draws a 5 pointed star with the points having twice the radius as the bends.
- </summary>
- <param name="g">The Graphics surface to draw on</param>
- <param name="scaledBorderPen">The Pen to draw the border with</param>
- <param name="fillBrush">The Brush to use to fill the Star</param>
- <param name="scaledSize">The SizeF size to fit the Start to</param>
- </member>
- <member name="M:DotSpatial.Symbology.SimpleSymbol.AddEllipse(System.Drawing.Drawing2D.GraphicsPath,System.Drawing.SizeF)">
- <summary>
- Draws an ellipse on the specified graphics surface.
- </summary>
- <param name="gp">The GraphicsPath to add this shape to</param>
- <param name="scaledSize">The size to fit the ellipse into (the ellipse will be centered at 0, 0)</param>
- </member>
- <member name="M:DotSpatial.Symbology.SimpleSymbol.DrawEllipse(System.Drawing.Graphics,System.Drawing.Pen,System.Drawing.Brush,System.Drawing.SizeF)">
- <summary>
- Draws an ellipse on the specified graphics surface.
- </summary>
- <param name="g">The graphics surface to draw on</param>
- <param name="scaledBorderPen">The Pen to use for the border, or null if no border should be drawn</param>
- <param name="fillBrush">The Brush to use for the fill, or null if no fill should be drawn</param>
- <param name="scaledSize">The size to fit the ellipse into (the ellipse will be centered at 0, 0)</param>
- </member>
- <member name="M:DotSpatial.Symbology.SimpleSymbol.AddRegularPoly(System.Drawing.Drawing2D.GraphicsPath,System.Drawing.SizeF,System.Int32)">
- <summary>
- Draws a regular polygon with equal sides. The first point will be located all the way to the right on the X axis.
- </summary>
- <param name="gp">Specifies the GraphicsPath surface to draw on</param>
- <param name="scaledSize">Specifies the SizeF to fit the polygon into</param>
- <param name="numSides">Specifies the integer number of sides that the polygon should have</param>
- </member>
- <member name="M:DotSpatial.Symbology.SimpleSymbol.DrawRegularPoly(System.Drawing.Graphics,System.Drawing.Pen,System.Drawing.Brush,System.Drawing.SizeF,System.Int32)">
- <summary>
- Draws a regular polygon with equal sides. The first point will be located all the way to the right on the X axis.
- </summary>
- <param name="g">Specifies the Graphics surface to draw on</param>
- <param name="scaledBorderPen">Specifies the Pen to use for the border</param>
- <param name="fillBrush">Specifies the Brush to use for to fill the shape</param>
- <param name="scaledSize">Specifies the SizeF to fit the polygon into</param>
- <param name="numSides">Specifies the integer number of sides that the polygon should have</param>
- </member>
- <member name="P:DotSpatial.Symbology.SimpleSymbol.XmlColor">
- <summary>
- Only provided because XML Serialization doesn't work for colors
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SimpleSymbol.Color">
- <summary>
- Gets or sets the Color
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SimpleSymbol.Opacity">
- <summary>
- Gets or sets the opacity as a floating point value ranging from 0 to 1, where
- 0 is fully transparent and 1 is fully opaque. This actually adjusts the alpha of the color value.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SimpleSymbol.PointShape">
- <summary>
- Gets or sets the PointTypes enumeration that describes how to draw the simple symbol.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.SymbolListEM">
- <summary>
- SymbolListEM
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.SymbolListEM.GetBoundingSize(System.Collections.Generic.IList{DotSpatial.Symbology.ISymbol})">
- <summary>
- Calculates the bounding size for this entire symbol.
- </summary>
- <param name="self"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Symbology.SymbolType">
- <summary>
- SymbolTypes
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.SymbolType.Character">
- <summary>
- A symbol based on a character, including special purpose symbolic character sets.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.SymbolType.Custom">
- <summary>
- An extended, custom symbol that is not part of the current design.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.SymbolType.Picture">
- <summary>
- A symbol based on an image or icon.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.SymbolType.Simple">
- <summary>
- A symbol described by a simple geometry, outline and color.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IPolygonCategory">
- <summary>
- IPointSchemeCategory
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IPolygonCategory.Symbolizer">
- <summary>
- Gets or sets the symbolizer for this category
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IPolygonCategory.SelectionSymbolizer">
- <summary>
- Gets or sets the symbolizer to use to draw selected features from this category.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IPolygonLayer">
- <summary>
- A layer with drawing characteristics for LineStrings
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IPolygonLayer.SelectionSymbolizer">
- <summary>
- Gets or sets the symbolizer describing the selection on the default category.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IPolygonLayer.Symbolizer">
- <summary>
- Gets or sets the symbolizer describing the symbolizer on the default category.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IPolygonLayer.Symbology">
- <summary>
- Gets or sets the polygon scheme that symbolically breaks down the drawing into symbol categories.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IPolygonScheme">
- <summary>
- IPointScheme
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IPolygonScheme.Categories">
- <summary>
- Gets the list of scheme categories belonging to this scheme.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IPolygonSymbolizer">
- <summary>
- IPolygonSymbolizer
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IPolygonSymbolizer.GetFillColor">
- <summary>
- Gets the color of the top-most pattern, if it is a simple pattern,
- or return Color.Empty otherwise
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IPolygonSymbolizer.SetFillColor(System.Drawing.Color)">
- <summary>
- Sets the color, forcing a simple pattern if necessary
- </summary>
- <param name="color">Gets the color of the top-most pattern</param>
- </member>
- <member name="M:DotSpatial.Symbology.IPolygonSymbolizer.GetOutlineWidth">
- <summary>
- This gets the largest width of all the strokes of the outlines of all the patterns. Setting this will
- forceably adjust the width of all the strokes of the outlines of all the patterns.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IPolygonSymbolizer.SetOutlineWidth(System.Double)">
- <summary>
- Forces the specified width to be the width of every stroke outlining every pattern.
- </summary>
- <param name="width">The width to force as the outline width</param>
- </member>
- <member name="P:DotSpatial.Symbology.IPolygonSymbolizer.OutlineSymbolizer">
- <summary>
- Gets or sets the method for drawing the lines that make up the borders of this polygon
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IPolygonSymbolizer.Patterns">
- <summary>
- gets or sets the list of patterns to use for filling polygons.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IPolygonSymbolizerOld">
- <summary>
- An interface for a symbolizer specific to polygons.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IPolygonSymbolizerOld.BorderSymbolizer">
- <summary>
- Gets or sets the border symbolizer
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IPolygonSymbolizerOld.BorderIsVisible">
- <summary>
- Gets or sets a boolean that determines whether or not the polygon border should be drawn.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.GradientPattern">
- <summary>
- GradientPattern
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Pattern">
- <summary>
- The pattern can act as both the base class for specific types of pattern as well as a wrapper class that allows
- for an enumerated constructor that makes it easier to figure out what kinds of patterns can be created.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IPattern">
- <summary>
- IPattern
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IPattern.CopyOutline(DotSpatial.Symbology.IPattern)">
- <summary>
- Copies the properties defining the outline from the specified source onto this pattern.
- </summary>
- <param name="source">The source pattern to copy outline properties from.</param>
- </member>
- <member name="M:DotSpatial.Symbology.IPattern.FillPath(System.Drawing.Graphics,System.Drawing.Drawing2D.GraphicsPath)">
- <summary>
- Fills the specified graphics path with the pattern specified by this object
- </summary>
- <param name="g">The Graphics device to draw to</param>
- <param name="gp">The GraphicsPath that describes the closed shape to fill</param>
- </member>
- <member name="M:DotSpatial.Symbology.IPattern.DrawPath(System.Drawing.Graphics,System.Drawing.Drawing2D.GraphicsPath,System.Double)">
- <summary>
- Draws the borders for this graphics path by sequentially drawing all
- the strokes in the border symbolizer
- </summary>
- <param name="g">The Graphics device to draw to </param>
- <param name="gp">The GraphicsPath that describes the outline to draw</param>
- <param name="scaleWidth">The scaleWidth to use for scaling the line width </param>
- </member>
- <member name="M:DotSpatial.Symbology.IPattern.GetFillColor">
- <summary>
- Gets a color that can be used to represent this pattern. In some cases, a color is not
- possible, in which case, this returns Gray.
- </summary>
- <returns>A single System.Color that can be used to represent this pattern.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.IPattern.SetFillColor(System.Drawing.Color)">
- <summary>
- Sets the color that will attempt to be applied to the top pattern. If the pattern is
- not colorable, this does nothing.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IPattern.Bounds">
- <summary>
- Gets or sets the rectangular bounds. This controls how the gradient is drawn, and
- should be set to the envelope of the entire layer being drawn
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IPattern.Outline">
- <summary>
- Gets or sets the line symbolizer that is the outline for this pattern.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IPattern.PatternType">
- <summary>
- Gets the pattern type of this pattern.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IPattern.UseOutline">
- <summary>
- Gets or sets a boolean indicating whether or not the pattern should use the outline symbolizer.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Pattern.#ctor">
- <summary>
- Creates a new instance of Pattern
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Pattern.#ctor(DotSpatial.Symbology.PatternType)">
- <summary>
- Creates a new pattern with the specified type
- </summary>
- <param name="type">The subclass of pattern to use as the internal pattern</param>
- </member>
- <member name="M:DotSpatial.Symbology.Pattern.GetFillColor">
- <summary>
- Gets a color that can be used to represent this pattern. In some cases, a color is not
- possible, in which case, this returns Gray.
- </summary>
- <returns>A single System.Color that can be used to represent this pattern.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.Pattern.SetFillColor(System.Drawing.Color)">
- <summary>
- Sets the color that will attempt to be applied to the top pattern. If the pattern is
- not colorable, this does nothing.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Pattern.CopyOutline(DotSpatial.Symbology.IPattern)">
- <summary>
- Copies the properties defining the outline from the specified source onto this pattern.
- </summary>
- <param name="source">The source pattern to copy outline properties from.</param>
- </member>
- <member name="M:DotSpatial.Symbology.Pattern.FillPath(System.Drawing.Graphics,System.Drawing.Drawing2D.GraphicsPath)">
- <summary>
- Fills the specified graphics path with the pattern specified by this object
- </summary>
- <param name="g">The Graphics device to draw to</param>
- <param name="gp">The GraphicsPath that describes the closed shape to fill</param>
- </member>
- <member name="M:DotSpatial.Symbology.Pattern.DrawPath(System.Drawing.Graphics,System.Drawing.Drawing2D.GraphicsPath,System.Double)">
- <summary>
- Draws the borders for this graphics path by sequentially drawing all
- the strokes in the border symbolizer
- </summary>
- <param name="g">The Graphics device to draw to </param>
- <param name="gp">The GraphicsPath that describes the outline to draw</param>
- <param name="scaleWidth">The scaleWidth to use for scaling the line width </param>
- </member>
- <member name="M:DotSpatial.Symbology.Pattern.OnItemChanged">
- <summary>
- Occurs when the item is changed
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Pattern.OnRemoveItem">
- <summary>
- This is not currently used, but technically should cause the list of patterns to remove this pattern.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Pattern.ItemChanged">
- <summary>
- Fires the item changed event
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.Pattern.RemoveItem">
- <summary>
- Not Used
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Pattern.Bounds">
- <summary>
- Gets or sets the rectangular bounds. This controls how the gradient is drawn, and
- should be set to the envelope of the entire layer being drawn
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Pattern.Outline">
- <summary>
- Gets or sets the ILineSymbolizer that describes the outline symbology for this pattern.
- </summary>
- <remarks>
- [TypeConverter(typeof(GeneralTypeConverter))]
- [Editor(typeof(LineSymbolizerEditor), typeof(UITypeEditor))]
- </remarks>
- </member>
- <member name="P:DotSpatial.Symbology.Pattern.PatternType">
- <summary>
- Gets or sets the pattern type. Setting this
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Pattern.UseOutline">
- <summary>
- Gets or sets a boolean indicating whether or not the pattern should use the outline symbolizer.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IGradientPattern">
- <summary>
- IGradientPath
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IGradientPattern.Angle">
- <summary>
- Gets or sets the angle for the gradient pattern.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IGradientPattern.Colors">
- <summary>
- Gets or sets an array of colors that match the corresponding positions. The length of
- colors and positions should be the same length.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IGradientPattern.Positions">
- <summary>
- The positions as floating point values from 0 to 1 that represent the corresponding location
- in the gradient brush pattern.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IGradientPattern.GradientType">
- <summary>
- Gets or sets the gradient type
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.GradientPattern.#ctor">
- <summary>
- Creates a new instance of GradientPattern
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.GradientPattern.#ctor(System.Drawing.Color,System.Drawing.Color)">
- <summary>
- Creates a new instance of a Gradient Pattern using the specified colors
- </summary>
- <param name="startColor"></param>
- <param name="endColor"></param>
- </member>
- <member name="M:DotSpatial.Symbology.GradientPattern.#ctor(System.Drawing.Color,System.Drawing.Color,System.Double)">
- <summary>
- Creates a new instance of a Gradient Pattern using the specified colors and angle
- </summary>
- <param name="startColor">The start color</param>
- <param name="endColor">The end color</param>
- <param name="angle">The direction of the gradient, measured in degrees clockwise from the x-axis</param>
- </member>
- <member name="M:DotSpatial.Symbology.GradientPattern.#ctor(System.Drawing.Color,System.Drawing.Color,System.Double,DotSpatial.Symbology.GradientType)">
- <summary>
- Creates a new instance of a Gradient Pattern using the specified colors and angle
- </summary>
- <param name="startColor">The start color</param>
- <param name="endColor">The end color</param>
- <param name="angle">The direction of the gradient, measured in degrees clockwise from the x-axis</param>
- <param name="style">Controls how the gradient is drawn</param>
- </member>
- <member name="M:DotSpatial.Symbology.GradientPattern.GetFillColor">
- <summary>
- Gets a color that can be used to represent this pattern. In some cases, a color is not
- possible, in which case, this returns Gray.
- </summary>
- <returns>A single System.Color that can be used to represent this pattern.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.GradientPattern.SetFillColor(System.Drawing.Color)">
- <summary>
- Sets the fill color, keeping the approximate gradiant RGB changes the same, but adjusting
- the mean color to the specifeid color.
- </summary>
- <param name="color">The mean color to apply.</param>
- </member>
- <member name="M:DotSpatial.Symbology.GradientPattern.FillPath(System.Drawing.Graphics,System.Drawing.Drawing2D.GraphicsPath)">
- <summary>
- Handles the drawing code for linear gradient paths.
- </summary>
- <param name="g"></param>
- <param name="gp"></param>
- </member>
- <member name="P:DotSpatial.Symbology.GradientPattern.Angle">
- <summary>
- Gets or sets the angle for the gradient pattern.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.GradientPattern.Colors">
- <summary>
- Gets or sets the end color
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.GradientPattern.Positions">
- <summary>
- Gets or sets the start color
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.GradientPattern.GradientType">
- <summary>
- Gets or sets the gradient type
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.GradientType">
- <summary>
- GradientTypes
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.GradientType.Circular">
- <summary>
- Draws the gradient with the start color for the center of the circle
- and the end color for the surround color
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.GradientType.Contour">
- <summary>
- Draws the gradient with the start color for the center of the circle
- and the end color for the color at the contour.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.GradientType.Linear">
- <summary>
- Draws the gradient in a line with a specified direction
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.GradientType.Rectangular">
- <summary>
- Draws the gradient in a rectangular path with the start color
- at the center and the end color for the surround color
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.HatchPattern">
- <summary>
- HatchPattern
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IHatchPattern">
- <summary>
- IHatchPattern
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IHatchPattern.HatchStyle">
- <summary>
- Gets or sets the hatch style
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IHatchPattern.ForeColor">
- <summary>
- Gets or sets the fore color of the hatch pattern
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IHatchPattern.ForeColorOpacity">
- <summary>
- Sets the opacity of this simple pattern by modifying the alpha channel of the fill color.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IHatchPattern.BackColor">
- <summary>
- Gets or sets the background color of the hatch pattern
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IHatchPattern.BackColorOpacity">
- <summary>
- Sets the opacity of this simple pattern by modifying the alpha channel of the fill color.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.HatchPattern.#ctor">
- <summary>
- Creates a new instance of HatchPattern
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.HatchPattern.#ctor(System.Drawing.Drawing2D.HatchStyle,System.Drawing.Color,System.Drawing.Color)">
- <summary>
- Creates a new HatchPattern with the specified image
- </summary>
- <param name="style">The hatch style to use</param>
- <param name="foreColor">the forecolor to use</param>
- <param name="backColor">the background color to use</param>
- </member>
- <member name="M:DotSpatial.Symbology.HatchPattern.FillPath(System.Drawing.Graphics,System.Drawing.Drawing2D.GraphicsPath)">
- <summary>
- Instructs the drawing code to fill the specified path with the specified pattern
- </summary>
- <param name="g">The Graphics device to draw to</param>
- <param name="gp">The GraphicsPath to fill</param>
- </member>
- <member name="M:DotSpatial.Symbology.HatchPattern.GetFillColor">
- <summary>
- Gets the forecolor
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.HatchPattern.SetFillColor(System.Drawing.Color)">
- <summary>
- Sets the foreColor to the specified color
- </summary>
- <param name="color"></param>
- </member>
- <member name="P:DotSpatial.Symbology.HatchPattern.HatchStyle">
- <summary>
- Gets or sets the hatch style
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.HatchPattern.ForeColor">
- <summary>
- Gets or sets the fore color of the hatch pattern
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.HatchPattern.ForeColorOpacity">
- <summary>
- Sets the opacity of this simple pattern by modifying the alpha channel of the fill color.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.HatchPattern.BackColor">
- <summary>
- Gets or sets the background color of the hatch pattern
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.HatchPattern.BackColorOpacity">
- <summary>
- Sets the opacity of this simple pattern by modifying the alpha channel of the fill color.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.IPicturePattern">
- <summary>
- IPicturePattern
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.IPicturePattern.Open(System.String)">
- <summary>
- Opens the specified image or icon file to a local copy. Icons are converted into bitmaps.
- </summary>
- <param name="fileName">The string fileName to open.</param>
- </member>
- <member name="P:DotSpatial.Symbology.IPicturePattern.Angle">
- <summary>
- Gets or sets the angle for the texture in degrees.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IPicturePattern.DialogFilter">
- <summary>
- Gets the string dialog filter that represents the supported picture file formats.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IPicturePattern.Picture">
- <summary>
- Gets or sets the image to use as a repeating texture
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IPicturePattern.PictureFilename">
- <summary>
- Gets or sets the picture fileName. Setting this will load the picture.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IPicturePattern.Scale">
- <summary>
- Gets or sets a multiplier that should be multiplied against the width and height of the
- picture before it is used as a texture in pixel coordinates.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.IPicturePattern.WrapMode">
- <summary>
- Gets or sets the wrap mode.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.ISimplePattern">
- <summary>
- ISimplePattern
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ISimplePattern.FillColor">
- <summary>
- Gets or sets solid Color used for filling this pattern.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.ISimplePattern.Opacity">
- <summary>
- Sets the opacity of this simple pattern by modifying the alpha channel of the fill color.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.PatternType">
- <summary>
- PatternTypes
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.PatternType.Gradient">
- <summary>
- A pattern that gradually changes from one color to another
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.PatternType.Line">
- <summary>
- A pattern comprised of evenly spaced lines
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.PatternType.Marker">
- <summary>
- A pattern comprised of point symbolizers
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.PatternType.Picture">
- <summary>
- A pattern comprised of a tiled texture
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.PatternType.Simple">
- <summary>
- A pattern comprised strictly of a fill color.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.PicturePattern">
- <summary>
- PicturePattern
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.PicturePattern.#ctor">
- <summary>
- Creates a new instance of PicturePattern
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.PicturePattern.#ctor(System.Drawing.Image,System.Drawing.Drawing2D.WrapMode,System.Double)">
- <summary>
- Creates a new PicturePattern with the specified image
- </summary>
- <param name="picture">The picture to draw</param>
- <param name="wrap">The way to wrap the picture</param>
- <param name="angle">The angle to rotate the image</param>
- </member>
- <member name="M:DotSpatial.Symbology.PicturePattern.Open(System.String)">
- <summary>
- Opens the specified image or icon file to a local copy. Icons are converted into bitmaps.
- </summary>
- <param name="fileName">The string fileName to open.</param>
- </member>
- <member name="M:DotSpatial.Symbology.PicturePattern.Dispose">
- <summary>
- Disposes the image picture for this PicturePattern.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.PicturePattern.FillPath(System.Drawing.Graphics,System.Drawing.Drawing2D.GraphicsPath)">
- <summary>
- Instructs the drawing code to fill the specified path with the specified image.
- </summary>
- <param name="g">The Graphics device to draw to</param>
- <param name="gp">The GraphicsPath to fill</param>
- </member>
- <member name="P:DotSpatial.Symbology.PicturePattern.Angle">
- <summary>
- Gets or sets the angle for the texture in degrees.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.PicturePattern.DialogFilter">
- <summary>
- Gets the string dialog filter that represents the supported picture file formats.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.PicturePattern.Picture">
- <summary>
- Gets or sets the image to use as a repeating texture
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.PicturePattern.PictureFilename">
- <summary>
- Gets or sets the picture fileName. Setting this will load the picture.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.PicturePattern.Scale">
- <summary>
- Gets or sets a multiplier that should be multiplied against the width and height of the
- picture before it is used as a texture in pixel coordinates.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.PicturePattern.WrapMode">
- <summary>
- Gets or sets the wrap mode.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.SimplePattern">
- <summary>
- SimplePattern
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.SimplePattern.#ctor">
- <summary>
- Creates a new instance of SimplePattern
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.SimplePattern.#ctor(System.Drawing.Color)">
- <summary>
- Creates a new SimplePattern with the specified fill color
- </summary>
- <param name="fillColor">The fill color to use for this simple pattern</param>
- </member>
- <member name="M:DotSpatial.Symbology.SimplePattern.GetFillColor">
- <summary>
- Gets the fill color
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.SimplePattern.SetFillColor(System.Drawing.Color)">
- <summary>
- Sets the fill color
- </summary>
- <param name="color"></param>
- </member>
- <member name="M:DotSpatial.Symbology.SimplePattern.FillPath(System.Drawing.Graphics,System.Drawing.Drawing2D.GraphicsPath)">
- <summary>
- Fills the path
- </summary>
- <param name="g">The Graphics device to draw to</param>
- <param name="gp">The GraphicsPath to fill using this pattern</param>
- </member>
- <member name="P:DotSpatial.Symbology.SimplePattern.FillColor">
- <summary>
- Gets or sets solid Color used for filling this pattern.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.SimplePattern.Opacity">
- <summary>
- Sets the opacity of this simple pattern by modifying the alpha channel of the fill color.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.PolygonCategory">
- <summary>
- PointSchemeCategory
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonCategory.#ctor">
- <summary>
- Creates a new instance of PointSchemeCategory
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonCategory.#ctor(System.Drawing.Color,System.Drawing.Color,System.Double)">
- <summary>
- Specifies a category that is made up from a simple color.
- </summary>
- <param name="fillColor">The color to fill the polygons with</param>
- <param name="outlineColor">The border color for the polygons</param>
- <param name="outlineWidth">The width of the line drawn on the border</param>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonCategory.#ctor(System.Drawing.Image,System.Drawing.Drawing2D.WrapMode,System.Double)">
- <summary>
- Creates a new PolygonCategory with the specified image being tiled within the category.
- The s
- </summary>
- <param name="picture">The picture to draw</param>
- <param name="wrap">The way to wrap the picture</param>
- <param name="angle">The angle to rotate the image</param>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonCategory.#ctor(System.Drawing.Image,System.Drawing.Drawing2D.WrapMode,System.Double,System.Drawing.Color,System.Double)">
- <summary>
- Creates a new PolygonCategory with the specified image being tiled within the category.
- The simple outline characteristics are also defined.
- </summary>
- <param name="picture">The picture to draw</param>
- <param name="wrap">The way to wrap the picture</param>
- <param name="angle">The angle to rotate the image</param>
- <param name="outlineColor">The color to use</param>
- <param name="outlineWidth">The outline width</param>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonCategory.#ctor(System.Drawing.Color,System.Drawing.Color,System.Double,DotSpatial.Symbology.GradientType,System.Drawing.Color,System.Double)">
- <summary>
- Creates a new instance of a Gradient Pattern using the specified colors and angle
- </summary>
- <param name="startColor">The start color</param>
- <param name="endColor">The end color</param>
- <param name="angle">The direction of the gradient</param>
- <param name="style">The type of gradient to use</param>
- <param name="outlineColor">The color to use for the border symbolizer</param>
- <param name="outlineWidth">The width of the line to use for the border symbolizer</param>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonCategory.#ctor(DotSpatial.Symbology.IPolygonSymbolizer)">
- <summary>
- Creates a new category based on a symbolizer, and uses the same symbolizer, but with a fill and border color of light cyan
- for the selection symbolizer
- </summary>
- <param name="polygonSymbolizer">The symbolizer to use in order to create a category</param>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonCategory.GetColor">
- <summary>
- This gets a single color that attempts to represent the specified
- category. For polygons, for example, this is the fill color (or central fill color)
- of the top pattern. If an image is being used, the color will be gray.
- </summary>
- <returns>The System.Color that can be used as an approximation to represent this category.</returns>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonCategory.SetColor(System.Drawing.Color)">
- <summary>
- Sets the fill color of the top-most pattern to the specified color, if the pattern can specify a color.
- </summary>
- <param name="color">Sets the color of the top most pattern for the principal symbolizer.</param>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonCategory.ToString">
- <summary>
- A string representation of this category.
- </summary>
- <returns>String</returns>
- </member>
- <member name="P:DotSpatial.Symbology.PolygonCategory.Symbolizer">
- <summary>
- Gets or sets the symbolizer for this category
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.PolygonCategory.SelectionSymbolizer">
- <summary>
- Gets or sets the symbolizer to use to draw selected features from this category.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.PolygonCategoryCollection">
- <summary>
- This is simply an alias to make things a tad (though not much) more understandable
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonCategoryCollection.#ctor">
- <summary>
- Initializes a new PolygonCategoryCollection instance with the supplied scheme.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonCategoryCollection.#ctor(DotSpatial.Symbology.IPolygonScheme)">
- <summary>
- Initializes a new PolygonCategoryCollection instance with the supplied scheme.
- </summary>
- <param name="scheme">The scheme to use ofr this collection.</param>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonCategoryCollection.OnSelectFeatures(System.Object,DotSpatial.Symbology.ExpressionEventArgs)">
- <summary>
- Instructs the parent layer to select features matching the specified expression.
- </summary>
- <param name="sender">The object sender where features were selected.</param>
- <param name="e">The event args describing the expression used for selection.</param>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonCategoryCollection.OnDeselectFeatures(System.Object,DotSpatial.Symbology.ExpressionEventArgs)">
- <summary>
- Instructs the parent layer to select features matching the specified expression.
- </summary>
- <param name="sender">The object sender where features were selected.</param>
- <param name="e">The event args describing which expression was used.</param>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonCategoryCollection.OnInclude(DotSpatial.Symbology.IPolygonCategory)">
- <summary>
- Ensures that newly added categories can navigate to higher legend items.
- </summary>
- <param name="item">The newly added legend item.</param>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonCategoryCollection.OnCopy(DotSpatial.Data.CopyList{DotSpatial.Symbology.IPolygonCategory})">
- <summary>
- Overrides the copy behavior to remove the now unnecessary SelecTFeatures event handler.
- </summary>
- <param name="copy"></param>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonCategoryCollection.OnExclude(DotSpatial.Symbology.IPolygonCategory)">
- <summary>
- Changes the parent item of the specified category
- </summary>
- <param name="item"></param>
- </member>
- <member name="P:DotSpatial.Symbology.PolygonCategoryCollection.Scheme">
- <summary>
- Gets or sets the parent scheme for this collection
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.PolygonCategoryCollection.SelectFeatures">
- <summary>
- Occurs when a category indicates that its filter expression should be used
- to select its members.
- </summary>
- </member>
- <member name="E:DotSpatial.Symbology.PolygonCategoryCollection.DeselectFeatures">
- <summary>
- Occurs when the deselect features context menu is clicked.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.PolygonFeatureTypeException">
- <summary>
- PolygonFeatureTypeException
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonFeatureTypeException.#ctor">
- <summary>
- Creates a new instance of PolygonFeatureTypeException
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonFeatureTypeException.#ctor(System.String)">
- <summary>
- Creates a new instance of PolygonFeatureTypeException
- </summary>
- <param name="message">The custom error message to use for this exception</param>
- </member>
- <member name="T:DotSpatial.Symbology.PolygonLayer">
- <summary>
- A layer with drawing characteristics for LineStrings
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonLayer.#ctor(DotSpatial.Data.IFeatureSet)">
- <summary>
- Constructor
- </summary>
- <param name="inFeatureSet">A featureset that contains polygons</param>
- <exception cref="T:DotSpatial.Symbology.PolygonFeatureTypeException">Thrown if a non-polygon featureset is supplied.</exception>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonLayer.#ctor(DotSpatial.Data.IFeatureSet,DotSpatial.Data.IProgressHandler)">
- <summary>
- Constructor that also shows progress
- </summary>
- <param name="inFeatureSet">A featureset that contains polygons</param>
- <param name="progressHandler">An IProgressHandler to receive progress messages</param>
- <exception cref="T:DotSpatial.Symbology.PolygonFeatureTypeException">Thrown if a non-polygon featureset is supplied.</exception>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonLayer.#ctor(DotSpatial.Data.IFeatureSet,System.Collections.Generic.ICollection{DotSpatial.Symbology.ILayer},DotSpatial.Data.IProgressHandler)">
- <summary>
- Initializes a new instance of the PolygonLayer class.
- </summary>
- <param name="inFeatureSet">A featureset that contains polygons.</param>
- <param name="container">A Container to store the newly created layer in.</param>
- <param name="progressHandler">An IProgressHandler to receive progress messages.</param>
- <exception cref="T:DotSpatial.Symbology.PolygonFeatureTypeException">Thrown if a non-polygon featureset is supplied.</exception>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonLayer.DrawSnapShot(System.Drawing.Graphics,DotSpatial.Data.IProj)">
- <summary>
- Draws some section of the extent to the specified graphics object.
- </summary>
- <param name="g">The graphics object to draw to.</param>
- <param name="p">The projection interface that specifies how to transform geographic coordinates to an image.</param>
- </member>
- <member name="P:DotSpatial.Symbology.PolygonLayer.SelectionSymbolizer">
- <summary>
- Gets or sets the symbolic characteristics for the members of this symbol class that have been selected.
- </summary>
- <remarks>
- [TypeConverter(typeof(GeneralTypeConverter))]
- [Editor(typeof(PolygonSymbolizerEditor), typeof(UITypeEditor))]
- </remarks>
- </member>
- <member name="P:DotSpatial.Symbology.PolygonLayer.Symbolizer">
- <summary>
- Gets or sets the default Polygon Symbolizer to use with all the lines on this layer.
- Setting this will not clear the existing individually specified Symbolizers,
- only the default symbolizer.
- </summary>
- <remarks>
- [TypeConverter(typeof(GeneralTypeConverter))]
- [Editor(typeof(PolygonSymbolizerEditor), typeof(UITypeEditor))]
- </remarks>
- </member>
- <member name="P:DotSpatial.Symbology.PolygonLayer.Symbology">
- <summary>
- Gets or sets the polygon scheme that symbolically breaks down the drawing into symbol categories.
- </summary>
- <remarks>
- [TypeConverter(typeof(GeneralTypeConverter))]
- [Editor(typeof(PolygonSchemePropertyGridEditor), typeof(UITypeEditor))]
- </remarks>
- </member>
- <member name="T:DotSpatial.Symbology.PolygonScheme">
- <summary>
- PointScheme
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonScheme.#ctor">
- <summary>
- Creates a new instance of PointScheme with no categories added to the list yet.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonScheme.#ctor(DotSpatial.Data.IFeatureSet,System.String)">
- <summary>
- Initializes a new instance of the PolygonScheme class.
- </summary>
- <param name="fs">THe featureset with the data Table definition to use for symbolizing.</param>
- <param name="uniqueField">The string name of the field to use
- when calculating separate color codes. Unique entries will be
- assigned a random color.</param>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonScheme.GenerateUniqueColors(DotSpatial.Data.IFeatureSet,System.String)">
- <summary>
- Calculates the unique colors as a scheme.
- </summary>
- <param name="fs">The featureset with the data Table definition.</param>
- <param name="uniqueField">The unique field.</param>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonScheme.DrawCategory(System.Int32,System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Draws the regular symbolizer for the specified cateogry to the specified graphics
- surface in the specified bounding rectangle.
- </summary>
- <param name="index">The integer index of the feature to draw.</param>
- <param name="g">The Graphics object to draw to</param>
- <param name="bounds">The rectangular bounds to draw in</param>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonScheme.AddCategory(DotSpatial.Symbology.ICategory)">
- <summary>
- Adds a new scheme, assuming that the new scheme is the correct type.
- </summary>
- <param name="category">The category to add</param>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonScheme.DecreaseCategoryIndex(DotSpatial.Symbology.ICategory)">
- <summary>
- Reduces the index value of the specified category by 1 by
- exchaning it with the category before it. If there is no
- category before it, then this does nothing.
- </summary>
- <param name="category">The category to decrease the index of</param>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonScheme.IncreaseCategoryIndex(DotSpatial.Symbology.ICategory)">
- <summary>
- Re-orders the specified member by attempting to exchange it with the next higher
- index category. If there is no higher index, this does nothing.
- </summary>
- <param name="category">The category to increase the index of</param>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonScheme.InsertCategory(System.Int32,DotSpatial.Symbology.ICategory)">
- <summary>
- Inserts the category at the specified index
- </summary>
- <param name="index">The integer index where the category should be inserted</param>
- <param name="category">The category to insert</param>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonScheme.RemoveCategory(DotSpatial.Symbology.ICategory)">
- <summary>
- Removes the specified category
- </summary>
- <param name="category">The category to remove</param>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonScheme.SuspendEvents">
- <summary>
- Suspends the category events
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonScheme.ResumeEvents">
- <summary>
- Resumes the category events
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonScheme.ClearCategories">
- <summary>
- Clears the categories
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonScheme.GetDefaultColors(System.Int32)">
- <summary>
- If possible, use the template to control the colors. Otherwise, just use the default
- settings for creating "unbounded" colors.
- </summary>
- <param name="count">The integer count.</param>
- <returns>The List of colors</returns>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonScheme.GetCategories">
- <summary>
- Gets teh categories as an IEnumerable of type IFeatureCategory
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonScheme.CreateNewCategory(System.Drawing.Color,System.Double)">
- <summary>
- Creates the category using a random fill color
- </summary>
- <param name="fillColor">The base color to use for creating the category</param>
- <param name="size">This is ignored for polygons</param>
- <returns>A new polygon category</returns>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonScheme.CreateRandomCategory(System.String)">
- <summary>
- Uses the settings on this scheme to create a random category.
- </summary>
- <returns>A new IFeatureCategory</returns>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonScheme.OnExcludeCategories(DotSpatial.Symbology.PolygonCategoryCollection)">
- <summary>
- Handle the event un-wiring and scheme update for the old categories
- </summary>
- <param name="categories">The category collection to update.</param>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonScheme.OnIncludeCategories(DotSpatial.Symbology.PolygonCategoryCollection)">
- <summary>
- Handle the event wiring and scheme update for the new categories.
- </summary>
- <param name="categories">The category collection to update</param>
- </member>
- <member name="P:DotSpatial.Symbology.PolygonScheme.Categories">
- <summary>
- Gets or sets the symbolic categories as a valid IPointSchemeCategoryCollection.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.PolygonScheme.NumCategories">
- <summary>
- Gets the number of categories in this scheme
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.PolygonSymbolizer">
- <summary>
- PolygonSymbolizer
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonSymbolizer.#ctor">
- <summary>
- Creates a new instance of PolygonSymbolizer
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonSymbolizer.#ctor(System.Drawing.Color,System.Drawing.Color)">
- <summary>
- Creates a new instance of a polygon symbolizer
- </summary>
- <param name="fillColor">The fill color to use for the polygons</param>
- <param name="outlineColor">The border color to use for the polygons</param>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonSymbolizer.#ctor(System.Drawing.Color,System.Drawing.Color,System.Double)">
- <summary>
- Creates a new instance of a solid colored polygon symbolizer
- </summary>
- <param name="fillColor">The fill color to use for the polygons</param>
- <param name="outlineColor">The border color to use for the polygons</param>
- <param name="outlineWidth">The width of the outline to use fo</param>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonSymbolizer.#ctor(System.Drawing.Color,System.Drawing.Color,System.Double,DotSpatial.Symbology.GradientType)">
- <summary>
- Creates a new instance of a Gradient Pattern using the specified colors and angle
- </summary>
- <param name="startColor">The start color</param>
- <param name="endColor">The end color</param>
- <param name="angle">The direction of the gradient, measured in degrees clockwise from the x-axis</param>
- <param name="style">Controls how the gradient is drawn</param>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonSymbolizer.#ctor(System.Drawing.Color,System.Drawing.Color,System.Double,DotSpatial.Symbology.GradientType,System.Drawing.Color,System.Double)">
- <summary>
- Creates a new instance of a Gradient Pattern using the specified colors and angle
- </summary>
- <param name="startColor">The start color</param>
- <param name="endColor">The end color</param>
- <param name="angle">The direction of the gradient, measured in degrees clockwise from the x-axis</param>
- <param name="style">The type of gradient to use</param>
- <param name="outlineColor">The color to use for the border symbolizer</param>
- <param name="outlineWidth">The width of the line to use for the border symbolizer</param>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonSymbolizer.#ctor(System.Drawing.Image,System.Drawing.Drawing2D.WrapMode,System.Double)">
- <summary>
- Creates a new PicturePattern with the specified image
- </summary>
- <param name="picture">The picture to draw</param>
- <param name="wrap">The way to wrap the picture</param>
- <param name="angle">The angle to rotate the image</param>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonSymbolizer.#ctor(System.Drawing.Image,System.Drawing.Drawing2D.WrapMode,System.Double,System.Drawing.Color,System.Double)">
- <summary>
- Creates a new PicturePattern with the specified image
- </summary>
- <param name="picture">The picture to draw</param>
- <param name="wrap">The way to wrap the picture</param>
- <param name="angle">The angle to rotate the image</param>
- <param name="outlineColor">The color to use for the border symbolizer</param>
- <param name="outlineWidth">The width of the line to use for the border symbolizer</param>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonSymbolizer.#ctor(System.Collections.Generic.IEnumerable{DotSpatial.Symbology.IPattern})">
- <summary>
- Creates a new symbolizer, using the patterns specified by the list or array of patterns.
- </summary>
- <param name="patterns">The patterns to add to this symbolizer.</param>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonSymbolizer.#ctor(System.Drawing.Color)">
- <summary>
- Specifies a polygon symbolizer with a specific fill color.
- </summary>
- <param name="fillColor">The color to use as a fill color.</param>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonSymbolizer.#ctor(System.Boolean)">
- <summary>
- Creates a new instance of PolygonSymbolizer
- </summary>
- <param name="selected">Boolean, true if this should use selection symbology</param>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonSymbolizer.SetOutline(System.Drawing.Color,System.Double)">
- <summary>
- Sets the outline, assuming that the symbolizer either supports outlines, or
- else by using a second symbol layer.
- </summary>
- <param name="outlineColor">The color of the outline</param>
- <param name="width">The width of the outline in pixels</param>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonSymbolizer.GetOutlineWidth">
- <summary>
- This gets the largest width of all the strokes of the outlines of all the patterns. Setting this will
- forceably adjust the width of all the strokes of the outlines of all the patterns.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonSymbolizer.SetOutlineWidth(System.Double)">
- <summary>
- Forces the specified width to be the width of every stroke outlining every pattern.
- </summary>
- <param name="width">The width to force as the outline width</param>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonSymbolizer.GetFillColor">
- <summary>
- Gets the fill color of the top-most pattern.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonSymbolizer.SetFillColor(System.Drawing.Color)">
- <summary>
- Sets the fill color of the top-most pattern.
- If the pattern is not a simple pattern, a simple pattern will be forced.
- </summary>
- <param name="color">The Color structure</param>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonSymbolizer.Draw(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Draws the polygon symbology
- </summary>
- <param name="g">The graphics device to draw to</param>
- <param name="target">The target rectangle to draw symbology content to</param>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonSymbolizer.OnHandlePatternEvents">
- <summary>
- Occurs after the pattern list is set so that we can listen for when
- the outline symbolizer gets updated.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonSymbolizer.OnIgnorePatternEvents">
- <summary>
- Occurs before the pattern list is set so that we can stop listening
- for messages from the old outline.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.PolygonSymbolizer.OutlineSymbolizer">
- <summary>
- Gets or sets the Symbolizer for the borders of this polygon as they appear on the top-most pattern.
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.PolygonSymbolizer.Patterns">
- <summary>
- gets or sets the list of patterns to use for filling polygons.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.PolygonSymbolizerEventArgs">
- <summary>
- PolygonSymbolizerEventArgs
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonSymbolizerEventArgs.#ctor(DotSpatial.Symbology.IPolygonSymbolizer)">
- <summary>
- Creates a new instance of PolygonSymbolizerEventArgs
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.PolygonSymbolizerEventArgs.Symbolizer">
- <summary>
- Gets or sets the Symbolizer, casting it to an IPolygonSymbolizer
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.PolygonSymbolizerOld">
- <summary>
- A class that specifically controls the drawing for Polygons
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonSymbolizerOld.#ctor">
- <summary>
- Constructor
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonSymbolizerOld.#ctor(System.Boolean)">
- <summary>
- Gets or sets the polygon symbolizer
- </summary>
- <param name="selected">Boolean, true if this should use a standard selection symbology of light cyan coloring</param>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonSymbolizerOld.#ctor(DotSpatial.Topology.IEnvelope,System.Boolean)">
- <summary>
- Creates a new polygon symbolizer based on the specified parameters.
- </summary>
- <param name="env">The IEnvelope representing the base geometric size of the layer. This helps to estimate a useful geographic line width</param>
- <param name="selected">Boolean, true if this should use a standard selection symbology of light cyan coloring</param>
- </member>
- <member name="M:DotSpatial.Symbology.PolygonSymbolizerOld.Draw(System.Drawing.Graphics,System.Drawing.Rectangle)">
- <summary>
- Replaces the drawing code so that the polygon characteristics are more evident.
- </summary>
- <param name="g"></param>
- <param name="target"></param>
- </member>
- <member name="P:DotSpatial.Symbology.PolygonSymbolizerOld.BorderSymbolizer">
- <summary>
- Gets or sets the border symbolizer
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.PolygonSymbolizerOld.BorderIsVisible">
- <summary>
- Gets or sets a boolean that determines whether or not the polygon border should be drawn.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.QuickSchemeType">
- <summary>
- QuickSchemeTypes
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.QuickSchemeType.Box">
- <summary>
- Box-plot: Tukey 1977
- Basically it is like subdividing the data into 4 quartiles,
- denoted like Q1, Q2, Q3, Q4.
- -------
- Low Outlier (less than the Quartile - 3/2 Interquartile range)
- Q1 (Q1 - 3/2 the Interquartile range to Q1
- Q2 (Quartile 1 to Median)
- Q3 (Median to Quartile 3)
- Q4 (Q3 to Q3 + 3/2 the Interquartile range
- High Outlier (Greater than Q3 plus the interquartile range
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.QuickSchemeType.DefinedInterval">
- <summary>
- The interval size is defined, rather than the number of subdivisions
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.QuickSchemeType.EqualInterval">
- <summary>
- Symbolize so that the total range of values for a specific field are subdivided into
- a number of breaks where all the breaks cover the same difference in values.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.QuickSchemeType.Exponential">
- <summary>
- Intervals are selected so that the number of observations in each successive interval
- increases or decreases exponentially
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.QuickSchemeType.NaturalBreaks">
- <summary>
- The Jenks natural breaks algorithm strives for variance minimization within
- a classification.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.QuickSchemeType.Percentile">
- <summary>
- Percentile subdivides into the following six categories:
- less than 1%,
- 1% to just less than 10%,
- 10% to just less than 50%
- 50% to just less than 90%
- 90% to just less than 99%
- greater than or equal to 99%
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.QuickSchemeType.Quantile">
- <summary>
- The number of members found in each cateogry is the same, but the range might be
- widely different for datasets that don't have equally distributed values.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.QuickSchemeType.StandardDeviation">
- <summary>
- The mean and standard deviation of the attribute values are calculated, and
- values are classified according to their deviation from the mean (z-transform)
- The transformed values are mapped, usually at intervales of 1.0 or .5 standard
- deviations. This often results in no central class.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.QuickSchemeType.UniqueValues">
- <summary>
- Symbolize so that each separate entry will have a separate category for that entry.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Selection.#ctor(DotSpatial.Data.IFeatureSet,DotSpatial.Symbology.IDrawingFilter)">
- <summary>
- Creates a new instance of Selection
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.SelectionEM">
- <summary>
- SelectionEM
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.SelectionEM.InvertSelection(DotSpatial.Symbology.ISelection,DotSpatial.Topology.IEnvelope)">
- <summary>
- Inverts the selection based on the current SelectionMode
- </summary>
- <param name="self">The ISelection to invert</param>
- <param name="region">The geographic region to reverse the selected state</param>
- </member>
- <member name="T:DotSpatial.Symbology.SelectionMode">
- <summary>
- SelectionModes
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.SelectionMode.Contains">
- <summary>
- The vertices of the feature are all inside (and not touching the boundary of) the region.
- </summary>
- <remarks>
- Use ContainsExtent for faster selections.
- </remarks>
- </member>
- <member name="F:DotSpatial.Symbology.SelectionMode.ContainsExtent">
- <summary>
- *Faster, the item to be selected must be completely contained by the extent
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.SelectionMode.CoveredBy">
- <summary>
- The entire region is inside the feature and not touching the border.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.SelectionMode.Covers">
- <summary>
- The feature is completely inside the region, but touching the edges is ok (unlike Contains).
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.SelectionMode.Crosses">
- <summary>
- For this to be true the feature must be a point or a curve and must cross
- the specified
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.SelectionMode.Disjoint">
- <summary>
- The interiors and boundaries don't intersect, touch, or overlap, so they are
- completely separate.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.SelectionMode.IntersectsExtent">
- <summary>
- *Faster, the item will be selected if any part of that item is visible in the extent
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.SelectionMode.Intersects">
- <summary>
- The most inclusive possible. If any element is touching or overlapping the region in any
- way, then this will be true.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.SelectionMode.Overlaps">
- <summary>
- Like intersects, specifically requires that part of the feature is inside
- and part of the feature is outside of the region.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.SelectionMode.Touches">
- <summary>
- The feature has borders or edges in common, but otherwise does not fall inside
- the region.
- </summary>
- </member>
- <member name="F:DotSpatial.Symbology.SelectionMode.Within">
- <summary>
- The region is found completely inside the specified region to the extent
- that no borders come in contact with the outside edge of the region.
- </summary>
- </member>
- <member name="T:DotSpatial.Symbology.Statistics">
- <summary>
- Statistics
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Statistics.Clear">
- <summary>
- resets all statistics to 0.
- </summary>
- </member>
- <member name="M:DotSpatial.Symbology.Statistics.Calculate(System.Collections.Generic.List{System.Double})">
- <summary>
- Calculates the statistics for the specified values
- </summary>
- <param name="values"></param>
- </member>
- <member name="M:DotSpatial.Symbology.Statistics.Calculate(System.Collections.Generic.List{System.Double},System.Double,System.Double)">
- <summary>
- Calculates the statistics for the specified values
- </summary>
- <param name="values"></param>
- <param name="min"></param>
- <param name="max"></param>
- </member>
- <member name="P:DotSpatial.Symbology.Statistics.Count">
- <summary>
- Gets the integer count of the values
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Statistics.Maximum">
- <summary>
- Gets the highest value
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Statistics.Mean">
- <summary>
- Gets the average value
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Statistics.Median">
- <summary>
- Gets the middle value, or the average of the two middle values
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Statistics.Minimum">
- <summary>
- Gets the minimum value
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Statistics.StandardDeviation">
- <summary>
- Gets the standard deviation
- </summary>
- </member>
- <member name="P:DotSpatial.Symbology.Statistics.Sum">
- <summary>
- Gets the sum of the values.
- </summary>
- </member>
- </members>
-</doc>
diff --git a/MES_Wind/bin/Debug/DotSpatial.Topology.pdb b/MES_Wind/bin/Debug/DotSpatial.Topology.pdb
deleted file mode 100644
index 933c3b8b4c03adc67e65ab2b0c19863a252b8425..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/DotSpatial.Topology.pdb and /dev/null differ
diff --git a/MES_Wind/bin/Debug/DotSpatial.Topology.xml b/MES_Wind/bin/Debug/DotSpatial.Topology.xml
deleted file mode 100644
index fb795b66a9ec1b4b77dec18d02920e83be908756..0000000000000000000000000000000000000000
--- a/MES_Wind/bin/Debug/DotSpatial.Topology.xml
+++ /dev/null
@@ -1,24664 +0,0 @@
-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>DotSpatial.Topology</name>
- </assembly>
- <members>
- <member name="T:DotSpatial.Topology.DimensionType">
- <summary>
- Constants representing the dimensions of a point, a curve and a surface.
- Also, constants representing the dimensions of the empty point and
- non-empty geometries, and a wildcard dimension meaning "any dimension".
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.DimensionType.Point">
- <summary>
- Dimension value of a point (0).
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.DimensionType.Curve">
- <summary>
- Dimension value of a curve (1).
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.DimensionType.Surface">
- <summary>
- Dimension value of a surface (2).
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.DimensionType.False">
- <summary>
- Dimension value of a empty point (-1).
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.DimensionType.True">
- <summary>
- Dimension value of non-empty geometries (= {Point, Curve, A}).
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.DimensionType.Dontcare">
- <summary>
- Dimension value for any dimension (= {False, True}).
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.FeatureType">
- <summary>
- An abreviated list for quick classification
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.FeatureType.Unspecified">
- <summary>
- None specified or custom
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.FeatureType.Point">
- <summary>
- Point
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.FeatureType.Line">
- <summary>
- Line
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.FeatureType.Polygon">
- <summary>
- Polygon
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.FeatureType.MultiPoint">
- <summary>
- MultiPoint
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Angle">
- <summary>
- A geometric angle mesured in degrees or radians
- the angle will wrap around, so setting larger values will
- result in an appropriate angle.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Angle.PI">
- <summary>
- The value of 3.14159 or whatever from Math.PI
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Angle.#ctor(System.Double)">
- <summary>
- Creates a new instance of an angle with the radians specified
- </summary>
- <param name="radians">The angle in radians</param>
- </member>
- <member name="M:DotSpatial.Topology.Angle.Copy">
- <summary>
- Returns a new instance of the Angle class with the same angle as this object.
- </summary>
- <returns>Angle which has the same values</returns>
- </member>
- <member name="M:DotSpatial.Topology.Angle.Equals(System.Object)">
- <summary>
- False for anything that is not an angle.
- Tests two angles to see if they have the same value.
- </summary>
- <param name="obj">An object to test.</param>
- <returns>Boolean, true if the angles have the same value.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Angle.GetHashCode">
- <summary>
- Gets a hash code
- </summary>
- <returns>Int hash code</returns>
- </member>
- <member name="M:DotSpatial.Topology.Angle.op_Explicit(System.Double)~DotSpatial.Topology.Angle">
- <summary>
- Returns a new angle object with an angle of Value in radians
- </summary>
- <param name="value">The double value indicating the angle</param>
- <returns>An Angle structure with the specified value</returns>
- </member>
- <member name="M:DotSpatial.Topology.Angle.op_Explicit(DotSpatial.Topology.Angle)~System.Double">
- <summary>
- Returns a double specifying the radian value of the angle
- </summary>
- <param name="value">The angle structure to determine the angle of</param>
- <returns>A Double with the angle in radians</returns>
- </member>
- <member name="M:DotSpatial.Topology.Angle.op_Equality(DotSpatial.Topology.Angle,DotSpatial.Topology.Angle)">
- <summary>
- Returns true if the two angles are equal to each other.
- </summary>
- <param name="a">An angle to compare</param>
- <param name="b">A second angle.</param>
- <returns>Boolean, true if they are equal.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Angle.op_Inequality(DotSpatial.Topology.Angle,DotSpatial.Topology.Angle)">
- <summary>
- Returns true if the two angles are equal to each other.
- </summary>
- <param name="a">An angle to compare</param>
- <param name="b">A second angle.</param>
- <returns>Boolean, true if they are equal.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Angle.op_Addition(DotSpatial.Topology.Angle,DotSpatial.Topology.Angle)">
- <summary>
- Returns the sum of the two angles, cycling if greater than 2 pi.
- </summary>
- <param name="a">An angle to add</param>
- <param name="b">A second angle to add</param>
- <returns>A new Angle structure equal to the sum of the two angles</returns>
- </member>
- <member name="M:DotSpatial.Topology.Angle.op_Subtraction(DotSpatial.Topology.Angle,DotSpatial.Topology.Angle)">
- <summary>
- Returns the difference of two angles.
- </summary>
- <param name="a">An angle to subtract from</param>
- <param name="b">The angle to subtract</param>
- <returns>A new angle structure with a sum equal to the two angles</returns>
- </member>
- <member name="M:DotSpatial.Topology.Angle.op_Division(DotSpatial.Topology.Angle,DotSpatial.Topology.Angle)">
- <summary>
- Divides angle A by angle B
- </summary>
- <param name="a">An angle to divide</param>
- <param name="b">An angle to divide into A</param>
- <returns>A new angle with the quotient of the division</returns>
- </member>
- <member name="M:DotSpatial.Topology.Angle.op_Multiply(DotSpatial.Topology.Angle,DotSpatial.Topology.Angle)">
- <summary>
- Multiplies angle A by Angle B.
- </summary>
- <param name="a">An angle to multiply</param>
- <param name="b">A second angle to multiply.</param>
- <returns>A new angle with the product of the two angles.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Angle.Cos(DotSpatial.Topology.Angle)">
- <summary>
- Returns the mathematical Cos of the angle specified
- </summary>
- <param name="value">The Angle to find the cosign of</param>
- <returns>Double, the cosign of the angle specified</returns>
- </member>
- <member name="M:DotSpatial.Topology.Angle.Sin(DotSpatial.Topology.Angle)">
- <summary>
- Returns the mathematical Sin of the angle specified
- </summary>
- <param name="value">The Angle to find the Sin of</param>
- <returns>Double, the Sin of the Angle</returns>
- </member>
- <member name="M:DotSpatial.Topology.Angle.Tan(DotSpatial.Topology.Angle)">
- <summary>
- Returns the mathematical Tan of the angle specified
- </summary>
- <param name="value">The Angle to find the Tan of</param>
- <returns>Double, the Tan of the Angle</returns>
- </member>
- <member name="M:DotSpatial.Topology.Angle.ATan(System.Double)">
- <summary>
- Returns the mathematical ATan of the value specified
- </summary>
- <param name="value">The Double to find the ATan of</param>
- <returns>Angle, the ATan of the Value specified</returns>
- </member>
- <member name="M:DotSpatial.Topology.Angle.ACos(System.Double)">
- <summary>
- Returns the mathematical ACos of the value specified
- </summary>
- <param name="value">The Double to find the ACos of</param>
- <returns>Angle, the ACos of the Value specified</returns>
- </member>
- <member name="M:DotSpatial.Topology.Angle.ASin(System.Double)">
- <summary>
- Returns the mathematical ASin of the value specified
- </summary>
- <param name="value">The Double to find the ASin of</param>
- <returns>Angle, the ASin of the Value specified</returns>
- </member>
- <member name="P:DotSpatial.Topology.Angle.Degrees">
- <summary>
- Gets or sets the angle in degrees, ranging from -360 to 360
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Angle.DegreesPos">
- <summary>
- Gets or sets the angle in degrees ranging from 0 to 360
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Angle.Radians">
- <summary>
- Only allows values from -2PI to 2PI.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.BufferStyle">
- <summary>
- Buffer styles.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.BufferStyle.CapRound">
- <summary>
- Specifies a round line buffer end cap endCapStyle (Default).
- </summary>/
- </member>
- <member name="F:DotSpatial.Topology.BufferStyle.CapButt">
- <summary>
- Specifies a butt (or flat) line buffer end cap endCapStyle.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.BufferStyle.CapSquare">
- <summary>
- Specifies a square line buffer end cap endCapStyle.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.PrecisionModelType">
- <summary>
- The types of Precision Model which NTS supports.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.PrecisionModelType.Floating">
- <summary>
- Floating precision corresponds to the standard
- double-precision floating-point representation, which is
- based on the IEEE-754 standard
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.PrecisionModelType.FloatingSingle">
- <summary>
- Floating single precision corresponds to the standard
- single-precision floating-point representation, which is
- based on the IEEE-754 standard
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.PrecisionModelType.Fixed">
- <summary>
- Fixed Precision indicates that coordinates have a fixed number of decimal places.
- The number of decimal places is determined by the log10 of the scale factor.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.LocationType">
- <summary>
- A list of DE-9IM row indices clarifying the interior, boundary or exterior.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.LocationType.Interior">
- <summary>
- DE-9IM row index of the interior of the first point and column index of
- the interior of the second point. Location value for the interior of a
- point.
- int value = 0;
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.LocationType.Boundary">
- <summary>
- DE-9IM row index of the boundary of the first point and column index of
- the boundary of the second point. Location value for the boundary of a
- point.
- int value = 1;
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.LocationType.Exterior">
- <summary>
- DE-9IM row index of the exterior of the first point and column index of
- the exterior of the second point. Location value for the exterior of a
- point.
- int value = 2;
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.LocationType.Null">
- <summary>
- Used for uninitialized location values.
- int value = -1;
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Ordinate">
- <summary>
- Standard ordinate index values.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Ordinate.X">
- <summary>
- X Ordinate = 0.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Ordinate.Y">
- <summary>
- Y Ordinate = 1.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Ordinate.Z">
- <summary>
- Z Ordinate = 2.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Ordinate.M">
- <summary>
- M Ordinate = 3.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Utilities.BeBinaryReader">
- <summary>
- Extends the <see cref="T:System.IO.BinaryReader"/> class to allow reading values in the BigEndian format.
- </summary>
- <remarks>
- While BigEndianBinaryReader extends BinaryReader
- adding methods for reading integer values
- and double values in the BigEndian format,
- this implementation overrides methods, such <see cref="M:System.IO.BinaryReader.ReadInt32"/>
- and <see cref="M:System.IO.BinaryReader.ReadDouble"/> and more,
- for reading ByteOrder.BigEndian values in the BigEndian format.
- </remarks>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.BeBinaryReader.#ctor(System.IO.Stream)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Topology.Utilities.BeBinaryReader"/> class.
- </summary>
- <param name="stream">The stream.</param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.BeBinaryReader.#ctor(System.IO.Stream,System.Text.Encoding)">
- <summary>
- Initializes a new instance of the BEBinaryReader class.
- </summary>
- <param name="input">The supplied stream.</param>
- <param name="encoding">The character encoding.</param>
- <exception cref="T:System.ArgumentNullException">encoding is null. </exception>
- <exception cref="T:System.ArgumentException">The stream does not support reading, the stream is null, or the stream is already closed. </exception>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.BeBinaryReader.ReadInt16">
- <summary>
- Reads a 2-byte signed integer from the current stream using big endian encoding
- and advances the current position of the stream by two bytes.
- </summary>
- <returns>
- A 2-byte signed integer read from the current stream.
- </returns>
- <exception cref="T:System.ObjectDisposedException">The stream is closed. </exception>
- <exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
- <exception cref="T:System.IO.EndOfStreamException">The end of the stream is reached. </exception>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.BeBinaryReader.ReadInt32">
- <summary>
- Reads a 4-byte signed integer from the current stream using big endian encoding
- and advances the current position of the stream by four bytes.
- </summary>
- <returns>
- A 4-byte signed integer read from the current stream.
- </returns>
- <exception cref="T:System.ObjectDisposedException">The stream is closed. </exception>
- <exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
- <exception cref="T:System.IO.EndOfStreamException">The end of the stream is reached. </exception>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.BeBinaryReader.ReadInt64">
- <summary>
- Reads an 8-byte signed integer from the current stream using big endian encoding
- and advances the current position of the stream by eight bytes.
- </summary>
- <returns>
- An 8-byte signed integer read from the current stream.
- </returns>
- <exception cref="T:System.ObjectDisposedException">The stream is closed. </exception>
- <exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
- <exception cref="T:System.IO.EndOfStreamException">The end of the stream is reached. </exception>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.BeBinaryReader.ReadSingle">
- <summary>
- Reads a 4-byte floating point value from the current stream using big endian encoding
- and advances the current position of the stream by four bytes.
- </summary>
- <returns>
- A 4-byte floating point value read from the current stream.
- </returns>
- <exception cref="T:System.ObjectDisposedException">The stream is closed. </exception>
- <exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
- <exception cref="T:System.IO.EndOfStreamException">The end of the stream is reached. </exception>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.BeBinaryReader.ReadDouble">
- <summary>
- Reads an 8-byte floating point value from the current stream using big endian encoding
- and advances the current position of the stream by eight bytes.
- </summary>
- <returns>
- An 8-byte floating point value read from the current stream.
- </returns>
- <exception cref="T:System.ObjectDisposedException">The stream is closed. </exception>
- <exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
- <exception cref="T:System.IO.EndOfStreamException">The end of the stream is reached. </exception>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.BeBinaryReader.ReadDecimal">
- <inheritdoc />
- </member>
- <member name="T:DotSpatial.Topology.Utilities.BeBinaryWriter">
- <summary>
- Extends the <see cref="T:System.IO.BinaryWriter"/> class to allow writing values in the BigEndian format.
- </summary>
- <remarks>
- While BigEndianBinaryWriter extends <see cref="T:System.IO.BinaryWriter"/>
- adding methods for writing integer values (BigEndianBinaryWriter.WriteIntBE)
- and double values (BigEndianBinaryWriter.WriteDoubleBE) in the BigEndian format,
- this implementation overrides methods, such BinaryWriter.Write(Int32)
- and BinaryWriter.Write(Double)and more,
- for writing T:ByteOrder.BigEndian values in the BigEndian format.
- </remarks>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.BeBinaryWriter.#ctor">
- <summary>
- Initializes a new instance of the class.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.BeBinaryWriter.#ctor(System.IO.Stream)">
- <summary>
- Initializes a new instance of the class.
- </summary>
- <param name="output">The supplied stream.</param>
- <exception cref="T:System.ArgumentNullException">output is null. </exception>
- <exception cref="T:System.ArgumentException">
- The stream does not support writing, or the stream is already closed. </exception>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.BeBinaryWriter.#ctor(System.IO.Stream,System.Text.Encoding)">
- <summary>
- Initializes a new instance of the class.
- </summary>
- <param name="output">The supplied stream.</param>
- <param name="encoding">The character encoding.</param>
- <exception cref="T:System.ArgumentNullException">output or encoding is null. </exception>
- <exception cref="T:System.ArgumentException">
- The stream does not support writing, or the stream is already closed. </exception>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.BeBinaryWriter.Write(System.Int16)">
- <summary>
- Writes a two-byte signed integer to the current stream using BigEndian encoding
- and advances the stream position by two bytes.
- </summary>
- <param name="value">The two-byte signed integer to write.</param>
- <exception cref="T:System.ObjectDisposedException">The stream is closed. </exception>
- <exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.BeBinaryWriter.Write(System.Int32)">
- <summary>
- Writes a four-byte signed integer to the current stream using BigEndian encoding
- and advances the stream position by four bytes.
- </summary>
- <param name="value">The four-byte signed integer to write.</param>
- <exception cref="T:System.ObjectDisposedException">The stream is closed. </exception>
- <exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.BeBinaryWriter.Write(System.Int64)">
- <summary>
- Writes an eight-byte signed integer to the current stream using BigEndian encoding
- and advances the stream position by eight bytes.
- </summary>
- <param name="value">The eight-byte signed integer to write.</param>
- <exception cref="T:System.ObjectDisposedException">The stream is closed. </exception>
- <exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.BeBinaryWriter.Write(System.Single)">
- <summary>
- Writes a four-byte floating-point value to the current stream using BigEndian encoding
- and advances the stream position by four bytes.
- </summary>
- <param name="value">The four-byte floating-point value to write.</param>
- <exception cref="T:System.ObjectDisposedException">The stream is closed. </exception>
- <exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.BeBinaryWriter.Write(System.Double)">
- <summary>
- Writes an eight-byte floating-point value to the current stream using BigEndian encoding
- and advances the stream position by eight bytes.
- </summary>
- <param name="value">The eight-byte floating-point value to write.</param>
- <exception cref="T:System.ObjectDisposedException">The stream is closed. </exception>
- <exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.BeBinaryWriter.Write(System.String)">
- <summary>
- Writes a length-prefixed string to this stream in the current encoding
- of the <see cref="T:System.IO.BinaryWriter"></see>,
- and advances the current position of the stream in accordance
- with the encoding used and the specific characters being written to the stream.
- </summary>
- <param name="value">The value to write.</param>
- <exception cref="T:System.ObjectDisposedException">The stream is closed. </exception>
- <exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
- <exception cref="T:System.ArgumentNullException">value is null. </exception>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.BeBinaryWriter.Write(System.Decimal)">
- <summary>
- Writes a decimal value to the current stream and advances the stream position by sixteen bytes.
- </summary>
- <param name="value">The decimal value to write.</param>
- <exception cref="T:System.ObjectDisposedException">The stream is closed. </exception>
- <exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
- </member>
- <member name="T:DotSpatial.Topology.Utilities.ByteOrder">
- <summary>
- Byte order
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Utilities.ByteOrder.BigEndian">
- <summary>
- Big Endian
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Utilities.ByteOrder.LittleEndian">
- <summary>
- Little Endian
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Coordinate">
- <summary>
- The original idea of comming up with a coordinate that used public accessors and an
- ICoordinate interface was actually quite slow, given that every access point was
- multiplied across many instances.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Coordinate.M">
- <summary>
- An optional place holder for a measure value if needed
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Coordinate.X">
- <summary>
- The X or horizontal, or longitudinal ordinate
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Coordinate.Y">
- <summary>
- The Y or vertical, or latitudinal ordinate
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Coordinate.Z">
- <summary>
- The Z or up or altitude ordinate
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Coordinate.#ctor">
- <summary>
- Creates an empty coordinate
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Coordinate.#ctor(System.Double,System.Double)">
- <summary>
- Creates a 2D coordinate with NaN for the Z and M values
- </summary>
- <param name="x"></param>
- <param name="y"></param>
- </member>
- <member name="M:DotSpatial.Topology.Coordinate.#ctor(System.Double,System.Double,System.Double)">
- <summary>
- Creates a new coordinate with the specified values
- </summary>
- <param name="x"></param>
- <param name="y"></param>
- <param name="z"></param>
- </member>
- <member name="M:DotSpatial.Topology.Coordinate.#ctor(System.Double[])">
- <summary>
- Creates a new coordinate with the values in X, Y, Z order, or X, Y order.
- </summary>
- <param name="values"></param>
- </member>
- <member name="M:DotSpatial.Topology.Coordinate.#ctor(DotSpatial.Topology.ICoordinate)">
- <summary>
- Constructs a new instance of the coordinate
- </summary>
- <param name="c"></param>
- </member>
- <member name="M:DotSpatial.Topology.Coordinate.#ctor(DotSpatial.Topology.Coordinate)">
- <summary>
- Constructs a new instance of the coordinate
- </summary>
- <param name="c"></param>
- </member>
- <member name="M:DotSpatial.Topology.Coordinate.#ctor(System.Double,System.Double,System.Double,System.Double)">
- <summary>
- Creates a new instance of Coordinate
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Coordinate.Equals(System.Object)">
- <summary>
- Compares the X, Y and Z values with the specified item.
- If the Z value is NaN then only the X and Y values are considered
- </summary>
- <param name="obj">This should be either a Coordiante or an ICoordinate</param>
- <returns>Boolean, true if the two are equal</returns>
- </member>
- <member name="M:DotSpatial.Topology.Coordinate.GetHashCode">
- <summary>
- returns the simple base.GetHashCode
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Coordinate.ToArray">
- <summary>
- Returns the underlying two dimensional array of coordinates
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Coordinate.Distance(DotSpatial.Topology.Coordinate)">
- <summary>
- Returns Euclidean 2D distance from ICoordinate p.
- </summary>
- <param name="end"><i>ICoordinate</i> with which to do the distance comparison.</param>
- <returns>Double, the distance between the two locations.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Coordinate.Equals2D(DotSpatial.Topology.Coordinate)">
- <summary>
- Returns whether the planar projections of the two <i>Coordinate</i>s are equal.
- </summary>
- <param name="b">The ICoordinate with which to do the 2D comparison.</param>
- <returns>
- <c>true</c> if the x- and y-coordinates are equal;
- the Z coordinates do not have to be equal.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Coordinate.Equals3D(DotSpatial.Topology.Coordinate)">
- <summary>
- Returns true if other has the same values for x, y and z.
- </summary>
- <param name="b">The second ICoordiante for a 3D comparison</param>
- <returns><c>true</c> if <c>other</c> is a <c>ICoordinate</c> with the same values for x, y and z.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Coordinate.HyperDistance(DotSpatial.Topology.Coordinate)">
- <summary>
- Returns the distance that is appropriate for N dimensions. In otherwords, if this point is
- three dimensional, then all three dimensions will be used for calculating the distance.
- </summary>
- <param name="b">The coordinate to compare to this coordinate</param>
- <returns>A double valued distance measure that is invariant to the number of coordinates</returns>
- <exception cref="T:DotSpatial.Topology.CoordinateMismatchException">The number of dimensions does not match between the points.</exception>
- </member>
- <member name="M:DotSpatial.Topology.Coordinate.ToString">
- <summary>
- Returns a <c>string</c> of the form <I>(x, y, z)</I> .
- </summary>
- <returns><c>string</c> of the form <I>(x, y, z)</I></returns>
- </member>
- <member name="M:DotSpatial.Topology.Coordinate.System#IComparable#CompareTo(System.Object)">
- <summary>
- Compares this object with the specified object for order.
- Since Coordinates are 2.5D, this routine ignores the z value when making the comparison.
- Returns
- -1 : this.x lowerthan other.x || ((this.x == other.x) AND (this.y lowerthan other.y))
- 0 : this.x == other.x AND this.y = other.y
- 1 : this.x greaterthan other.x || ((this.x == other.x) AND (this.y greaterthan other.y))
- </summary>
- <param name="other"><c>Coordinate</c> with which this <c>Coordinate</c> is being compared.</param>
- <returns>
- A negative integer, zero, or a positive integer as this <c>Coordinate</c>
- is less than, equal to, or greater than the specified <c>Coordinate</c>.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Coordinate.CompareTo(DotSpatial.Topology.Coordinate)">
- <summary>
- Compares this object with the specified object for order.
- Since Coordinates are 2.5D, this routine ignores the z value when making the comparison.
- Returns
- -1 : this.x lowerthan other.x || ((this.x == other.x) AND (this.y lowerthan other.y))
- 0 : this.x == other.x AND this.y = other.y
- 1 : this.x greaterthan other.x || ((this.x == other.x) AND (this.y greaterthan other.y))
- </summary>
- <param name="other"><c>Coordinate</c> with which this <c>Coordinate</c> is being compared.</param>
- <returns>
- A negative integer, zero, or a positive integer as this <c>Coordinate</c>
- is less than, equal to, or greater than the specified <c>Coordinate</c>.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Coordinate.IsEmpty">
- <summary>
- If either X or Y is defined as NaN, then this coordinate is considered empty.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Coordinate.Clone">
- <summary>
- Duplicates this coordinate
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Coordinate.op_Equality(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="obj1"></param>
- <param name="obj2"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Coordinate.op_Inequality(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="obj1"></param>
- <param name="obj2"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Coordinate.op_Addition(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
- Overloaded + operator.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Coordinate.op_Addition(DotSpatial.Topology.Coordinate,System.Double)">
- <summary>
- Overloaded + operator.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Coordinate.op_Addition(System.Double,DotSpatial.Topology.Coordinate)">
- <summary>
- Overloaded + operator.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Coordinate.op_Multiply(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
- Overloaded * operator.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Coordinate.op_Multiply(DotSpatial.Topology.Coordinate,System.Double)">
- <summary>
- Overloaded * operator.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Coordinate.op_Multiply(System.Double,DotSpatial.Topology.Coordinate)">
- <summary>
- Overloaded * operator.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Coordinate.op_Subtraction(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
- Overloaded - operator.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Coordinate.op_Subtraction(DotSpatial.Topology.Coordinate,System.Double)">
- <summary>
- Overloaded - operator.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Coordinate.op_Subtraction(System.Double,DotSpatial.Topology.Coordinate)">
- <summary>
- Overloaded - operator.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Coordinate.op_Division(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
- Overloaded / operator.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Coordinate.op_Division(DotSpatial.Topology.Coordinate,System.Double)">
- <summary>
- Overloaded / operator.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Coordinate.op_Division(System.Double,DotSpatial.Topology.Coordinate)">
- <summary>
- Overloaded / operator.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Coordinate.Empty">
- <summary>
- Gets a pre-defined coordinate that has double.NaN for all the values.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Coordinate.Item(System.Int32)">
- <summary>
- Gets or sets the double value associated with the specified ordinate index
- </summary>
- <param name="index">The zero-based integer index of the ordinate</param>
- <returns>A double value representing a single ordinate</returns>
- </member>
- <member name="P:DotSpatial.Topology.Coordinate.NumOrdinates">
- <summary>
- This is not a true length, but simply tests the Z value. If the Z value
- is NaN then the value is 2. Otherwise this is 3.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.CoordinateArrays">
- <summary>
- Useful utility functions for handling Coordinate arrays.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateArrays.PointNotInList(DotSpatial.Topology.Coordinate[],DotSpatial.Topology.Coordinate[])">
- <summary>
- Finds a <see cref="T:DotSpatial.Topology.Coordinate"/> in a list of <see cref="T:DotSpatial.Topology.Coordinate"/>s
- which is not contained in another list of <see cref="T:DotSpatial.Topology.Coordinate"/>s.
- </summary>
- <param name="testPts">The <see cref="T:DotSpatial.Topology.Coordinate"/>s to test.</param>
- <param name="pts">An array of <see cref="T:DotSpatial.Topology.Coordinate"/>s to test the input points against.</param>
- <returns>
- A <see cref="T:DotSpatial.Topology.Coordinate"/> from <paramref name="testPts"/>
- which is not in <paramref name="pts"/>, or <c>null</c>.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateArrays.Compare(DotSpatial.Topology.Coordinate[],DotSpatial.Topology.Coordinate[])">
- <summary>
- Compares two <see cref="T:DotSpatial.Topology.Coordinate"/> arrays
- in the forward direction of their coordinates,
- using lexicographic ordering.
- </summary>
- <param name="pts1"></param>
- <param name="pts2"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateArrays.IncreasingDirection(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate})">
- <summary>
- Determines which orientation of the <see cref="T:DotSpatial.Topology.Coordinate"/> array is (overall) increasing.
- In other words, determines which end of the array is "smaller"
- (using the standard ordering on <see cref="T:DotSpatial.Topology.Coordinate"/>).
- Returns an integer indicating the increasing direction.
- If the sequence is a palindrome, it is defined to be
- oriented in a positive direction.
- </summary>
- <param name="pts">The array of Coordinates to test.</param>
- <returns>
- <c>1</c> if the array is smaller at the start or is a palindrome,
- <c>-1</c> if smaller at the end.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateArrays.IsEqualReversed(DotSpatial.Topology.Coordinate[],DotSpatial.Topology.Coordinate[])">
- <summary>
- Determines whether two <see cref="T:DotSpatial.Topology.Coordinate"/> arrays of equal length
- are equal in opposite directions.
- </summary>
- <param name="pts1"></param>
- <param name="pts2"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateArrays.CopyDeep(DotSpatial.Topology.Coordinate[])">
- <summary>
- Creates a deep copy of the argument <c>Coordinate</c> array.
- </summary>
- <param name="coordinates">Array of Coordinates.</param>
- <returns>Deep copy of the input.</returns>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateArrays.ToCoordinateArray(System.Collections.IList)">
- <summary>
- Converts the given <see cref="T:System.Collections.IList"/> of
- <see cref="T:DotSpatial.Topology.Coordinate"/>s into a <see cref="T:DotSpatial.Topology.Coordinate"/> array.
- </summary>
- <param name="coordList"><see cref="T:System.Collections.IList"/> of coordinates.</param>
- <returns></returns>
- <exception cref="T:System.InvalidCastException">
- If <paramref name="coordList"/> contains not only <see cref="T:DotSpatial.Topology.Coordinate"/>s.
- </exception>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateArrays.ToCoordinateArray(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate})">
- <summary>
- Converts the given <see cref="T:System.Collections.IList"/> of
- <see cref="T:DotSpatial.Topology.Coordinate"/>s into a <see cref="T:DotSpatial.Topology.Coordinate"/> array.
- </summary>
- <param name="coordList"><see cref="T:System.Collections.IList"/> of coordinates.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateArrays.HasRepeatedPoints(System.Collections.Generic.IEnumerable{DotSpatial.Topology.Coordinate})">
- <summary>
- Returns whether Equals returns true for any two consecutive
- coordinates in the given array.
- </summary>
- <param name="coords">Array of Coordinates.</param>
- <returns>true if coord has repeated points; false otherwise.</returns>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateArrays.AtLeastNCoordinatesOrNothing(System.Int32,DotSpatial.Topology.Coordinate[])">
- <summary>
- Returns either the given coordinate array if its length is greater than
- the given amount, or an empty coordinate array.
- </summary>
- <param name="n">Length amount.</param>
- <param name="c">Array of Coordinates.</param>
- <returns>New Coordinate array.</returns>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateArrays.RemoveRepeatedPoints(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate})">
- <summary>
- If the coordinate array argument has repeated points,
- constructs a new array containing no repeated points.
- Otherwise, returns the argument.
- </summary>
- <param name="coords"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateArrays.Reverse(DotSpatial.Topology.Coordinate[])">
- <summary>
- Reverses the coordinates in an array in-place.
- </summary>
- <param name="coord">Array of Coordinates.</param>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateArrays.Equals(DotSpatial.Topology.Coordinate[],DotSpatial.Topology.Coordinate[])">
- <summary>
- Returns <c>true</c> if the two arrays are identical, both <c>null</c>, or pointwise
- equal (as compared using Coordinate.Equals).
- </summary>
- <param name="coord1">First array of Coordinates.</param>
- <param name="coord2">Second array of Coordinates.</param>
- <returns><c>true</c> if two Coordinates array are equals; false otherwise</returns>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateArrays.Equals(DotSpatial.Topology.Coordinate[],DotSpatial.Topology.Coordinate[],System.Collections.Generic.IComparer{DotSpatial.Topology.Coordinate[]})">
- <summary>
- Returns <c>true</c> if the two arrays are identical, both <c>null</c>, or pointwise
- equal, using a user-defined <see cref="T:System.Collections.IComparer"/>
- for <see cref="T:DotSpatial.Topology.Coordinate"/>s.
- </summary>
- <param name="coord1">An array of <see cref="T:DotSpatial.Topology.Coordinate"/>s.</param>
- <param name="coord2">Another array of <see cref="T:DotSpatial.Topology.Coordinate"/>s.</param>
- <param name="coordinateComparer">
- A <see cref="T:System.Collections.IComparer"/> for <see cref="T:DotSpatial.Topology.Coordinate"/>s.
- </param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateArrays.MinCoordinate(DotSpatial.Topology.Coordinate[])">
- <summary>
- Returns the minimum coordinate, using the usual lexicographic comparison.
- </summary>
- <param name="coordinates">Array to search.</param>
- <returns>The minimum coordinate in the array, found using <c>CompareTo</c>.</returns>
- <seeaalso cref="M:DotSpatial.Topology.Coordinate.CompareTo(DotSpatial.Topology.Coordinate)"/>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateArrays.Scroll(DotSpatial.Topology.Coordinate[],DotSpatial.Topology.Coordinate)">
- <summary>
- Shifts the positions of the coordinates until <c>firstCoordinate</c> is first.
- </summary>
- <param name="coordinates">Array to rearrange.</param>
- <param name="firstCoordinate">Coordinate to make first.</param>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateArrays.IndexOf(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate[])">
- <summary>
- Returns the index of <paramref name="coordinate"/> in <paramref name="coordinates"/>.
- The first position is 0; the second is 1; etc.
- </summary>
- <param name="coordinate">A <see cref="T:DotSpatial.Topology.Coordinate"/> to search for.</param>
- <param name="coordinates">A <see cref="T:DotSpatial.Topology.Coordinate"/> array to search.</param>
- <returns>The position of <c>coordinate</c>, or -1 if it is not found.</returns>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateArrays.Extract(DotSpatial.Topology.Coordinate[],System.Int32,System.Int32)">
- <summary>
- Extracts a subsequence of the input <see cref="T:DotSpatial.Topology.Coordinate"/> array
- from indices <paramref name="start"/> to <paramref name="end"/> (inclusive).
- </summary>
- <param name="pts">The input array.</param>
- <param name="start">The index of the start of the subsequence to extract.</param>
- <param name="end">The index of the end of the subsequence to extract.</param>
- <returns>A subsequence of the input array.</returns>
- </member>
- <member name="T:DotSpatial.Topology.CoordinateArrays.BidirectionalComparator">
- <summary>
- A comparator for <see cref="T:DotSpatial.Topology.Coordinate"/> arrays modulo their directionality.
- E.g. if two coordinate arrays are identical but reversed
- they will compare as equal under this ordering.
- If the arrays are not equal, the ordering returned
- is the ordering in the forward direction.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateArrays.BidirectionalComparator.Compare(DotSpatial.Topology.Coordinate[],DotSpatial.Topology.Coordinate[])">
- <summary>
-
- </summary>
- <param name="pts1"></param>
- <param name="pts2"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.CoordinateArrays.ForwardComparator">
- <summary>
- Compares two <see cref="T:DotSpatial.Topology.Coordinate"/> arrays
- in the forward direction of their coordinates,
- using lexicographic ordering.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateArrays.ForwardComparator.Compare(DotSpatial.Topology.Coordinate[],DotSpatial.Topology.Coordinate[])">
- <summary>
- Compares the specified <see cref="T:DotSpatial.Topology.Coordinate"/>s arrays.
- </summary>
- <param name="pts1"></param>
- <param name="pts2"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.CoordinateArraySequence">
- <summary>
- The <c>ICoordinateSequence</c> implementation that <c>Geometry</c>s use by default.
- In this implementation, Coordinates returned by ToArray and Coordinate are live --
- modifications to them are actually changing the
- CoordinateSequence's underlying data.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.ICoordinateSequence">
- <summary>
- The internal representation of a list of coordinates inside a Geometry.
- <para>
- There are some cases in which you might want Geometries to store their
- points using something other than the NTS Coordinate class. For example, you
- may want to experiment with another implementation, such as an array of x’s
- and an array of y’s. or you might want to use your own coordinate class, one
- that supports extra attributes like M-values.
- </para>
- <para>
- You can do this by implementing the ICoordinateSequence and
- ICoordinateSequenceFactory interfaces. You would then create a
- GeometryFactory parameterized by your ICoordinateSequenceFactory, and use
- this GeometryFactory to create new Geometries. All of these new Geometries
- will use your ICoordinateSequence implementation.
- An observation on performance: If your ICoordinateSequence is not based on an array
- of Coordinates, it may incur a performance penalty when its ToArray() method
- is called because the array needs to be built from scratch.
- </para>
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.ICoordinateSequence.GetOrdinate(System.Int32,DotSpatial.Topology.Ordinate)">
- <summary>
- Returns the ordinate of a coordinate in this sequence.
- Ordinate indices 0 and 1 are assumed to be X and Y.
- Ordinates indices greater than 1 have user-defined semantics
- (for instance, they may contain other dimensions or measure values).
- </summary>
- <param name="index">The coordinate index in the sequence.</param>
- <param name="ordinate">The ordinate index in the coordinate (in range [0, dimension-1]).</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.ICoordinateSequence.SetOrdinate(System.Int32,DotSpatial.Topology.Ordinate,System.Double)">
- <summary>
- Sets the value for a given ordinate of a coordinate in this sequence.
- </summary>
- <param name="index">The coordinate index in the sequence.</param>
- <param name="ordinate">The ordinate index in the coordinate (in range [0, dimension-1]).</param>
- <param name="value">The new ordinate value.</param>
- </member>
- <member name="M:DotSpatial.Topology.ICoordinateSequence.ToCoordinateArray">
- <summary>
- Returns (possibly copies of) the Coordinates in this collection.
- Whether or not the Coordinates returned are the actual underlying
- Coordinates or merely copies depends on the implementation. Notice that
- if this implementation does not store its data as an array of Coordinates,
- this method will incur a performance penalty because the array needs to
- be built from scratch.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.ICoordinateSequence.ExpandEnvelope(DotSpatial.Topology.IEnvelope)">
- <summary>
- Expands the given Envelope to include the coordinates in the sequence.
- Does not modify the original envelope, but rather returns a copy of the
- original envelope after being modified.
- </summary>
- <param name="env">The envelope use as the starting point for expansion. This envelope will not be modified.</param>
- <returns>The newly created envelope that is the expanded version of the original.</returns>
- </member>
- <member name="P:DotSpatial.Topology.ICoordinateSequence.Dimension">
- <summary>
- Returns the dimension (number of ordinates in each coordinate) for this sequence.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.ICoordinateSequence.Item(System.Int32)">
- <summary>
- Direct accessor to an ICoordinate
- </summary>
- <param name="index">An integer index in this array sequence</param>
- <returns>An ICoordinate for the specified index</returns>
- </member>
- <member name="P:DotSpatial.Topology.ICoordinateSequence.VersionID">
- <summary>
- Every time a member is added to, subtracted from, or edited in the sequence,
- this VersionID is incremented. This doesn't uniquely separate this sequence
- from other sequences, but rather acts as a way to rapidly track if changes
- have occured against a cached version.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateArraySequence.IncrementVersion">
- <summary>
- Increments the version with the understanding that we are using integers. If the user
- uses too many version, it will cycle around. The statistical odds of accidentally
- reaching the same value as a previous version should be small enough to prevent
- conflicts.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateArraySequence.#ctor">
- <summary>
- Creates a new array sequence dimensioned with exactly 1 coordinate that is empty.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateArraySequence.#ctor(DotSpatial.Topology.Coordinate)">
- <summary>
- Creates a new array sequence dimensioned with exactly 1 coordinate, which is set to the coordinate
- </summary>
- <param name="coordinate">The ICoordinate to use when constructing this sequence</param>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateArraySequence.#ctor(System.Collections.Generic.IEnumerable{DotSpatial.Topology.Coordinate})">
- <summary>
- Creates a new CoordinateArraySequence whose members are
- </summary>
- <param name="coordinates">The existing list whose members will be copied to the array.</param>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateArraySequence.#ctor(DotSpatial.Topology.Coordinate[])">
- <summary>
- Constructs a sequence based on the given array (the array is not copied).
- </summary>
- <param name="coordinates">The coordinate array that will be referenced.</param>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateArraySequence.#ctor(System.Int32)">
- <summary>
- Constructs a sequence of a given size, populated with new Coordinates.
- </summary>
- <param name="size">The size of the sequence to create.</param>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateArraySequence.#ctor(DotSpatial.Topology.ICoordinateSequence)">
- <summary>
- Constructs a sequence based on the given array (the array is not copied).
- </summary>
- <param name="coordSeq">The coordinate array that will be referenced.</param>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateArraySequence.Add(DotSpatial.Topology.Coordinate)">
- <summary>
- Adds a single item to the array. This is very slow for arrays because it has to
- copy all the values into a new array.
- </summary>
- <param name="item"></param>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateArraySequence.Clear">
- <summary>
- Clears the array, reducing the measure to 1 empty coordinate.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateArraySequence.Contains(DotSpatial.Topology.Coordinate)">
- <summary>
- Tests to see if the array contains the specified item
- </summary>
- <param name="item">the ICoordinate to test</param>
- <returns>True if the value is in the array.</returns>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateArraySequence.Clone">
- <summary>
- Creates a deep copy of the object.
- </summary>
- <returns>The deep copy.</returns>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateArraySequence.CopyTo(DotSpatial.Topology.Coordinate[],System.Int32)">
- <summary>
- Copies all of the members from this sequence into the specifeid array.
- </summary>
- <param name="array">The array of Icoordinates to copy values to.</param>
- <param name="arrayIndex">The starting index</param>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateArraySequence.ExpandEnvelope(DotSpatial.Topology.IEnvelope)">
- <summary>
- Expands the given Envelope to include the coordinates in the sequence.
- Does not modify the original envelope, but rather returns a copy of the
- original envelope after being modified.
- </summary>
- <param name="env">The envelope use as the starting point for expansion. This envelope will not be modified.</param>
- <returns>The newly created envelope that is the expanded version of the original.</returns>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateArraySequence.GetEnumerator">
- <summary>
- Returns an enumerator object for cycling through each of the various members of the array.
- BEWARE! This will bypass the VersionID code. Since ICoordinateSequence does not contain
- the GetEnumerator methods, using an ICoordinateSequence should safely advance the version
- during changes.
- </summary>
- <returns>An Enumerator for this array.</returns>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateArraySequence.GetOrdinate(System.Int32,DotSpatial.Topology.Ordinate)">
- <summary>
- Returns the ordinate of a coordinate in this sequence.
- Ordinate indices 0 and 1 are assumed to be X and Y.
- Ordinates indices greater than 1 have user-defined semantics
- (for instance, they may contain other dimensions or measure values).
- </summary>
- <param name="index">The coordinate index in the sequence.</param>
- <param name="ordinate">The ordinate index in the coordinate (in range [0, dimension-1]).</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateArraySequence.Remove(DotSpatial.Topology.Coordinate)">
- <summary>
- For arrays, this is very inneficient. This will copy all the members
- except for the item to a new array.
- </summary>
- <param name="item">The item to remove.</param>
- <returns>Boolean, true if a match was found and an item was removed, false otherwise.</returns>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateArraySequence.SetOrdinate(System.Int32,DotSpatial.Topology.Ordinate,System.Double)">
- <summary>
- Sets the value for a given ordinate of a coordinate in this sequence.
- </summary>
- <param name="index">The coordinate index in the sequence.</param>
- <param name="ordinate">The ordinate index in the coordinate (in range [0, dimension-1]).</param>
- <param name="value">The new ordinate value.</param>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateArraySequence.ToCoordinateArray">
- <summary>
- This method exposes the internal Array of Coordinate Objects.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateArraySequence.ToString">
- <summary>
- Returns the string representation of the coordinate array.
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.CoordinateArraySequence.Count">
- <summary>
- Returns the length of the coordinate sequence.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.CoordinateArraySequence.Dimension">
- <summary>
- Returns the dimension (number of ordinates in each coordinate) for this sequence.
- </summary>
- <value></value>
- </member>
- <member name="P:DotSpatial.Topology.CoordinateArraySequence.IsReadOnly">
- <summary>
- CoordinateArraySequences are not ReadOnly
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.CoordinateArraySequence.Item(System.Int32)">
- <summary>
- Direct accessor to an ICoordinate
- </summary>
- <param name="index">An integer index in this array sequence</param>
- <returns>An ICoordinate for the specified index</returns>
- </member>
- <member name="P:DotSpatial.Topology.CoordinateArraySequence.VersionID">
- <summary>
- Every time a member is added to, subtracted from, or edited in the sequence,
- this VersionID is incremented. This doesn't uniquely separate this sequence
- from other sequences, but rather acts as a way to rapidly track if changes
- have occured against a cached version.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.CoordinateArraySequence.Enumerator">
- <summary>
- CoordinateArraySequenceEnumerator
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateArraySequence.Enumerator.#ctor(System.Collections.IEnumerator)">
- <summary>
- Creates a new instance of CoordinateArraySequenceEnumerator
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateArraySequence.Enumerator.Dispose">
- <summary>
- Does nothing
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateArraySequence.Enumerator.MoveNext">
- <summary>
- Advances the enumerator to the next member
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateArraySequence.Enumerator.Reset">
- <summary>
- Resets the enumerator to the original position
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.CoordinateArraySequence.Enumerator.Current">
- <summary>
- Gets the current member
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Utilities.CoordinateArraySequenceFactory">
- <summary>
- Creates CoordinateSequences represented as an array of Coordinates.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.ICoordinateSequenceFactory">
- <summary>
- An object that knows how to build a particular implementation of
- <c>ICoordinateSequence</c> from an array of Coordinates.
- </summary>
- <seealso cref="T:DotSpatial.Topology.ICoordinateSequence"/>
- </member>
- <member name="M:DotSpatial.Topology.ICoordinateSequenceFactory.Create(System.Collections.Generic.IEnumerable{DotSpatial.Topology.Coordinate})">
- <summary>
- Returns a CoordinateSequence based on the given array; whether or not the
- array is copied is implementation-dependent.
- </summary>
- <param name="coordinates">Coordinates array, which may not be null nor contain null elements</param>
- </member>
- <member name="M:DotSpatial.Topology.ICoordinateSequenceFactory.Create(DotSpatial.Topology.Coordinate)">
- <summary>
- Constructs a new coordinate sequence using a single coordinate.
- </summary>
- <param name="coord">A single coordinate to be used in a coordinate sequence factory.</param>
- <returns>A valid ICoordinateSequence.</returns>
- </member>
- <member name="M:DotSpatial.Topology.ICoordinateSequenceFactory.Create">
- <summary>
- Constructs either an array with 1 member or an empty list, depending on the implementation.
- </summary>
- <returns>A new seqeunce</returns>
- </member>
- <member name="F:DotSpatial.Topology.Utilities.CoordinateArraySequenceFactory.Instance">
- <summary>
- This appears to be part of a singleton for a coordinate array sequence factory
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.CoordinateArraySequenceFactory.#ctor">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.CoordinateArraySequenceFactory.Create(System.Collections.Generic.IEnumerable{DotSpatial.Topology.Coordinate})">
- <summary>
- Returns a CoordinateArraySequence based on the given array (the array is not copied).
- </summary>
- <param name="coordinates">the coordinates, which may not be null nor contain null elements.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.CoordinateArraySequenceFactory.Create(DotSpatial.Topology.Coordinate)">
- <summary>
- Constructs a new coordinate sequence using a single coordinate.
- </summary>
- <param name="coord">A single coordinate to be used in a coordinate sequence factory.</param>
- <returns>A valid ICoordinateSequence.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.CoordinateArraySequenceFactory.Create">
- <summary>
- Constructs either an array with 1 member or an empty list, depending on the implementation.
- </summary>
- <returns>A new seqeunce</returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.CoordinateArraySequenceFactory.Create(DotSpatial.Topology.ICoordinateSequence)">
- <summary>
-
- </summary>
- <param name="coordSeq"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.CoordinateF">
- <summary>
- A lightweight class used to store coordinates
- on the 2-dimensional Cartesian plane.
- It is distinct from <c>Point</c>, which is a subclass of <c>Geometry</c>.
- Unlike objects of type <c>Point</c> (which contain additional
- information such as an envelope, a precision model, and spatial reference
- system information), a <c>Coordinate</c> only contains ordinate values
- and accessor methods.
- <c>Coordinate</c>s are two-dimensional points, with an additional
- z-ordinate. NTS does not support any operations on the z-ordinate except
- the basic accessor functions. Constructed coordinates will have a
- z-ordinate of <c>NaN</c>. The standard comparison functions will ignore
- the z-ordinate.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateF.#ctor(DotSpatial.Topology.FloatVector3)">
- <summary>
- Creates a CoordinateF by using the X, Y and Z terms of a FloatVector
- </summary>
- <param name="floatVector"></param>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateF.#ctor(System.Single,System.Single,System.Single,System.Single)">
- <summary>
- Constructs a <c>Coordinate</c> at (x, y, z).
- </summary>
- <param name="x">X value.</param>
- <param name="y">Y value.</param>
- <param name="z">Z value.</param>
- <param name="m">Measure value.</param>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateF.#ctor(System.Single,System.Single,System.Single)">
- <summary>
- Constructs a <c>Coordinate</c> at (x, y, z).
- </summary>
- <param name="x">X value.</param>
- <param name="y">Y value.</param>
- <param name="z">Z value.</param>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateF.#ctor(DotSpatial.Topology.Coordinate)">
- <summary>
- Creates a Coordinate from any ICoordinate Interface
- </summary>
- <param name="coordinate">The Vector.IPoint interface to construct a coordinate from</param>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateF.#ctor">
- <summary>
- Constructs a <c>Coordinate</c> at (0, 0, NaN).
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateF.#ctor(System.Single,System.Single)">
- <summary>
- Constructs a <c>Coordinate</c> at (x, y, NaN).
- </summary>
- <param name="x">X value.</param>
- <param name="y">Y value.</param>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateF.Equals2D(DotSpatial.Topology.CoordinateF)">
- <summary>
- Returns whether the planar projections of the two <i>Coordinate</i>s are equal.
- </summary>
- <param name="coordinate"><i>ICoordinate</i> with which to do the 2D comparison.</param>
- <returns>
- <c>true</c> if the x- and y-coordinates are equal;
- the Z coordinates do not have to be equal.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateF.Equals(System.Object)">
- <summary>
- Returns <c>true</c> if <c>other</c> has the same values for the x and y ordinates.
- Since Coordinates are 2.5D, this routine ignores the z value when making the comparison.
- </summary>
- <param name="other"><c>Coordinate</c> with which to do the comparison.</param>
- <returns><c>true</c> if <c>other</c> is a <c>Coordinate</c> with the same values for the x and y ordinates.</returns>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateF.op_Equality(DotSpatial.Topology.CoordinateF,DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="obj1"></param>
- <param name="obj2"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateF.op_Inequality(DotSpatial.Topology.CoordinateF,DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="obj1"></param>
- <param name="obj2"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateF.CompareTo(System.Object)">
- <summary>
- Compares this object with the specified object for order.
- Since Coordinates are 2.5D, this routine ignores the z value when making the comparison.
- Returns
- -1 : this.x lowerthan other.x || ((this.x == other.x) AND (this.y lowerthan other.y))
- 0 : this.x == other.x AND this.y = other.y
- 1 : this.x greaterthan other.x || ((this.x == other.x) AND (this.y greaterthan other.y))
- </summary>
- <param name="other"><c>Coordinate</c> with which this <c>Coordinate</c> is being compared.</param>
- <returns>
- A negative integer, zero, or a positive integer as this <c>Coordinate</c>
- is less than, equal to, or greater than the specified <c>Coordinate</c>.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateF.Equals3D(DotSpatial.Topology.CoordinateF)">
- <summary>
- Returns true if other has the same values for x, y and z.
- </summary>
- <param name="other"><i>ICoordinate</i> with which to do the 3D comparison.</param>
- <returns><c>true</c> if <c>other</c> is a <c>ICoordinate</c> with the same values for x, y and z.</returns>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateF.ToString">
- <summary>
- Returns a <c>string</c> of the form <I>(x, y, z)</I> .
- </summary>
- <returns><c>string</c> of the form <I>(x, y, z)</I></returns>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateF.Clone">
- <summary>
- Create a new object as copy of this instance.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateF.Copy">
- <summary>
- Creates a new ICoordinate copy of this instance
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateF.Distance(DotSpatial.Topology.Coordinate)">
- <summary>
- Returns Euclidean 2D distance from ICoordinate p.
- </summary>
- <param name="coordinate"><i>ICoordinate</i> with which to do the distance comparison.</param>
- <returns>Double, the distance between the two locations.</returns>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateF.HyperDistance(DotSpatial.Topology.Coordinate)">
- <summary>
- Returns the distance that is appropriate for N dimensions. In otherwords, if this point is
- three dimensional, then all three dimensions will be used for calculating the distance.
- </summary>
- <param name="coordinate">The coordinate to compare to this coordinate</param>
- <returns>A double valued distance measure that is invariant to the number of coordinates</returns>
- <exception cref="T:DotSpatial.Topology.CoordinateMismatchException">The number of dimensions does not match between the points.</exception>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateF.GetHashCode">
- <summary>
- Return HashCode.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateF.GetHashCode(System.Double)">
- <summary>
- Return HashCode.
- </summary>
- <param name="x">Value from HashCode computation.</param>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateF.op_Addition(DotSpatial.Topology.CoordinateF,DotSpatial.Topology.Coordinate)">
- <summary>
- Overloaded + operator.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateF.op_Addition(DotSpatial.Topology.CoordinateF,System.Single)">
- <summary>
- Overloaded + operator.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateF.op_Addition(System.Single,DotSpatial.Topology.CoordinateF)">
- <summary>
- Overloaded + operator.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateF.op_Multiply(DotSpatial.Topology.CoordinateF,DotSpatial.Topology.Coordinate)">
- <summary>
- Overloaded * operator.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateF.op_Multiply(DotSpatial.Topology.CoordinateF,System.Single)">
- <summary>
- Overloaded * operator.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateF.op_Multiply(System.Single,DotSpatial.Topology.CoordinateF)">
- <summary>
- Overloaded * operator.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateF.op_Subtraction(DotSpatial.Topology.CoordinateF,DotSpatial.Topology.Coordinate)">
- <summary>
- Overloaded - operator.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateF.op_Subtraction(DotSpatial.Topology.CoordinateF,System.Single)">
- <summary>
- Overloaded - operator.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateF.op_Subtraction(System.Single,DotSpatial.Topology.CoordinateF)">
- <summary>
- Overloaded - operator.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateF.op_Division(DotSpatial.Topology.CoordinateF,DotSpatial.Topology.Coordinate)">
- <summary>
- Overloaded / operator.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateF.op_Division(DotSpatial.Topology.CoordinateF,System.Single)">
- <summary>
- Overloaded / operator.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateF.op_Division(System.Single,DotSpatial.Topology.CoordinateF)">
- <summary>
- Overloaded / operator.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateF.ToArray">
- <summary>
- Gets an array of double values for each of the ordinates
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.CoordinateF.X">
- <summary>
- Direct access to the coordinate works as a float. If you only have the interface,
- it must involve conversions to and from a float. This may cause errors if the
- value being set is outside the range of the float values.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.CoordinateF.Y">
- <summary>
- Direct access to the Y coordinate as a float
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.CoordinateF.Z">
- <summary>
- Z coordinate.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.CoordinateF.M">
- <summary>
- A Measure coordinate
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.CoordinateF.CoordinateValue">
- <summary>
- Gets/Sets <c>Coordinate</c>s (x, y, z) values.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.CoordinateF.Item(System.Int32)">
- <summary>
- Gets or sets the double value corresponding to the specific ordinate
- </summary>
- <param name="index"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.CoordinateF.NumOrdinates">
- <summary>
- For now this is 3D
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.CoordinateF.Values">
- <summary>
- Gets or sets the values of this CoordinateF using an array of double values
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.CoordinateList">
- <summary>
- A list of Coordinates, which may
- be set to prevent repeated coordinates from occuring in the list.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateList.#ctor">
- <summary>
- Creates a new instance of a coordiante list
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateList.#ctor(System.Collections.Generic.IEnumerable{DotSpatial.Topology.Coordinate})">
- <summary>
- The basic constructor for a CoordinateArray allows repeated points
- (i.e produces a CoordinateList with exactly the same set of points).
- </summary>
- <param name="coords">Initial coordinates</param>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateList.#ctor(System.Collections.Generic.IEnumerable{DotSpatial.Topology.Coordinate},System.Boolean)">
- <summary>
- Constructs a new list from an array of Coordinates,
- allowing caller to specify if repeated points are to be removed.
- </summary>
- <param name="coords">Array of coordinates to load into the list.</param>
- <param name="allowRepeated">If <c>false</c>, repeated points are removed.</param>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateList.Clone">
- <summary>
- Returns a deep copy of this collection.
- </summary>
- <returns>The copied object.</returns>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateList.Add(System.Collections.Generic.IEnumerable{DotSpatial.Topology.Coordinate},System.Boolean,System.Boolean)">
- <summary>
- Add an array of coordinates.
- </summary>
- <param name="coords">Coordinates to be inserted.</param>
- <param name="allowRepeated">If set to false, repeated coordinates are collapsed.</param>
- <param name="direction">If false, the array is added in reverse order.</param>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateList.Add(System.Collections.Generic.IEnumerable{DotSpatial.Topology.Coordinate},System.Boolean)">
- <summary>
- Add an array of coordinates.
- </summary>
- <param name="coord">Coordinates to be inserted.</param>
- <param name="allowRepeated">If set to false, repeated coordinates are collapsed.</param>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateList.Add(DotSpatial.Topology.Coordinate,System.Boolean)">
- <summary>
- Add a coordinate.
- </summary>
- <param name="coord">Coordinate to be inserted.</param>
- <param name="allowRepeated">If set to false, repeated coordinates are collapsed.</param>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateList.DoAdd(DotSpatial.Topology.Coordinate,System.Boolean)">
- <summary>
-
- </summary>
- <param name="coord"></param>
- <param name="allowRepeated"></param>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateList.DoAddRange(System.Collections.Generic.IEnumerable{DotSpatial.Topology.Coordinate},System.Boolean)">
- <summary>
- Adds the entire range of coordinates, preventing coordinates with the identical 2D signiture from
- being added immediately after it's duplicate.
- </summary>
- <param name="coords"></param>
- <param name="allowRepeated"></param>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateList.CloseRing">
- <summary>
- Ensure this coordList is a ring, by adding the start point if necessary.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateList.ToCoordinateArray">
- <summary>
- Returns the Coordinates in this collection.
- </summary>
- <returns>Coordinater as <c>Coordinate[]</c> array.</returns>
- </member>
- <member name="T:DotSpatial.Topology.CoordinateListSequence">
- <summary>
- An ICoordinateSequence based on a list instead of an array.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateListSequence.#ctor(DotSpatial.Topology.Coordinate)">
- <summary>
- Creates a new instance of a CoordinateListSequence
- </summary>
- <param name="coordinate"></param>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateListSequence.#ctor">
- <summary>
- Creates a new instance of a CoordinateListSequence
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateListSequence.#ctor(System.Collections.Generic.IEnumerable{DotSpatial.Topology.Coordinate})">
- <summary>
- Creates a new instance of a CoordinateListSequence
- </summary>
- <param name="coordinates">If this is a List of ICoordinates, the sequence will be a shallow list.
- Otherwise, a List is created and shallow copies of each coordinate is added.</param>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateListSequence.#ctor(DotSpatial.Topology.ICoordinateSequence)">
- <summary>
- Creates a new instance of CoordinateListSequence
- </summary>
- <param name="sequence">The sequence to use</param>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateListSequence.Add(DotSpatial.Topology.Coordinate)">
- <summary>
- Adds an item to the end of the CoordinateList
- </summary>
- <param name="item">An ICoordinate to add</param>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateListSequence.Clear">
- <summary>
- Clears the list entirely.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateListSequence.Clone">
- <summary>
- Creates a deep copy of this object
- </summary>
- <returns>CoordinateListSequence</returns>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateListSequence.Contains(DotSpatial.Topology.Coordinate)">
- <summary>
- Tests wheather or not the specified ICoordinate is contained in the list.
- </summary>
- <param name="item">An ICoordinate to test</param>
- <returns>Boolean, true if the list contains the item.</returns>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateListSequence.CopyTo(DotSpatial.Topology.Coordinate[],System.Int32)">
- <summary>
- Copies all the members of this list into the specified array.
- </summary>
- <param name="array">The array to copy values to.</param>
- <param name="arrayIndex">The 0 based integer index in the array at which copying begins</param>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateListSequence.ExpandEnvelope(DotSpatial.Topology.IEnvelope)">
- <summary>
- Expands the given Envelope to include the coordinates in the sequence.
- Does not modify the original envelope, but rather returns a copy of the
- original envelope after being modified.
- </summary>
- <param name="env">The envelope use as the starting point for expansion. This envelope will not be modified.</param>
- <returns>The newly created envelope that is the expanded version of the original.</returns>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateListSequence.GetEnumerator">
- <summary>
- Obtains an enumerator for cycling through the list. BEWARE! This
- will return an underlying list enumerator, and so code that uses
- a foreach process or an enumerator will bypass the Version incrementing code.
- </summary>
- <returns>An Enumerator object for cycling through the list.</returns>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateListSequence.GetOrdinate(System.Int32,DotSpatial.Topology.Ordinate)">
- <summary>
- Gets a specific X, Y or Z value depending on the index specified and the ordinate specified
- </summary>
- <param name="index"></param>
- <param name="ordinate"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateListSequence.Remove(DotSpatial.Topology.Coordinate)">
- <summary>
- Removes the specified ICoordinate from the list.
- </summary>
- <param name="item">An ICoordinate that should be removed from the list</param>
- <returns>Boolean, true if the item was successfully removed.</returns>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateListSequence.SetOrdinate(System.Int32,DotSpatial.Topology.Ordinate,System.Double)">
- <summary>
- Sets a specific X, Y or Z value depending on the index specified and the ordinate specified
- </summary>
- <param name="index"></param>
- <param name="ordinate"></param>
- <param name="value"></param>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateListSequence.ToCoordinateArray">
- <summary>
- Copies all the members to an ICoordiante[]
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateListSequence.IncrementVersion">
- <summary>
- Increments the version with the understanding that we are using integers. If the user
- uses too many version, it will cycle around. The statistical odds of accidentally
- reaching the same value as a previous version should be small enough to prevent
- conflicts.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.CoordinateListSequence.Count">
- <summary>
- Gets an integer representing the number of ICoordinates currently stored in this list
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.CoordinateListSequence.Dimension">
- <summary>
- This always returns 0
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.CoordinateListSequence.IsReadOnly">
- <summary>
- The CoordinateListSequence is not readonly
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.CoordinateListSequence.Item(System.Int32)">
- <summary>
- Direct accessor to an ICoordinate
- </summary>
- <param name="index">An integer index in this array sequence</param>
- <returns>An ICoordinate for the specified index</returns>
- </member>
- <member name="P:DotSpatial.Topology.CoordinateListSequence.VersionID">
- <summary>
- This only works as long as an enumeration is not used on the CoordinateListSequence.
- Since ICoordinateSequence does not support a GetEnumerator object, as long as you
- are using an ICoordinateSequence interface, VersionID should work.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Utilities.CoordinateListSequenceFactory">
- <summary>
- Creates CoordinateSequences represented as an array of Coordinates.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Utilities.CoordinateListSequenceFactory.Instance">
- <summary>
- Creates an instance of the CoordinateListSequenceFactory
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.CoordinateListSequenceFactory.Create(System.Collections.Generic.IEnumerable{DotSpatial.Topology.Coordinate})">
- <summary>
- Returns a CoordinateArraySequence based on the given array (the array is not copied).
- </summary>
- <param name="coordinates">the coordinates, which may not be null nor contain null elements.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.CoordinateListSequenceFactory.Create">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.CoordinateListSequenceFactory.Create(DotSpatial.Topology.Coordinate)">
- <summary>
- Creates a new CoordinateListSequence and populates it with a single coordinate.
- </summary>
- <param name="coordinate"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.CoordinateListSequenceFactory.Create(DotSpatial.Topology.ICoordinateSequence)">
- <summary>
-
- </summary>
- <param name="coordSeq"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.CoordinateMismatchException">
- <summary>
- CoordinateMismatchException
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.CoordinateMismatchException.#ctor">
- <summary>
- Creates a new instance of CoordinateMismatchException
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Dimension">
- <summary>
- Class containing static methods for conversions
- between Dimension values and characters.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Dimension.ToDimensionSymbol(DotSpatial.Topology.DimensionType)">
- <summary>
- Converts the dimension value to a dimension symbol,
- for example, <c>True => 'T'</c>
- </summary>
- <param name="dimensionValue">Number that can be stored in the <c>IntersectionMatrix</c>.
- Possible values are <c>True, False, Dontcare, 0, 1, 2</c>.</param>
- <returns>Character for use in the string representation of an <c>IntersectionMatrix</c>.
- Possible values are <c>T, F, *, 0, 1, 2</c>.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Dimension.ToDimensionValue(System.Char)">
- <summary>
- Converts the dimension symbol to a dimension value,
- for example, <c>'*' => Dontcare</c>
- </summary>
- <param name="dimensionSymbol">Character for use in the string representation of an <c>IntersectionMatrix</c>.
- Possible values are <c>T, F, *, 0, 1, 2</c>.</param>
- <returns>Number that can be stored in the <c>IntersectionMatrix</c>.
- Possible values are <c>True, False, Dontcare, 0, 1, 2</c>.</returns>
- </member>
- <member name="T:DotSpatial.Topology.GeometryType">
- <summary>
- This is enumerates not only the specific types, but very specifically
- that the types are the Topology variety, and not simply the vector variety
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.GeometryType.Envelope">
- <summary>
- A non-geometry rectangle that strictly shows extents
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.GeometryType.GeometryCollection">
- <summary>
- A collective group of geometries
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.GeometryType.LinearRing">
- <summary>
- A closed linestring that doesn't self intersect
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.GeometryType.LineString">
- <summary>
- Any linear collection of points joined by line segments
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.GeometryType.MultiLineString">
- <summary>
- A collection of independant LineStrings that are not connected
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.GeometryType.MultiPoint">
- <summary>
- A Grouping of points
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.GeometryType.MultiPolygon">
- <summary>
- A Collection of unconnected polygons
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.GeometryType.Point">
- <summary>
- A single coordinate location
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.GeometryType.Polygon">
- <summary>
- At least one Linear Ring shell with any number of linear ring "holes"
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.GeometryType.Unknown">
- <summary>
- Any other type
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.ShapeGeometryType">
- <summary>
- Shapefile Shape types enumeration
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.ShapeGeometryType.NullShape">
- <summary>
- Null Shape
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.ShapeGeometryType.Point">
- <summary>
- Point
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.ShapeGeometryType.LineString">
- <summary>
- LineString
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.ShapeGeometryType.Polygon">
- <summary>
- Polygon
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.ShapeGeometryType.MultiPoint">
- <summary>
- MultiPoint
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.ShapeGeometryType.PointZM">
- <summary>
- PointMZ
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.ShapeGeometryType.LineStringZM">
- <summary>
- PolyLineMZ
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.ShapeGeometryType.PolygonZM">
- <summary>
- PolygonMZ
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.ShapeGeometryType.MultiPointZM">
- <summary>
- MultiPointMZ
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.ShapeGeometryType.PointM">
- <summary>
- PointM
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.ShapeGeometryType.LineStringM">
- <summary>
- LineStringM
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.ShapeGeometryType.PolygonM">
- <summary>
- PolygonM
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.ShapeGeometryType.MultiPointM">
- <summary>
- MultiPointM
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.ShapeGeometryType.MultiPatch">
- <summary>
- MultiPatch
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.ShapeGeometryType.PointZ">
- <summary>
- PointZ
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.ShapeGeometryType.LineStringZ">
- <summary>
- LineStringZ
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.ShapeGeometryType.PolygonZ">
- <summary>
- PolygonZ
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.ShapeGeometryType.MultiPointZ">
- <summary>
- MultiPointZ
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.VectorFieldType">
- <summary>
- Field Types
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.VectorFieldType.OFTInteger">
- <summary>
- Integer
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.VectorFieldType.OFTIntegerList">
- <summary>
- Integer List
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.VectorFieldType.OFTReal">
- <summary>
- Real
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.VectorFieldType.OFTRealList">
- <summary>
- Real List
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.VectorFieldType.OFTString">
- <summary>
- String
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.VectorFieldType.OFTStringList">
- <summary>
- String List
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.VectorFieldType.OFTWideString">
- <summary>
- Wide String
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.VectorFieldType.OFTWideStringList">
- <summary>
- Side String List
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.VectorFieldType.OFTBinary">
- <summary>
- Binary
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.VectorFieldType.OFTDate">
- <summary>
- Date
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.VectorFieldType.OFTTime">
- <summary>
- Time
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.VectorFieldType.OFTDateTime">
- <summary>
- DateTime
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.VectorFieldType.Invalid">
- <summary>
- Invalid
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.VectorGeometryType">
- <summary>
- Vector Geometry Types
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.VectorGeometryType.wkbUnknown">
- <summary>
- Unknown
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.VectorGeometryType.wkbPoint">
- <summary>
- Well Known Binary Point
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.VectorGeometryType.wkbLineString">
- <summary>
- Well Known Binary LineString
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.VectorGeometryType.wkbPolygon">
- <summary>
- Well Known Binary Polygon
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.VectorGeometryType.wkbMultiPoint">
- <summary>
- Well Known Binary MultiPoint
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.VectorGeometryType.wkbMultiLineString">
- <summary>
- Well Known Binary MultiLineString
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.VectorGeometryType.wkbMultiPolygon">
- <summary>
- Well Known Binary MultiPolygon
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.VectorGeometryType.wkbGeometryCollection">
- <summary>
- Well Known Binary Geometry Collection
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.VectorGeometryType.wkbLinearRing">
- <summary>
- Well Known Binary Linear Ring
- /* non-standard, just for createGeometry() */
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.VectorGeometryType.wkbPoint25D">
- <summary>
- Well Known Binary Point with Z value
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.VectorGeometryType.wkbLineString25D">
- <summary>
- Well Known Binary Line String with Z values
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.VectorGeometryType.wkbPolygon25D">
- <summary>
- Well Known Binary Polygon with Z values
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.VectorGeometryType.wkbMultiPoint25D">
- <summary>
- Well Known Binary MultiPoint with Z values
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.VectorGeometryType.wkbMultiLineString25D">
- <summary>
- Well Known Binary LineString with z values
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.VectorGeometryType.wkbMultiPolygon25D">
- <summary>
- Well Known Binary MultiPolygon with z values
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Envelope">
- <summary>
- Defines a rectangular region of the 2D coordinate plane.
- It is often used to represent the bounding box of a <c>Geometry</c>,
- e.g. the minimum and maximum x and y values of the <c>Coordinate</c>s.
- Notice that Envelopes support infinite or half-infinite regions, by using the values of
- <c>Double.PositiveInfinity</c> and <c>Double.NegativeInfinity</c>.
- When Envelope objects are created or initialized,
- the supplies extent values are automatically sorted into the correct order.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.IEnvelope">
- <summary>
- Defines a rectangular region of the 2D coordinate plane.
- It is often used to represent the bounding box of a <c>Geometry</c>,
- e.g. the minimum and maximum x and y values of the <c>Coordinate</c>s.
- Notice that Envelopes support infinite or half-infinite regions, by using the values of
- <c>Double.PositiveInfinity</c> and <c>Double.NegativeInfinity</c>.
- When Envelope objects are created or initialized,
- the supplies extent values are automatically sorted into the correct order.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.IRectangle">
- <summary>
- An IRectangle is not as specific to being a geometry, and can apply to anything as long as it is willing
- to support a double valued height, width, X and Y value.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.IRectangle.Height">
- <summary>
- Gets or sets the difference between the maximum and minimum y values.
- Setting this will change only the minimum Y value, leaving the Top alone
- </summary>
- <returns>max y - min y, or 0 if this is a null <c>Envelope</c>.</returns>
- </member>
- <member name="P:DotSpatial.Topology.IRectangle.Width">
- <summary>
- Gets or Sets the difference between the maximum and minimum x values.
- Setting this will change only the Maximum X value, and leave the minimum X alone
- </summary>
- <returns>max x - min x, or 0 if this is a null <c>Envelope</c>.</returns>
- </member>
- <member name="P:DotSpatial.Topology.IRectangle.X">
- <summary>
- In the precedent set by controls, envelopes support an X value and a width.
- The X value represents the Minimum.X coordinate for this envelope.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.IRectangle.Y">
- <summary>
- In the precedent set by controls, envelopes support a Y value and a height.
- the Y value represents the Top of the envelope, (Maximum.Y) and the Height
- represents the span between Maximum and Minimum Y.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.IEnvelope.Copy">
- <summary>
- Creates a copy of the current envelope.
- </summary>
- <returns>An IEnvelope Interface that is a duplicate of this envelope</returns>
- </member>
- <member name="M:DotSpatial.Topology.IEnvelope.SetToNull">
- <summary>
- Sets maxx to a value less than minx
- usually, maxx = -1 and minx = 0, maxy = -1 and miny = 0
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.IEnvelope.HasM">
- <summary>
- True only if the M coordinates are not NaN and the max is greater than the min.
- </summary>
- <returns>Boolean</returns>
- </member>
- <member name="M:DotSpatial.Topology.IEnvelope.HasZ">
- <summary>
- True only of the Z ordinates are not NaN and the max is greater than the min.
- </summary>
- <returns>Boolean</returns>
- </member>
- <member name="M:DotSpatial.Topology.IEnvelope.Init(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
- Because the envelope class attempts to protect users from accidentally manipulating
- the minimum/maximum conditions in an undesirable way, the init method should effectively
- initialize the existing envelope based on the new coordinates. This is how values
- are "Set" for the envelope. It is expected that this method will do a check
- to prevent larger values from being assigned to "maximum".
- </summary>
- <param name="p1">The first coordinate to test</param>
- <param name="p2">the second coordinate to test</param>
- </member>
- <member name="P:DotSpatial.Topology.IEnvelope.Minimum">
- <summary>
- This is a coordinate defining the minimum bound in any number of dimensions
- as controlled by NumOrdinates.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.IEnvelope.Maximum">
- <summary>
- This is a coordinate defining the maximum bound in any number of dimensions
- as controlled by NumOrdinates.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.IEnvelope.NumOrdinates">
- <summary>
- Gets the number of ordinates that define both coordinates of this envelope.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.IEnvelope.IsNull">
- <summary>
- Returns <c>true</c> if this <c>Envelope</c> is a "null" envelope.
- </summary>
- <returns>
- <c>true</c> if this <c>Envelope</c> is uninitialized
- or is the envelope of the empty point. This is usually defined
- as having a maxx less than a minx, like maxx = -1 and minx = 0.
- </returns>
- </member>
- <member name="E:DotSpatial.Topology.IEnvelope.EnvelopeChanged">
- <summary>
- Occurs when there is a basic change in the envelope.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Envelope.#ctor">
- <summary>
- Creates a null <c>Envelope</c>.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Envelope.#ctor(System.Double,System.Double,System.Double,System.Double)">
- <summary>
- Creates an <c>Envelope</c> for a region defined by maximum and minimum values.
- </summary>
- <param name="x1">The first x-value.</param>
- <param name="x2">The second x-value.</param>
- <param name="y1">The first y-value.</param>
- <param name="y2">The second y-value.</param>
- </member>
- <member name="M:DotSpatial.Topology.Envelope.#ctor(System.Double,System.Double,System.Double,System.Double,System.Double,System.Double)">
- <summary>
- Creates an <c>Envelope</c> for a region defined by maximum and minimum values.
- </summary>
- <param name="x1">The first x-value.</param>
- <param name="x2">The second x-value.</param>
- <param name="y1">The first y-value.</param>
- <param name="y2">The second y-value.</param>
- <param name="z1">The first z-value.</param>
- <param name="z2">The second z-value.</param>
- </member>
- <member name="M:DotSpatial.Topology.Envelope.#ctor(DotSpatial.Topology.IEnvelope)">
- <summary>
- Creates an <c>Envelope</c> for a region defined by an Vector.IEnvelope
- </summary>
- <param name="inEnvelope">The IEnvelope to create an envelope from</param>
- </member>
- <member name="M:DotSpatial.Topology.Envelope.#ctor(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
- Creates an <c>Envelope</c> for a region defined by two Coordinates.
- </summary>
- <param name="p1">The first Coordinate.</param>
- <param name="p2">The second Coordinate.</param>
- </member>
- <member name="M:DotSpatial.Topology.Envelope.#ctor(DotSpatial.Topology.Coordinate)">
- <summary>
- Creates an <c>Envelope</c> for a region defined by a single Coordinate.
- </summary>
- <param name="p">The Coordinate.</param>
- </member>
- <member name="M:DotSpatial.Topology.Envelope.#ctor(System.Double[],System.Double,System.Double)">
- <summary>
- This is a special constructor. This will not fire the OnEnvelopeChanged
- event, and expects values to be ordered as:
- XMin, XMax, YMin, YMax, ZMin, ZMax, higher dimenions...
- This constructor.
- </summary>
- <param name="extents">The ordinal extents.</param>
- <param name="mMin">The minimum m value.</param>
- <param name="mMax">The max M value.</param>
- </member>
- <member name="M:DotSpatial.Topology.Envelope.#ctor(System.Double[])">
- <summary>
- This is a special constructor. This will not fire the OnEnvelopeChanged
- event, and expects values to be ordered as:
- XMin, XMax, YMin, YMax, ZMin, ZMax, higher dimenions...
- This constructor sets M bounds to be 0.
- </summary>
- <param name="extents">The ordinal extents.</param>
- </member>
- <member name="M:DotSpatial.Topology.Envelope.Init(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
- Initialize an Envelope of any dimension for a region defined by two Coordinates.
- The number of ordinates (dimension) of the coordinates must match. M values
- will also be considered.
- </summary>
- <param name="p1">The first Coordinate.</param>
- <param name="p2">The second Coordinate.</param>
- </member>
- <member name="M:DotSpatial.Topology.Envelope.DoInit">
- <summary>
- This initializes the values without passing any coordinates and creates the default, 2D null envelope.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Envelope.DoInit(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
- This is an internal method forcing assignments to the internal coordinates
- </summary>
- <param name="min">The coordinate to use for the minimum in X, Y, Z etc.</param>
- <param name="max">The coordinate to use for the maximum in X, Y, Z etc.</param>
- </member>
- <member name="M:DotSpatial.Topology.Envelope.Init">
- <summary>
- Initialize to a null <c>Envelope</c>.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Envelope.Init(System.Double,System.Double,System.Double,System.Double)">
- <summary>
- Initialize an <c>Envelope</c> for a region defined by maximum and minimum values.
- </summary>
- <param name="x1">The first x-value.</param>
- <param name="x2">The second x-value.</param>
- <param name="y1">The first y-value.</param>
- <param name="y2">The second y-value.</param>
- </member>
- <member name="M:DotSpatial.Topology.Envelope.Init(System.Double,System.Double,System.Double,System.Double,System.Double,System.Double)">
- <summary>
- This will set all 3 dimensions. Be warned, the Z dimensions are just place holders
- for any topology opperations and do not have any true functionality. Whichever
- is smaller becomes the minimum and whichever is larger becomes the maximum.
- </summary>
- <param name="x1">An X coordinate </param>
- <param name="x2">Another X coordinate</param>
- <param name="y1">A Y coordinate</param>
- <param name="y2">Another Y coordinate</param>
- <param name="z1">A Z coordinate</param>
- <param name="z2">Another Z coordinate</param>
- </member>
- <member name="M:DotSpatial.Topology.Envelope.Init(DotSpatial.Topology.Coordinate)">
- <summary>
- Initialize an <c>Envelope</c> for a region defined by a single Coordinate.
- </summary>
- <param name="p">The Coordinate.</param>
- </member>
- <member name="M:DotSpatial.Topology.Envelope.Init(DotSpatial.Topology.IEnvelope)">
- <summary>
- Initialize an <c>Envelope</c> from an existing Envelope.
- </summary>
- <param name="env">The Envelope to initialize from.</param>
- </member>
- <member name="M:DotSpatial.Topology.Envelope.HasM">
- <summary>
- True only if the M coordinates are not NaN and the max is greater than the min.
- </summary>
- <returns>Boolean</returns>
- </member>
- <member name="M:DotSpatial.Topology.Envelope.HasZ">
- <summary>
- True only of the Z ordinates are not NaN and the max is greater than the min.
- </summary>
- <returns>Boolean</returns>
- </member>
- <member name="M:DotSpatial.Topology.Envelope.Clone">
- <summary>
- Creates a copy of the current envelope.
- </summary>
- <returns>An object satisfying ICloneable</returns>
- </member>
- <member name="M:DotSpatial.Topology.Envelope.SetToNull">
- <summary>
- Makes this <c>Envelope</c> a "null" envelope.
- </summary>
- <remarks>Internaly, envelopes that vioate that sacred criteria of min being less than max
- will be counted as a null case</remarks>
- </member>
- <member name="M:DotSpatial.Topology.Envelope.Copy">
- <summary>
- Creates a copy of the current envelope.
- </summary>
- <returns>An IEnvelope Interface that is a duplicate of this envelope</returns>
- </member>
- <member name="M:DotSpatial.Topology.Envelope.Intersects(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
- Test the point q to see whether it intersects the Envelope
- defined by p1-p2.
- </summary>
- <param name="p1">One extremal point of the envelope.</param>
- <param name="p2">Another extremal point of the envelope.</param>
- <param name="q">Point to test for intersection.</param>
- <returns><c>true</c> if q intersects the envelope p1-p2.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Envelope.Intersects(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
- Test the envelope defined by p1-p2 for intersection
- with the envelope defined by q1-q2
- </summary>
- <param name="p1">One extremal point of the envelope Point.</param>
- <param name="p2">Another extremal point of the envelope Point.</param>
- <param name="q1">One extremal point of the envelope Q.</param>
- <param name="q2">Another extremal point of the envelope Q.</param>
- <returns><c>true</c> if Q intersects Point</returns>
- </member>
- <member name="M:DotSpatial.Topology.Envelope.ToString">
- <summary>
- Generates a string form of this envelope.
- </summary>
- <returns></returns>
- <remarks>This should not be an extension method because it overrides ToString.</remarks>
- </member>
- <member name="M:DotSpatial.Topology.Envelope.OnEnvelopeChanged">
- <summary>
- Fires the EnvelopeChanged event
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Envelope.GeometryType">
- <summary>
- Specifies that this is in fact an envelope
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Envelope.BoundsX">
- <summary>
- Gets the Horizontal boundaries in geographic coordinates
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Envelope.BoundsY">
- <summary>
- Gets the vertical boundaries in geographic coordinates
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Envelope.Minimum">
- <summary>
- Gets the minimum coordinate
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Envelope.Maximum">
- <summary>
- Gets the maximum coordinate
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Envelope.NumOrdinates">
- <summary>
- Gets the number of ordinates for this envelope.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Envelope.IsNull">
- <summary>
- Returns <c>true</c> if this <c>Envelope</c> is a "null" envelope.
- </summary>
- <returns>
- <c>true</c> if this <c>Envelope</c> is uninitialized
- or is the envelope of the empty point.
- </returns>
- </member>
- <member name="P:DotSpatial.Topology.Envelope.Height">
- <summary>
- Gets or sets the difference between the maximum and minimum y values.
- Setting this will only change the _yMin value (leaving the top alone)
- </summary>
- <returns>max y - min y, or 0 if this is a null <c>Envelope</c>.</returns>
- <remarks>To resemble the precedent set by the dot net framework controls, this is left as a property</remarks>
- </member>
- <member name="P:DotSpatial.Topology.Envelope.Width">
- <summary>
- Gets or Sets the difference between the maximum and minimum x values.
- Setting this will change only the Maximum X value, and leave the minimum X alone
- </summary>
- <returns>max x - min x, or 0 if this is a null <c>Envelope</c>.</returns>
- </member>
- <member name="P:DotSpatial.Topology.Envelope.X">
- <summary>
- Gets or sets the Left extent of the envelope, keeping the width the same.
- In the precedent set by controls, envelopes support an X value and a width.
- The X value represents the Minimum.X coordinate for this envelope.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Envelope.Y">
- <summary>
- Gets or sets the Y coordinate for the top of the envelope. (YMax)
- In the precedent set by controls, envelopes support a Y value and a height.
- the Y value represents the Top of the envelope, (Maximum.Y) and the Height
- represents the span between Maximum and Minimum Y.
- </summary>
- </member>
- <member name="E:DotSpatial.Topology.Envelope.EnvelopeChanged">
- <summary>
- Occurs when there is a basic change in the envelope.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.EnvelopeExt">
- <summary>
- My concept for the Envelope is that there are several methods that are derived calculations. These are
- so straight forward that it is unlikey that "new" implementations of those derived values will be needed
- or wanted. However, we want lots of different kinds of things to be able to "become" an envelope
- with a minimum of fuss.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.Area(DotSpatial.Topology.IEnvelope)">
- <summary>
- Calculates the area of this envelope. Because the word Area,
- like Volume, is dimension specific, this method only looks
- at the X and Y ordinates, and requires at least 2 ordinates.
- </summary>
- <param name="self">The IEnvelope to use with this method</param>
- <returns>The 2D area as a double value.</returns>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.Border(DotSpatial.Topology.IEnvelope)">
- <summary>
- Gets a linear ring built clockwise around the border, starting from the TopLeft.
- </summary>
- <param name="self">The IEnvelope to use with this method</param>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.BorderSegments(DotSpatial.Topology.IEnvelope)">
- <summary>
- Gets an array of 4 line segments working clockwise from the top segment.
- </summary>
- <param name="self">The IEnvelope to use with this method</param>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.Bottom(DotSpatial.Topology.IEnvelope)">
- <summary>
- Gets the minY, which is Y - Height.
- </summary>
- <param name="self">The <c>IEnvelope</c> that this calculation is for.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.BottomBorder(DotSpatial.Topology.IEnvelope)">
- <summary>
- Gets an ILineSegment from the top right corner to the bottom right corner
- </summary>
- <param name="self">The IEnvelope to use with this method</param>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.BottomLeft(DotSpatial.Topology.IEnvelope)">
- <summary>
- Gets the bottom left corner of this rectangle as a 2D coordinate.
- </summary>
- <param name="self">The <c>IEnvelope</c> that this calculation is for.</param>
- <returns>An <c>ICoordinate</c> at the lower left corner of this rectangle</returns>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.BottomRight(DotSpatial.Topology.IEnvelope)">
- <summary>
- Gets the bottom right corner of this rectangle as a 2D coordinate
- </summary>
- <param name="self">The <c>IEnvelope</c> that this calculation is for.</param>
- <returns>An <c>ICoordinate</c> at the lower right corner of this rectangle</returns>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.Center(DotSpatial.Topology.IEnvelope)">
- <summary>
- Gets the coordinate defining the center of this envelope
- in all of the dimensions of this envelope.
- </summary>
- <param name="self">The <c>IEnvelope</c> to find the center for</param>
- <returns>An ICoordinate</returns>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.Left(DotSpatial.Topology.IEnvelope)">
- <summary>
- Gets the left value for this rectangle. This should be the
- X coordinate, but is added for clarity.
- </summary>
- <param name="self">The <c>IEnvelope</c> that this calculation is for.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.LeftBorder(DotSpatial.Topology.IEnvelope)">
- <summary>
- Gets an ILineSegment from the bottom left to the top left corners
- </summary>
- <param name="self">The <c>IEnvelope</c> that is being extended by this method</param>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.Right(DotSpatial.Topology.IEnvelope)">
- <summary>
- Gets the right value, which is X + Width.
- </summary>
- <param name="self">The <c>IEnvelope</c> that this calculation is for.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.RightBorder(DotSpatial.Topology.IEnvelope)">
- <summary>
- Gets an ILineSegment from the bottom right corner to the bottom left corner
- </summary>
- <param name="self">The IEnvelope to use with this method</param>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.ToLinearRing(DotSpatial.Topology.IEnvelope)">
- <summary>
- Converts this envelope into a linear ring.
- </summary>
- <param name="self">The IEnvelope to use with this method</param>
- <returns>A Linear ring describing the border of this envelope.</returns>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.TopBorder(DotSpatial.Topology.IEnvelope)">
- <summary>
- Gets an ILineSegment from the top left to the top right corners
- </summary>
- <param name="self">The IEnvelope to use with this method</param>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.TopLeft(DotSpatial.Topology.IEnvelope)">
- <summary>
- Calculates the TopLeft 2D coordinate from this envelope.
- </summary>
- <param name="self">The IEnvelope to use with this method</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.ToPolygon(DotSpatial.Topology.IEnvelope)">
- <summary>
- Technically an Evelope object is not actually a geometry.
- This creates a polygon from the extents.
- </summary>
- <param name="self">The IEnvelope to use with this method</param>
- <returns>A Polygon, which technically qualifies as an IGeometry</returns>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.TopRight(DotSpatial.Topology.IEnvelope)">
- <summary>
- Calcualte the TopRight 2D Coordinate from this envelope
- </summary>
- <param name="self">The IEnvelope to use with this method</param>
- <returns>An ICoordinate in the position of maximum X, Maximum Y</returns>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.Zoom(DotSpatial.Topology.IEnvelope,System.Double)">
- <summary>
- Changes the envelope extent by the specified amount relative
- to it's current extent in that dimension (preserving the aspect ratio).
- So Zoom(10) on a 100 unit wide envelope creates a 110 unit wide envlope,
- while Zoom(-10) on a 100 unit wide envelope creates a 90 unit wide envelope.
- Zoom(-100) on an envelope makes it 100% smaller, or effectively a point.
- Tragically, a point cannot be "zoomed" back in, so a check should be used
- to ensure that the envelope is not currently a point before attempting
- to zoom in.
- </summary>
- <param name="self">The IEnvelope that this zoom method modifies</param>
- <param name="percent">
- Positive 50 makes the envelope 50% larger
- Negative 50 makes the envelope 50% smaller
- </param>
- <example>
- perCent = -50 compact the envelope a 50% (make it smaller).
- perCent = 200 enlarge envelope by 2.
- </example>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.Union(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.Coordinate)">
- <summary>
- Returns a new envelope that is a copy of this envelope, but modified
- to include the specified coordinate.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.Union(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IEnvelope)">
- <summary>
- Calculates the union of the current box and the given box.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.SetCenter(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.Coordinate)">
- <summary>
- Moves the envelope to the indicated coordinate.
- </summary>
- <param name="self">The IEnvelope to use with this method</param>
- <param name="center">The new center coordinate.</param>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.SetCenter(DotSpatial.Topology.IEnvelope,System.Double,System.Double)">
- <summary>
- Resizes the envelope to the indicated point.
- </summary>
- <param name="self">The IEnvelope to use with this method</param>
- <param name="width">The new width.</param>
- <param name="height">The new height.</param>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.SetCenter(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.Coordinate,System.Double,System.Double)">
- <summary>
- Moves and resizes the current envelope.
- </summary>
- <param name="self">The IEnvelope to use with this method</param>
- <param name="center">The new centre coordinate.</param>
- <param name="width">The new width.</param>
- <param name="height">The new height.</param>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.SetCenter(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
- This handles setting the center and scale in N dimensions. The size is equivalent to the
- span in each dimension, while the center is the central position in each dimension. The
- envelope will have values in each dimension where either the existing envelope or both the
- specified center and size values have been specified. If only the existing envelope
- and a size is specified for dimension 3, for example, the existing center will be used.
- </summary>
- <param name="self">The envelope to modify</param>
- <param name="center">The center position. This can also be null.</param>
- <param name="size">The size (or span) in each dimension. This can also be null.</param>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.SetExtents(DotSpatial.Topology.IEnvelope,System.Double,System.Double,System.Double,System.Double,System.Double,System.Double)">
- <summary>
- Despite the naming of the extents, this will force the larger of the two x values
- to become Xmax etc.
- </summary>
- <param name="self">The IEnvelope to use with this method</param>
- <param name="minX">An X coordinate</param>
- <param name="minY">A Y coordinate</param>
- <param name="minZ">A Z coordinate</param>
- <param name="maxX">Another X coordinate</param>
- <param name="maxY">Another Y coordinate</param>
- <param name="maxZ">Another Z coordinate</param>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.SetExtents(DotSpatial.Topology.IEnvelope,System.Double,System.Double,System.Double,System.Double)">
- <summary>
- The two dimensional overload for consistency with other code.
- Despite the names, this will force the smallest X coordinate given
- to become maxX.
- </summary>
- <param name="self">The IEnvelope to use with this method</param>
- <param name="minX">An X coordinate</param>
- <param name="minY">A Y coordinate</param>
- <param name="maxX">Another X coordinate</param>
- <param name="maxY">Another Y coordinate</param>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.Top(DotSpatial.Topology.IEnvelope)">
- <summary>
- Gets the maxY value, which should be Y.
- </summary>
- <param name="self">The <c>IEnvelope</c> that this calculation is for.</param>
- <returns>The double value representing the Max Y value of this rectangle</returns>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.Translate(DotSpatial.Topology.IEnvelope,System.Double,System.Double)">
- <summary>
- Translates this envelope by given amounts in the X and Y direction.
- </summary>
- <param name="self">The IEnvelope to use with this method</param>
- <param name="shiftX">The amount to translate along the X axis.</param>
- <param name="shiftY">The amount to translate along the Y axis.</param>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.Translate(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.Coordinate)">
- <summary>
- Translates the envelope by given amounts up to the minimum dimension between
- the envelope and the shift coordinate. (e.g., A 2D envelope will only
- be shifted in 2 dimensions because it has no Z, while a 2D coordinate
- can only shift a cube based on the X and Y positions, leaving the Z
- info alone.
- </summary>
- <param name="self">The IEnvelope to use with this method</param>
- <param name="shift"></param>
- <remarks>This does nothing to a "NULL" envelope</remarks>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.Overlaps(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IEnvelope)">
- <summary>
- Overlaps is defined as intersecting, but having some part of each envelope that is also outside
- of the other envelope. Therefore it would amount to saying "Intersects And Not Contains And Not Within"
- </summary>
- <param name="self">The IEnvelope to use with this method</param>
- <param name="other"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.Overlaps(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.Coordinate)">
- <summary>
- For a point, or coordinate, this is a degenerate case and
- will simply perform an intersection test instead.
- </summary>
- <param name="self">The IEnvelope to use with this method</param>
- <param name="p"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.Overlaps(DotSpatial.Topology.IEnvelope,System.Double,System.Double)">
- <summary>
- For a point, or coordinate, this is a degenerate case and
- will simply perform an intersection test instead.
- </summary>
- <param name="self">The IEnvelope to use with this method</param>
- <param name="x">The x coordinate</param>
- <param name="y">The y coordinate</param>
- <returns>Boolean, true if the specified point intersects with this envelope</returns>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.Contains(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.Coordinate)">
- <summary>
- Evaluates if the specified coordinate is found inside or on the border.
- This will test all the dimensions shared by both the envelope and point.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.Contains(DotSpatial.Topology.IEnvelope,System.Double,System.Double)">
- <summary>
- Returns <c>true</c> if the given point lies in or on the envelope.
- </summary>
- <param name="self">The IEnvelope that this is for</param>
- <param name="x"> the x-coordinate of the point which this <c>Envelope</c> is
- being checked for containing.</param>
- <param name="y"> the y-coordinate of the point which this <c>Envelope</c> is
- being checked for containing.</param>
- <returns><c>true</c> if <c>(x, y)</c> lies in the interior or
- on the boundary of this <c>Envelope</c>.</returns>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.Contains(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IEnvelope)">
- <summary>
- Returns true if the other <c>IEnvelope</c> is within this envelope in all dimensions.
- If the boundaries touch, this will true. This will test the number of
- dimensions that is the smallest dimensionality. This will ignore M values.
- </summary>
- <param name="envelope">The first envelope (this object when extending)</param>
- <param name="other"> the <c>Envelope</c> which this <c>Envelope</c> is being checked for containing.</param>
- <returns><c>true</c> if <c>other</c> is contained in this <c>Envelope</c>.</returns>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.Distance(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IEnvelope)">
- <summary>
- Computes the distance between this and another Envelope.
- The distance between overlapping Envelopes is 0. Otherwise, the
- distance is the hyper Euclidean distance between the closest points.
- M values are ignored, but every dimension is considered, up to
- the minimum of the number of ordinates between the two envelopes.
- Use Distance with a dimension specified to force 2D distance calculations.
- </summary>
- <param name="self">The first envelope (this object when extending)</param>
- <param name="other">The other envelope to calculate the distance to</param>
- <returns>The distance between this and another <c>Envelope</c>.</returns>
- <remarks>Null cases produce a distance of -1</remarks>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.Distance2D(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IEnvelope)">
- <summary>
- Sometimes only two dimensions are important, and the full dimensionality is not needed.
- The Distance 2D performs the same distance check but only in X and Y, regardless
- of how many dimensions exist in the envelopes. Both envelopes should have at least
- two ordinates however. (Not a criteria of the Distance() method)
- </summary>
- <param name="self">The first envelope (this object when extending)</param>
- <param name="other">The other envelope to calculate the distance to</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.Distance3D(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IEnvelope)">
- <summary>
- Calculates the distance specifically in 3D, even if the envelope
- exists in higher dimensions. The NumOrdinates of both envelopes
- must be at least 3.
- </summary>
- <param name="self">The first envelope (this object when extending)</param>
- <param name="other">The other envelope to calculate the distance to</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.ExpandBy(DotSpatial.Topology.IEnvelope,System.Double)">
- <summary>
- Uses the specified distance to expand the envelope by that amount in all dimensions.
- </summary>
- <param name="self"></param>
- <param name="distance"></param>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.ExpandBy(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.Coordinate)">
- <summary>
- Uses the dimensions of the specified distances coordinate to
- specify the amount to expand the envelopes in each ordinate.
- This will apply the method to the minimum dimensions between
- the distances coordinate and this envelope. (eg. A 2D
- distances coordinate will not affect Z values in the envelope).
- </summary>
- <param name="self">The first envelope (this object when extending)</param>
- <param name="distances">The distance to expand the envelope.</param>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.ExpandBy(DotSpatial.Topology.IEnvelope,System.Double,System.Double)">
- <summary>
- Expands this envelope by a given distance in all directions.
- Both positive and negative distances are supported.
- </summary>
- <param name="self">The first envelope (this object when extending)</param>
- <param name="deltaX">The distance to expand the envelope along the the X axis.</param>
- <param name="deltaY">The distance to expand the envelope along the the Y axis.</param>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.ExpandToInclude(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.Coordinate)">
- <summary>
- Enlarges the boundary of the <c>Envelope</c> so that it contains (p).
- Does nothing if (p) is already on or within the boundaries.
- This executes to the minimum of dimensions between p and this envelope.
- </summary>
- <param name="self">The first envelope (this object when extending)</param>
- <param name="p">The Coordinate.</param>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.ExpandToInclude(DotSpatial.Topology.IEnvelope,System.Double,System.Double)">
- <summary>
- Enlarges the boundary of the <c>Envelope</c> so that it contains
- (x, y). Does nothing if (x, y) is already on or within the boundaries.
- </summary>
- <param name="self">The first envelope (this object when extending)</param>
- <param name="x">The value to lower the minimum x to or to raise the maximum x to.</param>
- <param name="y">The value to lower the minimum y to or to raise the maximum y to.</param>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.ExpandToInclude(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IEnvelope)">
- <summary>
- Enlarges the boundary of the <c>Envelope</c> so that it contains
- <c>other</c>. Does nothing if <c>other</c> is wholly on or
- within the boundaries.
- </summary>
- <param name="self">The first envelope (this object when extending)</param>
- <param name="other">the <c>Envelope</c> to merge with.</param>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.Intersection(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.ILineSegment)">
- <summary>
- Returns the intersection of the specified segment with this bounding box. If there is no intersection,
- then this returns null. If the intersection is a corner, then the LineSegment will be degenerate,
- that is both the coordinates will be the same. Otherwise, the segment will be returned so that the
- direction is the same as the original segment.
- </summary>
- <param name="self">The IEnvelope to use with this method</param>
- <param name="segment">The LineSegment to intersect.</param>
- <returns>An ILineSegment that is cropped to fit within the bounding box.</returns>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.Intersection(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IEnvelope)">
- <summary>
- Finds an envelope that represents the intersection between this
- envelope and the specified <c>IEnvelope</c>. The number of dimensions of the
- returned envelope is the maximum of the NumOrdinates between the two envelopes,
- since a 2D envelope will only constrain a cube in 2 dimensions, and allow the
- z bounds to remain unaltered.
- </summary>
- <param name="self">The <c>IEnvelope</c> that is being extended by this method</param>
- <param name="env">An <c>IEnvelope</c> to compare against</param>
- <returns>an <c>IEnvelope</c> that bounds the intersection area</returns>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.Intersection(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IBasicGeometry)">
- <summary>
- Using an envelope intersection has some optimizations by checking against the envelope
- of the geometry. In the worst case scenario, the envelope crops the geometry, and a new geometry is created.
- This will be much faster if the envelope contains the geometries envelope, however, simply returning
- the original geometry.
- </summary>
- <param name="self">The <c>IEnvelope</c> that is being extended by this method</param>
- <param name="geom">A geometric intersection against the area of this envelope</param>
- <returns>A geometry, cropped to the space of this envelope if necessary.</returns>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.Intersects(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.Coordinate)">
- <summary>
- Check if the point <c>p</c> overlaps (lies inside) the region of this <c>Envelope</c>.
- </summary>
- <param name="self">The <c>IEnvelope</c> that is being extended by this method</param>
- <param name="p"> the <c>Coordinate</c> to be tested.</param>
- <returns><c>true</c> if the point overlaps this <c>Envelope</c>.</returns>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.Intersects(DotSpatial.Topology.IEnvelope,System.Double,System.Double)">
- <summary>
- Check if the point <c>(x, y)</c> overlaps (lies inside) the region of this <c>Envelope</c>.
- </summary>
- <param name="self">The <c>IEnvelope</c> that is being extended by this method</param>
- <param name="x"> the x-ordinate of the point.</param>
- <param name="y"> the y-ordinate of the point.</param>
- <returns><c>true</c> if the point overlaps this <c>Envelope</c>.</returns>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.Intersects(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.ILineSegment)">
- <summary>
- This should only be used if the Intersection is not actually required because it uses the Intersection method
- and returns false if the return value is null.
- </summary>
- <param name="self">The <c>IEnvelope</c> that is being extended by this method</param>
- <param name="segment">The segment to be tested against this envelope.</param>
- <returns>The line segment to compare against.</returns>
- </member>
- <member name="M:DotSpatial.Topology.EnvelopeExt.Intersects(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.IEnvelope)">
- <summary>
- Tests for intersection (any overlap) between the two envelopes. In cases of unequal
- dimensions, the smaller dimension is used (e.g., if a 2D rectangle doesn't intersect
- a cube in its own plane, this would return false.)
- </summary>
- <param name="self">The <c>IEnvelope</c> that is being extended by this method</param>
- <param name="other"> the <c>Envelope</c> which this <c>Envelope</c> is
- being checked for overlapping.
- </param>
- <returns>
- <c>true</c> if the <c>Envelope</c>s overlap.
- </returns>
- </member>
- <member name="T:DotSpatial.Topology.EnumerableExt">
- <summary>
- EnumerableEM
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.EnumerableExt.CloneList``1(System.Collections.Generic.IEnumerable{``0})">
- <summary>
- cycles through any strong typed collection where the type implements ICLoneable
- and clones each member, inserting that member into the new list.
- </summary>
- <typeparam name="T">The type of the values in the list.</typeparam>
- <param name="original">The original enumerable collection of type T.</param>
- <returns>A deep copy of the list.</returns>
- </member>
- <member name="M:DotSpatial.Topology.EnumerableExt.SafeCastTo``1(System.Object)">
- <summary>
- A Generic Safe Casting method that should simply exist as part of the core framework
- </summary>
- <typeparam name="T">The type of the member to attempt to cast to.</typeparam>
- <param name="obj">The original object to attempt to System.Convert.</param>
- <returns>An output variable of type T.</returns>
- </member>
- <member name="T:DotSpatial.Topology.InsufficientDimensionsException">
- <summary>
- InsufficientDimensionsException
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.InsufficientDimensionsException.#ctor">
- <summary>
- Creates a new instance of InsufficientDimensionsException
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.InsufficientDimensionsException.#ctor(System.String)">
- <summary>
- Creates a new instance of InsufficientDimesionsException, but specifies the name of the argument,
- or a similar string like "both envelopes".
- </summary>
- <param name="argumentName">The string name of the argument to introduce in to exception message</param>
- </member>
- <member name="F:DotSpatial.Topology.FloatVector3.X">
- <summary>
- X
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.FloatVector3.Y">
- <summary>
- Y
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.FloatVector3.Z">
- <summary>
- Z
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.FloatVector3.#ctor(DotSpatial.Topology.CoordinateF)">
- <summary>
- Copies the X, Y and Z values from the CoordinateF without doing a conversion.
- </summary>
- <param name="coord">X, Y Z</param>
- </member>
- <member name="M:DotSpatial.Topology.FloatVector3.#ctor(System.Single,System.Single,System.Single)">
- <summary>
- Creates a new FloatVector3 with the specified values
- </summary>
- <param name="xValue">X</param>
- <param name="yValue">Y</param>
- <param name="zValue">Z</param>
- </member>
- <member name="M:DotSpatial.Topology.FloatVector3.#ctor(DotSpatial.Topology.Coordinate)">
- <summary>
- Uses the X, Y and Z values from the coordinate to create a new FloatVector3
- </summary>
- <param name="coord">The coordinate to obtain X, Y and Z values from</param>
- </member>
- <member name="M:DotSpatial.Topology.FloatVector3.Equals(System.Object)">
- <summary>
- tests to see if the specified object has the same X, Y and Z values
- </summary>
- <param name="obj"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.FloatVector3.GetHashCode">
- <summary>
- Not sure what I should be doing here since Int can't really contain this much info very well
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.FloatVector3.Add(DotSpatial.Topology.FloatVector3,DotSpatial.Topology.FloatVector3)">
- <summary>
- Adds all the scalar members of the the two vectors
- </summary>
- <param name="lhs">Left hand side</param>
- <param name="rhs">Right hand side</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.FloatVector3.Add(DotSpatial.Topology.FloatVector3)">
- <summary>
- Adds the specified v
- </summary>
- <param name="vector">A FloatVector3 to add to this vector</param>
- </member>
- <member name="M:DotSpatial.Topology.FloatVector3.Subtract(DotSpatial.Topology.FloatVector3,DotSpatial.Topology.FloatVector3)">
- <summary>
- Subtracts all the scalar members of the the two vectors
- </summary>
- <param name="lhs">Left hand side</param>
- <param name="rhs">Right hand side</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.FloatVector3.Subtract(DotSpatial.Topology.FloatVector3)">
- <summary>
- Subtracts the specified value
- </summary>
- <param name="vector">A FloatVector3</param>
- </member>
- <member name="M:DotSpatial.Topology.FloatVector3.CrossProduct(DotSpatial.Topology.FloatVector3,DotSpatial.Topology.FloatVector3)">
- <summary>
- Returns the Cross Product of two vectors lhs and V
- </summary>
- <param name="lhs">Vector, the first input vector</param>
- <param name="rhs">Vector, the second input vector</param>
- <returns>A FloatVector3 containing the cross product of lhs and V</returns>
- </member>
- <member name="M:DotSpatial.Topology.FloatVector3.Dot(DotSpatial.Topology.FloatVector3,DotSpatial.Topology.FloatVector3)">
- <summary>
- Multiplies all the scalar members of the the two vectors
- </summary>
- <param name="lhs">Left hand side</param>
- <param name="rhs">Right hand side</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.FloatVector3.Multiply(DotSpatial.Topology.FloatVector3,System.Single)">
- <summary>
- Multiplies the source vector by a scalar.
- </summary>
- <param name="source"></param>
- <param name="scalar"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.FloatVector3.Multiply(System.Single)">
- <summary>
- Multiplies this vector by a scalar value.
- </summary>
- <param name="scalar">The scalar to multiply by</param>
- </member>
- <member name="M:DotSpatial.Topology.FloatVector3.Normalize">
- <summary>
- Normalizes the vectors
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.FloatVector3.op_Addition(DotSpatial.Topology.FloatVector3,DotSpatial.Topology.FloatVector3)">
- <summary>
- Adds the vectors lhs and V using vector addition, which adds the corresponding components
- </summary>
- <param name="lhs">One vector to be added</param>
- <param name="rhs">A second vector to be added</param>
- <returns>The sum of the vectors</returns>
- </member>
- <member name="M:DotSpatial.Topology.FloatVector3.op_Equality(DotSpatial.Topology.FloatVector3,DotSpatial.Topology.FloatVector3)">
- <summary>
- Tests two float vectors for equality.
- </summary>
- <param name="lhs">The left hand side FloatVector3 to test.</param>
- <param name="rhs">The right hand side FloatVector3 to test.</param>
- <returns>Returns true if X, Y and Z are all equal.</returns>
- </member>
- <member name="M:DotSpatial.Topology.FloatVector3.op_Inequality(DotSpatial.Topology.FloatVector3,DotSpatial.Topology.FloatVector3)">
- <summary>
- Tests two float vectors for inequality.
- </summary>
- <param name="lhs">The left hand side FloatVector3 to test.</param>
- <param name="rhs">The right hand side FloatVector3 to test.</param>
- <returns>Returns true if any of X, Y and Z are unequal.</returns>
- </member>
- <member name="M:DotSpatial.Topology.FloatVector3.op_ExclusiveOr(DotSpatial.Topology.FloatVector3,DotSpatial.Topology.FloatVector3)">
- <summary>
- Returns the Cross Product of two vectors lhs and rhs
- </summary>
- <param name="lhs">Vector, the first input vector</param>
- <param name="rhs">Vector, the second input vector</param>
- <returns>A FloatVector3 containing the cross product of lhs and V</returns>
- </member>
- <member name="M:DotSpatial.Topology.FloatVector3.op_Division(DotSpatial.Topology.FloatVector3,DotSpatial.Topology.FloatVector3)">
- <summary>
- Divides the components of vector lhs by the respective components
- ov vector V and returns the resulting vector.
- </summary>
- <param name="lhs">FloatVector3 Dividend (Numbers to be divided)</param>
- <param name="rhs">FloatVector3 Divisor (Numbers to divide by)</param>
- <returns>A FloatVector3 quotient of lhs and V</returns>
- <remarks>To prevent divide by 0, if a 0 is in V, it will return 0 in the result</remarks>
- </member>
- <member name="M:DotSpatial.Topology.FloatVector3.op_Division(DotSpatial.Topology.FloatVector3,System.Single)">
- <summary>
- Multiplies each component of vector lhs by the Scalar value
- </summary>
- <param name="lhs">A vector representing the vector to be multiplied</param>
- <param name="scalar">Double, the scalar value to mulitiply the vector components by</param>
- <returns>A FloatVector3 representing the vector product of vector lhs and the Scalar</returns>
- </member>
- <member name="M:DotSpatial.Topology.FloatVector3.op_Multiply(DotSpatial.Topology.FloatVector3,DotSpatial.Topology.FloatVector3)">
- <summary>
- Returns the Inner Product also known as the dot product of two vectors, lhs and V
- </summary>
- <param name="lhs">The input vector</param>
- <param name="rhs">The vector to take the inner product against lhs</param>
- <returns>a Double containing the dot product of lhs and V</returns>
- </member>
- <member name="M:DotSpatial.Topology.FloatVector3.op_Multiply(System.Single,DotSpatial.Topology.FloatVector3)">
- <summary>
- Multiplies the vectors lhs and V using vector multiplication,
- which adds the corresponding components
- </summary>
- <param name="scalar">A scalar to multpy to the vector</param>
- <param name="rhs">A vector to be multiplied</param>
- <returns>The scalar product for the vectors</returns>
- </member>
- <member name="M:DotSpatial.Topology.FloatVector3.op_Multiply(DotSpatial.Topology.FloatVector3,System.Single)">
- <summary>
- Multiplies each component of vector lhs by the Scalar value
- </summary>
- <param name="lhs">A vector representing the vector to be multiplied</param>
- <param name="scalar">Double, the scalar value to mulitiply the vector components by</param>
- <returns>A FloatVector3 representing the vector product of vector lhs and the Scalar</returns>
- </member>
- <member name="M:DotSpatial.Topology.FloatVector3.op_Subtraction(DotSpatial.Topology.FloatVector3,DotSpatial.Topology.FloatVector3)">
- <summary>
- Subtracts FloatVector3 V from FloatVector3 lhs
- </summary>
- <param name="lhs">A FloatVector3 to subtract from</param>
- <param name="rhs">A FloatVector3 to subtract</param>
- <returns>The FloatVector3 difference lhs - V</returns>
- </member>
- <member name="P:DotSpatial.Topology.FloatVector3.Length">
- <summary>
- Gets the length of the vector
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.FloatVector3.LengthSq">
- <summary>
- Gets the square of length of this vector
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Utilities.WkbReader">
- <summary>
- Converts a Well-Known Binary byte data to a <c>Geometry</c>.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WkbReader.#ctor">
- <summary>
- Initialize reader with a standard <c>GeometryFactory</c>.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WkbReader.#ctor(DotSpatial.Topology.IGeometryFactory)">
- <summary>
- Initialize reader with the given <c>GeometryFactory</c>.
- </summary>
- <param name="factory"></param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WkbReader.Read(System.Byte[])">
- <summary>
-
- </summary>
- <param name="data"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WkbReader.Read(System.IO.Stream)">
- <summary>
-
- </summary>
- <param name="stream"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WkbReader.Read(System.IO.BinaryReader)">
- <summary>
-
- </summary>
- <param name="reader"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WkbReader.ReadByteOrder(System.IO.BinaryReader)">
- <summary>
-
- </summary>
- <param name="reader"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WkbReader.ReadCoordinate(System.IO.BinaryReader)">
- <summary>
-
- </summary>
- <param name="reader"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WkbReader.ReadRing(System.IO.BinaryReader)">
- <summary>
-
- </summary>
- <param name="reader"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WkbReader.ReadPoint(System.IO.BinaryReader)">
- <summary>
-
- </summary>
- <param name="reader"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WkbReader.ReadLineString(System.IO.BinaryReader)">
- <summary>
-
- </summary>
- <param name="reader"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WkbReader.ReadPolygon(System.IO.BinaryReader)">
- <summary>
-
- </summary>
- <param name="reader"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WkbReader.ReadMultiPoint(System.IO.BinaryReader)">
- <summary>
-
- </summary>
- <param name="reader"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WkbReader.ReadMultiLineString(System.IO.BinaryReader)">
- <summary>
-
- </summary>
- <param name="reader"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WkbReader.ReadMultiPolygon(System.IO.BinaryReader)">
- <summary>
-
- </summary>
- <param name="reader"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WkbReader.ReadGeometryCollection(System.IO.BinaryReader)">
- <summary>
-
- </summary>
- <param name="reader"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.Utilities.WkbReader.Factory">
- <summary>
- <c>Geometry</c> builder.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Geometry">
- <summary>
- Basic implementation of <c>Geometry</c>.
- <c>Clone</c> returns a deep copy of the object.
- <para>
- Binary Predicates:
- Because it is not clear at this time what semantics for spatial
- analysis methods involving <c>GeometryCollection</c>s would be useful,
- <c>GeometryCollection</c>s are not supported as arguments to binary
- predicates (other than <c>ConvexHull</c>) or the <c>Relate</c> method.
- </para>
- <para>
- Set-Theoretic Methods:
- The spatial analysis methods will
- return the most specific class possible to represent the result. If the
- result is homogeneous, a <c>Point</c>, <c>LineString</c>, or
- <c>Polygon</c> will be returned if the result contains a single
- element; otherwise, a <c>MultiPoint</c>, <c>MultiLineString</c>,
- or <c>MultiPolygon</c> will be returned. If the result is
- heterogeneous a <c>GeometryCollection</c> will be returned.
- </para>
- <para>
- Representation of Computed Geometries:
- The SFS states that the result
- of a set-theoretic method is the "point-set" result of the usual
- set-theoretic definition of the operation (SFS 3.2.21.1). However, there are
- sometimes many ways of representing a point set as a <c>Geometry</c>.
- The SFS does not specify an unambiguous representation of a given point set
- returned from a spatial analysis method. One goal of NTS is to make this
- specification precise and unambiguous. NTS will use a canonical form for
- <c>Geometry</c>s returned from spatial analysis methods. The canonical
- form is a <c>Geometry</c> which is simple and noded:
- Simple means that the Geometry returned will be simple according to
- the NTS definition of <c>IsSimple</c>.
- Noded applies only to overlays involving <c>LineString</c>s. It
- means that all intersection points on <c>LineString</c>s will be
- present as endpoints of <c>LineString</c>s in the result.
- This definition implies that non-simple geometries which are arguments to
- spatial analysis methods must be subjected to a line-dissolve process to
- ensure that the results are simple.
- </para>
- <para>
- Constructed Points And The Precision Model:
- The results computed by the set-theoretic methods may
- contain constructed points which are not present in the input <c>Geometry</c>
- s. These new points arise from intersections between line segments in the
- edges of the input <c>Geometry</c>s. In the general case it is not
- possible to represent constructed points exactly. This is due to the fact
- that the coordinates of an intersection point may contain twice as many bits
- of precision as the coordinates of the input line segments. In order to
- represent these constructed points explicitly, NTS must truncate them to fit
- the <c>PrecisionModel</c>.
- Unfortunately, truncating coordinates moves them slightly. Line segments
- which would not be coincident in the exact result may become coincident in
- the truncated representation. This in turn leads to "topology collapses" --
- situations where a computed element has a lower dimension than it would in
- the exact result.
- When NTS detects topology collapses during the computation of spatial
- analysis methods, it will throw an exception. If possible the exception will
- report the location of the collapse.
- </para>
- </summary>
- <remarks>
- <see cref="M:System.Object.Equals(System.Object)"/> and <see cref="M:System.Object.GetHashCode"/> are not overridden, so that when two
- topologically equal Geometries are added to Collections and Dictionaries, they
- remain distinct. This behaviour is desired in many cases.
- </remarks>
- </member>
- <member name="T:DotSpatial.Topology.IGeometry">
- <summary>
- This has the methods and properties associated with any topology
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.IRelate">
- <summary>
- Supports the specific methods associated with relationships, usually
- returning a boolean style test if the relationship is true.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.IRelate.Contains(DotSpatial.Topology.IGeometry)">
- Contains
- <summary>
- Returns true if other.within(this) returns true.
- </summary>
- <param name="geom">The Geometry with which to compare this Geometry.</param>
- <returns>true if this Geometry contains other.</returns>
- </member>
- <member name="M:DotSpatial.Topology.IRelate.CoveredBy(DotSpatial.Topology.IGeometry)">
- CoveredBy
- <summary>
- Returns <c>true</c> if this geometry is covered by the specified geometry.
- <para>
- The <c>CoveredBy</c> predicate has the following equivalent definitions:
- - Every point of this geometry is a point of the other geometry.
- - The DE-9IM Intersection Matrix for the two geometries is <c>T*F**F***</c> or <c>*TF**F***</c> or <c>**FT*F***</c> or <c>**F*TF***</c>.
- - <c>g.Covers(this)</c> (<c>CoveredBy</c> is the inverse of <c>Covers</c>).
- </para>
- Notice the difference between <c>CoveredBy</c> and <c>Within</c>: <c>CoveredBy</c> is a more inclusive relation.
- </summary>
- <param name="geom">The <c>Geometry</c> with which to compare this <c>Geometry</c></param>.
- <returns><c>true</c> if this <c>Geometry</c> is covered by <paramref name="geom" />.</returns>
- </member>
- <member name="M:DotSpatial.Topology.IRelate.Covers(DotSpatial.Topology.IGeometry)">
- Covers
- <summary>
- Returns <c>true</c> if this geometry covers the specified geometry.
- <para>
- The <c>Covers</c> predicate has the following equivalent definitions:
- - Every point of the other geometry is a point of this geometry.
- - The DE-9IM Intersection Matrix for the two geometries is <c>T*****FF*</c> or <c>*T****FF*</c> or <c>***T**FF*</c> or <c>****T*FF*</c>.
- - <c>g.CoveredBy(this)</c> (<c>Covers</c> is the inverse of <c>CoveredBy</c>).
- </para>
- Notice the difference between <c>Covers</c> and <c>Contains</c>: <c>Covers</c> is a more inclusive relation.
- In particular, unlike <c>Contains</c> it does not distinguish between
- points in the boundary and in the interior of geometries.
- </summary>
- <remarks>
- For most situations, <c>Covers</c> should be used in preference to <c>Contains</c>.
- As an added benefit, <c>Covers</c> is more amenable to optimization, and hence should be more performant.
- </remarks>
- <param name="geom">The <c>Geometry</c> with which to compare this <c>Geometry</c></param>
- <returns><c>true</c> if this <c>Geometry</c> covers <paramref name="geom" /></returns>
- </member>
- <member name="M:DotSpatial.Topology.IRelate.Crosses(DotSpatial.Topology.IGeometry)">
- Crosses
- <summary>
- Returns <c>true</c> if the DE-9IM intersection matrix for the two
- <c>Geometry</c>s is
- T*T****** (for a point and a curve, a point and an area or a line
- and an area) 0******** (for two curves).
- </summary>
- <param name="geom">The <c>Geometry</c> with which to compare this <c>Geometry</c>.</param>
- <returns>
- <c>true</c> if the two <c>Geometry</c>s cross.
- For this function to return <c>true</c>, the <c>Geometry</c>
- s must be a point and a curve; a point and a surface; two curves; or a
- curve and a surface.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.IRelate.Disjoint(DotSpatial.Topology.IGeometry)">
- Disjoint
- <summary>
- Returns <c>true</c> if the DE-9IM intersection matrix for the two
- <c>Geometry</c>s is DE-9IM: FF*FF****.
- </summary>
- <param name="geom">The <c>Geometry</c> with which to compare this <c>Geometry</c>.</param>
- <returns><c>true</c> if the two <c>Geometry</c>s are disjoint.</returns>
- </member>
- <member name="M:DotSpatial.Topology.IRelate.Intersects(DotSpatial.Topology.IGeometry)">
- Intersects
- <summary>
- Returns <c>true</c> if <c>disjoint</c> returns false.
- </summary>
- <param name="geom">The <c>Geometry</c> with which to compare this <c>Geometry</c>.</param>
- <returns><c>true</c> if the two <c>Geometry</c>s intersect.</returns>
- </member>
- <member name="M:DotSpatial.Topology.IRelate.Overlaps(DotSpatial.Topology.IGeometry)">
- Overlaps
- <summary>
- Returns <c>true</c> if the DE-9IM intersection matrix for the two
- <c>Geometry</c>s is
- T*T***T** (for two points or two surfaces)
- 1*T***T** (for two curves).
- </summary>
- <param name="geom">The <c>Geometry</c> with which to compare this <c>Geometry</c>.</param>
- <returns>
- <c>true</c> if the two <c>Geometry</c>s overlap.
- For this function to return <c>true</c>, the <c>Geometry</c>
- s must be two points, two curves or two surfaces.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.IRelate.Relate(DotSpatial.Topology.IGeometry,System.String)">
- Relate
- <summary>
- Returns <c>true</c> if the elements in the DE-9IM intersection
- matrix for the two <c>Geometry</c>s match the elements in <c>intersectionPattern</c>
- , which may be:
- 0
- 1
- 2
- T ( = 0, 1 or 2)
- F ( = -1)
- * ( = -1, 0, 1 or 2)
- For more information on the DE-9IM, see the OpenGIS Simple Features
- Specification.
- </summary>
- <param name="geom">The <c>Geometry</c> with which to compare this <c>Geometry</c>.</param>
- <param name="intersectionPattern">The pattern against which to check the intersection matrix for the two <c>Geometry</c>s.</param>
- <returns><c>true</c> if the DE-9IM intersection matrix for the two <c>Geometry</c>s match <c>intersectionPattern</c>.</returns>
- </member>
- <member name="M:DotSpatial.Topology.IRelate.Relate(DotSpatial.Topology.IGeometry)">
- <summary>
- Returns the DE-9IM intersection matrix for the two <c>Geometry</c>s.
- </summary>
- <param name="g">The <c>Geometry</c> with which to compare this <c>Geometry</c></param>
- <returns>
- A matrix describing the intersections of the interiors,
- boundaries and exteriors of the two <c>Geometry</c>s.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.IRelate.Touches(DotSpatial.Topology.IGeometry)">
- Touches
- <summary>
- Returns <c>true</c> if the DE-9IM intersection matrix for the two
- <c>Geometry</c>s is FT*******, F**T***** or F***T****.
- </summary>
- <param name="geom">The <c>Geometry</c> with which to compare this <c>Geometry</c>.</param>
- <returns>
- <c>true</c> if the two <c>Geometry</c>s touch;
- Returns false if both <c>Geometry</c>s are points.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.IRelate.Within(DotSpatial.Topology.IGeometry)">
- Within
- <summary>
- Returns <c>true</c> if the DE-9IM intersection matrix for the two
- <c>Geometry</c>s is T*F**F***.
- </summary>
- <param name="geom">The <c>Geometry</c> with which to compare this <c>Geometry</c>.</param>
- <returns><c>true</c> if this <c>Geometry</c> is within <c>other</c>.</returns>
- </member>
- <member name="T:DotSpatial.Topology.IOverlay">
- <summary>
- An interface for supporting the functions specific to geometry overlay opperations
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.IOverlay.Difference(DotSpatial.Topology.IGeometry)">
- Difference
- <summary>
- Returns a <c>Geometry</c> representing the points making up this
- <c>Geometry</c> that do not make up <c>other</c>. This method
- returns the closure of the resultant <c>Geometry</c>.
- </summary>
- <param name="geom">The <c>Geometry</c> with which to compute the difference.</param>
- <returns>The point set difference of this <c>Geometry</c> with <c>other</c>.</returns>
- </member>
- <member name="M:DotSpatial.Topology.IOverlay.Intersection(DotSpatial.Topology.IGeometry)">
- Intersection
- <summary>
- Returns a <c>Geometry</c> representing the points shared by this
- <c>Geometry</c> and <c>other</c>.
- </summary>
- <param name="geom">The <c>Geometry</c> with which to compute the intersection.</param>
- <returns>The points common to the two <c>Geometry</c>s.</returns>
- </member>
- <member name="M:DotSpatial.Topology.IOverlay.SymmetricDifference(DotSpatial.Topology.IGeometry)">
- SymmetricDifference
- <summary>
- Returns a set combining the points in this <c>Geometry</c> not in
- <c>other</c>, and the points in <c>other</c> not in this
- <c>Geometry</c>. This method returns the closure of the resultant
- <c>Geometry</c>.
- </summary>
- <param name="geom">The <c>Geometry</c> with which to compute the symmetric difference.</param>
- <returns>The point set symmetric difference of this <c>Geometry</c> with <c>other</c>.</returns>
- </member>
- <member name="M:DotSpatial.Topology.IOverlay.Union(DotSpatial.Topology.IGeometry)">
- Union
- <summary>
- Returns a <c>Geometry</c> representing all the points in this <c>Geometry</c>
- and <c>other</c>.
- </summary>
- <param name="geom">The <c>Geometry</c> with which to compute the union.</param>
- <returns>A set combining the points of this <c>Geometry</c> and the points of <c>other</c>.</returns>
- </member>
- <member name="T:DotSpatial.Topology.IBasicGeometry">
- <summary>
- This is a lightweight version of the components that represent the strictly data related
- commands.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.IBasicGeometry.GetBasicGeometryN(System.Int32)">
- <summary>
- This returns the index'th BasicGeometry where index is between 0 and NumGeometries - 1.
- If there is only one geometry, this will return this object.
- </summary>
- <param name="index">An integer index between 0 and NumGeometries - 1 specifying the basic geometry</param>
- <returns>A BasicGeometry representing only the specific sub-geometry specified</returns>
- </member>
- <member name="M:DotSpatial.Topology.IBasicGeometry.ExportToGml">
- <summary>
- Returns the string that is the valid GML markup string.
- </summary>
- <returns>A String containing the valid GML</returns>
- </member>
- <member name="M:DotSpatial.Topology.IBasicGeometry.ToBinary">
- <summary>
- Returns the Well-known Binary representation of this <c>Geometry</c>.
- For a definition of the Well-known Binary format, see the OpenGIS Simple
- Features Specification.
- </summary>
- <returns>The Well-known Binary representation of this <c>Geometry</c>.</returns>
- </member>
- <member name="M:DotSpatial.Topology.IBasicGeometry.ToString">
- ToString
- <summary>
- Returns the Well-known Text representation of this <c>Geometry</c>.
- For a definition of the Well-known Text format, see the OpenGIS Simple
- Features Specification.
- </summary>
- <returns>
- The Well-known Text representation of this <c>Geometry</c>.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.IBasicGeometry.UpdateEnvelope">
- <summary>
- Forces the cached envelope to be re-calculated using the coordinates.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.IBasicGeometry.Coordinates">
- Coordinates
- <summary>
- Using an IList guarantees that we can access indexed coordinates, but the actual implementation
- can be either in the form of an array or a list.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.IBasicGeometry.Envelope">
- <summary>
- Returns this Geometry's bounding box. If this Geometry is the empty point,
- returns an empty Point. If the Geometry is a point, returns a non-empty Point.
- Otherwise, returns a Polygon whose points are (minx, miny), (maxx, miny),
- (maxx, maxy), (minx, maxy), (minx, miny).
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.IBasicGeometry.NumGeometries">
- NumGeometries
- <summary>
- Returns the number of Geometries in a Geometry Collection, or 1, if the geometry is not a collection
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.IBasicGeometry.NumPoints">
- NumPoints
- <summary>
- Returns the count of this geometry's vertices. The geometries contained by
- composite geometries must be geometries. That is, they must implement NumPoints.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.IBasicGeometry.GeometryType">
- <summary>
- Clarifies the subtype of geometry in string format in accordance with
- OGC convenction, but most internal identification simply uses
- the type identification.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.IBasicGeometry.FeatureType">
- <summary>
- Specifies either a Point, Line, Polygon or Empty feature type for simple flow control
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.IGeometry.Apply(DotSpatial.Topology.ICoordinateFilter)">
- <summary>
- Performs an operation with or on this <c>Geometry</c>'s
- coordinates. If you are using this method to modify the point, be sure
- to call GeometryChanged() afterwards. Notice that you cannot use this
- method to
- modify this Geometry if its underlying CoordinateSequence's Get method
- returns a copy of the Coordinate, rather than the actual Coordinate stored
- (if it even stores Coordinates at all).
- </summary>
- <param name="filter">The filter to apply to this <c>Geometry</c>'s coordinates</param>
- </member>
- <member name="M:DotSpatial.Topology.IGeometry.Apply(DotSpatial.Topology.IGeometryFilter)">
- <summary>
- Performs an operation with or on this <c>Geometry</c> and its
- subelement <c>Geometry</c>s (if any).
- Only GeometryCollections and subclasses
- have subelement Geometry's.
- </summary>
- <param name="filter">
- The filter to apply to this <c>Geometry</c> (and
- its children, if it is a <c>GeometryCollection</c>).
- </param>
- </member>
- <member name="M:DotSpatial.Topology.IGeometry.Apply(DotSpatial.Topology.IGeometryComponentFilter)">
- <summary>
- Performs an operation with or on this Geometry and its
- component Geometry's. Only GeometryCollections and
- Polygons have component Geometry's; for Polygons they are the LinearRings
- of the shell and holes.
- </summary>
- <param name="filter">The filter to apply to this <c>Geometry</c>.</param>
- </member>
- <member name="M:DotSpatial.Topology.IGeometry.Buffer(System.Double)">
- <summary>
- Returns a buffer region around this <c>Geometry</c> having the given width.
- The buffer of a Geometry is the Minkowski sum or difference of the Geometry with a disc of radius <c>distance</c>.
- </summary>
- <param name="distance">
- The width of the buffer, interpreted according to the
- <c>PrecisionModel</c> of the <c>Geometry</c>.
- </param>
- <returns>
- All points whose distance from this <c>Geometry</c>
- are less than or equal to <c>distance</c>.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.IGeometry.Buffer(System.Double,DotSpatial.Topology.BufferStyle)">
- Buffer
- <summary>
- Returns a buffer region around this <c>Geometry</c> having the given width.
- The buffer of a Geometry is the Minkowski sum or difference of the Geometry with a disc of radius <c>distance</c>.
- </summary>
- <param name="distance">
- The width of the buffer, interpreted according to the
- <c>PrecisionModel</c> of the <c>Geometry</c>.
- </param>
- <param name="endCapStyle">Cap Style to use for compute buffer.</param>
- <returns>
- All points whose distance from this <c>Geometry</c>
- are less than or equal to <c>distance</c>.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.IGeometry.Buffer(System.Double,System.Int32)">
- Buffer
- <summary>
- Returns a buffer region around this <c>Geometry</c> having the given
- width and with a specified number of segments used to approximate curves.
- The buffer of a Geometry is the Minkowski sum of the Geometry with
- a disc of radius <c>distance</c>. Curves in the buffer polygon are
- approximated with line segments. This method allows specifying the
- accuracy of that approximation.
- </summary>
- <param name="distance">
- The width of the buffer, interpreted according to the
- <c>PrecisionModel</c> of the <c>Geometry</c>.
- </param>
- <param name="quadrantSegments">The number of segments to use to approximate a quadrant of a circle.</param>
- <returns>
- All points whose distance from this <c>Geometry</c>
- are less than or equal to <c>distance</c>.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.IGeometry.Buffer(System.Double,System.Int32,DotSpatial.Topology.BufferStyle)">
- Buffer
- <summary>
- Returns a buffer region around this <c>Geometry</c> having the given
- width and with a specified number of segments used to approximate curves.
- The buffer of a Geometry is the Minkowski sum of the Geometry with
- a disc of radius <c>distance</c>. Curves in the buffer polygon are
- approximated with line segments. This method allows specifying the
- accuracy of that approximation.
- </summary>
- <param name="distance">
- The width of the buffer, interpreted according to the
- <c>PrecisionModel</c> of the <c>Geometry</c>.
- </param>
- <param name="quadrantSegments">The number of segments to use to approximate a quadrant of a circle.</param>
- <param name="endCapStyle">Cap Style to use for compute buffer.</param>
- <returns>
- All points whose distance from this <c>Geometry</c>
- are less than or equal to <c>distance</c>.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.IGeometry.ClearEnvelope">
- <summary>
- Clears any cached envelopes
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.IGeometry.ClosestPoint(DotSpatial.Topology.Coordinate)">
- <summary>
- Given the specified test point, this returns the closest point in this geometry.
- </summary>
- <param name="testPoint"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.IGeometry.ConvexHull">
- ConvexHull
- <summary>
- Returns the smallest convex Polygon that contains all the points in the Geometry. This obviously applies only to Geometry s which contain 3 or more points.
- </summary>
- <returns>the minimum-area convex polygon containing this Geometry's points.</returns>
- </member>
- <member name="M:DotSpatial.Topology.IGeometry.CompareToSameClass(System.Object)">
- <summary>
- Returns whether this <c>Geometry</c> is greater than, equal to,
- or less than another <c>Geometry</c> having the same class.
- </summary>
- <param name="o">A <c>Geometry</c> having the same class as this <c>Geometry</c>.</param>
- <returns>
- A positive number, 0, or a negative number, depending on whether
- this object is greater than, equal to, or less than <c>o</c>, as
- defined in "Normal Form For Geometry" in the NTS Technical
- Specifications.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.IGeometry.Distance(DotSpatial.Topology.IGeometry)">
- Distance
- <summary>
- Returns the minimum distance between this <c>Geometry</c>
- and the <c>Geometry</c> g.
- </summary>
- <param name="geom">The <c>Geometry</c> from which to compute the distance.</param>
- </member>
- <member name="M:DotSpatial.Topology.IGeometry.Equals(DotSpatial.Topology.IGeometry)">
- Equals
- <summary>
- Returns <c>true</c> if the DE-9IM intersection matrix for the two
- <c>Geometry</c>s is T*F**FFF*.
- </summary>
- <param name="geom">The <c>Geometry</c> with which to compare this <c>Geometry</c>.</param>
- <returns><c>true</c> if the two <c>Geometry</c>s are equal.</returns>
- </member>
- <member name="M:DotSpatial.Topology.IGeometry.EqualsExact(DotSpatial.Topology.IGeometry,System.Double)">
- EqualsExact
- <summary>
- Returns true if the two <c>Geometry</c>s are exactly equal,
- up to a specified tolerance.
- Two Geometries are exactly within a tolerance equal iff:
- they have the same class,
- they have the same values of Coordinates,
- within the given tolerance distance, in their internal
- Coordinate lists, in exactly the same order.
- If this and the other <c>Geometry</c>s are
- composites and any children are not <c>Geometry</c>s, returns
- false.
- </summary>
- <param name="geom">The <c>Geometry</c> with which to compare this <c>Geometry</c></param>
- <param name="tolerance">Distance at or below which two Coordinates will be considered equal.</param>
- <returns>
- <c>true</c> if this and the other <c>Geometry</c>
- are of the same class and have equal internal data.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.IGeometry.EqualsExact(DotSpatial.Topology.IGeometry)">
- EqualsExact
- <summary>
- Returns true if the two <c>Geometry</c>s are exactly equal.
- Two Geometries are exactly equal iff:
- they have the same class,
- they have the same values of Coordinates in their internal
- Coordinate lists, in exactly the same order.
- If this and the other <c>Geometry</c>s are
- composites and any children are not <c>Geometry</c>s, returns
- false.
- This provides a stricter test of equality than <c>equals</c>.
- </summary>
- <param name="geom">The <c>Geometry</c> with which to compare this <c>Geometry</c>.</param>
- <returns>
- <c>true</c> if this and the other <c>Geometry</c>
- are of the same class and have equal internal data.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.IGeometry.GeometryChangedAction">
- <summary>
- Notifies this Geometry that its Coordinates have been changed by an external
- party. When GeometryChanged is called, this method will be called for
- this Geometry and its component Geometries.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.IGeometry.GeometryChanged">
- <summary>
- Notifies this Geometry that its Coordinates have been changed by an external
- party (using a CoordinateFilter, for example). The Geometry will flush
- and/or update any information it has cached (such as its Envelope).
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.IGeometry.GetGeometryN(System.Int32)">
- GetGeometryN
- <summary>
- Returns an element Geometry from a GeometryCollection,
- or <code>this</code>, if the geometry is not a collection.
- </summary>
- <param name="n">The index of the geometry element.</param>
- <returns>The n'th geometry contained in this geometry.</returns>
- </member>
- <member name="M:DotSpatial.Topology.IGeometry.IsWithinDistance(DotSpatial.Topology.IGeometry,System.Double)">
- IsWithinDistance
- <summary>
- Tests whether the distance from this <c>Geometry</c>
- to another is less than or equal to a specified value.
- </summary>
- <param name="geom">the Geometry to check the distance to.</param>
- <param name="distance">the distance value to compare.</param>
- <returns><c>true</c> if the geometries are less than <c>distance</c> apart.</returns>
- </member>
- <member name="M:DotSpatial.Topology.IGeometry.Normalize">
- Normalize
- <summary>
- Converts this <c>Geometry</c> to normal form (or
- canonical form ). Normal form is a unique representation for <c>Geometry</c>
- s. It can be used to test whether two <c>Geometry</c>s are equal
- in a way that is independent of the ordering of the coordinates within
- them. Normal form equality is a stronger condition than topological
- equality, but weaker than pointwise equality. The definitions for normal
- form use the standard lexicographical ordering for coordinates. "Sorted in
- order of coordinates" means the obvious extension of this ordering to
- sequences of coordinates.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.IGeometry.ToGmlFeature">
- <summary>
- Returns the feature representation as GML 2.1.1 XML document.
- This XML document is based on <c>Geometry.xsd</c> schema.
- NO features or XLink are implemented here!
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.IGeometry.Rotate(DotSpatial.Topology.Coordinate,System.Double)">
- <summary>
- Rotates the geometry by the given radian angle around the Origin.
- </summary>
- <param name="Origin">Coordinate the geometry gets rotated around.</param>
- <param name="radAngle">Rotation angle in radian.</param>
- </member>
- <member name="P:DotSpatial.Topology.IGeometry.Area">
- Area
- <summary>
- Returns the area of this Geometry.
- Areal Geometries have a non-zero area.
- They override this function to compute the area.
- Others return 0.0
- </summary>
- <returns>The area of the Geometry.</returns>
- </member>
- <member name="P:DotSpatial.Topology.IGeometry.Boundary">
- Boundary
- <summary>
- Returns the boundary, or the empty point if this <c>Geometry</c>
- is empty. For a discussion of this function, see the OpenGIS Simple
- Features Specification. As stated in SFS Section 2.1.13.1, "the boundary
- of a Geometry is a set of Geometries of the next lower dimension."
- </summary>
- <returns>The closure of the combinatorial boundary of this <c>Geometry</c>.</returns>
- </member>
- <member name="P:DotSpatial.Topology.IGeometry.BoundaryDimension">
- <summary>
- Returns the dimension of this <c>Geometry</c>s inherent boundary.
- </summary>
- <returns>
- The dimension of the boundary of the class implementing this
- interface, whether or not this object is the empty point. Returns
- <c>Dimension.False</c> if the boundary is the empty point.
- </returns>
- </member>
- <member name="P:DotSpatial.Topology.IGeometry.Centroid">
- Centroid
- <summary>
- Computes the centroid of this Geometry.
- The centroid is equal to the centroid of the set of component Geometries of highest
- dimension (since the lower-dimension geometries contribute zero "weight" to the centroid).
- </summary>
- <returns>A Point which is the centroid of this Geometry.</returns>
- </member>
- <member name="P:DotSpatial.Topology.IGeometry.Coordinate">
- Coordinate
- <summary>
- Returns a vertex of this Geometry
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.IGeometry.Dimension">
- Dimension
- <summary>
- Gets or sets the DotSpatial.Geometries.Dimensions of this Geometry.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.IGeometry.EnvelopeInternal">
- EnvelopeInternal
- <summary>
- Returns the interior geometry
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.IGeometry.Factory">
- Factory
- <summary>
- Gets the factory which contains the context in whcih this geometry was created
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.IGeometry.InteriorPoint">
- InteriorPoint
- <summary>
- Computes an interior point of this Geometry. An interior point is guaranteed
- to lie in the interior of the Geometry, if it possible to calculate such a point
- exactly. Otherwise, the point may lie on the boundary of the point.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.IGeometry.IsEmpty">
- IsEmpty
- <summary>
- Returns whether or not the set of points in this geometry is empty
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.IGeometry.IsRectangle">
- IsRectangle
- <summary>
- Essentially is false for anything other than a polygon, which
- does a check to see if the polygon in question is a rectangle.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.IGeometry.IsSimple">
- IsSimple
- <summary>
- Returns false if the Geometry not simple. Subclasses provide their own definition
- of "simple". If this Geometry is empty, returns true. In general, the SFS specifications
- of simplicity seem to follow the following rule: A Geometry is simple if the only
- self-intersections are at boundary points. For all empty Geometrys, IsSimple==true.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.IGeometry.IsValid">
- IsValid
- <summary>
- Tests the validity of this Geometry. Subclasses provide their own definition of "valid"
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.IGeometry.Length">
- Length
- <summary>
- Returns the length of this Geometry. Linear geometries return their length.
- Areal geometries return their perimeter. Others return 0.0
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.IGeometry.PrecisionModel">
- <summary>
- There used to be a class for precision model stuff, but for Interface purposes, this will be
- communicated as a an enumeration which can later be converted into a full fledged PrecisionModel.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.IGeometry.Srid">
- SRID
- <summary>
- Gets/Sets the ID of the Spatial Reference System used by the Geometry. NTS supports Spatial Reference
- System information in the simple way defined in the SFS. A Spatial Reference System ID (SRID) is present
- in each Geometry object. Geometry provides basic accessor operations for this field, but no others. The SRID
- is represented as an integer.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.IGeometry.UserData">
- UserData
- <summary>
- Gets/Sets the user data object for this point, if any. A simple scheme for applications to add their own custom
- data to a Geometry. An example use might be to add an object representing a Coordinate Reference System.
- Notice that user data objects are not present in geometries created by construction methods.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.#ctor">
- <summary>
- Creates a sort of default geometry object from the default geometry factory, or creates
- a new one if one doesn't exist yet.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.#ctor(DotSpatial.Topology.IGeometryFactory)">
- <summary>
-
- </summary>
- <param name="factory"></param>
- </member>
- <member name="F:DotSpatial.Topology.Geometry.SortedClasses">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Geometry.DefaultFactory">
- <summary>
- A predefined <see cref="T:DotSpatial.Topology.GeometryFactory"/> with <see cref="P:DotSpatial.Topology.Geometry.PrecisionModel"/> <c> == </c> <see cref="F:DotSpatial.Topology.PrecisionModelType.Fixed"/>.
- </summary>
- <seealso cref="P:DotSpatial.Topology.GeometryFactory.Default"/>
- <seealso cref="P:DotSpatial.Topology.GeometryFactory.Fixed"/>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.GetGeometryN(System.Int32)">
- <summary>
- Returns an element Geometry from a GeometryCollection,
- or <code>this</code>, if the geometry is not a collection.
- </summary>
- <param name="n">The index of the geometry element.</param>
- <returns>The n'th geometry contained in this geometry.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.GetBasicGeometryN(System.Int32)">
- <summary>
- This returns the index'th BasicGeometry where index is between 0 and NumGeometries - 1.
- If there is only one geometry, this will return this object.
- </summary>
- <param name="index">An integer index between 0 and NumGeometries - 1 specifying the basic geometry</param>
- <returns>A BasicGeometry representing only the specific sub-geometry specified</returns>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.Distance(DotSpatial.Topology.IGeometry)">
- <summary>
- Returns the minimum distance between this <c>Geometry</c>
- and the <c>Geometry</c> g.
- </summary>
- <param name="g">The <c>Geometry</c> from which to compute the distance.</param>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.IsWithinDistance(DotSpatial.Topology.IGeometry,System.Double)">
- <summary>
- Tests whether the distance from this <c>Geometry</c>
- to another is less than or equal to a specified value.
- </summary>
- <param name="geom">the Geometry to check the distance to.</param>
- <param name="distance">the distance value to compare.</param>
- <returns><c>true</c> if the geometries are less than <c>distance</c> apart.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.ClosestPoint(DotSpatial.Topology.Coordinate)">
- <summary>
- Given the specified test point, this returns the closest point in this geometry.
- </summary>
- <param name="testPoint"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.GeometryChanged">
- <summary>
- Notifies this Geometry that its Coordinates have been changed by an external
- party (using a CoordinateFilter, for example). The Geometry will flush
- and/or update any information it has cached (such as its Envelope).
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.GeometryChangedAction">
- <summary>
- Notifies this Geometry that its Coordinates have been changed by an external
- party. When GeometryChanged is called, this method will be called for
- this Geometry and its component Geometries.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.Disjoint(DotSpatial.Topology.IGeometry)">
- <summary>
- Returns <c>true</c> if the DE-9IM intersection matrix for the two
- <c>Geometry</c>s is FF*FF****.
- </summary>
- <param name="g">The <c>Geometry</c> with which to compare this <c>Geometry</c>.</param>
- <returns><c>true</c> if the two <c>Geometry</c>s are disjoint.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.Touches(DotSpatial.Topology.IGeometry)">
- <summary>
- Returns <c>true</c> if the DE-9IM intersection matrix for the two
- <c>Geometry</c>s is FT*******, F**T***** or F***T****.
- </summary>
- <param name="g">The <c>Geometry</c> with which to compare this <c>Geometry</c>.</param>
- <returns>
- <c>true</c> if the two <c>Geometry</c>s touch;
- Returns false if both <c>Geometry</c>s are points.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.Intersects(DotSpatial.Topology.IGeometry)">
- <summary>
- Returns <c>true</c> if <c>disjoint</c> returns false.
- </summary>
- <param name="g">The <c>Geometry</c> with which to compare this <c>Geometry</c>.</param>
- <returns><c>true</c> if the two <c>Geometry</c>s intersect.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.Crosses(DotSpatial.Topology.IGeometry)">
- <summary>
- Returns <c>true</c> if the DE-9IM intersection matrix for the two
- <c>Geometry</c>s is
- T*T****** (for a point and a curve, a point and an area or a line
- and an area) 0******** (for two curves).
- </summary>
- <param name="g">The <c>Geometry</c> with which to compare this <c>Geometry</c>.</param>
- <returns>
- <c>true</c> if the two <c>Geometry</c>s cross.
- For this function to return <c>true</c>, the <c>Geometry</c>
- s must be a point and a curve; a point and a surface; two curves; or a
- curve and a surface.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.Within(DotSpatial.Topology.IGeometry)">
- <summary>
- Returns <c>true</c> if the DE-9IM intersection matrix for the two
- <c>Geometry</c>s is T*F**F***.
- </summary>
- <param name="g">The <c>Geometry</c> with which to compare this <c>Geometry</c>.</param>
- <returns><c>true</c> if this <c>Geometry</c> is within <c>other</c>.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.Overlaps(DotSpatial.Topology.IGeometry)">
- <summary>
- Returns <c>true</c> if the DE-9IM intersection matrix for the two
- <c>Geometry</c>s is
- T*T***T** (for two points or two surfaces)
- 1*T***T** (for two curves).
- </summary>
- <param name="g">The <c>Geometry</c> with which to compare this <c>Geometry</c>.</param>
- <returns>
- <c>true</c> if the two <c>Geometry</c>s overlap.
- For this function to return <c>true</c>, the <c>Geometry</c>
- s must be two points, two curves or two surfaces.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.Covers(DotSpatial.Topology.IGeometry)">
- <summary>
- Returns <c>true</c> if this geometry covers the specified geometry.
- <para>
- The <c>Covers</c> predicate has the following equivalent definitions:
- - Every point of the other geometry is a point of this geometry.
- - The DE-9IM Intersection Matrix for the two geometries is <c>T*****FF*</c> or <c>*T****FF*</c> or <c>***T**FF*</c> or <c>****T*FF*</c>.
- - <c>g.CoveredBy(this)</c> (<c>Covers</c> is the inverse of <c>CoveredBy</c>).
- </para>
- Notice the difference between <c>Covers</c> and <c>Contains</c>: <c>Covers</c> is a more inclusive relation.
- In particular, unlike <c>Contains</c> it does not distinguish between
- points in the boundary and in the interior of geometries.
- </summary>
- <remarks>
- For most situations, <c>Covers</c> should be used in preference to <c>Contains</c>.
- As an added benefit, <c>Covers</c> is more amenable to optimization, and hence should be more performant.
- </remarks>
- <param name="g">The <c>Geometry</c> with which to compare this <c>Geometry</c></param>
- <returns><c>true</c> if this <c>Geometry</c> covers <paramref name="g"/></returns>
- <seealso cref="M:DotSpatial.Topology.Geometry.Contains(DotSpatial.Topology.IGeometry)"/>
- <seealso cref="M:DotSpatial.Topology.Geometry.CoveredBy(DotSpatial.Topology.IGeometry)"/>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.CoveredBy(DotSpatial.Topology.IGeometry)">
- <summary>
- Returns <c>true</c> if this geometry is covered by the specified geometry.
- <para>
- The <c>CoveredBy</c> predicate has the following equivalent definitions:
- - Every point of this geometry is a point of the other geometry.
- - The DE-9IM Intersection Matrix for the two geometries is <c>T*F**F***</c> or <c>*TF**F***</c> or <c>**FT*F***</c> or <c>**F*TF***</c>.
- - <c>g.Covers(this)</c> (<c>CoveredBy</c> is the inverse of <c>Covers</c>).
- </para>
- Notice the difference between <c>CoveredBy</c> and <c>Within</c>: <c>CoveredBy</c> is a more inclusive relation.
- </summary>
- <param name="g">The <c>Geometry</c> with which to compare this <c>Geometry</c></param>.
- <returns><c>true</c> if this <c>Geometry</c> is covered by <paramref name="g"/>.</returns>
- <seealso cref="M:DotSpatial.Topology.Geometry.Within(DotSpatial.Topology.IGeometry)"/>
- <seealso cref="M:DotSpatial.Topology.Geometry.Covers(DotSpatial.Topology.IGeometry)"/>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.Relate(DotSpatial.Topology.IGeometry,System.String)">
- <summary>
- Returns <c>true</c> if the elements in the DE-9IM intersection
- matrix for the two <c>Geometry</c>s match the elements in <c>intersectionPattern</c>
- , which may be:
- 0
- 1
- 2
- T ( = 0, 1 or 2)
- F ( = -1)
- * ( = -1, 0, 1 or 2)
- For more information on the DE-9IM, see the OpenGIS Simple Features
- Specification.
- </summary>
- <param name="g">The <c>Geometry</c> with which to compare this <c>Geometry</c>.</param>
- <param name="intersectionPattern">The pattern against which to check the intersection matrix for the two <c>Geometry</c>s.</param>
- <returns><c>true</c> if the DE-9IM intersection matrix for the two <c>Geometry</c>s match <c>intersectionPattern</c>.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.Relate(DotSpatial.Topology.IGeometry)">
- <summary>
- Returns the DE-9IM intersection matrix for the two <c>Geometry</c>s.
- </summary>
- <param name="g">The <c>Geometry</c> with which to compare this <c>Geometry</c></param>
- <returns>
- A matrix describing the intersections of the interiors,
- boundaries and exteriors of the two <c>Geometry</c>s.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.Equals(DotSpatial.Topology.IGeometry)">
- <summary>
- Returns <c>true</c> if the DE-9IM intersection matrix for the two
- <c>Geometry</c>s is T*F**FFF*.
- </summary>
- <param name="g">The <c>Geometry</c> with which to compare this <c>Geometry</c>.</param>
- <returns><c>true</c> if the two <c>Geometry</c>s are equal.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.ToString">
- <summary>
- Returns the Well-known Text representation of this <c>Geometry</c>.
- For a definition of the Well-known Text format, see the OpenGIS Simple
- Features Specification.
- </summary>
- <returns>
- The Well-known Text representation of this <c>Geometry</c>.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.ToBinary">
- <summary>
- Returns the Well-known Binary representation of this <c>Geometry</c>.
- For a definition of the Well-known Binary format, see the OpenGIS Simple
- Features Specification.
- </summary>
- <returns>The Well-known Binary representation of this <c>Geometry</c>.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.ToGmlFeature">
- <summary>
- Returns the feature representation as GML 2.1.1 XML document.
- This XML document is based on <c>Geometry.xsd</c> schema.
- NO features or XLink are implemented here!
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.ExportToGml">
- <summary>
- Returns a GML string for this geometry
- </summary>
- <returns>A String with the GML</returns>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.ConvexHull">
- <summary>
- Returns the smallest convex <c>Polygon</c> that contains all the
- points in the <c>Geometry</c>. This obviously applies only to <c>Geometry</c>
- s which contain 3 or more points.
- </summary>
- <returns>the minimum-area convex polygon containing this <c>Geometry</c>'s points.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.Intersection(DotSpatial.Topology.IGeometry)">
- <summary>
- Returns a <c>Geometry</c> representing the points shared by this
- <c>Geometry</c> and <c>other</c>.
- </summary>
- <param name="other">The <c>Geometry</c> with which to compute the intersection.</param>
- <returns>The points common to the two <c>Geometry</c>s.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.UpdateEnvelope">
- <summary>
- Forces the cached envelope to be re-calculated using the coordinates.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.ClearEnvelope">
- <summary>
- Clears any cached envelopes
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.Union(DotSpatial.Topology.IGeometry)">
- <summary>
- Returns a <c>Geometry</c> representing all the points in this <c>Geometry</c>
- and <c>other</c>.
- </summary>
- <param name="other">The <c>Geometry</c> with which to compute the union.</param>
- <returns>A set combining the points of this <c>Geometry</c> and the points of <c>other</c>.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.Difference(DotSpatial.Topology.IGeometry)">
- <summary>
- Returns a <c>Geometry</c> representing the points making up this
- <c>Geometry</c> that do not make up <c>other</c>. This method
- returns the closure of the resultant <c>Geometry</c>.
- </summary>
- <param name="other">The <c>Geometry</c> with which to compute the difference.</param>
- <returns>The point set difference of this <c>Geometry</c> with <c>other</c>.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.SymmetricDifference(DotSpatial.Topology.IGeometry)">
- <summary>
- Returns a set combining the points in this <c>Geometry</c> not in
- <c>other</c>, and the points in <c>other</c> not in this
- <c>Geometry</c>. This method returns the closure of the resultant
- <c>Geometry</c>.
- </summary>
- <param name="other">The <c>Geometry</c> with which to compute the symmetric difference.</param>
- <returns>The point set symmetric difference of this <c>Geometry</c> with <c>other</c>.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.EqualsExact(DotSpatial.Topology.IGeometry,System.Double)">
- <summary>
- Returns true if the two <c>Geometry</c>s are exactly equal,
- up to a specified tolerance.
- Two Geometries are exactly within a tolerance equal iff:
- they have the same class,
- they have the same values of Coordinates,
- within the given tolerance distance, in their internal
- Coordinate lists, in exactly the same order.
- If this and the other <c>Geometry</c>s are
- composites and any children are not <c>Geometry</c>s, returns
- false.
- </summary>
- <param name="other">The <c>Geometry</c> with which to compare this <c>Geometry</c></param>
- <param name="tolerance">Distance at or below which two Coordinates will be considered equal.</param>
- <returns>
- <c>true</c> if this and the other <c>Geometry</c>
- are of the same class and have equal internal data.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.EqualsExact(DotSpatial.Topology.IGeometry)">
- <summary>
- Returns true if the two <c>Geometry</c>s are exactly equal.
- Two Geometries are exactly equal iff:
- they have the same class,
- they have the same values of Coordinates in their internal
- Coordinate lists, in exactly the same order.
- If this and the other <c>Geometry</c>s are
- composites and any children are not <c>Geometry</c>s, returns
- false.
- This provides a stricter test of equality than <c>equals</c>.
- </summary>
- <param name="other">The <c>Geometry</c> with which to compare this <c>Geometry</c>.</param>
- <returns>
- <c>true</c> if this and the other <c>Geometry</c>
- are of the same class and have equal internal data.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.Apply(DotSpatial.Topology.ICoordinateFilter)">
- <summary>
- Performs an operation with or on this <c>Geometry</c>'s
- coordinates. If you are using this method to modify the point, be sure
- to call GeometryChanged() afterwards. Notice that you cannot use this
- method to
- modify this Geometry if its underlying CoordinateSequence's Get method
- returns a copy of the Coordinate, rather than the actual Coordinate stored
- (if it even stores Coordinates at all).
- </summary>
- <param name="filter">The filter to apply to this <c>Geometry</c>'s coordinates</param>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.Apply(DotSpatial.Topology.IGeometryFilter)">
- <summary>
- Performs an operation with or on this <c>Geometry</c> and its
- subelement <c>Geometry</c>s (if any).
- Only GeometryCollections and subclasses
- have subelement Geometry's.
- </summary>
- <param name="filter">
- The filter to apply to this <c>Geometry</c> (and
- its children, if it is a <c>GeometryCollection</c>).
- </param>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.Apply(DotSpatial.Topology.IGeometryComponentFilter)">
- <summary>
- Performs an operation with or on this Geometry and its
- component Geometry's. Only GeometryCollections and
- Polygons have component Geometry's; for Polygons they are the LinearRings
- of the shell and holes.
- </summary>
- <param name="filter">The filter to apply to this <c>Geometry</c>.</param>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.System#ICloneable#Clone">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.Normalize">
- <summary>
- Converts this <c>Geometry</c> to normal form (or
- canonical form ). Normal form is a unique representation for <c>Geometry</c>
- s. It can be used to test whether two <c>Geometry</c>s are equal
- in a way that is independent of the ordering of the coordinates within
- them. Normal form equality is a stronger condition than topological
- equality, but weaker than pointwise equality. The definitions for normal
- form use the standard lexicographical ordering for coordinates. "Sorted in
- order of coordinates" means the obvious extension of this ordering to
- sequences of coordinates.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.CompareTo(System.Object)">
- <summary>
- Returns whether this <c>Geometry</c> is greater than, equal to,
- or less than another <c>Geometry</c>.
- If their classes are different, they are compared using the following
- ordering:
- Point (lowest),
- MultiPoint,
- LineString,
- LinearRing,
- MultiLineString,
- Polygon,
- MultiPolygon,
- GeometryCollection (highest).
- If the two <c>Geometry</c>s have the same class, their first
- elements are compared. If those are the same, the second elements are
- compared, etc.
- </summary>
- <param name="o">A <c>Geometry</c> with which to compare this <c>Geometry</c></param>
- <returns>
- A positive number, 0, or a negative number, depending on whether
- this object is greater than, equal to, or less than <c>o</c>, as
- defined in "Normal Form For Geometry" in the NTS Technical
- Specifications.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.CompareToSameClass(System.Object)">
- <summary>
- Returns whether this <c>Geometry</c> is greater than, equal to,
- or less than another <c>Geometry</c> having the same class.
- </summary>
- <param name="o">A <c>Geometry</c> having the same class as this <c>Geometry</c>.</param>
- <returns>
- A positive number, 0, or a negative number, depending on whether
- this object is greater than, equal to, or less than <c>o</c>, as
- defined in "Normal Form For Geometry" in the NTS Technical
- Specifications.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.Buffer(System.Double,System.Int32,DotSpatial.Topology.BufferStyle)">
- <summary>
- Returns a buffer region around this <c>Geometry</c> having the given
- width and with a specified number of segments used to approximate curves.
- The buffer of a Geometry is the Minkowski sum of the Geometry with
- a disc of radius <c>distance</c>. Curves in the buffer polygon are
- approximated with line segments. This method allows specifying the
- accuracy of that approximation.
- </summary>
- <param name="distance">
- The width of the buffer, interpreted according to the
- <c>PrecisionModel</c> of the <c>Geometry</c>.
- </param>
- <param name="quadrantSegments">The number of segments to use to approximate a quadrant of a circle.</param>
- <param name="endCapStyle">Cap Style to use for compute buffer.</param>
- <returns>
- All points whose distance from this <c>Geometry</c>
- are less than or equal to <c>distance</c>.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.Buffer(System.Double,System.Int32)">
- <summary>
- Returns a buffer region around this <c>Geometry</c> having the given
- width and with a specified number of segments used to approximate curves.
- The buffer of a Geometry is the Minkowski sum of the Geometry with
- a disc of radius <c>distance</c>. Curves in the buffer polygon are
- approximated with line segments. This method allows specifying the
- accuracy of that approximation.
- </summary>
- <param name="distance">
- The width of the buffer, interpreted according to the
- <c>PrecisionModel</c> of the <c>Geometry</c>.
- </param>
- <param name="quadrantSegments">The number of segments to use to approximate a quadrant of a circle.</param>
- <returns>
- All points whose distance from this <c>Geometry</c>
- are less than or equal to <c>distance</c>.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.Buffer(System.Double,DotSpatial.Topology.BufferStyle)">
- <summary>
- Returns a buffer region around this <c>Geometry</c> having the given width.
- The buffer of a Geometry is the Minkowski sum or difference of the Geometry with a disc of radius <c>distance</c>.
- </summary>
- <param name="distance">
- The width of the buffer, interpreted according to the
- <c>PrecisionModel</c> of the <c>Geometry</c>.
- </param>
- <param name="endCapStyle">Cap Style to use for compute buffer.</param>
- <returns>
- All points whose distance from this <c>Geometry</c>
- are less than or equal to <c>distance</c>.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.Buffer(System.Double)">
- <summary>
- Returns a buffer region around this <c>Geometry</c> having the given width.
- The buffer of a Geometry is the Minkowski sum or difference of the Geometry with a disc of radius <c>distance</c>.
- </summary>
- <param name="distance">
- The width of the buffer, interpreted according to the
- <c>PrecisionModel</c> of the <c>Geometry</c>.
- </param>
- <returns>
- All points whose distance from this <c>Geometry</c>
- are less than or equal to <c>distance</c>.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.Contains(DotSpatial.Topology.IGeometry)">
- <summary>
- Returns <c>true</c> if <c>other.within(this)</c> returns <c>true</c>.
- </summary>
- <param name="geom">The <c>Geometry</c> with which to compare this <c>Geometry</c>.</param>
- <returns><c>true</c> if this <c>Geometry</c> contains <c>other</c>.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.Rotate(DotSpatial.Topology.Coordinate,System.Double)">
- <summary>
- Rotates the geometry by the given radian angle around the Origin.
- </summary>
- <param name="Origin">Coordinate the geometry gets rotated around.</param>
- <param name="radAngle">Rotation angle in radian.</param>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.FromBasicGeometry(DotSpatial.Topology.IBasicGeometry)">
- <summary>
- This is convenient for casting troublesome basic geometries into fully fledged geometries
- without having to parse them each time. It uses the constructors, and effectively the default factory.
- </summary>
- <param name="geom"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.HasNonEmptyElements(DotSpatial.Topology.IGeometry[])">
- <summary>
- Returns true if the array contains any non-empty <c>Geometry</c>s.
- </summary>
- <param name="geometries"> an array of <c>Geometry</c>s; no elements may be <c>null</c></param>
- <returns>
- <c>true</c> if any of the <c>Geometry</c>s
- <c>IsEmpty</c> methods return <c>false</c>.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.HasNullElements(System.Collections.Generic.IEnumerable{DotSpatial.Topology.IBasicGeometry})">
- <summary>
- Returns true if the array contains any <c>null</c> elements.
- </summary>
- <param name="array"> an array to validate.</param>
- <returns><c>true</c> if any of <c>array</c>s elements are <c>null</c>.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.ToText">
- <summary>
- Returns the Well-known Text representation of this <c>Geometry</c>.
- For a definition of the Well-known Text format, see the OpenGIS Simple
- Features Specification.
- </summary>
- <returns>
- The Well-known Text representation of this <c>Geometry</c>.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.OnCopy(DotSpatial.Topology.Geometry)">
- <summary>
- Allows each geometry to control any custom behavior that cannot be solved with MemberwiseClone.
- The Coordinates of the geometry are already duplicated.
- </summary>
- <param name="copy"></param>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.IsEquivalentClass(DotSpatial.Topology.IGeometry)">
- <summary>
- Returns whether the two <c>Geometry</c>s are equal, from the point
- of view of the <c>EqualsExact</c> method. Called by <c>EqualsExact</c>
- . In general, two <c>Geometry</c> classes are considered to be
- "equivalent" only if they are the same class. An exception is <c>LineString</c>
- , which is considered to be equivalent to its subclasses.
- </summary>
- <param name="other">The <c>Geometry</c> with which to compare this <c>Geometry</c> for equality.</param>
- <returns>
- <c>true</c> if the classes of the two <c>Geometry</c>
- s are considered to be equal by the <c>equalsExact</c> method.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.CheckNotGeometryCollection(DotSpatial.Topology.IGeometry)">
- <summary>
- Throws an exception if <c>g</c>'s class is <c>GeometryCollection</c>.
- (Its subclasses do not trigger an exception).
- </summary>
- <param name="g">
- The <c>Geometry</c> to check;
- throws ArgumentException if <c>g</c> is a <c>GeometryCollection</c>
- but not one of its subclasses.
- </param>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.ComputeEnvelopeInternal">
- <summary>
- Returns the minimum and maximum x and y values in this <c>Geometry</c>
- , or a null <c>Envelope</c> if this <c>Geometry</c> is empty.
- Unlike <c>EnvelopeInternal</c>, this method calculates the <c>Envelope</c>
- each time it is called; <c>EnvelopeInternal</c> caches the result
- of this method.
- </summary>
- <returns>
- This <c>Geometry</c>s bounding box; if the <c>Geometry</c>
- is empty, <c>Envelope.IsNull</c> will return <c>true</c>.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.Compare(System.Collections.ArrayList,System.Collections.ArrayList)">
- <summary>
- Returns the first non-zero result of <c>CompareTo</c> encountered as
- the two <c>Collection</c>s are iterated over. If, by the time one of
- the iterations is complete, no non-zero result has been encountered,
- returns 0 if the other iteration is also complete. If <c>b</c>
- completes before <c>a</c>, a positive number is returned; if a
- before b, a negative number.
- </summary>
- <param name="a">The left hand side ArrayList to compare.</param>
- <param name="b">The right hand side ArrayList to compare.</param>
- <returns>The first non-zero <c>compareTo</c> result, if any; otherwise, zero.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.Equal(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,System.Double)">
- <summary>
-
- </summary>
- <param name="a"></param>
- <param name="b"></param>
- <param name="tolerance"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.RotateCoordinateRad(DotSpatial.Topology.Coordinate,System.Double@,System.Double@,System.Double)">
- <summary>
- Rotates the given coordinate by the given radian angle around the Origin.
- </summary>
- <param name="Origin">Coordinate the geometry gets rotated around.</param>
- <param name="CoordX">X-value of the coordinate that gets rotated.</param>
- <param name="CoordY">Y-value of the coordinate that gets rotated.</param>
- <param name="RadAngle">Rotation angle in radian.</param>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.CreatePointFromInternalCoord(DotSpatial.Topology.Coordinate,DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="coord"></param>
- <param name="exemplar"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.Intersects(DotSpatial.Topology.IEnvelope)">
- <summary>
- Tests the specified IEnvelope for an intersection with this Geometry
- </summary>
- <param name="env">The IEnvelope to test</param>
- <returns>True if the envelope intersects this geometry</returns>
- </member>
- <member name="M:DotSpatial.Topology.Geometry.Intersects(System.Double,System.Double)">
- <summary>
- Tests the specified location to see if it intersects with this geometry
- </summary>
- <param name="x">The double X coordinate to test</param>
- <param name="y">The double Y coordinate to test</param>
- <returns>Boolean, true if the specified coordinates intersect this geometry</returns>
- </member>
- <member name="P:DotSpatial.Topology.Geometry.EnvelopeAsGeometry">
- <summary>
- Returns this <c>Geometry</c>s bounding box. If this <c>Geometry</c>
- is the empty point, returns an empty <c>Point</c>. If the <c>Geometry</c>
- is a point, returns a non-empty <c>Point</c>. Otherwise, returns a
- <c>Polygon</c> whose points are (minx, miny), (maxx, miny), (maxx,
- maxy), (minx, maxy), (minx, miny).
- </summary>
- <returns>
- An empty <c>Point</c> (for empty <c>Geometry</c>s), a
- <c>Point</c> (for <c>Point</c>s) or a <c>Polygon</c>
- (in all other cases).
- </returns>
- </member>
- <member name="P:DotSpatial.Topology.Geometry.ClassSortIndex">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Geometry.Factory">
- <summary>
- Gets the factory which contains the context in which this point was created.
- </summary>
- <returns>The factory for this point.</returns>
- </member>
- <member name="P:DotSpatial.Topology.Geometry.UserData">
- <summary>
- Gets/Sets the user data object for this point, if any.
- A simple scheme for applications to add their own custom data to a Geometry.
- An example use might be to add an object representing a Coordinate Reference System.
- notice that user data objects are not present in geometries created by
- construction methods.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Geometry.Srid">
- <summary>
- Gets/Sets the ID of the Spatial Reference System used by the <c>Geometry</c>.
- NTS supports Spatial Reference System information in the simple way
- defined in the SFS. A Spatial Reference System ID (SRID) is present in
- each <c>Geometry</c> object. <c>Geometry</c> provides basic
- accessor operations for this field, but no others. The SRID is represented
- as an integer.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Geometry.GeometryType">
- <summary>
- Clarifies which subtype of geometry we are working with
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Geometry.PrecisionModel">
- <summary>
- Returns the <c>PrecisionModel</c> used by the <c>Geometry</c>.
- </summary>
- <returns>
- the specification of the grid of allowable points, for this
- <c>Geometry</c> and all other <c>Geometry</c>s.
- </returns>
- </member>
- <member name="P:DotSpatial.Topology.Geometry.Coordinate">
- <summary>
- Returns a vertex of this <c>Geometry</c>.
- </summary>
- <returns>
- a Coordinate which is a vertex of this <c>Geometry</c>.
- Returns <c>null</c> if this Geometry is empty.
- </returns>
- </member>
- <member name="P:DotSpatial.Topology.Geometry.Coordinates">
- <summary>
- Returns this <c>Geometry</c> s vertices. If you modify the coordinates
- in this array, be sure to call GeometryChanged afterwards.
- The <c>Geometry</c>s contained by composite <c>Geometry</c>s
- must be Geometry's; that is, they must implement <c>Coordinates</c>.
- </summary>
- <returns>The vertices of this <c>Geometry</c>.</returns>
- </member>
- <member name="P:DotSpatial.Topology.Geometry.NumPoints">
- <summary>
- Returns the count of this <c>Geometry</c>s vertices. The <c>Geometry</c>
- s contained by composite <c>Geometry</c>s must be
- Geometry's; that is, they must implement <c>NumPoints</c>.
- </summary>
- <returns>The number of vertices in this <c>Geometry</c>.</returns>
- </member>
- <member name="P:DotSpatial.Topology.Geometry.NumGeometries">
- <summary>
- Returns the number of Geometryes in a GeometryCollection,
- or 1, if the geometry is not a collection.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Geometry.IsSimple">
- <summary>
- Returns false if the <c>Geometry</c> not simple.
- Subclasses provide their own definition of "simple". If
- this <c>Geometry</c> is empty, returns <c>true</c>.
- In general, the SFS specifications of simplicity seem to follow the
- following rule:
- A Geometry is simple if the only self-intersections are at boundary points.
- For all empty <c>Geometry</c>s, <c>IsSimple==true</c>.
- </summary>
- <returns>
- <c>false</c> if this <c>Geometry</c> has any points of
- self-tangency, self-intersection or other anomalous points.
- </returns>
- </member>
- <member name="P:DotSpatial.Topology.Geometry.IsValid">
- <summary>
- Tests the validity of this <c>Geometry</c>.
- Subclasses provide their own definition of "valid".
- </summary>
- <returns><c>true</c> if this <c>Geometry</c> is valid.</returns>
- </member>
- <member name="P:DotSpatial.Topology.Geometry.IsEmpty">
- <summary>
- Returns whether or not the set of points in this <c>Geometry</c> is empty.
- </summary>
- <returns><c>true</c> if this <c>Geometry</c> equals the empty point.</returns>
- </member>
- <member name="P:DotSpatial.Topology.Geometry.Area">
- <summary>
- Returns the area of this <c>Geometry</c>.
- Areal Geometries have a non-zero area.
- They override this function to compute the area.
- Others return 0.0
- </summary>
- <returns>The area of the Geometry.</returns>
- </member>
- <member name="P:DotSpatial.Topology.Geometry.Length">
- <summary>
- Returns the length of this <c>Geometry</c>.
- Linear geometries return their length.
- Areal geometries return their perimeter.
- They override this function to compute the length.
- Others return 0.0
- </summary>
- <returns>The length of the Geometry.</returns>
- </member>
- <member name="P:DotSpatial.Topology.Geometry.InteriorPoint">
- <summary>
- Computes an interior point of this <c>Geometry</c>.
- An interior point is guaranteed to lie in the interior of the Geometry,
- if it possible to calculate such a point exactly. Otherwise,
- the point may lie on the boundary of the point.
- </summary>
- <returns>A <c>Point</c> which is in the interior of this Geometry.</returns>
- </member>
- <member name="P:DotSpatial.Topology.Geometry.Dimension">
- <summary>
- Returns the dimension of this <c>Geometry</c>.
- </summary>
- <returns>
- The dimension of the class implementing this interface, whether
- or not this object is the empty point.
- </returns>
- </member>
- <member name="P:DotSpatial.Topology.Geometry.BoundaryDimension">
- <summary>
- Returns the dimension of this <c>Geometry</c>s inherent boundary.
- </summary>
- <returns>
- The dimension of the boundary of the class implementing this
- interface, whether or not this object is the empty point. Returns
- <c>Dimension.False</c> if the boundary is the empty point.
- </returns>
- </member>
- <member name="P:DotSpatial.Topology.Geometry.EnvelopeInternal">
- <summary>
- Returns the minimum and maximum x and y values in this <c>Geometry</c>
- , or a null <c>Envelope</c> if this <c>Geometry</c> is empty.
- </summary>
- <returns>
- This <c>Geometry</c>s bounding box; if the <c>Geometry</c>
- is empty, <c>Envelope.IsNull</c> will return <c>true</c>.
- </returns>
- </member>
- <member name="P:DotSpatial.Topology.Geometry.Envelope">
- <summary>
- Gets the IEnvelope that contains this geometry
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Geometry.IsRectangle">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.Geometry.Boundary">
- <summary>
- Returns the boundary, or the empty point if this <c>Geometry</c>
- is empty. For a discussion of this function, see the OpenGIS Simple
- Features Specification. As stated in SFS Section 2.1.13.1, "the boundary
- of a Geometry is a set of Geometries of the next lower dimension."
- </summary>
- <returns>The closure of the combinatorial boundary of this <c>Geometry</c>.</returns>
- </member>
- <member name="P:DotSpatial.Topology.Geometry.Centroid">
- <summary>
- Computes the centroid of this <c>Geometry</c>.
- The centroid is equal to the centroid of the set of component Geometries of highest
- dimension (since the lower-dimension geometries contribute zero "weight" to the centroid).
- </summary>
- <returns>A Point which is the centroid of this Geometry.</returns>
- </member>
- <member name="P:DotSpatial.Topology.Geometry.FeatureType">
- <summary>
- This will be overridden by the specific feature type since this is abstract
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.IGeometryComponentFilter">
- <summary>
- <c>Geometry</c> classes support the concept of applying
- an <c>IGeometryComponentFilter</c> filter to the <c>Geometry</c>.
- The filter is applied to every component of the <c>Geometry</c>
- which is itself a <c>Geometry</c>.
- (For instance, all the LinearRings in Polygons are visited.)
- An <c>IGeometryComponentFilter</c> filter can either
- record information about the <c>Geometry</c>
- or change the <c>Geometry</c> in some way.
- <c>IGeometryComponentFilter</c> is an example of the Gang-of-Four Visitor pattern.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.IGeometryComponentFilter.Filter(DotSpatial.Topology.IGeometry)">
- <summary>
- Performs an operation with or on <c>geom</c>.
- </summary>
- <param name="geom">A <c>Geometry</c> to which the filter is applied.</param>
- </member>
- <member name="T:DotSpatial.Topology.GeometryCollection">
- <summary>
- Basic implementation of <c>GeometryCollection</c>.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.IGeometryCollection">
- <summary>
- Specific topology functions for Mutigeometry code
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.IGeometryCollection.Count">
- <summary>
- Returns the number of geometries contained by this <see cref="T:DotSpatial.Topology.IGeometryCollection"/>.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.IGeometryCollection.Item(System.Int32)">
- <summary>
- Returns the iTh <see cref="T:DotSpatial.Topology.IGeometry"/> element in the collection.
- </summary>
- <param name="i"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.IGeometryCollection.IsHomogeneous">
- <summary>
- Return <c>true</c> if all features in collection are of the same type.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.IGeometryCollection.Geometries">
- <summary>
- Gets a System.Array of all the geometries in this collection
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.GeometryCollection.Empty">
- <summary>
- Represents an empty <c>GeometryCollection</c>.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.GeometryCollection._geometries">
- <summary>
- Internal representation of this <c>GeometryCollection</c>.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometryCollection.#ctor(DotSpatial.Topology.IGeometry[])">
- <summary>
-
- </summary>
- <param name="inGeometries">
- The <c>Geometry</c>s for this <c>GeometryCollection</c>,
- or <c>null</c> or an empty array to create the empty
- point. Elements may be empty <c>Geometry</c>s,
- but not <c>null</c>s.
- </param>
- <remarks>
- For create this <see cref="T:DotSpatial.Topology.Geometry"/> is used a standard <see cref="T:DotSpatial.Topology.GeometryFactory"/>
- with <see cref="T:DotSpatial.Topology.PrecisionModel"/> <c> == </c> <see cref="F:DotSpatial.Topology.PrecisionModelType.Floating"/>.
- </remarks>
- </member>
- <member name="M:DotSpatial.Topology.GeometryCollection.#ctor">
- <summary>
- This should only be used by derived classes because it does not actually set the geometries
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometryCollection.#ctor(DotSpatial.Topology.IGeometryFactory)">
- <summary>
- This should only be used by derived classes because it does not actually set the geometries
- </summary>
- <param name="factory">Specifies the factory that should be used when creating shapes in this multigeometry</param>
- </member>
- <member name="M:DotSpatial.Topology.GeometryCollection.#ctor(DotSpatial.Topology.IGeometry[],DotSpatial.Topology.IGeometryFactory)">
- <summary>
-
- </summary>
- <param name="inGeometries">
- The <c>Geometry</c>s for this <c>GeometryCollection</c>,
- or <c>null</c> or an empty array to create the empty
- point. Elements may be empty <c>Geometry</c>s,
- but not <c>null</c>s.
- </param>
- <param name="factory"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometryCollection.#ctor(DotSpatial.Topology.IBasicGeometry,DotSpatial.Topology.IGeometryFactory)">
- <summary>
- If the input geometry is a singular basic geometry, this will become a collection of 1 geometry.
- If the input geometry is a multi- basic geometry, this will simply ensure that each member
- is upgraded to a full geometry.
- </summary>
- <param name="inGeometry"></param>
- <param name="inFactory"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometryCollection.#ctor(System.Collections.Generic.IEnumerable{DotSpatial.Topology.IBasicGeometry},DotSpatial.Topology.IGeometryFactory)">
- <summary>
- Creates a new Geometry Collection
- </summary>
- <param name="baseGeometries"></param>
- <param name="factory"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometryCollection.ClosestPoint(DotSpatial.Topology.Coordinate)">
- <summary>
- Given the specified test point, this checks each segment, and will
- return the closest point on the specified segment.
- </summary>
- <param name="testPoint">The point to test.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometryCollection.GetGeometryN(System.Int32)">
- <summary>
-
- </summary>
- <param name="n"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometryCollection.GetBasicGeometryN(System.Int32)">
- <summary>
- This returns the index'th BasicGeometry where index is between 0 and NumGeometries - 1.
- If there is only one geometry, this will return this object.
- </summary>
- <param name="index">An integer index between 0 and NumGeometries - 1 specifying the basic geometry</param>
- <returns>A BasicGeometry representing only the specific sub-geometry specified</returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometryCollection.EqualsExact(DotSpatial.Topology.IGeometry,System.Double)">
- <summary>
-
- </summary>
- <param name="other"></param>
- <param name="tolerance"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometryCollection.Apply(DotSpatial.Topology.ICoordinateFilter)">
- <summary>
-
- </summary>
- <param name="filter"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometryCollection.Apply(DotSpatial.Topology.IGeometryFilter)">
- <summary>
-
- </summary>
- <param name="filter"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometryCollection.Apply(DotSpatial.Topology.IGeometryComponentFilter)">
- <summary>
-
- </summary>
- <param name="filter"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometryCollection.Normalize">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometryCollection.CompareToSameClass(System.Object)">
- <summary>
-
- </summary>
- <param name="o"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometryCollection.GetEnumerator">
- <summary>
- Returns a <c>GeometryCollectionEnumerator</c>:
- this IEnumerator returns the parent geometry as first element.
- In most cases is more useful the code
- <c>geometryCollectionInstance.Geometries.GetEnumerator()</c>:
- this returns an IEnumerator over geometries composing GeometryCollection.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometryCollection.OnCopy(DotSpatial.Topology.Geometry)">
- <summary>
- Handles the duplication process for geometry collections
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometryCollection.ComputeEnvelopeInternal">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometryCollection.Rotate(DotSpatial.Topology.Coordinate,System.Double)">
- <summary>
- Rotates the geometries of the GeometryCollection by the given radian angle around the Origin.
- </summary>
- <param name="Origin">Coordinate the geometries get rotated around.</param>
- <param name="radAngle">Rotation angle in radian.</param>
- </member>
- <member name="P:DotSpatial.Topology.GeometryCollection.Coordinate">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometryCollection.Coordinates">
- <summary>
- Collects all coordinates of all subgeometries into an Array.
- Notice that while changes to the coordinate objects themselves
- may modify the Geometries in place, the returned Array as such
- is only a temporary container which is not synchronized back.
- </summary>
- <returns>The collected coordinates.</returns>
- </member>
- <member name="P:DotSpatial.Topology.GeometryCollection.IsEmpty">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometryCollection.Dimension">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometryCollection.BoundaryDimension">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometryCollection.NumGeometries">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometryCollection.Geometries">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometryCollection.NumPoints">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometryCollection.GeometryType">
- <summary>
- Uses an Enumeration to clarify the type of geometry
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometryCollection.IsSimple">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometryCollection.Boundary">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometryCollection.Area">
- <summary>
- Returns the area of this <c>GeometryCollection</c>.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometryCollection.Length">
- <summary>
- Returns the length of this <c>GeometryCollection</c>.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometryCollection.IsHomogeneous">
- <summary>
- Return <c>true</c> if all features in collection are of the same type.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometryCollection.Item(System.Int32)">
- <summary>
- Returns the iTh element in the collection.
- </summary>
- <param name="i"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.GeometryCollection.Count">
- <summary>
- Returns the number of geometries contained by this <see cref="T:DotSpatial.Topology.GeometryCollection"/>.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometryCollection.Envelope">
- <summary>
- Gets the Envelope that envelops this GeometryCollection
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.GeometryCollection.Enumerator">
- <summary>
- Iterates over all <c>Geometry</c>'s in a <c>GeometryCollection</c>.
- Implements a pre-order depth-first traversal of the <c>GeometryCollection</c>
- (which may be nested). The original <c>GeometryCollection</c> is
- returned as well (as the first object), as are all sub-collections. It is
- simple to ignore the <c>GeometryCollection</c> objects if they are not
- needed.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.GeometryCollection.Enumerator._max">
- <summary>
- The number of <c>Geometry</c>s in the the <c>GeometryCollection</c>.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.GeometryCollection.Enumerator._parent">
- <summary>
- The <c>GeometryCollection</c> being iterated over.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.GeometryCollection.Enumerator._atStart">
- <summary>
- Indicates whether or not the first element (the <c>GeometryCollection</c>
- ) has been returned.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.GeometryCollection.Enumerator._index">
- <summary>
- The index of the <c>Geometry</c> that will be returned when <c>next</c>
- is called.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.GeometryCollection.Enumerator._subcollectionEnumerator">
- <summary>
- The iterator over a nested <c>GeometryCollection</c>, or <c>null</c>
- if this <c>GeometryCollectionIterator</c> is not currently iterating
- over a nested <c>GeometryCollection</c>.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometryCollection.Enumerator.#ctor(DotSpatial.Topology.IGeometryCollection)">
- <summary>
- Constructs an iterator over the given <c>GeometryCollection</c>.
- </summary>
- <param name="parent">
- The collection over which to iterate; also, the first
- element returned by the iterator.
- </param>
- </member>
- <member name="M:DotSpatial.Topology.GeometryCollection.Enumerator.MoveNext">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometryCollection.Enumerator.Reset">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometryCollection.Enumerator.Current">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.GeometryCollectionNotSupportedException">
- <summary>
- A GeometryCollectionNotSupportedException Class
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometryCollectionNotSupportedException.#ctor">
- <summary>
- Creates a new instance of GeometryCollectionNotSupportedException
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.GeometryFactory">
- <summary>
- Supplies a set of utility methods for building Geometry objects from lists
- of Coordinates.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.IGeometryFactory">
- <summary>
- Factory for Geometry stuff
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.IGeometryFactory.BuildGeometry(System.Collections.IList)">
- <summary>
- Generic constructor that parses a list and tries to form a working
- object that implements MapWindow.Interfaces.IGeometry
- </summary>
- <param name="geomList">some list of things</param>
- <returns>An object that implements DotSpatial.Geometries.IGeometry</returns>
- </member>
- <member name="M:DotSpatial.Topology.IGeometryFactory.CreatePoint(DotSpatial.Topology.Coordinate)">
- <summary>
- Method to produce a point given a coordinate
- </summary>
- <param name="coord">An object that implements DotSpatial.Geometries.ICoordinate</param>
- <returns>An object that implements DotSpatial.Geometries.IPoint</returns>
- </member>
- <member name="M:DotSpatial.Topology.IGeometryFactory.CreateMultiLineString(DotSpatial.Topology.IBasicLineString[])">
- <summary>
- Creates a new object that implements DotSpatial.Geometries.MultiLineString
- given an array of objects that implement DotSpatial.Geometries.ILineStringBase
- </summary>
- <param name="lineStrings">The Array of objects that implement DotSpatial.Geometries.IlineStringBase </param>
- <returns>A new MultiLineString that implements IMultiLineString</returns>
- </member>
- <member name="M:DotSpatial.Topology.IGeometryFactory.CreateGeometryCollection(DotSpatial.Topology.IGeometry[])">
- <summary>
- Creates an object that implements DotSpatial.Geometries.IGeometryCollection
- from an array of objects that implement DotSpatial.Geometries.IGeometry
- </summary>
- <param name="geometries">An array of objects that implement DotSpatial.Geometries.IGeometry</param>
- <returns>A new object that implements DotSpatial.Geometries.IGeometryCollection</returns>
- </member>
- <member name="M:DotSpatial.Topology.IGeometryFactory.CreateMultiPolygon(DotSpatial.Topology.IPolygon[])">
- <summary>
- Creates an object that implements DotSpatial.Geometries.IMultiPolygon from an array of
- objects that implement DotSpatial.Geometries.IPolygon
- </summary>
- <param name="polygons">An Array of objects that implement DotSpatial.Geometries.IPolygon</param>
- <returns>An object that implements DotSpatial.Geometries.IMultiPolygon</returns>
- </member>
- <member name="M:DotSpatial.Topology.IGeometryFactory.CreateLinearRing(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate})">
- <summary>
- Creates an object that implements DotSpatial.Geometries.ILinearRing from an array of DotSpatial.Geometries.ICoordinates
- </summary>
- <param name="coordinates">An array of objects that implement ICoordinate</param>
- <returns>An object that implements DotSpatial.Geometries.ILinearRing</returns>
- </member>
- <member name="M:DotSpatial.Topology.IGeometryFactory.CreateMultiPoint(System.Collections.Generic.IEnumerable{DotSpatial.Topology.ICoordinate})">
- <summary>
- Creates an object that implements DotSpatial.Geometries.IMultiPoint from an array of objects that implement DotSpatial.Geometries.ICoordinate
- </summary>
- <param name="coordinates">An array of objects that implement DotSpatial.Geometries.ICoordinate</param>
- <returns>An object that implements DotSpatial.Geometries.IMultiPoint</returns>
- </member>
- <member name="M:DotSpatial.Topology.IGeometryFactory.CreateMultiPoint(System.Collections.Generic.IEnumerable{DotSpatial.Topology.Coordinate})">
- <summary>
- Creates an object that implements DotSpatial.Geometries.IMultiPoint from an array of objects that implement DotSpatial.Geometries.ICoordinate
- </summary>
- <param name="coordinates">An array of objects that implement DotSpatial.Geometries.ICoordinate</param>
- <returns>An object that implements DotSpatial.Geometries.IMultiPoint</returns>
- </member>
- <member name="M:DotSpatial.Topology.IGeometryFactory.CreateLineString(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate})">
- <summary>
- Creates an object that implements DotSpatial.Geometries.ILineString from an array of objects that implement DotSpatial.Geometries.ICoordinate
- </summary>
- <param name="coordinates">An array of objects that implement DotSpatial.Geometries.ICoordinate</param>
- <returns>A DotSpatial.Geometries.ILineString</returns>
- </member>
- <member name="M:DotSpatial.Topology.IGeometryFactory.CreateGeometry(DotSpatial.Topology.IGeometry)">
- <summary>
- Creates an object that implements DotSpatial.Geometries.IGeometry that is a copy
- of the specified object that implements DotSpatial.Geometries.IGeometry
- </summary>
- <param name="g">An object that implements DotSpatial.Geometries.IGeometry</param>
- <returns>An copy of the original object that implements DotSpatial.Geometries.IGeometry</returns>
- </member>
- <member name="M:DotSpatial.Topology.IGeometryFactory.CreatePolygon(DotSpatial.Topology.ILinearRing,DotSpatial.Topology.ILinearRing[])">
- <summary>
- Creates an object that implements DotSpatial.Geometries.IPolygon given a specified
- DotSpatial.Geometries.ILinearRing shell and an array of
- DotSpatial.Geometries.ILinearRing that represent the holes
- </summary>
- <param name="shell">The outer perimeter of the polygon, represented by an object that implements DotSpatial.Geometries.ILinearRing</param>
- <param name="holes">The interior holes in the polygon, represented by an array of objects that implements DotSpatial.Geometries.ILinearRing</param>
- <returns>An object that implements DotSpatial.Geometries.IPolygon</returns>
- </member>
- <member name="P:DotSpatial.Topology.IGeometryFactory.Floating">
- <summary>
- Floating reference
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.IGeometryFactory.FloatingSingle">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.IGeometryFactory.Srid">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.IGeometryFactory.PrecisionModel">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.IGeometryFactory.CoordinateSequenceFactory">
- <summary>
- CoordinateSequenceFactory that can manufacture a coordinate sequence
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.GeometryFactory._default">
- <summary>
- A predefined <see cref="T:DotSpatial.Topology.GeometryFactory"/> with <see cref="P:DotSpatial.Topology.GeometryFactory.PrecisionModel"/> <c> == </c> <see cref="F:DotSpatial.Topology.PrecisionModelType.Floating"/>.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.GeometryFactory._floating">
- <summary>
- A predefined <see cref="T:DotSpatial.Topology.GeometryFactory"/> with <see cref="P:DotSpatial.Topology.GeometryFactory.PrecisionModel"/>
- <c> == </c> <see cref="F:DotSpatial.Topology.PrecisionModelType.Floating"/>.
- </summary>
- <remarks>A shortcut for <see cref="P:DotSpatial.Topology.GeometryFactory.Default"/>.</remarks>
- </member>
- <member name="F:DotSpatial.Topology.GeometryFactory._floatingSingle">
- <summary>
- A predefined <see cref="T:DotSpatial.Topology.GeometryFactory"/> with <see cref="P:DotSpatial.Topology.GeometryFactory.PrecisionModel"/>
- <c> == </c> <see cref="F:DotSpatial.Topology.PrecisionModelType.FloatingSingle"/>.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.GeometryFactory._fixed">
- <summary>
- A predefined <see cref="T:DotSpatial.Topology.GeometryFactory"/> with <see cref="P:DotSpatial.Topology.GeometryFactory.PrecisionModel"/>
- <c> == </c> <see cref="F:DotSpatial.Topology.PrecisionModelType.Fixed"/>.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometryFactory.#ctor(DotSpatial.Topology.PrecisionModel,System.Int32,DotSpatial.Topology.ICoordinateSequenceFactory)">
- <summary>
- Constructs a GeometryFactory that generates Geometries having the given
- PrecisionModel, spatial-reference ID, and CoordinateSequence implementation.
- </summary>
- <param name="precisionModel"></param>
- <param name="srid"></param>
- <param name="coordinateSequenceFactory"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometryFactory.#ctor(DotSpatial.Topology.IGeometryFactory)">
- <summary>
- Constructs a GeometryFactory object from any valid IGeometryFactory interface
- </summary>
- <param name="gf"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometryFactory.#ctor(DotSpatial.Topology.IGeometryFactory,DotSpatial.Topology.ICoordinateSequenceFactory)">
- <summary>
- Constructs a GeometryFactory pertaining to a specific _coordinateSequenceFactory
- using any valid IGeometryFactory and ICoordinateSequenceFactory interface
- </summary>
- <param name="gf">An IGeometryFactory Interface</param>
- <param name="coordinateSequenceFactory">An ICoordianteSequenceFactory interface</param>
- </member>
- <member name="M:DotSpatial.Topology.GeometryFactory.#ctor(DotSpatial.Topology.ICoordinateSequenceFactory)">
- <summary>
- Constructs a GeometryFactory that generates Geometries having the given
- CoordinateSequence implementation, a double-precision floating PrecisionModel and a
- spatial-reference ID of 0.
- </summary>
- <param name="coordinateSequenceFactory"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometryFactory.#ctor(DotSpatial.Topology.PrecisionModel)">
- <summary>
- Constructs a GeometryFactory that generates Geometries having the given
- {PrecisionModel} and the default CoordinateSequence
- implementation.
- </summary>
- <param name="precisionModel">The PrecisionModel to use.</param>
- </member>
- <member name="M:DotSpatial.Topology.GeometryFactory.#ctor(DotSpatial.Topology.PrecisionModel,System.Int32)">
- <summary>
- Constructs a GeometryFactory that generates Geometries having the given
- <c>PrecisionModel</c> and spatial-reference ID, and the default CoordinateSequence
- implementation.
- </summary>
- <param name="precisionModel">The PrecisionModel to use.</param>
- <param name="srid">The SRID to use.</param>
- </member>
- <member name="M:DotSpatial.Topology.GeometryFactory.#ctor">
- <summary>
- Constructs a GeometryFactory that generates Geometries having a floating
- PrecisionModel and a spatial-reference ID of 0.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometryFactory.CreatePoint(DotSpatial.Topology.Coordinate)">
- <summary>
- Creates a Point using the given Coordinate; a null Coordinate will create
- an empty Geometry.
- </summary>
- <param name="coordinate"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometryFactory.CreateMultiLineString(DotSpatial.Topology.IBasicLineString[])">
- <summary>
- Creates a <c>MultiLineString</c> using the given <c>LineStrings</c>; a null or empty
- array will create an empty MultiLineString.
- </summary>
- <param name="lineStrings">LineStrings, each of which may be empty but not null-</param>
- </member>
- <member name="M:DotSpatial.Topology.GeometryFactory.CreateGeometryCollection(DotSpatial.Topology.IGeometry[])">
- <summary>
- Creates a <c>GeometryCollection</c> using the given <c>Geometries</c>; a null or empty
- array will create an empty GeometryCollection.
- </summary>
- <param name="geometries">Geometries, each of which may be empty but not null.</param>
- </member>
- <member name="M:DotSpatial.Topology.GeometryFactory.CreateMultiPolygon(DotSpatial.Topology.IPolygon[])">
- <summary>
- Creates a <c>MultiPolygon</c> using the given <c>Polygons</c>; a null or empty array
- will create an empty Polygon. The polygons must conform to the
- assertions specified in the <see href="http://www.opengis.org/techno/specs.htm"/> OpenGIS Simple Features
- Specification for SQL.
- </summary>
- <param name="polygons">Polygons, each of which may be empty but not null.</param>
- </member>
- <member name="M:DotSpatial.Topology.GeometryFactory.CreateLinearRing(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate})">
- <summary>
- Creates a <c>LinearRing</c> using the given <c>Coordinates</c>; a null or empty array will
- create an empty LinearRing. The points must form a closed and simple
- linestring. Consecutive points must not be equal.
- </summary>
- <param name="coordinates">An array without null elements, or an empty array, or null.</param>
- </member>
- <member name="M:DotSpatial.Topology.GeometryFactory.CreateMultiPoint(System.Collections.Generic.IEnumerable{DotSpatial.Topology.Coordinate})">
- <summary>
- Creates a MultiPoint using the given Points; a null or empty array will
- create an empty MultiPoint.
- </summary>
- <param name="point">An array without null elements, or an empty array, or null.</param>
- </member>
- <member name="M:DotSpatial.Topology.GeometryFactory.CreateMultiPoint(System.Collections.Generic.IEnumerable{DotSpatial.Topology.ICoordinate})">
- <summary>
- Creates an object that implements DotSpatial.Geometries.IMultiPoint from an array of objects that implement DotSpatial.Geometries.ICoordinate
- </summary>
- <param name="coordinates">An array of objects that implement DotSpatial.Geometries.ICoordinate</param>
- <returns>An object that implements DotSpatial.Geometries.IMultiPoint</returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometryFactory.CreatePolygon(DotSpatial.Topology.ILinearRing,DotSpatial.Topology.ILinearRing[])">
- <summary>
- Constructs a <c>Polygon</c> with the given exterior boundary and
- interior boundaries.
- </summary>
- <param name="shell">
- The outer boundary of the new <c>Polygon</c>, or
- <c>null</c> or an empty <c>LinearRing</c> if
- the empty point is to be created.
- </param>
- <param name="holes">
- The inner boundaries of the new <c>Polygon</c>, or
- <c>null</c> or empty <c>LinearRing</c> s if
- the empty point is to be created.
- </param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometryFactory.BuildGeometry(System.Collections.IList)">
- <summary>
- Build an appropriate <c>Geometry</c>, <c>MultiGeometry</c>, or
- <c>GeometryCollection</c> to contain the <c>Geometry</c>s in
- it.
- <example>
- If <c>geomList</c> contains a single <c>Polygon</c>,
- the <c>Polygon</c> is returned.
- If <c>geomList</c> contains several <c>Polygon</c>s, a
- <c>MultiPolygon</c> is returned.
- If <c>geomList</c> contains some <c>Polygon</c>s and
- some <c>LineString</c>s, a <c>GeometryCollection</c> is
- returned.
- If <c>geomList</c> is empty, an empty <c>GeometryCollection</c>
- is returned.
- Notice that this method does not "flatten" Geometries in the input, and hence if
- any MultiGeometries are contained in the input a GeometryCollection containing
- them will be returned.
- </example>
- </summary>
- <param name="geomList">The <c>Geometry</c>s to combine.</param>
- <returns>A <c>Geometry</c> of the "smallest", "most type-specific" class that can contain the elements of <c>geomList</c>.</returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometryFactory.CreateLineString(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate})">
- <summary>
- Creates a LineString using the given Coordinates; a null or empty array will
- create an empty LineString. Consecutive points must not be equal.
- </summary>
- <param name="coordinates">An array without null elements, or an empty array, or null.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometryFactory.CreateGeometry(DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="g"></param>
- <returns>
- A clone of g based on a CoordinateSequence created by this
- GeometryFactory's CoordinateSequenceFactory.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometryFactory.CreatePointFromInternalCoord(DotSpatial.Topology.Coordinate,DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="coord"></param>
- <param name="exemplar"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometryFactory.ToPointArray(System.Collections.IList)">
- <summary>
- Converts the <c>List</c> to an array.
- </summary>
- <param name="points">The <c>List</c> of Points to convert.</param>
- <returns>The <c>List</c> in array format.</returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometryFactory.ToGeometryArray(System.Collections.IList)">
- <summary>
- Converts the <c>List</c> to an array.
- </summary>
- <param name="geometries">The list of <c>Geometry's</c> to convert.</param>
- <returns>The <c>List</c> in array format.</returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometryFactory.ToLinearRingArray(System.Collections.IList)">
- <summary>
- Converts the <c>List</c> to an array.
- </summary>
- <param name="linearRings">The <c>List</c> of LinearRings to convert.</param>
- <returns>The <c>List</c> in array format.</returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometryFactory.ToLineStringArray(System.Collections.IList)">
- <summary>
- Converts the <c>List</c> to an array.
- </summary>
- <param name="lineStrings">The <c>List</c> of LineStrings to convert.</param>
- <returns>The <c>List</c> in array format.</returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometryFactory.ToPolygonArray(System.Collections.IList)">
- <summary>
- Converts the <c>List</c> to an array.
- </summary>
- <param name="polygons">The <c>List</c> of Polygons to convert.</param>
- <returns>The <c>List</c> in array format.</returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometryFactory.ToMultiPolygonArray(System.Collections.IList)">
- <summary>
- Converts the <c>List</c> to an array.
- </summary>
- <param name="multiPolygons">The <c>List</c> of MultiPolygons to convert.</param>
- <returns>The <c>List</c> in array format.</returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometryFactory.ToMultiLineStringArray(System.Collections.IList)">
- <summary>
- Converts the <c>List</c> to an array.
- </summary>
- <param name="multiLineStrings">The <c>List</c> of MultiLineStrings to convert.</param>
- <returns>The <c>List</c> in array format.</returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometryFactory.ToMultiPointArray(System.Collections.IList)">
- <summary>
- Converts the <c>List</c> to an array.
- </summary>
- <param name="multiPoints">The <c>List</c> of MultiPoints to convert.</param>
- <returns>The <c>List</c> in array format.</returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometryFactory.ToGeometry(DotSpatial.Topology.IEnvelope)">
- <summary>
- If the <c>Envelope</c> is a null <c>Envelope</c>, returns an
- empty <c>Point</c>. If the <c>Envelope</c> is a point, returns
- a non-empty <c>Point</c>. If the <c>Envelope</c> is a
- rectangle, returns a <c>Polygon</c> whose points are (minx, miny),
- (maxx, miny), (maxx, maxy), (minx, maxy), (minx, miny).
- </summary>
- <param name="envelope">The <c>Envelope</c> to convert to a <c>Geometry</c>.</param>
- <returns>
- An empty <c>Point</c> (for null <c>Envelope</c>
- s), a <c>Point</c> (when min x = max x and min y = max y) or a
- <c>Polygon</c> (in all other cases)
- throws a <c>TopologyException</c> if <c>coordinates</c>
- is not a closed linestring, that is, if the first and last coordinates
- are not equal.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometryFactory.CreateMultiPoint(DotSpatial.Topology.ICoordinateSequence)">
- <summary>
- Creates a MultiPoint using the given CoordinateSequence; a null or empty CoordinateSequence will
- create an empty MultiPoint.
- </summary>
- <param name="coordinates">A CoordinateSequence possibly empty, or null.</param>
- </member>
- <member name="M:DotSpatial.Topology.GeometryFactory.GetDefaultCoordinateSequenceFactory">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.GeometryFactory.Default">
- <summary>
- A default IGeometryFactory.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometryFactory.Fixed">
- <summary>
- Returns the Fixed geometry factory
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometryFactory.Floating">
- <summary>
- The floating IGeometryFactory
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometryFactory.FloatingSingle">
- <summary>
- A floating Single IGeometryFactory
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometryFactory.PrecisionModel">
- <summary>
- Returns the PrecisionModel that Geometries created by this factory
- will be associated with.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometryFactory.CoordinateSequenceFactory">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometryFactory.Srid">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Utilities.GeometryEditor.CoordinateOperation">
- <summary>
- A GeometryEditorOperation which modifies the coordinate list of a <c>Geometry</c>.
- Operates on Geometry subclasses which contains a single coordinate list.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Utilities.GeometryEditor.IGeometryEditorOperation">
- <summary>
- A interface which specifies an edit operation for Geometries.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Utilities.GeometryEditor">
- <summary>
- Supports creating a new <c>Geometry</c> which is a modification of an existing one.
- Geometry objects are intended to be treated as immutable.
- This class allows you to "modify" a Geometry
- by traversing it and creating a new Geometry with the same overall structure but
- possibly modified components.
- The following kinds of modifications can be made:
- <para>
- The values of the coordinates may be changed.
- Changing coordinate values may make the result Geometry invalid;
- this is not checked by the GeometryEditor.
- </para>
- <para>The coordinate lists may be changed
- (e.g. by adding or deleting coordinates).
- The modifed coordinate lists must be consistent with their original parent component
- (e.g. a LinearRing must always have at least 4 coordinates, and the first and last
- coordinate must be equal).
- </para>
- <para>Components of the original point may be deleted
- (e.g. holes may be removed from a Polygon, or LineStrings removed from a MultiLineString).
- Deletions will be propagated up the component tree appropriately.
- </para>
- Notice that all changes must be consistent with the original Geometry's structure
- (e.g. a Polygon cannot be collapsed into a LineString).
- The resulting Geometry is not checked for validity.
- If validity needs to be enforced, the new Geometry's IsValid should be checked.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Utilities.GeometryEditor._factory">
- <summary>
- The factory used to create the modified Geometry.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.GeometryEditor.#ctor">
- <summary>
- Creates a new GeometryEditor object which will create
- an edited <c>Geometry</c> with the same {GeometryFactory} as the input Geometry.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.GeometryEditor.#ctor(DotSpatial.Topology.IGeometryFactory)">
- <summary>
- Creates a new GeometryEditor object which will create
- the edited Geometry with the given GeometryFactory.
- </summary>
- <param name="factory">The GeometryFactory to create the edited Geometry with.</param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.GeometryEditor.Edit(DotSpatial.Topology.IGeometry,DotSpatial.Topology.Utilities.GeometryEditor.IGeometryEditorOperation)">
- <summary>
- Edit the input <c>Geometry</c> with the given edit operation.
- Clients will create subclasses of GeometryEditorOperation or
- CoordinateOperation to perform required modifications.
- </summary>
- <param name="geometry">The Geometry to edit.</param>
- <param name="operation">The edit operation to carry out.</param>
- <returns>A new <c>Geometry</c> which is the result of the editing.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.GeometryEditor.EditPolygon(DotSpatial.Topology.IGeometry,DotSpatial.Topology.Utilities.GeometryEditor.IGeometryEditorOperation)">
- <summary>
-
- </summary>
- <param name="polygon"></param>
- <param name="operation"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.GeometryEditor.EditGeometryCollection(DotSpatial.Topology.IGeometry,DotSpatial.Topology.Utilities.GeometryEditor.IGeometryEditorOperation)">
- <summary>
-
- </summary>
- <param name="collection"></param>
- <param name="operation"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.Utilities.GeometryEditor.CoordinateOperation">
- <summary>
- A GeometryEditorOperation which modifies the coordinate list of a <c>Geometry</c>.
- Operates on Geometry subclasses which contains a single coordinate list.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Utilities.GeometryEditor.IGeometryEditorOperation">
- <summary>
- A interface which specifies an edit operation for Geometries.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.GeometryEditor.IGeometryEditorOperation.Edit(DotSpatial.Topology.IGeometry,DotSpatial.Topology.IGeometryFactory)">
- <summary>
- Edits a Geometry by returning a new Geometry with a modification.
- The returned Geometry might be the same as the Geometry passed in.
- </summary>
- <param name="geometry">The Geometry to modify.</param>
- <param name="factory">
- The factory with which to construct the modified Geometry
- (may be different to the factory of the input point).
- </param>
- <returns>A new Geometry which is a modification of the input Geometry.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.GeometryEditor.CoordinateOperation.Edit(DotSpatial.Topology.IGeometry,DotSpatial.Topology.IGeometryFactory)">
- <summary>
-
- </summary>
- <param name="geometry"></param>
- <param name="factory"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.GeometryEditor.CoordinateOperation.Edit(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate},DotSpatial.Topology.IGeometry)">
- <summary>
- Edits the array of <c>Coordinate</c>s from a <c>Geometry</c>.
- </summary>
- <param name="coordinates">The coordinate array to operate on.</param>
- <param name="geometry">The point containing the coordinate list.</param>
- <returns>An edited coordinate array (which may be the same as the input).</returns>
- </member>
- <member name="T:DotSpatial.Topology.Utilities.GmlWriter">
- <summary>
- Writes the GML representation of the features of Topology model.
- Uses GML 2.1.1 <c>Geometry.xsd</c> schema for base for features.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.GmlWriter.Write(DotSpatial.Topology.IGeometry)">
- <summary>
- Returns an <c>XmlReader</c> with feature informations.
- Use <c>XmlDocument.Load(XmlReader)</c> for obtain a <c>XmlDocument</c> to work.
- </summary>
- <param name="geometry"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.GmlWriter.Write(DotSpatial.Topology.IGeometry,System.IO.Stream)">
- <summary>
- Writes a GML feature into a generic <c>Stream</c>, such a <c>FileStream</c> or other streams.
- </summary>
- <param name="geometry"></param>
- <param name="stream"></param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.GmlWriter.Write(DotSpatial.Topology.Coordinate,System.Xml.XmlTextWriter)">
- <summary>
-
- </summary>
- <param name="coordinate"></param>
- <param name="writer"></param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.GmlWriter.Write(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate},System.Xml.XmlTextWriter)">
- <summary>
-
- </summary>
- <param name="coordinates"></param>
- <param name="writer"></param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.GmlWriter.Write(DotSpatial.Topology.IGeometry,System.Xml.XmlTextWriter)">
- <summary>
-
- </summary>
- <param name="geometry"></param>
- <param name="writer"></param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.GmlWriter.Write(DotSpatial.Topology.IPoint,System.Xml.XmlTextWriter)">
- <summary>
-
- </summary>
- <param name="point"></param>
- <param name="writer"></param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.GmlWriter.Write(DotSpatial.Topology.LineString,System.Xml.XmlTextWriter)">
- <summary>
-
- </summary>
- <param name="lineString"></param>
- <param name="writer"></param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.GmlWriter.Write(DotSpatial.Topology.LinearRing,System.Xml.XmlTextWriter)">
- <summary>
-
- </summary>
- <param name="linearRing"></param>
- <param name="writer"></param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.GmlWriter.Write(DotSpatial.Topology.Polygon,System.Xml.XmlTextWriter)">
- <summary>
-
- </summary>
- <param name="polygon"></param>
- <param name="writer"></param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.GmlWriter.Write(DotSpatial.Topology.MultiPoint,System.Xml.XmlTextWriter)">
- <summary>
-
- </summary>
- <param name="multiPoint"></param>
- <param name="writer"></param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.GmlWriter.Write(DotSpatial.Topology.MultiLineString,System.Xml.XmlTextWriter)">
- <summary>
-
- </summary>
- <param name="multiLineString"></param>
- <param name="writer"></param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.GmlWriter.Write(DotSpatial.Topology.MultiPolygon,System.Xml.XmlTextWriter)">
- <summary>
-
- </summary>
- <param name="multiPolygon"></param>
- <param name="writer"></param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.GmlWriter.Write(DotSpatial.Topology.GeometryCollection,System.Xml.XmlTextWriter)">
- <summary>
-
- </summary>
- <param name="geometryCollection"></param>
- <param name="writer"></param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.GmlWriter.GetBytes(DotSpatial.Topology.IGeometry)">
- <summary>
- Sets corrent length for Byte Stream.
- </summary>
- <param name="geometry"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.GmlWriter.SetByteStreamLength(DotSpatial.Topology.Geometry)">
- <summary>
- Sets corrent length for Byte Stream.
- </summary>
- <param name="geometry"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.GmlWriter.SetByteStreamLength(DotSpatial.Topology.GeometryCollection)">
- <summary>
-
- </summary>
- <param name="geometryCollection"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.GmlWriter.SetByteStreamLength(DotSpatial.Topology.MultiPolygon)">
- <summary>
-
- </summary>
- <param name="multiPolygon"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.GmlWriter.SetByteStreamLength(DotSpatial.Topology.MultiLineString)">
- <summary>
-
- </summary>
- <param name="multiLineString"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.GmlWriter.SetByteStreamLength(DotSpatial.Topology.MultiPoint)">
- <summary>
-
- </summary>
- <param name="multiPoint"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.GmlWriter.SetByteStreamLength(DotSpatial.Topology.Polygon)">
- <summary>
-
- </summary>
- <param name="polygon"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.GmlWriter.SetByteStreamLength(DotSpatial.Topology.LineString)">
- <summary>
-
- </summary>
- <param name="lineString"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.GmlWriter.SetByteStreamLength(DotSpatial.Topology.Point)">
- <summary>
-
- </summary>
- <param name="point"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.Utilities.GmlWriter.NumberFormatter">
- <summary>
- Formatter for double values of coordinates
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.IBasicLineString">
- <summary>
- This is the simpler interface to implement
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.IBasicPoint">
- <summary>
- This is a BasicGeometry that contains information about a specific point.
- The easier way to do this is have the IPoint inherit the IBasicGeometry
- and the store implementations for ICoordinate.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.ICoordinate">
- <summary>
- Adds any topology functions to the basic Vector ICoordinate
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.ICoordinate.GetHashCode">
- <summary>
- Return HashCode.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.ICoordinate.M">
- <summary>
- A Measure coordinate
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.ICoordinate.NumOrdinates">
- <summary>
- A 1D coordinate only has a valid X. A 2D coordinate has X and Y, while a 3D coordinate
- has X, Y, and Z. Presumably this is open ended and could support higher coordinates,
- but this coordinate is not responsible for storing values beyond its dimension and
- may cause exceptions if a value higher than the dimension is used.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.ICoordinate.Item(System.Int32)">
- <summary>
- Gets a double value for the specified zero based ordinate.
- </summary>
- <param name="index">The zero based integer ordinate.</param>
- <returns>A double value.</returns>
- </member>
- <member name="P:DotSpatial.Topology.ICoordinate.Values">
- <summary>
- Gets or sets the values as a one dimensional array of doubles.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.ICoordinate.X">
- <summary>
- The X coordinate
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.ICoordinate.Y">
- <summary>
- The Y coordinate
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.ICoordinate.Z">
- <summary>
- The Z coordinate
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.IBasicPolygon">
- <summary>
- This supports some of the basic data-related capabilities of a polygon, but no topology functions.
- Each of these uses the specifically different nomenclature so that the parallel concepts in a
- full Polygon can return the appropriate datatype. Since Polygon will Implement IPolygonBase, it
- is the responsibility of the developer to perform the necessary casts when returning this
- set from the more complete topology classes.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.IBasicPolygon.Holes">
- <summary>
- Gets the list of Interior Rings in the form of ILineStringBase objects
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.IBasicPolygon.Shell">
- <summary>
- Gets the exterior ring of the polygon as an ILineStringBase.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.IBasicPolygon.NumHoles">
- <summary>
- Gets the count of holes or interior rings
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.ICoordinateF">
- <summary>
- ICoordinateF
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.ICoordinateF.Xf">
- <summary>
- Gets or sets the X coordinate using a single precision floating point
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.ICoordinateF.Yf">
- <summary>
- Gets or sets the Y coordinate using a single precision floating point value
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.ICoordinateF.Zf">
- <summary>
- Gets or sets the Z coordinate using a single precision floating point value
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.ICoordinateFilter">
- <summary>
- <c>Geometry</c> classes support the concept of applying a
- coordinate filter to every coordinate in the <c>Geometry</c>. A
- coordinate filter can either record information about each coordinate or
- change the coordinate in some way. Coordinate filters implement the
- interface <c>ICoordinateFilter</c>.
- <c>ICoordinateFilter</c> is an example of the Gang-of-Four Visitor pattern.
- Coordinate filters can be
- used to implement such things as coordinate transformations, centroid and
- envelope computation, and many other functions.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.ICoordinateFilter.Filter(DotSpatial.Topology.Coordinate)">
- <summary>
- Performs an operation with or on <c>coord</c>.
- </summary>
- <param name="coord"><c>Coordinate</c> to which the filter is applied.</param>
- </member>
- <member name="T:DotSpatial.Topology.IGeometryFilter">
- <summary>
- <c>GeometryCollection</c> classes support the concept of
- applying a <c>IGeometryFilter</c> to the <c>Geometry</c>.
- The filter is applied to every element <c>Geometry</c>.
- A <c>IGeometryFilter</c> can either record information about the <c>Geometry</c>
- or change the <c>Geometry</c> in some way.
- <c>IGeometryFilter</c> is an example of the Gang-of-Four Visitor pattern.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.IGeometryFilter.Filter(DotSpatial.Topology.IGeometry)">
- <summary>
- Performs an operation with or on <c>geom</c>.
- </summary>
- <param name="geom">A <c>Geometry</c> to which the filter is applied.</param>
- </member>
- <member name="T:DotSpatial.Topology.IIntersectionMatrix">
- <summary>
- A Dimensionally Extended Nine-Intersection Model (DE-9IM) matrix. This class
- can used to represent both computed DE-9IM's (like 212FF1FF2) as well as
- patterns for matching them (like T*T******).
- Methods are provided to:
- Set and query the elements of the matrix in a convenient fashion
- convert to and from the standard string representation (specified in
- SFS Section 2.1.13.2).
- Test to see if a matrix matches a given pattern string.
- For a description of the DE-9IM, see the <see href="http://www.opengis.org/techno/specs.htm"/>OpenGIS Simple Features
- Specification for SQL.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.IIntersectionMatrix.Add(DotSpatial.Topology.IIntersectionMatrix)">
- <summary>
- Adds one matrix to another.
- Addition is defined by taking the maximum dimension value of each position
- in the summand matrices.
- </summary>
- <param name="im">The matrix to add.</param>
- </member>
- <member name="M:DotSpatial.Topology.IIntersectionMatrix.Set(DotSpatial.Topology.LocationType,DotSpatial.Topology.LocationType,DotSpatial.Topology.DimensionType)">
- <summary>
- Changes the value of one of this <c>IntersectionMatrix</c>s
- elements.
- </summary>
- <param name="row">
- The row of this <c>IntersectionMatrix</c>,
- indicating the interior, boundary or exterior of the first <c>Geometry</c>
- </param>
- <param name="column">
- The column of this <c>IntersectionMatrix</c>,
- indicating the interior, boundary or exterior of the second <c>Geometry</c>
- </param>
- <param name="dimensionValue">
- The new value of the element
- </param>
- </member>
- <member name="M:DotSpatial.Topology.IIntersectionMatrix.Set(System.String)">
- <summary>
- Changes the elements of this <c>IntersectionMatrix</c> to the
- dimension symbols in <c>dimensionSymbols</c>.
- </summary>
- <param name="dimensionSymbols">
- Nine dimension symbols to which to set this <c>IntersectionMatrix</c>
- s elements. Possible values are <c>{T, F, *, 0, 1, 2}</c>
- </param>
- </member>
- <member name="M:DotSpatial.Topology.IIntersectionMatrix.SetAtLeast(DotSpatial.Topology.LocationType,DotSpatial.Topology.LocationType,DotSpatial.Topology.DimensionType)">
- <summary>
- Changes the specified element to <c>minimumDimensionValue</c> if the
- element is less.
- </summary>
- <param name="row">
- The row of this <c>IntersectionMatrix</c>
- , indicating the interior, boundary or exterior of the first <c>Geometry</c>.
- </param>
- <param name="column">
- The column of this <c>IntersectionMatrix</c>
- , indicating the interior, boundary or exterior of the second <c>Geometry</c>.
- </param>
- <param name="minimumDimensionValue">
- The dimension value with which to compare the
- element. The order of dimension values from least to greatest is
- <c>True, False, Dontcare, 0, 1, 2</c>.
- </param>
- </member>
- <member name="M:DotSpatial.Topology.IIntersectionMatrix.SetAtLeastIfValid(DotSpatial.Topology.LocationType,DotSpatial.Topology.LocationType,DotSpatial.Topology.DimensionType)">
- <summary>
- If row >= 0 and column >= 0, changes the specified element to <c>minimumDimensionValue</c>
- if the element is less. Does nothing if row is smaller to 0 or column is smaller to 0.
- </summary>
- <param name="row"></param>
- <param name="column"></param>
- <param name="minimumDimensionValue"></param>
- </member>
- <member name="M:DotSpatial.Topology.IIntersectionMatrix.SetAtLeast(System.String)">
- <summary>
- For each element in this <c>IntersectionMatrix</c>, changes the
- element to the corresponding minimum dimension symbol if the element is
- less.
- </summary>
- <param name="minimumDimensionSymbols">
- Nine dimension symbols with which to
- compare the elements of this <c>IntersectionMatrix</c>. The
- order of dimension values from least to greatest is <c>Dontcare, True, False, 0, 1, 2</c>.
- </param>
- </member>
- <member name="M:DotSpatial.Topology.IIntersectionMatrix.SetAll(DotSpatial.Topology.DimensionType)">
- <summary>
- Changes the elements of this <c>IntersectionMatrix</c> to <c>dimensionValue</c>.
- </summary>
- <param name="dimensionValue">
- The dimension value to which to set this <c>IntersectionMatrix</c>
- s elements. Possible values <c>True, False, Dontcare, 0, 1, 2}</c>.
- </param>
- </member>
- <member name="M:DotSpatial.Topology.IIntersectionMatrix.Get(DotSpatial.Topology.LocationType,DotSpatial.Topology.LocationType)">
- <summary>
- Returns the value of one of this <c>IntersectionMatrix</c>s
- elements.
- </summary>
- <param name="row">
- The row of this <c>IntersectionMatrix</c>, indicating
- the interior, boundary or exterior of the first <c>Geometry</c>.
- </param>
- <param name="column">
- The column of this <c>IntersectionMatrix</c>,
- indicating the interior, boundary or exterior of the second <c>Geometry</c>.
- </param>
- <returns>The dimension value at the given matrix position.</returns>
- </member>
- <member name="M:DotSpatial.Topology.IIntersectionMatrix.IsDisjoint">
- <summary>
- Returns <c>true</c> if this <c>IntersectionMatrix</c> is
- FF*FF****.
- </summary>
- <returns>
- <c>true</c> if the two <c>Geometry</c>s related by
- this <c>IntersectionMatrix</c> are disjoint.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.IIntersectionMatrix.IsIntersects">
- <summary>
- Returns <c>true</c> if <c>isDisjoint</c> returns false.
- </summary>
- <returns>
- <c>true</c> if the two <c>Geometry</c>s related by
- this <c>IntersectionMatrix</c> intersect.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.IIntersectionMatrix.IsTouches(DotSpatial.Topology.DimensionType,DotSpatial.Topology.DimensionType)">
- <summary>
- Returns <c>true</c> if this <c>IntersectionMatrix</c> is
- FT*******, F**T***** or F***T****.
- </summary>
- <param name="dimensionOfGeometryA">The dimension of the first <c>Geometry</c>.</param>
- <param name="dimensionOfGeometryB">The dimension of the second <c>Geometry</c>.</param>
- <returns>
- <c>true</c> if the two <c>Geometry</c>
- s related by this <c>IntersectionMatrix</c> touch; Returns false
- if both <c>Geometry</c>s are points.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.IIntersectionMatrix.IsCrosses(DotSpatial.Topology.DimensionType,DotSpatial.Topology.DimensionType)">
- <summary>
- Returns <c>true</c> if this <c>IntersectionMatrix</c> is
- T*T****** (for a point and a curve, a point and an area or a line
- and an area) 0******** (for two curves).
- </summary>
- <param name="dimensionOfGeometryA">The dimension of the first <c>Geometry</c>.</param>
- <param name="dimensionOfGeometryB">The dimension of the second <c>Geometry</c>.</param>
- <returns>
- <c>true</c> if the two <c>Geometry</c>
- s related by this <c>IntersectionMatrix</c> cross. For this
- function to return <c>true</c>, the <c>Geometry</c>s must
- be a point and a curve; a point and a surface; two curves; or a curve
- and a surface.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.IIntersectionMatrix.IsWithin">
- <summary>
- Returns <c>true</c> if this <c>IntersectionMatrix</c> is
- T*F**F***.
- </summary>
- <returns><c>true</c> if the first <c>Geometry</c> is within the second.</returns>
- </member>
- <member name="M:DotSpatial.Topology.IIntersectionMatrix.IsContains">
- <summary>
- Returns <c>true</c> if this <c>IntersectionMatrix</c> is
- T*****FF*.
- </summary>
- <returns><c>true</c> if the first <c>Geometry</c> contains the second.</returns>
- </member>
- <member name="M:DotSpatial.Topology.IIntersectionMatrix.IsCovers">
- <summary>
- Returns <c>true</c> if this <c>IntersectionMatrix</c> is <c>T*****FF*</c>
- or <c>*T****FF*</c> or <c>***T**FF*</c> or <c>****T*FF*</c>.
- </summary>
- <returns><c>true</c> if the first <c>Geometry</c> covers the second</returns>
- </member>
- <member name="M:DotSpatial.Topology.IIntersectionMatrix.IsEquals(DotSpatial.Topology.DimensionType,DotSpatial.Topology.DimensionType)">
- <summary>
- Returns <c>true</c> if this <c>IntersectionMatrix</c> is T*F**FFF*.
- </summary>
- <param name="dimensionOfGeometryA">The dimension of the first <c>Geometry</c>.</param>
- <param name="dimensionOfGeometryB">The dimension of the second <c>Geometry</c>.</param>
- <returns>
- <c>true</c> if the two <c>Geometry</c>
- s related by this <c>IntersectionMatrix</c> are equal; the
- <c>Geometry</c>s must have the same dimension for this function
- to return <c>true</c>.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.IIntersectionMatrix.IsOverlaps(DotSpatial.Topology.DimensionType,DotSpatial.Topology.DimensionType)">
- <summary>
- Returns <c>true</c> if this <c>IntersectionMatrix</c> is
- T*T***T** (for two points or two surfaces)
- 1*T***T** (for two curves).
- </summary>
- <param name="dimensionOfGeometryA">The dimension of the first <c>Geometry</c>.</param>
- <param name="dimensionOfGeometryB">The dimension of the second <c>Geometry</c>.</param>
- <returns>
- <c>true</c> if the two <c>Geometry</c>
- s related by this <c>IntersectionMatrix</c> overlap. For this
- function to return <c>true</c>, the <c>Geometry</c>s must
- be two points, two curves or two surfaces.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.IIntersectionMatrix.Matches(System.String)">
- <summary>
- Returns whether the elements of this <c>IntersectionMatrix</c>
- satisfies the required dimension symbols.
- </summary>
- <param name="requiredDimensionSymbols">
- Nine dimension symbols with which to
- compare the elements of this <c>IntersectionMatrix</c>. Possible
- values are <c>{T, F, *, 0, 1, 2}</c>.
- </param>
- <returns>
- <c>true</c> if this <c>IntersectionMatrix</c>
- matches the required dimension symbols.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.IIntersectionMatrix.Transpose">
- <summary>
- Transposes this IntersectionMatrix.
- </summary>
- <returns>This <c>IntersectionMatrix</c> as a convenience,</returns>
- </member>
- <member name="M:DotSpatial.Topology.IIntersectionMatrix.ToString">
- <summary>
- Returns a nine-character <c>String</c> representation of this <c>IntersectionMatrix</c>.
- </summary>
- <returns>
- The nine dimension symbols of this <c>IntersectionMatrix</c>
- in row-major order.
- </returns>
- </member>
- <member name="T:DotSpatial.Topology.ILinearRing">
- <summary>
- A closed, non-self intersecting Linestring
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.ILineString">
- <summary>
- This adds the basic functionality of a
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.ILineString.GetPointN(System.Int32)">
- <summary>
- Retrieves a topologically complete IPoint for the n'th coordinate in the
- 0 based index of point values.
- </summary>
- <param name="n">Integer index specifying the point to retrieve</param>
- <returns>IPoint to retrieve</returns>
- </member>
- <member name="M:DotSpatial.Topology.ILineString.Reverse">
- <summary>
- Returns an ILineString that has its coordinates completely reversed
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.ILineString.IsCoordinate(DotSpatial.Topology.Coordinate)">
- <summary>
- Returns true if the given point is a vertex of this <c>LineString</c>.
- </summary>
- <param name="pt">The <c>Coordinate</c> to check.</param>
- <returns><c>true</c> if <c>pt</c> is one of this <c>LineString</c>'s vertices.</returns>
- </member>
- <member name="P:DotSpatial.Topology.ILineString.StartPoint">
- <summary>
- Gets a topologically complete IPoint for the first coordinate
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.ILineString.EndPoint">
- <summary>
- Gets a topologically complete IPoint for the last coordinate
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.ILineString.IsClosed">
- <summary>
- If the first coordinate is the same as the final coordinate, then the
- linestring is closed.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.ILineString.IsRing">
- <summary>
- If the coordinates listed for the linestring are both closed and simple then
- they qualify as a linear ring.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.ILineString.Angle">
- <summary>
- Returns the value of the angle between the <see cref="P:DotSpatial.Topology.ILineString.StartPoint"/>
- and the <see cref="P:DotSpatial.Topology.ILineString.EndPoint"/>.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.ILineSegment">
- <summary>
- Represents a line segment defined by two <c>Coordinate</c>s.
- Provides methods to compute various geometric properties
- and relationships of line segments.
- This class is designed to be easily mutable (to the extent of
- having its contained points public).
- This supports a common pattern of reusing a single LineSegment
- object as a way of computing segment properties on the
- segments defined by arrays or lists of <c>Coordinate</c>s.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.ILineSegmentBase">
- <summary>
- This is a low-level place holder for a linestring with only two points.
- This does not inherit geometry (Use ILineString for those features).
- The Idea is that this provides just enough information to communicate
- the definition of a LineSegment.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.ILineSegmentBase.P1">
- <summary>
- The first of two coordinates that defines the segment
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.ILineSegmentBase.P0">
- <summary>
- The second of two endpoints that defines the segment
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.ILineSegment.GetCoordinate(System.Int32)">
- <summary>
- Returns an ICoordinate for the point specified by index i.
- </summary>
- <param name="i">Integer point index. 0 returns the first point, 1 returns the second.</param>
- <returns>ICoordinate</returns>
- </member>
- <member name="M:DotSpatial.Topology.ILineSegment.SetCoordinates(DotSpatial.Topology.ILineSegmentBase)">
- <summary>
- Sets the two coordinates to match the coordinates in the specified ILineSegment
- </summary>
- <param name="ls"></param>
- </member>
- <member name="M:DotSpatial.Topology.ILineSegment.SetCoordinates(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
- Sets the two coordinates of this ILineString based on the ICoordinate
- values passed.
- </summary>
- <param name="p0">An ICoordinate that specifies the startpoint of the segment</param>
- <param name="p1">An ICoordinate that specifies the location of the endpoint of the segment</param>
- </member>
- <member name="M:DotSpatial.Topology.ILineSegment.OrientationIndex(DotSpatial.Topology.ILineSegmentBase)">
- <summary>
- Determines the orientation of a LineSegment relative to this segment.
- The concept of orientation is specified as follows:
- Given two line segments A and L,
- A is to the left of a segment L if A lies wholly in the
- closed half-plane lying to the left of L
- A is to the right of a segment L if A lies wholly in the
- closed half-plane lying to the right of L
- otherwise, A has indeterminate orientation relative to L. This
- happens if A is collinear with L or if A crosses the line determined by L.
- </summary>
- <param name="seg">The <c>LineSegment</c> to compare.</param>
- <returns>
- 1 if <c>seg</c> is to the left of this segment,
- -1 if <c>seg</c> is to the right of this segment,
- 0 if <c>seg</c> has indeterminate orientation relative to this segment.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.ILineSegment.Reverse">
- <summary>
- Reverses the direction of the line segment.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.ILineSegment.Normalize">
- <summary>
- Puts the line segment into a normalized form.
- This is useful for using line segments in maps and indexes when
- topological equality rather than exact equality is desired.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.ILineSegment.Distance(DotSpatial.Topology.ILineSegmentBase)">
- <summary>
- Computes the distance between this line segment and another one.
- </summary>
- <param name="ls"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.ILineSegment.Distance(DotSpatial.Topology.Coordinate)">
- <summary>
- Computes the distance between this line segment and a point.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.ILineSegment.DistancePerpendicular(DotSpatial.Topology.Coordinate)">
- <summary>
- Computes the perpendicular distance between the (infinite) line defined
- by this line segment and a point.
- </summary>
- <param name="p"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.ILineSegment.ProjectionFactor(DotSpatial.Topology.Coordinate)">
- <summary>
- Compute the projection factor for the projection of the point p
- onto this <c>LineSegment</c>. The projection factor is the constant k
- by which the vector for this segment must be multiplied to
- equal the vector for the projection of p.
- </summary>
- <param name="p"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.ILineSegment.Project(DotSpatial.Topology.Coordinate)">
- <summary>
- Compute the projection of a point onto the line determined
- by this line segment.
- Notice that the projected point
- may lie outside the line segment. If this is the case,
- the projection factor will lie outside the range [0.0, 1.0].
- </summary>
- <param name="p"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.ILineSegment.Project(DotSpatial.Topology.ILineSegmentBase)">
- <summary>
- Project a line segment onto this line segment and return the resulting
- line segment. The returned line segment will be a subset of
- the target line line segment. This subset may be null, if
- the segments are oriented in such a way that there is no projection.
- Notice that the returned line may have zero length (i.e. the same endpoints).
- This can happen for instance if the lines are perpendicular to one another.
- </summary>
- <param name="seg">The line segment to project.</param>
- <returns>The projected line segment, or <c>null</c> if there is no overlap.</returns>
- </member>
- <member name="M:DotSpatial.Topology.ILineSegment.ClosestPoint(DotSpatial.Topology.Coordinate)">
- <summary>
- Computes the closest point on this line segment to another point.
- </summary>
- <param name="p">The point to find the closest point to.</param>
- <returns>
- A Coordinate which is the closest point on the line segment to the point p.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.ILineSegment.ClosestPoints(DotSpatial.Topology.ILineSegmentBase)">
- <summary>
- Computes the closest points on a line segment.
- </summary>
- <param name="line"></param>
- <returns>
- A pair of Coordinates which are the closest points on the line segments.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.ILineSegment.Intersection(DotSpatial.Topology.ILineSegmentBase)">
- <summary>
- Computes an intersection point between two segments, if there is one.
- There may be 0, 1 or many intersection points between two segments.
- If there are 0, null is returned. If there is 1 or more, a single one
- is returned (chosen at the discretion of the algorithm). If
- more information is required about the details of the intersection,
- the {RobustLineIntersector} class should be used.
- </summary>
- <param name="line"></param>
- <returns> An intersection point, or <c>null</c> if there is none.</returns>
- </member>
- <member name="M:DotSpatial.Topology.ILineSegment.Intersection(DotSpatial.Topology.Envelope)">
- <summary>
- Performs an intersection of this line segment with the specified envelope
- </summary>
- <param name="inEnvelope">The envelope to compare against</param>
- <returns>An ILineSegment, or null if there is no intersection.</returns>
- </member>
- <member name="M:DotSpatial.Topology.ILineSegment.Intersects(DotSpatial.Topology.Envelope)">
- <summary>
- Determines if any portion of this segment intersects the specified extent.
- </summary>
- <param name="inEnvelope">The</param>
- <returns>Boolean, true if this line segment intersects the specified envelope</returns>
- </member>
- <member name="M:DotSpatial.Topology.ILineSegment.EqualsTopologically(DotSpatial.Topology.ILineSegmentBase)">
- <summary>
- Returns <c>true</c> if <c>other</c> is
- topologically equal to this LineSegment (e.g. irrespective
- of orientation).
- </summary>
- <param name="other">
- A <c>LineSegment</c> with which to do the comparison.
- </param>
- <returns>
- <c>true</c> if <c>other</c> is a <c>LineSegment</c>
- with the same values for the x and y ordinates.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.ILineSegment.ToString">
- <summary>
- Returns Well Known Text for a LineString with just 2 points
- </summary>
- <returns>String: Well Known Text</returns>
- </member>
- <member name="P:DotSpatial.Topology.ILineSegment.Length">
- <summary>
- Computes the length of the line segment.
- </summary>
- <returns>The length of the line segment.</returns>
- </member>
- <member name="P:DotSpatial.Topology.ILineSegment.IsHorizontal">
- <summary>
- Tests whether the segment is horizontal.
- </summary>
- <returns><c>true</c> if the segment is horizontal.</returns>
- </member>
- <member name="P:DotSpatial.Topology.ILineSegment.IsVertical">
- <summary>
- Tests whether the segment is vertical.
- </summary>
- <returns><c>true</c> if the segment is vertical.</returns>
- </member>
- <member name="P:DotSpatial.Topology.ILineSegment.Angle">
- <returns>
- The angle this segment makes with the x-axis (in radians).
- </returns>
- </member>
- <member name="T:DotSpatial.Topology.IMatrix">
- <summary>
- IMatrix
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.IMatrix.Multiply(DotSpatial.Topology.IMatrix)">
- <summary>
- Performs the matrix multiplication against the specified matrix
- </summary>
- <param name="matrix"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.IMatrix.NumRows">
- <summary>
- Gets the number of rows
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.IMatrix.NumColumns">
- <summary>
- Gets the number of columns
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.IMatrix4">
- <summary>
- Operations on 3D vectors can be carried out using a 4D Matrix. This interface
- provides access to methods that are specific to 3D vector opperations.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.IMatrixD">
- <summary>
- IMatrix4
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.IMatrixD.Multiply(System.Double)">
- <summary>
- Multiplies every value in the specified n x m matrix by the specified double inScalar.
- </summary>
- <param name="inScalar">The double precision floating point to multiply all the members against</param>
- <returns>A new n x m matrix</returns>
- </member>
- <member name="M:DotSpatial.Topology.IMatrixD.Multiply(DotSpatial.Topology.IMatrixD)">
- <summary>
- This replaces the underlying general multiplication with a more specific type.
- </summary>
- <param name="matrix"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.IMatrixD.Values">
- <summary>
- Gets or sets the values for this matrix of double precision coordinates
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.IMatrix4.RotateZ(System.Double)">
- <summary>
- Specifies amount to rotate
- </summary>
- <param name="degrees"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.IMatrix4.RotateX(System.Double)">
- <summary>
- Multiplies the current matrix by a rotation matrix corresponding
- to the specified angle to create rotation in the Z direction.
- </summary>
- <param name="degrees">The angle to rotate in degrees.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.IMatrix4.RotateY(System.Double)">
- <summary>
- Rotates the current matrix around the Y axis by multiplying the
- current matrix by a rotation matrix.
- </summary>
- <param name="degrees"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.IMatrix4.Translate(System.Double,System.Double,System.Double)">
- <summary>
- Translates the matrix by the specified amount in each of the directions
- by multiplying by a translation matrix created from the specified values.
- </summary>
- <param name="x">The translation in the X coordinate</param>
- <param name="y">The translation in the Y coordinate</param>
- <param name="z">The translation in the Z coordinate</param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.IMultiLineString">
- <summary>
- A type specific Geometry collection that deals with ILineStrings
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.IMultiLineString.Item(System.Int32)">
- <summary>
- Changes the default indexer to assume that the members are ILineString instead of simply IGeometry
- </summary>
- <param name="index"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.IMultiPoint">
- <summary>
- A type specific MultiGeometry that specifically uses points
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.IMultiPoint.Item(System.Int32)">
- <summary>
- Gets or sets the point that resides at the specified index
- </summary>
- <param name="index">A zero-based integer index specifying the point to get or set</param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.IMultiPolygon">
- <summary>
- specifically for handling
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.IntersectionMatrix">
- <summary>
- A Dimensionally Extended Nine-Intersection Model (DE-9IM) matrix. This class
- can used to represent both computed DE-9IM's (like 212FF1FF2) as well as
- patterns for matching them (like T*T******).
- Methods are provided to:
- Set and query the elements of the matrix in a convenient fashion
- convert to and from the standard string representation (specified in
- SFS Section 2.1.13.2).
- Test to see if a matrix matches a given pattern string.
- For a description of the DE-9IM, see the <see href="http://www.opengis.org/techno/specs.htm"/>OpenGIS Simple Features
- Specification for SQL.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.IntersectionMatrix._matrix">
- <summary>
- Internal representation of this <c>IntersectionMatrix</c>.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.IntersectionMatrix.#ctor">
- <summary>
- Creates an <c>IntersectionMatrix</c> with <c>Null</c> location values.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.IntersectionMatrix.#ctor(System.String)">
- <summary>
- Creates an <c>IntersectionMatrix</c> with the given dimension
- symbols.
- </summary>
- <param name="elements">A string of nine dimension symbols in row major order.</param>
- </member>
- <member name="M:DotSpatial.Topology.IntersectionMatrix.#ctor(DotSpatial.Topology.IntersectionMatrix)">
- <summary>
- Creates an <c>IntersectionMatrix</c> with the same elements as
- <c>other</c>.
- </summary>
- <param name="other">An <c>IntersectionMatrix</c> to copy.</param>
- </member>
- <member name="M:DotSpatial.Topology.IntersectionMatrix.Add(DotSpatial.Topology.IIntersectionMatrix)">
- <summary>
- Adds one matrix to another.
- Addition is defined by taking the maximum dimension value of each position
- in the summand matrices.
- </summary>
- <param name="im">The matrix to add.</param>
- </member>
- <member name="M:DotSpatial.Topology.IntersectionMatrix.Set(DotSpatial.Topology.LocationType,DotSpatial.Topology.LocationType,DotSpatial.Topology.DimensionType)">
- <summary>
- Changes the value of one of this <c>IntersectionMatrix</c>s
- elements.
- </summary>
- <param name="row">
- The row of this <c>IntersectionMatrix</c>,
- indicating the interior, boundary or exterior of the first <c>Geometry</c>
- </param>
- <param name="column">
- The column of this <c>IntersectionMatrix</c>,
- indicating the interior, boundary or exterior of the second <c>Geometry</c>
- </param>
- <param name="dimensionValue">
- The new value of the element
- </param>
- </member>
- <member name="M:DotSpatial.Topology.IntersectionMatrix.Set(System.String)">
- <summary>
- Changes the elements of this <c>IntersectionMatrix</c> to the
- dimension symbols in <c>dimensionSymbols</c>.
- </summary>
- <param name="dimensionSymbols">
- Nine dimension symbols to which to set this <c>IntersectionMatrix</c>
- s elements. Possible values are <c>{T, F, *, 0, 1, 2}</c>
- </param>
- </member>
- <member name="M:DotSpatial.Topology.IntersectionMatrix.SetAtLeast(DotSpatial.Topology.LocationType,DotSpatial.Topology.LocationType,DotSpatial.Topology.DimensionType)">
- <summary>
- Changes the specified element to <c>minimumDimensionValue</c> if the
- element is less.
- </summary>
- <param name="row">
- The row of this <c>IntersectionMatrix</c>
- , indicating the interior, boundary or exterior of the first <c>Geometry</c>.
- </param>
- <param name="column">
- The column of this <c>IntersectionMatrix</c>
- , indicating the interior, boundary or exterior of the second <c>Geometry</c>.
- </param>
- <param name="minimumDimensionValue">
- The dimension value with which to compare the
- element. The order of dimension values from least to greatest is
- <c>True, False, Dontcare, 0, 1, 2</c>.
- </param>
- </member>
- <member name="M:DotSpatial.Topology.IntersectionMatrix.SetAtLeastIfValid(DotSpatial.Topology.LocationType,DotSpatial.Topology.LocationType,DotSpatial.Topology.DimensionType)">
- <summary>
- If row >= 0 and column >= 0, changes the specified element to <c>minimumDimensionValue</c>
- if the element is less. Does nothing if row is smaller to 0 or column is smaller to 0.
- </summary>
- <param name="row"></param>
- <param name="column"></param>
- <param name="minimumDimensionValue"></param>
- </member>
- <member name="M:DotSpatial.Topology.IntersectionMatrix.SetAtLeast(System.String)">
- <summary>
- For each element in this <c>IntersectionMatrix</c>, changes the
- element to the corresponding minimum dimension symbol if the element is
- less.
- </summary>
- <param name="minimumDimensionSymbols">
- Nine dimension symbols with which to
- compare the elements of this <c>IntersectionMatrix</c>. The
- order of dimension values from least to greatest is <c>Dontcare, True, False, 0, 1, 2</c>.
- </param>
- </member>
- <member name="M:DotSpatial.Topology.IntersectionMatrix.SetAll(DotSpatial.Topology.DimensionType)">
- <summary>
- Changes the elements of this <c>IntersectionMatrix</c> to <c>dimensionValue</c>.
- </summary>
- <param name="dimensionValue">
- The dimension value to which to set this <c>IntersectionMatrix</c>
- s elements. Possible values <c>True, False, Dontcare, 0, 1, 2}</c>.
- </param>
- </member>
- <member name="M:DotSpatial.Topology.IntersectionMatrix.Get(DotSpatial.Topology.LocationType,DotSpatial.Topology.LocationType)">
- <summary>
- Returns the value of one of this <c>IntersectionMatrix</c>s
- elements.
- </summary>
- <param name="row">
- The row of this <c>IntersectionMatrix</c>, indicating
- the interior, boundary or exterior of the first <c>Geometry</c>.
- </param>
- <param name="column">
- The column of this <c>IntersectionMatrix</c>,
- indicating the interior, boundary or exterior of the second <c>Geometry</c>.
- </param>
- <returns>The dimension value at the given matrix position.</returns>
- </member>
- <member name="M:DotSpatial.Topology.IntersectionMatrix.IsDisjoint">
- <summary>
- Returns <c>true</c> if this <c>IntersectionMatrix</c> is
- FF*FF****.
- </summary>
- <returns>
- <c>true</c> if the two <c>Geometry</c>s related by
- this <c>IntersectionMatrix</c> are disjoint.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.IntersectionMatrix.IsIntersects">
- <summary>
- Returns <c>true</c> if <c>isDisjoint</c> returns false.
- </summary>
- <returns>
- <c>true</c> if the two <c>Geometry</c>s related by
- this <c>IntersectionMatrix</c> intersect.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.IntersectionMatrix.IsTouches(DotSpatial.Topology.DimensionType,DotSpatial.Topology.DimensionType)">
- <summary>
- Returns <c>true</c> if this <c>IntersectionMatrix</c> is
- FT*******, F**T***** or F***T****.
- </summary>
- <param name="dimensionOfGeometryA">The dimension of the first <c>Geometry</c>.</param>
- <param name="dimensionOfGeometryB">The dimension of the second <c>Geometry</c>.</param>
- <returns>
- <c>true</c> if the two <c>Geometry</c>
- s related by this <c>IntersectionMatrix</c> touch; Returns false
- if both <c>Geometry</c>s are points.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.IntersectionMatrix.IsCrosses(DotSpatial.Topology.DimensionType,DotSpatial.Topology.DimensionType)">
- <summary>
- Returns <c>true</c> if this <c>IntersectionMatrix</c> is
- T*T****** (for a point and a curve, a point and an area or a line
- and an area) 0******** (for two curves).
- </summary>
- <param name="dimensionOfGeometryA">The dimension of the first <c>Geometry</c>.</param>
- <param name="dimensionOfGeometryB">The dimension of the second <c>Geometry</c>.</param>
- <returns>
- <c>true</c> if the two <c>Geometry</c>
- s related by this <c>IntersectionMatrix</c> cross. For this
- function to return <c>true</c>, the <c>Geometry</c>s must
- be a point and a curve; a point and a surface; two curves; or a curve
- and a surface.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.IntersectionMatrix.IsWithin">
- <summary>
- Returns <c>true</c> if this <c>IntersectionMatrix</c> is
- T*F**F***.
- </summary>
- <returns><c>true</c> if the first <c>Geometry</c> is within the second.</returns>
- </member>
- <member name="M:DotSpatial.Topology.IntersectionMatrix.IsContains">
- <summary>
- Returns <c>true</c> if this <c>IntersectionMatrix</c> is
- T*****FF*.
- </summary>
- <returns><c>true</c> if the first <c>Geometry</c> contains the second.</returns>
- </member>
- <member name="M:DotSpatial.Topology.IntersectionMatrix.IsCovers">
- <summary>
- Returns <c>true</c> if this <c>IntersectionMatrix</c> is <c>T*****FF*</c>
- or <c>*T****FF*</c> or <c>***T**FF*</c> or <c>****T*FF*</c>.
- </summary>
- <returns><c>true</c> if the first <c>Geometry</c> covers the second</returns>
- </member>
- <member name="M:DotSpatial.Topology.IntersectionMatrix.IsEquals(DotSpatial.Topology.DimensionType,DotSpatial.Topology.DimensionType)">
- <summary>
- Returns <c>true</c> if this <c>IntersectionMatrix</c> is T*F**FFF*.
- </summary>
- <param name="dimensionOfGeometryA">The dimension of the first <c>Geometry</c>.</param>
- <param name="dimensionOfGeometryB">The dimension of the second <c>Geometry</c>.</param>
- <returns>
- <c>true</c> if the two <c>Geometry</c>
- s related by this <c>IntersectionMatrix</c> are equal; the
- <c>Geometry</c>s must have the same dimension for this function
- to return <c>true</c>.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.IntersectionMatrix.IsOverlaps(DotSpatial.Topology.DimensionType,DotSpatial.Topology.DimensionType)">
- <summary>
- Returns <c>true</c> if this <c>IntersectionMatrix</c> is
- T*T***T** (for two points or two surfaces)
- 1*T***T** (for two curves).
- </summary>
- <param name="dimensionOfGeometryA">The dimension of the first <c>Geometry</c>.</param>
- <param name="dimensionOfGeometryB">The dimension of the second <c>Geometry</c>.</param>
- <returns>
- <c>true</c> if the two <c>Geometry</c>
- s related by this <c>IntersectionMatrix</c> overlap. For this
- function to return <c>true</c>, the <c>Geometry</c>s must
- be two points, two curves or two surfaces.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.IntersectionMatrix.Matches(System.String)">
- <summary>
- Returns whether the elements of this <c>IntersectionMatrix</c>
- satisfies the required dimension symbols.
- </summary>
- <param name="requiredDimensionSymbols">
- Nine dimension symbols with which to
- compare the elements of this <c>IntersectionMatrix</c>. Possible
- values are <c>{T, F, *, 0, 1, 2}</c>.
- </param>
- <returns>
- <c>true</c> if this <c>IntersectionMatrix</c>
- matches the required dimension symbols.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.IntersectionMatrix.Transpose">
- <summary>
- Transposes this IntersectionMatrix.
- </summary>
- <returns>This <c>IntersectionMatrix</c> as a convenience, </returns>
- </member>
- <member name="M:DotSpatial.Topology.IntersectionMatrix.ToString">
- <summary>
- Returns a nine-character <c>String</c> representation of this <c>IntersectionMatrix</c>.
- </summary>
- <returns>
- The nine dimension symbols of this <c>IntersectionMatrix</c>
- in row-major order.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.IntersectionMatrix.Matches(DotSpatial.Topology.DimensionType,System.Char)">
- <summary>
- Returns true if the dimension value satisfies the dimension symbol.
- </summary>
- <param name="actualDimensionValue">
- A number that can be stored in the <c>IntersectionMatrix</c>
- . Possible values are <c>True, False, Dontcare, 0, 1, 2</c>.
- </param>
- <param name="requiredDimensionSymbol">
- A character used in the string
- representation of an <c>IntersectionMatrix</c>. Possible values
- are <c>T, F, *, 0, 1, 2</c>.
- </param>
- <returns>
- True if the dimension symbol encompasses
- the dimension value.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.IntersectionMatrix.Matches(System.String,System.String)">
- <summary>
- Returns true if each of the actual dimension symbols satisfies the
- corresponding required dimension symbol.
- </summary>
- <param name="actualDimensionSymbols">
- Nine dimension symbols to validate.
- Possible values are <c>T, F, *, 0, 1, 2</c>.
- </param>
- <param name="requiredDimensionSymbols">
- Nine dimension symbols to validate
- against. Possible values are <c>T, F, *, 0, 1, 2</c>.
- </param>
- <returns>
- True if each of the required dimension
- symbols encompass the corresponding actual dimension symbol.
- </returns>
- </member>
- <member name="P:DotSpatial.Topology.IntersectionMatrix.Item(DotSpatial.Topology.LocationType,DotSpatial.Topology.LocationType)">
- <summary>
- See methods Get(int, int) and Set(int, int, int value)
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.IPoint">
- <summary>
- This combines the full Topology.Geometry functions to the complete Vector.IPoint set of functions.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.IPolygon">
- <summary>
- Full powered topology style Polygon
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.IPolygon.GetInteriorRingN(System.Int32)">
- <summary>
- Gets a specific <see cref="T:DotSpatial.Topology.ILinearRing">ILinearRing</see> identified by the 0 based index n
- </summary>
- <param name="n">A 0 based integer index enumerating the rings</param>
- <returns><see cref="T:DotSpatial.Topology.ILinearRing">ILinearRing</see> outlining the n'th hole in the polygon</returns>
- </member>
- <member name="P:DotSpatial.Topology.IPolygon.Shell">
- <summary>
- Gets the <see cref="T:DotSpatial.Topology.ILinearRing">ILinearRing</see> for the Exterior Ring.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.IPolygon.Holes">
- <summary>
- Gets the System.Array of <see cref="T:DotSpatial.Topology.ILinearRing">ILinearRing</see>s that make up the holes in the polygon.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.ISize">
- <summary>
- ISize interface for expressing a length in the X, Y or Z directions
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.ISize.XSize">
- <summary>
- Gets or sets the size in the x direction or longitude
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.ISize.YSize">
- <summary>
- Gets or sets the size in the y direction or latitude
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.ISize.ZSize">
- <summary>
- Gets or sets the size in the z direction or altitude
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.IVector">
- <summary>
- Contains a magnitude and direction
- Supports more fundamental calculations than LineSegment, rather than topological functions
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.IVector.TransformCoordinate(DotSpatial.Topology.IMatrix4)">
- <summary>
- Transforms a point that has 3 dimensions by multiplying it by the
- specified 3 x 3 matrix in the upper left, but treats the
- bottom row as supplying the translation coordinates.
- </summary>
- <param name="transformMatrix"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.IVector.ToMatrix">
- <summary>
- Rotations and transformations work by applying matrix mathematics,
- so this creates a 1 x 4 version of this vector. The 4th value
- is always 1, and allows for the translation terms to work.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.IVector.Norm2">
- <summary>
- Returns the square of the distance of the vector without taking the square root
- This is the same as doting the vector with itself
- </summary>
- <returns>Double, the square of the distance between the vectors</returns>
- </member>
- <member name="M:DotSpatial.Topology.IVector.ToPoint">
- <summary>
- Assuming the vector starts at the origin of 0, 0, 0, this function returns
- a Point representing the tip of the vector.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.IVector.ToCoordinate">
- <summary>
- Converts this vector to a coordinate by assuming that the X, Y and Z values
- are the X, Y and Z values of the locaiton.
- </summary>
- <returns>An ICoordinate</returns>
- </member>
- <member name="M:DotSpatial.Topology.IVector.ToLineSegment">
- <summary>
- Returns a new segment from this vector, where the StartPoint is 0, 0, 0
- and the End Point is the tip of this vector
- </summary>
- <returns>An implementation of ILineSegment</returns>
- </member>
- <member name="M:DotSpatial.Topology.IVector.Normalize">
- <summary>
- Normalizes the vector.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.IVector.Cross(DotSpatial.Topology.IVector)">
- <summary>
- Returns the cross product of this vector with the specified vector V
- </summary>
- <param name="v">The vector to perform a cross product against</param>
- <returns>A vector result from the inner product</returns>
- </member>
- <member name="M:DotSpatial.Topology.IVector.Dot(DotSpatial.Topology.IVector)">
- <summary>
- Returns the dot product of this vector with V2
- </summary>
- <param name="v">The vector to perform an inner product against</param>
- <returns>A Double result from the inner product</returns>
- </member>
- <member name="M:DotSpatial.Topology.IVector.Intersects(DotSpatial.Topology.IVector)">
- <summary>
- Compares the values of each element, and if all the elements are equal, returns true.
- </summary>
- <param name="v">The vector to compare against this vector.</param>
- <returns>Boolean, true if all the elements have the same value.</returns>
- </member>
- <member name="M:DotSpatial.Topology.IVector.Equals(DotSpatial.Topology.IVector)">
- <summary>
- Override for definition of equality for vectors
- </summary>
- <param name="v">A vector to compare with</param>
- <returns>true if the X, Y, and Z coordinates are all equal</returns>
- </member>
- <member name="M:DotSpatial.Topology.IVector.Subtract(DotSpatial.Topology.IVector)">
- <summary>
- Subtracts each element of V from each element of this vector
- </summary>
- <param name="v">Vector, the vector to subtract from this vector</param>
- <returns>A vector result from the subtraction</returns>
- </member>
- <member name="M:DotSpatial.Topology.IVector.Add(DotSpatial.Topology.IVector)">
- <summary>
- Adds each of the elements of V to the elements of this vector
- </summary>
- <param name="v">Vector, the vector to add to this vector</param>
- <returns>A vector result from the addition</returns>
- </member>
- <member name="M:DotSpatial.Topology.IVector.Multiply(System.Double)">
- <summary>
- Returns the scalar product of this vector against a scalar
- </summary>
- <param name="scalar">Double, a value to multiply against all the members of this vector</param>
- <returns>A vector multiplied by the scalar</returns>
- </member>
- <member name="M:DotSpatial.Topology.IVector.RotateX(System.Double)">
- <summary>
- Rotates the vector about the X axis as though the tail of the vector were at the origin
- </summary>
- <param name="degrees">The angle in degrees to rotate counter-clockwise when looking at the origin from the positive axis.</param>
- <returns>A new IVector that has been rotated</returns>
- </member>
- <member name="M:DotSpatial.Topology.IVector.RotateY(System.Double)">
- <summary>
- Rotates the vector about the Y axis as though the tail of the vector were at the origin
- </summary>
- <param name="degrees">The angle in degrees to rotate counter-clockwise when looking at the origin from the positive axis.</param>
- <returns>A new IVector that has been rotated</returns>
- </member>
- <member name="M:DotSpatial.Topology.IVector.RotateZ(System.Double)">
- <summary>
- Rotates the vector about the Z axis as though the tail of the vector were at the origin
- </summary>
- <param name="degrees">The angle in degrees to rotate counter-clockwise when looking at the origin from the positive axis.</param>
- <returns>A new IVector that has been rotated</returns>
- </member>
- <member name="P:DotSpatial.Topology.IVector.Length">
- <summary>
- The Euclidean distance from the origin to the tip of the 3 dimensional vector
- Setting the magntiude won't change the direction.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.IVector.Length2D">
- <summary>
- Returns the magnitude of the projection of the vector onto the X-Y plane
- Setting this magnitude will not affect Z, which should be adjusted separately
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.IVector.Phi">
- <summary>
- Obtains the angle above the X-Y plane. Positive towards positive Z.
- Values are in radians from -Pi/2 to Pi/2
- Setting this value when no magnitude exists results in a unit vector with angle phi in the X direction.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.IVector.Theta">
- <summary>
- Represents the angle in the X-Y plane. 0 along the positive X axis, and increasing counterclockwise
- Values are in Radians. Setting this value when no X-Y magnitude exists results in a unit vector
- between X and Y, but does not affect Z, so you may have something other than a unit vector in 3-D.
- Set theta before phi in order to obtain a unit vector in 3-D space.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.IVectorD">
- <summary>
- Vector
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.IVectorD.Add(DotSpatial.Topology.Vector)">
- <summary>
- Adds each of the elements of V to the elements of this vector
- </summary>
- <param name="v">Vector, the vector to add to this vector</param>
- <returns>A vector result from the addition</returns>
- </member>
- <member name="M:DotSpatial.Topology.IVectorD.Cross(DotSpatial.Topology.Vector)">
- <summary>
- Returns the cross product of this vector with the specified vector V
- </summary>
- <param name="v">The vector to perform a cross product against</param>
- <returns>A vector result from the inner product</returns>
- </member>
- <member name="M:DotSpatial.Topology.IVectorD.Dot(DotSpatial.Topology.Vector)">
- <summary>
- Returns the dot product of this vector with V2
- </summary>
- <param name="v">The vector to perform an inner product against</param>
- <returns>A Double result from the inner product</returns>
- </member>
- <member name="M:DotSpatial.Topology.IVectorD.Multiply(System.Double)">
- <summary>
- Returns the scalar product of this vector against a scalar
- </summary>
- <param name="scalar">Double, a value to multiply against all the members of this vector</param>
- <returns>A vector multiplied by the scalar</returns>
- </member>
- <member name="M:DotSpatial.Topology.IVectorD.Normalize">
- <summary>
- Normalizes the vector.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.IVectorD.Subtract(DotSpatial.Topology.Vector)">
- <summary>
- Subtracts each element of V from each element of this vector
- </summary>
- <param name="v">Vector, the vector to subtract from this vector</param>
- <returns>A vector result from the subtraction</returns>
- </member>
- <member name="P:DotSpatial.Topology.IVectorD.Length">
- <summary>
- The Euclidean distance from the origin to the tip of the 3 dimensional vector
- Setting the magntiude won't change the direction.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.GeometriesGraph.Depth">
- <summary>
- A Depth object records the topological depth of the sides
- of an Edge for up to two Geometries.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.GeometriesGraph.Depth.NULL">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Depth.#ctor">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Depth.DepthAtLocation(DotSpatial.Topology.LocationType)">
- <summary>
-
- </summary>
- <param name="location"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Depth.GetDepth(System.Int32,DotSpatial.Topology.GeometriesGraph.PositionType)">
- <summary>
-
- </summary>
- <param name="geomIndex"></param>
- <param name="posIndex"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Depth.SetDepth(System.Int32,DotSpatial.Topology.GeometriesGraph.PositionType,System.Int32)">
- <summary>
-
- </summary>
- <param name="geomIndex"></param>
- <param name="posIndex"></param>
- <param name="depthValue"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Depth.GetLocation(System.Int32,DotSpatial.Topology.GeometriesGraph.PositionType)">
- <summary>
-
- </summary>
- <param name="geomIndex"></param>
- <param name="posIndex"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Depth.Add(System.Int32,DotSpatial.Topology.GeometriesGraph.PositionType,DotSpatial.Topology.LocationType)">
- <summary>
-
- </summary>
- <param name="geomIndex"></param>
- <param name="posIndex"></param>
- <param name="location"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Depth.IsNull">
- <summary>
- A Depth object is null (has never been initialized) if all depths are null.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Depth.IsNull(System.Int32)">
- <summary>
-
- </summary>
- <param name="geomIndex"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Depth.IsNull(System.Int32,DotSpatial.Topology.GeometriesGraph.PositionType)">
- <summary>
-
- </summary>
- <param name="geomIndex"></param>
- <param name="posIndex"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Depth.Add(DotSpatial.Topology.GeometriesGraph.Label)">
- <summary>
-
- </summary>
- <param name="lbl"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Depth.GetDelta(System.Int32)">
- <summary>
-
- </summary>
- <param name="geomIndex"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Depth.Normalize">
- <summary>
- Normalize the depths for each point, if they are non-null.
- A normalized depth
- has depth values in the set { 0, 1 }.
- Normalizing the depths
- involves reducing the depths by the same amount so that at least
- one of them is 0. If the remaining value is > 0, it is set to 1.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Depth.ToString">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.Depth.Item(System.Int32,DotSpatial.Topology.GeometriesGraph.PositionType)">
- <summary>
- Calls GetDepth and SetDepth.
- </summary>
- <param name="geomIndex"></param>
- <param name="posIndex"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.GeometriesGraph.DirectedEdge">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.GeometriesGraph.EdgeEnd">
- <summary>
- Models the end of an edge incident on a node.
- EdgeEnds have a direction
- determined by the direction of the ray from the initial
- point to the next point.
- EdgeEnds are IComparable under the ordering
- "a has a greater angle with the x-axis than b".
- This ordering is used to sort EdgeEnds around a node.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.GeometriesGraph.EdgeEnd._edge">
- <summary>
- The parent edge of this edge end.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeEnd.#ctor(DotSpatial.Topology.GeometriesGraph.Edge)">
- <summary>
-
- </summary>
- <param name="inEdge"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeEnd.#ctor(DotSpatial.Topology.GeometriesGraph.Edge,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="edge"></param>
- <param name="p0"></param>
- <param name="p1"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeEnd.#ctor(DotSpatial.Topology.GeometriesGraph.Edge,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.GeometriesGraph.Label)">
- <summary>
-
- </summary>
- <param name="edge"></param>
- <param name="p0"></param>
- <param name="p1"></param>
- <param name="inLabel"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeEnd.CompareTo(System.Object)">
- <summary>
-
- </summary>
- <param name="obj"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeEnd.Init(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="p0"></param>
- <param name="p1"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeEnd.CompareDirection(DotSpatial.Topology.GeometriesGraph.EdgeEnd)">
- <summary>
- Implements the total order relation:
- a has a greater angle with the positive x-axis than b.
- Using the obvious algorithm of simply computing the angle is not robust,
- since the angle calculation is obviously susceptible to roundoff.
- A robust algorithm is:
- - first compare the quadrant. If the quadrants
- are different, it it trivial to determine which vector is "greater".
- - if the vectors lie in the same quadrant, the computeOrientation function
- can be used to decide the relative orientation of the vectors.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeEnd.ComputeLabel">
- <summary>
- Subclasses should override this if they are using labels
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeEnd.Write(System.IO.StreamWriter)">
- <summary>
-
- </summary>
- <param name="outstream"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeEnd.ToString">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.EdgeEnd.Edge">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.EdgeEnd.Label">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.EdgeEnd.Coordinate">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.EdgeEnd.DirectedCoordinate">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.EdgeEnd.Quadrant">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.EdgeEnd.Dx">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.EdgeEnd.Dy">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.EdgeEnd.Node">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.GeometriesGraph.DirectedEdge._depth">
- <summary>
- The depth of each side (position) of this edge.
- The 0 element of the array is never used.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.DirectedEdge.#ctor(DotSpatial.Topology.GeometriesGraph.Edge,System.Boolean)">
- <summary>
- Creates a new instance of a directed edge
- </summary>
- <param name="inEdge">The edge to use in order to create a directed edge</param>
- <param name="inIsForward">A boolean that forces whether or not this edge is counted as forward</param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.DirectedEdge.ComputeDirectedLabel">
- <summary>
- Compute the label in the appropriate orientation for this DirEdge.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.DirectedEdge.GetDepth(DotSpatial.Topology.GeometriesGraph.PositionType)">
- <summary>
- Retrieves an integer that describes the depth
- </summary>
- <param name="position">A Positions enumeration</param>
- <returns>An integer showing the depth</returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.DirectedEdge.SetDepth(DotSpatial.Topology.GeometriesGraph.PositionType,System.Int32)">
- <summary>
- Sets the depth value for this edge based on the specified position
- </summary>
- <param name="position">A Position</param>
- <param name="depthVal">The integer depth to specify</param>
- <exception cref="T:DotSpatial.Topology.TopologyException">Assigned depths do not match</exception>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.DirectedEdge.SetEdgeDepths(DotSpatial.Topology.GeometriesGraph.PositionType,System.Int32)">
- <summary>
- Set both edge depths.
- One depth for a given side is provided.
- The other is computed depending on the Location
- transition and the depthDelta of the edge.
- </summary>
- <param name="position"></param>
- <param name="depth"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.DirectedEdge.Write(System.IO.StreamWriter)">
- <summary>
-
- </summary>
- <param name="outstream"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.DirectedEdge.WriteEdge(System.IO.StreamWriter)">
- <summary>
-
- </summary>
- <param name="outstream"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.DirectedEdge.DepthFactor(DotSpatial.Topology.LocationType,DotSpatial.Topology.LocationType)">
- <summary>
- Computes the factor for the change in depth when moving from one location to another.
- E.g. if crossing from the Interior to the Exterior the depth decreases, so the factor is -1.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.DirectedEdge.DepthDelta">
- <summary>
- Obtains the chaing in depth
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.DirectedEdge.EdgeRing">
- <summary>
- Gets or sets the EdgeRing
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.DirectedEdge.IsForward">
- <summary>
- Gets a boolean indicating whether this edge is directed forward
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.DirectedEdge.IsInResult">
- <summary>
- Gets a boolean that is true if this edge is in the result
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.DirectedEdge.IsInteriorAreaEdge">
- <summary>
- This is an interior Area edge if
- its label is an Area label for both Geometries
- and for each Geometry both sides are in the interior.
- </summary>
- <returns><c>true</c> if this is an interior Area edge.</returns>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.DirectedEdge.IsLineEdge">
- <summary>
- This edge is a line edge if
- at least one of the labels is a line label
- any labels which are not line labels have all Locations = Exterior.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.DirectedEdge.IsVisited">
- <summary>
- Gets or sets a boolean that is true if this edge has been visited
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.DirectedEdge.MinEdgeRing">
- <summary>
- Gets or sets the minimum Edge Ring
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.DirectedEdge.Next">
- <summary>
- Gets or sets the next directed edge relative to this directed edge
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.DirectedEdge.NextMin">
- <summary>
- Gets or sets a directed edge for Next Min
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.DirectedEdge.Sym">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.DirectedEdge.VisitedEdge">
- <summary>
- VisitedEdge get property returns <c>true</c> if bot Visited
- and Sym.Visited are <c>true</c>.
- VisitedEdge set property marks both DirectedEdges attached to a given Edge.
- This is used for edges corresponding to lines, which will only
- appear oriented in a single direction in the result.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.GeometriesGraph.DirectedEdgeStar">
- <summary>
- A DirectedEdgeStar is an ordered list of outgoing DirectedEdges around a node.
- It supports labelling the edges as well as linking the edges to form both
- MaximalEdgeRings and MinimalEdgeRings.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.GeometriesGraph.EdgeEndStar">
- <summary>
- A EdgeEndStar is an ordered list of EdgeEnds around a node.
- They are maintained in CCW order (starting with the positive x-axis) around the node
- for efficient lookup and topology building.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.GeometriesGraph.EdgeEndStar._edgeMap">
- <summary>
- A map which maintains the edges in sorted order around the node.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.GeometriesGraph.EdgeEndStar._ptInAreaLocation">
- <summary>
- The location of the point for this star in Geometry i Areas.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeEndStar.Insert(DotSpatial.Topology.GeometriesGraph.EdgeEnd)">
- <summary>
- Insert a EdgeEnd into this EdgeEndStar.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeEndStar.InsertEdgeEnd(DotSpatial.Topology.GeometriesGraph.EdgeEnd,System.Object)">
- <summary>
- Insert an EdgeEnd into the map, and clear the edgeList cache,
- since the list of edges has now changed.
- </summary>
- <param name="e"></param>
- <param name="obj"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeEndStar.GetEnumerator">
- <summary>
- Iterator access to the ordered list of edges is optimized by
- copying the map collection to a list. (This assumes that
- once an iterator is requested, it is likely that insertion into
- the map is complete).
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeEndStar.InitializeEdges">
- <summary>
- Initializes the edges in the _edgeList
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeEndStar.GetNextCw(DotSpatial.Topology.GeometriesGraph.EdgeEnd)">
- <summary>
-
- </summary>
- <param name="ee"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeEndStar.ComputeLabelling(DotSpatial.Topology.GeometriesGraph.GeometryGraph[])">
- <summary>
-
- </summary>
- <param name="geom"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeEndStar.ComputeEdgeEndLabels">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeEndStar.GetLocation(System.Int32,DotSpatial.Topology.Coordinate,DotSpatial.Topology.GeometriesGraph.GeometryGraph[])">
- <summary>
-
- </summary>
- <param name="geomIndex"></param>
- <param name="p"></param>
- <param name="geom"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeEndStar.CheckAreaLabelsConsistent(System.Int32)">
- <summary>
-
- </summary>
- <param name="geomIndex"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeEndStar.PropagateSideLabels(System.Int32)">
- <summary>
-
- </summary>
- <param name="geomIndex"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeEndStar.FindIndex(DotSpatial.Topology.GeometriesGraph.EdgeEnd)">
- <summary>
-
- </summary>
- <param name="eSearch"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeEndStar.Write(System.IO.StreamWriter)">
- <summary>
-
- </summary>
- <param name="outstream"></param>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.EdgeEndStar.EdgeMap">
- <summary>
- Gets the EdgeMap
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.EdgeEndStar.EdgeList">
- <summary>
- A list of all outgoing edges in the result, in CCW order.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.EdgeEndStar.Coordinate">
- <returns>
- The coordinate for the node this star is based at.
- </returns>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.EdgeEndStar.Degree">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.EdgeEndStar.Edges">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.EdgeEndStar.IsAreaLabelsConsistent">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.GeometriesGraph.DirectedEdgeStar._resultAreaEdgeList">
- <summary>
- A list of all outgoing edges in the result, in CCW order.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.DirectedEdgeStar.Insert(DotSpatial.Topology.GeometriesGraph.EdgeEnd)">
- <summary>
- Insert a directed edge in the list.
- </summary>
- <param name="ee"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.DirectedEdgeStar.GetOutgoingDegree">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.DirectedEdgeStar.GetOutgoingDegree(DotSpatial.Topology.GeometriesGraph.EdgeRing)">
- <summary>
-
- </summary>
- <param name="er"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.DirectedEdgeStar.GetRightmostEdge">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.DirectedEdgeStar.ComputeLabelling(DotSpatial.Topology.GeometriesGraph.GeometryGraph[])">
- <summary>
- Compute the labelling for all dirEdges in this star, as well
- as the overall labelling.
- </summary>
- <param name="geom"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.DirectedEdgeStar.MergeSymLabels">
- <summary>
- For each dirEdge in the star, merge the label .
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.DirectedEdgeStar.UpdateLabelling(DotSpatial.Topology.GeometriesGraph.Label)">
- <summary>
- Update incomplete dirEdge labels from the labelling for the node.
- </summary>
- <param name="nodeLabel"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.DirectedEdgeStar.LinkResultDirectedEdges">
- <summary>
- Traverse the star of DirectedEdges, linking the included edges together.
- To link two dirEdges, the next pointer for an incoming dirEdge
- is set to the next outgoing edge.
- DirEdges are only linked if:
- they belong to an area (i.e. they have sides)
- they are marked as being in the result
- Edges are linked in CCW order (the order they are stored).
- This means that rings have their face on the Right
- (in other words, the topological location of the face is given by the RHS label of the DirectedEdge).
- PRECONDITION: No pair of dirEdges are both marked as being in the result.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.DirectedEdgeStar.LinkMinimalDirectedEdges(DotSpatial.Topology.GeometriesGraph.EdgeRing)">
- <summary>
-
- </summary>
- <param name="er"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.DirectedEdgeStar.LinkAllDirectedEdges">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.DirectedEdgeStar.FindCoveredLineEdges">
- <summary>
- Traverse the star of edges, maintaing the current location in the result
- area at this node (if any).
- If any L edges are found in the interior of the result, mark them as covered.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.DirectedEdgeStar.ComputeDepths(DotSpatial.Topology.GeometriesGraph.DirectedEdge)">
- <summary>
-
- </summary>
- <param name="de"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.DirectedEdgeStar.ComputeDepths(System.Int32,System.Int32,System.Int32)">
- <summary>
- Compute the DirectedEdge depths for a subsequence of the edge array.
- </summary>
- <returns>The last depth assigned (from the R side of the last edge visited).</returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.DirectedEdgeStar.Write(System.IO.StreamWriter)">
- <summary>
-
- </summary>
- <param name="outstream"></param>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.DirectedEdgeStar.Label">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.GeometriesGraph.Edge">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.GeometriesGraph.GraphComponent">
- <summary>
- A GraphComponent is the parent class for the objects'
- that form a graph. Each GraphComponent can carry a
- Label.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.GraphComponent.#ctor">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.GraphComponent.#ctor(DotSpatial.Topology.GeometriesGraph.Label)">
- <summary>
-
- </summary>
- <param name="inLabel"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.GraphComponent.ComputeIm(DotSpatial.Topology.IntersectionMatrix)">
- <summary>
- Compute the contribution to an IM for this component.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.GraphComponent.UpdateIm(DotSpatial.Topology.IntersectionMatrix)">
- <summary>
- Update the IM with the contribution for this component.
- A component only contributes if it has a labelling for both parent geometries.
- </summary>
- <param name="im"></param>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.GraphComponent.Label">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.GraphComponent.IsInResult">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.GraphComponent.IsCovered">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.GraphComponent.IsCoveredSet">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.GraphComponent.IsVisited">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.GraphComponent.Coordinate">
- <summary>
-
- </summary>
- <returns>
- A coordinate in this component (or null, if there are none).
- </returns>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.GraphComponent.IsIsolated">
- <summary>
- An isolated component is one that does not intersect or touch any other
- component. This is the case if the label has valid locations for
- only a single Geometry.
- </summary>
- <returns><c>true</c> if this component is isolated.</returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Edge.#ctor(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate},DotSpatial.Topology.GeometriesGraph.Label)">
- <summary>
-
- </summary>
- <param name="pts"></param>
- <param name="label"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Edge.#ctor(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate})">
- <summary>
-
- </summary>
- <param name="pts"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Edge.UpdateIm(DotSpatial.Topology.GeometriesGraph.Label,DotSpatial.Topology.IntersectionMatrix)">
- <summary>
- Updates an IM from the label for an edge.
- Handles edges from both L and A geometries.
- </summary>
- <param name="label"></param>
- <param name="im"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Edge.GetCoordinate(System.Int32)">
- <summary>
-
- </summary>
- <param name="i"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Edge.AddIntersections(DotSpatial.Topology.Algorithm.LineIntersector,System.Int32,System.Int32)">
- <summary>
- Adds EdgeIntersections for one or both
- intersections found for a segment of an edge to the edge intersection list.
- </summary>
- <param name="li"></param>
- <param name="segmentIndex"></param>
- <param name="geomIndex"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Edge.AddIntersection(DotSpatial.Topology.Algorithm.LineIntersector,System.Int32,System.Int32,System.Int32)">
- <summary>
- Add an EdgeIntersection for intersection intIndex.
- An intersection that falls exactly on a vertex of the edge is normalized
- to use the higher of the two possible segmentIndexes.
- </summary>
- <param name="li"></param>
- <param name="segmentIndex"></param>
- <param name="geomIndex"></param>
- <param name="intIndex"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Edge.ComputeIm(DotSpatial.Topology.IntersectionMatrix)">
- <summary>
- Update the IM with the contribution for this component.
- A component only contributes if it has a labelling for both parent geometries.
- </summary>
- <param name="im"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Edge.Equals(System.Object)">
- <summary>
- Equals is defined to be:
- e1 equals e2
- iff
- the coordinates of e1 are the same or the reverse of the coordinates in e2.
- </summary>
- <param name="o"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Edge.Equals(DotSpatial.Topology.GeometriesGraph.Edge)">
- <summary>
- Equals is defined to be:
- e1 equals e2
- iff
- the coordinates of e1 are the same or the reverse of the coordinates in e2.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Edge.op_Equality(DotSpatial.Topology.GeometriesGraph.Edge,DotSpatial.Topology.GeometriesGraph.Edge)">
- <summary>
-
- </summary>
- <param name="obj1"></param>
- <param name="obj2"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Edge.op_Inequality(DotSpatial.Topology.GeometriesGraph.Edge,DotSpatial.Topology.GeometriesGraph.Edge)">
- <summary>
-
- </summary>
- <param name="obj1"></param>
- <param name="obj2"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Edge.GetHashCode">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Edge.IsPointwiseEqual(DotSpatial.Topology.GeometriesGraph.Edge)">
- <returns>
- <c>true</c> if the coordinate sequences of the Edges are identical.
- </returns>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Edge.Write(System.IO.StreamWriter)">
- <summary>
-
- </summary>
- <param name="outstream"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Edge.WriteReverse(System.IO.StreamWriter)">
- <summary>
-
- </summary>
- <param name="outstream"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Edge.ToString">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.Edge.Points">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.Edge.NumPoints">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.Edge.Name">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.Edge.Coordinates">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.Edge.Coordinate">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.Edge.Envelope">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.Edge.Depth">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.Edge.DepthDelta">
- <summary>
- The depthDelta is the change in depth as an edge is crossed from R to L.
- </summary>
- <returns>The change in depth as the edge is crossed from R to L.</returns>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.Edge.MaximumSegmentIndex">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.Edge.EdgeIntersectionList">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.Edge.MonotoneChainEdge">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.Edge.IsClosed">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.Edge.IsCollapsed">
- <summary>
- An Edge is collapsed if it is an Area edge and it consists of
- two segments which are equal and opposite (eg a zero-width V).
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.Edge.CollapsedEdge">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.Edge.Isolated">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.Edge.IsIsolated">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.GeometriesGraph.EdgeIntersection">
- <summary>
- An EdgeIntersection represents a point on an
- edge which intersects with another edge.
- The intersection may either be a single point, or a line segment
- (in which case this point is the start of the line segment)
- The label attached to this intersection point applies to
- the edge from this point forwards, until the next
- intersection or the end of the edge.
- The intersection point must be precise.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeIntersection.#ctor(DotSpatial.Topology.Coordinate,System.Int32,System.Double)">
- <summary>
-
- </summary>
- <param name="coord"></param>
- <param name="segmentIndex"></param>
- <param name="dist"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeIntersection.CompareTo(System.Object)">
- <summary>
-
- </summary>
- <param name="obj"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeIntersection.Compare(System.Int32,System.Double)">
- <summary>
-
- </summary>
- <param name="segmentIndex"></param>
- <param name="dist"></param>
- <returns>
- -1 this EdgeIntersection is located before the argument location,
- 0 this EdgeIntersection is at the argument location,
- 1 this EdgeIntersection is located after the argument location.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeIntersection.IsEndPoint(System.Int32)">
- <summary>
-
- </summary>
- <param name="maxSegmentIndex"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeIntersection.Write(System.IO.StreamWriter)">
- <summary>
-
- </summary>
- <param name="outstream"></param>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.EdgeIntersection.Coordinate">
- <summary>
- The point of intersection.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.EdgeIntersection.SegmentIndex">
- <summary>
- The index of the containing line segment in the parent edge.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.EdgeIntersection.Distance">
- <summary>
- The edge distance of this point along the containing line segment.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.GeometriesGraph.EdgeIntersectionList">
- <summary>
- A list of edge intersections along an Edge.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeIntersectionList.#ctor(DotSpatial.Topology.GeometriesGraph.Edge)">
- <summary>
-
- </summary>
- <param name="edge"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeIntersectionList.Add(DotSpatial.Topology.Coordinate,System.Int32,System.Double)">
- <summary>
- Adds an intersection into the list, if it isn't already there.
- The input segmentIndex and dist are expected to be normalized.
- </summary>
- <param name="intPt"></param>
- <param name="segmentIndex"></param>
- <param name="dist"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeIntersectionList.GetEnumerator">
- <summary>
- Returns an iterator of EdgeIntersections.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeIntersectionList.IsIntersection(DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="pt"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeIntersectionList.AddEndpoints">
- <summary>
- Adds entries for the first and last points of the edge to the list.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeIntersectionList.AddSplitEdges(System.Collections.IList)">
- <summary>
- Creates new edges for all the edges that the intersections in this
- list split the parent edge into.
- Adds the edges to the input list (this is so a single list
- can be used to accumulate all split edges for a Geometry).
- </summary>
- <param name="edgeList"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeIntersectionList.CreateSplitEdge(DotSpatial.Topology.GeometriesGraph.EdgeIntersection,DotSpatial.Topology.GeometriesGraph.EdgeIntersection)">
- <summary>
- Create a new "split edge" with the section of points between
- (and including) the two intersections.
- The label for the new edge is the same as the label for the parent edge.
- </summary>
- <param name="ei0"></param>
- <param name="ei1"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeIntersectionList.Write(System.IO.StreamWriter)">
- <summary>
-
- </summary>
- <param name="outstream"></param>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.EdgeIntersectionList.Count">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.GeometriesGraph.EdgeList">
- <summary>
- A EdgeList is a list of Edges. It supports locating edges
- that are pointwise equals to a target edge.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.GeometriesGraph.EdgeList._index">
- <summary>
- An index of the edges, for fast lookup.
- a Quadtree is used, because this index needs to be dynamic
- (e.g. allow insertions after queries).
- An alternative would be to use an ordered set based on the values
- of the edge coordinates.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeList.Remove(DotSpatial.Topology.GeometriesGraph.Edge)">
- <summary>
- Remove the selected Edge element from the list if present.
- </summary>
- <param name="e">Edge element to remove from list</param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeList.Add(DotSpatial.Topology.GeometriesGraph.Edge)">
- <summary>
- Insert an edge unless it is already in the list.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeList.AddAll(System.Collections.ICollection)">
- <summary>
-
- </summary>
- <param name="edgeColl"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeList.FindEqualEdge(DotSpatial.Topology.GeometriesGraph.Edge)">
- <summary>
- If there is an edge equal to e already in the list, return it.
- Otherwise return null.
- </summary>
- <param name="e"></param>
- <returns>
- equal edge, if there is one already in the list,
- null otherwise.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeList.GetEnumerator">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeList.Get(System.Int32)">
- <summary>
-
- </summary>
- <param name="i"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeList.FindEdgeIndex(DotSpatial.Topology.GeometriesGraph.Edge)">
- <summary>
- If the edge e is already in the list, return its index.
- </summary>
- <param name="e"></param>
- <returns>
- Index, if e is already in the list,
- -1 otherwise.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeList.Write(System.IO.StreamWriter)">
- <summary>
-
- </summary>
- <param name="outstream"></param>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.EdgeList.Edges">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.EdgeList.Item(System.Int32)">
- <summary>
-
- </summary>
- <param name="index"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.GeometriesGraph.EdgeNodingValidator">
- <summary>
- Validates that a collection of SegmentStrings is correctly noded.
- Throws an appropriate exception if an noding error is found.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeNodingValidator.#ctor(System.Collections.IEnumerable)">
- <summary>
-
- </summary>
- <param name="edges"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeNodingValidator.ToSegmentStrings(System.Collections.IEnumerable)">
- <summary>
-
- </summary>
- <param name="edges"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeNodingValidator.CheckValid">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.GeometriesGraph.EdgeRing">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeRing.#ctor(DotSpatial.Topology.GeometriesGraph.DirectedEdge,DotSpatial.Topology.IGeometryFactory)">
- <summary>
-
- </summary>
- <param name="start"></param>
- <param name="geometryFactory"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeRing.GetCoordinate(System.Int32)">
- <summary>
-
- </summary>
- <param name="i"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeRing.AddHole(DotSpatial.Topology.GeometriesGraph.EdgeRing)">
- <summary>
-
- </summary>
- <param name="ring"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeRing.ToPolygon(DotSpatial.Topology.IGeometryFactory)">
- <summary>
-
- </summary>
- <param name="geometryFactory"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeRing.ComputeRing">
- <summary>
- Compute a LinearRing from the point list previously collected.
- Test if the ring is a hole (i.e. if it is CCW) and set the hole flag
- accordingly.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeRing.GetNext(DotSpatial.Topology.GeometriesGraph.DirectedEdge)">
- <summary>
-
- </summary>
- <param name="de"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeRing.SetEdgeRing(DotSpatial.Topology.GeometriesGraph.DirectedEdge,DotSpatial.Topology.GeometriesGraph.EdgeRing)">
- <summary>
-
- </summary>
- <param name="de"></param>
- <param name="er"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeRing.ComputePoints(DotSpatial.Topology.GeometriesGraph.DirectedEdge)">
- <summary>
- Collect all the points from the DirectedEdges of this ring into a contiguous list.
- </summary>
- <param name="start"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeRing.ComputeMaxNodeDegree">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeRing.SetInResult">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeRing.MergeLabel(DotSpatial.Topology.GeometriesGraph.Label)">
- <summary>
-
- </summary>
- <param name="deLabel"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeRing.MergeLabel(DotSpatial.Topology.GeometriesGraph.Label,System.Int32)">
- <summary>
- Merge the RHS label from a DirectedEdge into the label for this EdgeRing.
- The DirectedEdge label may be null. This is acceptable - it results
- from a node which is NOT an intersection node between the Geometries
- (e.g. the end node of a LinearRing). In this case the DirectedEdge label
- does not contribute any information to the overall labelling, and is simply skipped.
- </summary>
- <param name="deLabel"></param>
- <param name="geomIndex"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeRing.AddPoints(DotSpatial.Topology.GeometriesGraph.Edge,System.Boolean,System.Boolean)">
- <summary>
-
- </summary>
- <param name="edge"></param>
- <param name="isForward"></param>
- <param name="isFirstEdge"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.EdgeRing.ContainsPoint(DotSpatial.Topology.Coordinate)">
- <summary>
- This method will cause the ring to be computed.
- It will also check any holes, if they have been assigned.
- </summary>
- <param name="p"></param>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.EdgeRing.InnerGeometryFactory">
- <summary>
- Gets the inner geometry factory
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.EdgeRing.IsIsolated">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.EdgeRing.IsHole">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.EdgeRing.LinearRing">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.EdgeRing.Label">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.EdgeRing.IsShell">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.EdgeRing.Shell">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.EdgeRing.Edges">
- <summary>
- Returns the list of DirectedEdges that make up this EdgeRing.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.EdgeRing.StartDe">
- <summary>
- The directed edge which starts the list of edges for this EdgeRing.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.EdgeRing.MaxNodeDegree">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.GeometriesGraph.GeometryGraph">
- <summary>
- A GeometryGraph is a graph that models a given Geometry.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.GeometriesGraph.PlanarGraph">
- <summary>
- The computation of the <c>IntersectionMatrix</c> relies on the use of a structure
- called a "topology graph". The topology graph contains nodes and edges
- corresponding to the nodes and line segments of a <c>Geometry</c>. Each
- node and edge in the graph is labeled with its topological location relative to
- the source point.
- Notice that there is no requirement that points of self-intersection be a vertex.
- Thus to obtain a correct topology graph, <c>Geometry</c>s must be
- self-noded before constructing their graphs.
- Two fundamental operations are supported by topology graphs:
- Computing the intersections between all the edges and nodes of a single graph
- Computing the intersections between the edges and nodes of two different graphs
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.PlanarGraph.#ctor(DotSpatial.Topology.GeometriesGraph.NodeFactory)">
- <summary>
- Creates a new instance of a Planar Graph
- </summary>
- <param name="nodeFact">A node Factory</param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.PlanarGraph.#ctor">
- <summary>
- Creates a new instance of a Planar Graph using a default NodeFactory
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.PlanarGraph.Add(DotSpatial.Topology.GeometriesGraph.EdgeEnd)">
- <summary>
- Adds a new EdgeEnd to the planar graph
- </summary>
- <param name="e">The EdgeEnd to add</param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.PlanarGraph.AddEdges(System.Collections.IList)">
- <summary>
- Add a set of edges to the graph. For each edge two DirectedEdges
- will be created. DirectedEdges are NOT linked by this method.
- </summary>
- <param name="edgesToAdd"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.PlanarGraph.AddNode(DotSpatial.Topology.GeometriesGraph.Node)">
- <summary>
- Adds the specified node to the geometry graph's NodeMap
- </summary>
- <param name="node">The node to add</param>
- <returns>The node after the addition</returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.PlanarGraph.AddNode(DotSpatial.Topology.Coordinate)">
- <summary>
- Adds a new ICoordinate as though it were a Node to the node map
- </summary>
- <param name="coord">An ICoordinate to add</param>
- <returns>The newly added node</returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.PlanarGraph.Find(DotSpatial.Topology.Coordinate)">
- <returns>
- The node if found; null otherwise
- </returns>
- <param name="coord"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.PlanarGraph.FindEdgeEnd(DotSpatial.Topology.GeometriesGraph.Edge)">
- <summary>
- Returns the EdgeEnd which has edge e as its base edge
- (MD 18 Feb 2002 - this should return a pair of edges).
- </summary>
- <param name="e"></param>
- <returns> The edge, if found <c>null</c> if the edge was not found.</returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.PlanarGraph.FindEdge(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
- Returns the edge whose first two coordinates are p0 and p1.
- </summary>
- <param name="p0"></param>
- <param name="p1"></param>
- <returns> The edge, if found <c>null</c> if the edge was not found.</returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.PlanarGraph.FindEdgeInSameDirection(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
- Returns the edge which starts at p0 and whose first segment is
- parallel to p1.
- </summary>
- <param name="p0"></param>
- <param name="p1"></param>
- <returns> The edge, if found <c>null</c> if the edge was not found.</returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.PlanarGraph.GetNodeEnumerator">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.PlanarGraph.GetEdgeEnumerator">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.PlanarGraph.InsertEdge(DotSpatial.Topology.GeometriesGraph.Edge)">
- <summary>
- Adds a new EdgeEnd to the planar graph
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.PlanarGraph.LinkResultDirectedEdges">
- <summary>
- Link the DirectedEdges at the nodes of the graph.
- This allows clients to link only a subset of nodes in the graph, for
- efficiency (because they know that only a subset is of interest).
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.PlanarGraph.LinkAllDirectedEdges">
- <summary>
- Link the DirectedEdges at the nodes of the graph.
- This allows clients to link only a subset of nodes in the graph, for
- efficiency (because they know that only a subset is of interest).
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.PlanarGraph.MatchInSameDirection(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
- The coordinate pairs match if they define line segments lying in the same direction.
- E.g. the segments are parallel and in the same quadrant
- (as opposed to parallel and opposite!).
- </summary>
- <param name="p0"></param>
- <param name="p1"></param>
- <param name="ep0"></param>
- <param name="ep1"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.PlanarGraph.WriteEdges(System.IO.StreamWriter)">
- <summary>
-
- </summary>
- <param name="outstream"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.PlanarGraph.IsBoundaryNode(System.Int32,DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="geomIndex"></param>
- <param name="coord"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.PlanarGraph.LinkResultDirectedEdges(System.Collections.IList)">
- <summary>
- For nodes in the Collection, link the DirectedEdges at the node that are in the result.
- This allows clients to link only a subset of nodes in the graph, for
- efficiency (because they know that only a subset is of interest).
- </summary>
- <param name="nodes"></param>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.PlanarGraph.EdgeEnds">
- <summary>
- Gets a list of edge ends
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.PlanarGraph.Edges">
- <summary>
- Gets or sets the list of edges.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.PlanarGraph.Nodes">
- <summary>
- Gets or sets the NodeMap for this graph
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.PlanarGraph.NodeValues">
- <summary>
- Gets a list of the actual values contained in the nodes
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.GeometriesGraph.GeometryGraph._lineEdgeMap">
- <summary>
- The lineEdgeMap is a map of the linestring components of the
- parentGeometry to the edges which are derived from them.
- This is used to efficiently perform findEdge queries
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.GeometriesGraph.GeometryGraph._useBoundaryDeterminationRule">
- <summary>
- If this flag is true, the Boundary Determination Rule will used when deciding
- whether nodes are in the boundary or not
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.GeometryGraph.#ctor(System.Int32,DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="argIndex"></param>
- <param name="parentGeom"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.GeometryGraph.IsInBoundary(System.Int32)">
- <summary>
- This method implements the Boundary Determination Rule
- for determining whether
- a component (node or edge) that appears multiple times in elements
- of a MultiGeometry is in the boundary or the interior of the Geometry.
- The SFS uses the "Mod-2 Rule", which this function implements.
- An alternative (and possibly more intuitive) rule would be
- the "At Most One Rule":
- isInBoundary = (componentCount == 1)
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.GeometryGraph.DetermineBoundary(System.Int32)">
- <summary>
-
- </summary>
- <param name="boundaryCount"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.GeometryGraph.CreateEdgeSetIntersector">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.GeometryGraph.GetBoundaryPoints">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.GeometryGraph.FindEdge(DotSpatial.Topology.ILineString)">
- <summary>
-
- </summary>
- <param name="line"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.GeometryGraph.ComputeSplitEdges(System.Collections.IList)">
- <summary>
-
- </summary>
- <param name="edgelist"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.GeometryGraph.Add(DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="g"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.GeometryGraph.AddCollection(DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="gc"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.GeometryGraph.AddPolygonRing(DotSpatial.Topology.IBasicGeometry,DotSpatial.Topology.LocationType,DotSpatial.Topology.LocationType)">
- <summary>
- The left and right topological location arguments assume that the ring is oriented CW.
- If the ring is in the opposite orientation,
- the left and right locations must be interchanged.
- </summary>
- <param name="lr"></param>
- <param name="cwLeft"></param>
- <param name="cwRight"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.GeometryGraph.AddPolygon(DotSpatial.Topology.Polygon)">
- <summary>
-
- </summary>
- <param name="p"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.GeometryGraph.AddLineString(DotSpatial.Topology.IBasicGeometry)">
- <summary>
-
- </summary>
- <param name="line"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.GeometryGraph.AddEdge(DotSpatial.Topology.GeometriesGraph.Edge)">
- <summary>
- Add an Edge computed externally. The label on the Edge is assumed
- to be correct.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.GeometryGraph.AddPoint(DotSpatial.Topology.Coordinate)">
- <summary>
- Add a point computed externally. The point is assumed to be a
- Point Geometry part, which has a location of INTERIOR.
- </summary>
- <param name="pt"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.GeometryGraph.ComputeSelfNodes(DotSpatial.Topology.Algorithm.LineIntersector,System.Boolean)">
- <summary>
- Compute self-nodes, taking advantage of the Geometry type to
- minimize the number of intersection tests. (E.g. rings are
- not tested for self-intersection, since they are assumed to be valid).
- </summary>
- <param name="li">The <c>LineIntersector</c> to use.</param>
- <param name="computeRingSelfNodes">If <c>false</c>, intersection checks are optimized to not test rings for self-intersection.</param>
- <returns>The SegmentIntersector used, containing information about the intersections found.</returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.GeometryGraph.ComputeEdgeIntersections(DotSpatial.Topology.GeometriesGraph.GeometryGraph,DotSpatial.Topology.Algorithm.LineIntersector,System.Boolean)">
- <summary>
-
- </summary>
- <param name="g"></param>
- <param name="li"></param>
- <param name="includeProper"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.GeometryGraph.InsertPoint(System.Int32,DotSpatial.Topology.Coordinate,DotSpatial.Topology.LocationType)">
- <summary>
-
- </summary>
- <param name="argIndex"></param>
- <param name="coord"></param>
- <param name="onLocation"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.GeometryGraph.InsertBoundaryPoint(System.Int32,DotSpatial.Topology.Coordinate)">
- <summary>
- Adds points using the mod-2 rule of SFS. This is used to add the boundary
- points of dim-1 geometries (Curves/MultiCurves). According to the SFS,
- an endpoint of a Curve is on the boundary
- if it is in the boundaries of an odd number of Geometries.
- </summary>
- <param name="argIndex"></param>
- <param name="coord"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.GeometryGraph.AddSelfIntersectionNodes(System.Int32)">
- <summary>
-
- </summary>
- <param name="argIndex"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.GeometryGraph.AddSelfIntersectionNode(System.Int32,DotSpatial.Topology.Coordinate,DotSpatial.Topology.LocationType)">
- <summary>
- Add a node for a self-intersection.
- If the node is a potential boundary node (e.g. came from an edge which
- is a boundary) then insert it as a potential boundary node.
- Otherwise, just add it as a regular node.
- </summary>
- <param name="argIndex"></param>
- <param name="coord"></param>
- <param name="loc"></param>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.GeometryGraph.HasTooFewPoints">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.GeometryGraph.InvalidPoint">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.GeometryGraph.Geometry">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.GeometryGraph.BoundaryNodes">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.GeometriesGraph.Index.EdgeSetIntersector">
- <summary>
- An <c>EdgeSetIntersector</c> computes all the intersections between the
- edges in the set. It adds the computed intersections to each edge
- they are found on. It may be used in two scenarios:
- determining the internal intersections between a single set of edges
- determining the mutual intersections between two different sets of edges
- It uses a <c>SegmentIntersector</c> to compute the intersections between
- segments and to record statistics about what kinds of intersections were found.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.EdgeSetIntersector.ComputeIntersections(System.Collections.IList,DotSpatial.Topology.GeometriesGraph.Index.SegmentIntersector,System.Boolean)">
- <summary>
- Computes all self-intersections between edges in a set of edges,
- allowing client to choose whether self-intersections are computed.
- </summary>
- <param name="edges">A list of edges to test for intersections.</param>
- <param name="si">The SegmentIntersector to use.</param>
- <param name="testAllSegments"><c>true</c> if self-intersections are to be tested as well.</param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.EdgeSetIntersector.ComputeIntersections(System.Collections.IList,System.Collections.IList,DotSpatial.Topology.GeometriesGraph.Index.SegmentIntersector)">
- <summary>
- Computes all mutual intersections between two sets of edges.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.GeometriesGraph.Index.MonotoneChain">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.MonotoneChain.#ctor(DotSpatial.Topology.GeometriesGraph.Index.MonotoneChainEdge,System.Int32)">
- <summary>
-
- </summary>
- <param name="mce"></param>
- <param name="chainIndex"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.MonotoneChain.ComputeIntersections(DotSpatial.Topology.GeometriesGraph.Index.MonotoneChain,DotSpatial.Topology.GeometriesGraph.Index.SegmentIntersector)">
- <summary>
-
- </summary>
- <param name="mc"></param>
- <param name="si"></param>
- </member>
- <member name="T:DotSpatial.Topology.GeometriesGraph.Index.MonotoneChainEdge">
- <summary>
- MonotoneChains are a way of partitioning the segments of an edge to
- allow for fast searching of intersections.
- They have the following properties:
- the segments within a monotone chain will never intersect each other, and
- the envelope of any contiguous subset of the segments in a monotone chain
- is simply the envelope of the endpoints of the subset.
- Property 1 means that there is no need to test pairs of segments from within
- the same monotone chain for intersection.
- Property 2 allows
- binary search to be used to find the intersection points of two monotone chains.
- For many types of real-world data, these properties eliminate a large number of
- segment comparisons, producing substantial speed gains.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.MonotoneChainEdge.#ctor(DotSpatial.Topology.GeometriesGraph.Edge)">
- <summary>
-
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.MonotoneChainEdge.GetMinX(System.Int32)">
- <summary>
-
- </summary>
- <param name="chainIndex"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.MonotoneChainEdge.GetMaxX(System.Int32)">
- <summary>
-
- </summary>
- <param name="chainIndex"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.MonotoneChainEdge.ComputeIntersects(DotSpatial.Topology.GeometriesGraph.Index.MonotoneChainEdge,DotSpatial.Topology.GeometriesGraph.Index.SegmentIntersector)">
- <summary>
-
- </summary>
- <param name="mce"></param>
- <param name="si"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.MonotoneChainEdge.ComputeIntersectsForChain(System.Int32,DotSpatial.Topology.GeometriesGraph.Index.MonotoneChainEdge,System.Int32,DotSpatial.Topology.GeometriesGraph.Index.SegmentIntersector)">
- <summary>
-
- </summary>
- <param name="chainIndex0"></param>
- <param name="mce"></param>
- <param name="chainIndex1"></param>
- <param name="si"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.MonotoneChainEdge.ComputeIntersectsForChain(System.Int32,System.Int32,DotSpatial.Topology.GeometriesGraph.Index.MonotoneChainEdge,System.Int32,System.Int32,DotSpatial.Topology.GeometriesGraph.Index.SegmentIntersector)">
- <summary>
-
- </summary>
- <param name="start0"></param>
- <param name="end0"></param>
- <param name="mce"></param>
- <param name="start1"></param>
- <param name="end1"></param>
- <param name="ei"></param>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.Index.MonotoneChainEdge.Coordinates">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.Index.MonotoneChainEdge.StartIndexes">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.GeometriesGraph.Index.MonotoneChainIndexer">
- <summary>
- MonotoneChains are a way of partitioning the segments of an edge to
- allow for fast searching of intersections.
- They have the following properties:
- the segments within a monotone chain will never intersect each other, and
- the envelope of any contiguous subset of the segments in a monotone chain
- is simply the envelope of the endpoints of the subset.
- Property 1 means that there is no need to test pairs of segments from within
- the same monotone chain for intersection.
- Property 2 allows
- binary search to be used to find the intersection points of two monotone chains.
- For many types of real-world data, these properties eliminate a large number of
- segment comparisons, producing substantial speed gains.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.MonotoneChainIndexer.ToIntArray(System.Collections.IList)">
- <summary>
-
- </summary>
- <param name="list"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.MonotoneChainIndexer.GetChainStartIndices(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate})">
- <summary>
-
- </summary>
- <param name="pts"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.MonotoneChainIndexer.FindChainEnd(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate},System.Int32)">
- <returns>
- The index of the last point in the monotone chain.
- </returns>
- </member>
- <member name="T:DotSpatial.Topology.GeometriesGraph.Index.SegmentIntersector">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.GeometriesGraph.Index.SegmentIntersector.NumTests">
- <summary>
- Testing only.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.SegmentIntersector.#ctor(DotSpatial.Topology.Algorithm.LineIntersector,System.Boolean,System.Boolean)">
- <summary>
-
- </summary>
- <param name="li"></param>
- <param name="includeProper"></param>
- <param name="recordIsolated"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.SegmentIntersector.IsAdjacentSegments(System.Int32,System.Int32)">
- <summary>
-
- </summary>
- <param name="i1"></param>
- <param name="i2"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.SegmentIntersector.SetBoundaryNodes(System.Collections.ICollection,System.Collections.ICollection)">
- <summary>
-
- </summary>
- <param name="bdyNodes0"></param>
- <param name="bdyNodes1"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.SegmentIntersector.IsTrivialIntersection(DotSpatial.Topology.GeometriesGraph.Edge,System.Int32,DotSpatial.Topology.GeometriesGraph.Edge,System.Int32)">
- <summary>
- A trivial intersection is an apparent self-intersection which in fact
- is simply the point shared by adjacent line segments.
- Notice that closed edges require a special check for the point shared by the beginning
- and end segments.
- </summary>
- <param name="e0"></param>
- <param name="segIndex0"></param>
- <param name="e1"></param>
- <param name="segIndex1"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.SegmentIntersector.AddIntersections(DotSpatial.Topology.GeometriesGraph.Edge,System.Int32,DotSpatial.Topology.GeometriesGraph.Edge,System.Int32)">
- <summary>
- This method is called by clients of the EdgeIntersector class to test for and add
- intersections for two segments of the edges being intersected.
- Notice that clients (such as MonotoneChainEdges) may choose not to intersect
- certain pairs of segments for efficiency reasons.
- </summary>
- <param name="e0"></param>
- <param name="segIndex0"></param>
- <param name="e1"></param>
- <param name="segIndex1"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.SegmentIntersector.IsBoundaryPoint(DotSpatial.Topology.Algorithm.LineIntersector,System.Collections.ICollection[])">
- <summary>
-
- </summary>
- <param name="li"></param>
- <param name="bdyNodes"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.SegmentIntersector.IsBoundaryPoint(DotSpatial.Topology.Algorithm.LineIntersector,System.Collections.IEnumerable)">
- <summary>
-
- </summary>
- <param name="li"></param>
- <param name="bdyNodes"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.Index.SegmentIntersector.ProperIntersectionPoint">
- <returns>
- The proper intersection point, or <c>null</c> if none was found.
- </returns>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.Index.SegmentIntersector.HasIntersection">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.Index.SegmentIntersector.HasProperIntersection">
- <summary>
- A proper intersection is an intersection which is interior to at least two
- line segments. Notice that a proper intersection is not necessarily
- in the interior of the entire Geometry, since another edge may have
- an endpoint equal to the intersection, which according to SFS semantics
- can result in the point being on the Boundary of the Geometry.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.Index.SegmentIntersector.HasProperInteriorIntersection">
- <summary>
- A proper interior intersection is a proper intersection which is not
- contained in the set of boundary nodes set for this SegmentIntersector.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.GeometriesGraph.Index.SimpleEdgeSetIntersector">
- <summary>
- Finds all intersections in one or two sets of edges,
- using the straightforward method of
- comparing all segments.
- This algorithm is too slow for production use, but is useful for testing purposes.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.SimpleEdgeSetIntersector.ComputeIntersections(System.Collections.IList,DotSpatial.Topology.GeometriesGraph.Index.SegmentIntersector,System.Boolean)">
- <summary>
-
- </summary>
- <param name="edges"></param>
- <param name="si"></param>
- <param name="testAllSegments"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.SimpleEdgeSetIntersector.ComputeIntersections(System.Collections.IList,System.Collections.IList,DotSpatial.Topology.GeometriesGraph.Index.SegmentIntersector)">
- <summary>
-
- </summary>
- <param name="edges0"></param>
- <param name="edges1"></param>
- <param name="si"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.SimpleEdgeSetIntersector.ComputeIntersects(DotSpatial.Topology.GeometriesGraph.Edge,DotSpatial.Topology.GeometriesGraph.Edge,DotSpatial.Topology.GeometriesGraph.Index.SegmentIntersector)">
- <summary>
- Performs a brute-force comparison of every segment in each Edge.
- This has n^2 performance, and is about 100 times slower than using
- monotone chains.
- </summary>
- <param name="e0"></param>
- <param name="e1"></param>
- <param name="si"></param>
- </member>
- <member name="T:DotSpatial.Topology.GeometriesGraph.Index.SimpleMcSweepLineIntersector">
- <summary>
- Finds all intersections in one or two sets of edges,
- using an x-axis sweepline algorithm in conjunction with Monotone Chains.
- While still O(n^2) in the worst case, this algorithm
- drastically improves the average-case time.
- The use of MonotoneChains as the items in the index
- seems to offer an improvement in performance over a sweep-line alone.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.SimpleMcSweepLineIntersector.ComputeIntersections(System.Collections.IList,DotSpatial.Topology.GeometriesGraph.Index.SegmentIntersector,System.Boolean)">
- <summary>
-
- </summary>
- <param name="edges"></param>
- <param name="si"></param>
- <param name="testAllSegments"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.SimpleMcSweepLineIntersector.ComputeIntersections(System.Collections.IList,System.Collections.IList,DotSpatial.Topology.GeometriesGraph.Index.SegmentIntersector)">
- <summary>
-
- </summary>
- <param name="edges0"></param>
- <param name="edges1"></param>
- <param name="si"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.SimpleMcSweepLineIntersector.Add(System.Collections.IEnumerable)">
- <summary>
-
- </summary>
- <param name="edges"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.SimpleMcSweepLineIntersector.Add(System.Collections.IEnumerable,System.Object)">
- <summary>
-
- </summary>
- <param name="edges"></param>
- <param name="edgeSet"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.SimpleMcSweepLineIntersector.Add(DotSpatial.Topology.GeometriesGraph.Edge,System.Object)">
- <summary>
-
- </summary>
- <param name="edge"></param>
- <param name="edgeSet"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.SimpleMcSweepLineIntersector.PrepareEvents">
- <summary>
- Because Delete Events have a link to their corresponding Insert event,
- it is possible to compute exactly the range of events which must be
- compared to a given Insert event object.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.SimpleMcSweepLineIntersector.ComputeIntersections(DotSpatial.Topology.GeometriesGraph.Index.SegmentIntersector)">
- <summary>
-
- </summary>
- <param name="si"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.SimpleMcSweepLineIntersector.ProcessOverlaps(System.Int32,System.Int32,DotSpatial.Topology.GeometriesGraph.Index.SweepLineEvent,DotSpatial.Topology.GeometriesGraph.Index.SegmentIntersector)">
- <summary>
-
- </summary>
- <param name="start"></param>
- <param name="end"></param>
- <param name="ev0"></param>
- <param name="si"></param>
- </member>
- <member name="T:DotSpatial.Topology.GeometriesGraph.Index.SimpleSweepLineIntersector">
- <summary>
- Finds all intersections in one or two sets of edges,
- using a simple x-axis sweepline algorithm.
- While still O(n^2) in the worst case, this algorithm
- drastically improves the average-case time.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.SimpleSweepLineIntersector.ComputeIntersections(System.Collections.IList,DotSpatial.Topology.GeometriesGraph.Index.SegmentIntersector,System.Boolean)">
- <summary>
-
- </summary>
- <param name="edges"></param>
- <param name="si"></param>
- <param name="testAllSegments"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.SimpleSweepLineIntersector.ComputeIntersections(System.Collections.IList,System.Collections.IList,DotSpatial.Topology.GeometriesGraph.Index.SegmentIntersector)">
- <summary>
-
- </summary>
- <param name="edges0"></param>
- <param name="edges1"></param>
- <param name="si"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.SimpleSweepLineIntersector.Add(System.Collections.IEnumerable)">
- <summary>
-
- </summary>
- <param name="edges"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.SimpleSweepLineIntersector.Add(System.Collections.IEnumerable,System.Object)">
- <summary>
-
- </summary>
- <param name="edges"></param>
- <param name="edgeSet"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.SimpleSweepLineIntersector.Add(DotSpatial.Topology.GeometriesGraph.Edge,System.Object)">
- <summary>
-
- </summary>
- <param name="edge"></param>
- <param name="edgeSet"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.SimpleSweepLineIntersector.PrepareEvents">
- <summary>
- Because Delete Events have a link to their corresponding Insert event,
- it is possible to compute exactly the range of events which must be
- compared to a given Insert event object.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.SimpleSweepLineIntersector.ComputeIntersections(DotSpatial.Topology.GeometriesGraph.Index.SegmentIntersector)">
- <summary>
-
- </summary>
- <param name="si"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.SimpleSweepLineIntersector.ProcessOverlaps(System.Int32,System.Int32,DotSpatial.Topology.GeometriesGraph.Index.SweepLineEvent,DotSpatial.Topology.GeometriesGraph.Index.SegmentIntersector)">
- <summary>
-
- </summary>
- <param name="start"></param>
- <param name="end"></param>
- <param name="ev0"></param>
- <param name="si"></param>
- </member>
- <member name="T:DotSpatial.Topology.GeometriesGraph.Index.SweepLineEvent">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.GeometriesGraph.Index.SweepLineEvent.INSERT">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.GeometriesGraph.Index.SweepLineEvent.DELETE">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.SweepLineEvent.#ctor(System.Object,System.Double,DotSpatial.Topology.GeometriesGraph.Index.SweepLineEvent,System.Object)">
- <summary>
-
- </summary>
- <param name="edgeSet"></param>
- <param name="x"></param>
- <param name="insertEvent"></param>
- <param name="obj"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.SweepLineEvent.CompareTo(System.Object)">
- <summary>
- ProjectionEvents are ordered first by their x-value, and then by their eventType.
- It is important that Insert events are sorted before Delete events, so that
- items whose Insert and Delete events occur at the same x-value will be
- correctly handled.
- </summary>
- <param name="o"></param>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.Index.SweepLineEvent.EdgeSet">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.Index.SweepLineEvent.IsInsert">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.Index.SweepLineEvent.IsDelete">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.Index.SweepLineEvent.InsertEvent">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.Index.SweepLineEvent.DeleteEventIndex">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.Index.SweepLineEvent.Object">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.GeometriesGraph.Index.SweepLineSegment">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.SweepLineSegment.#ctor(DotSpatial.Topology.GeometriesGraph.Edge,System.Int32)">
- <summary>
-
- </summary>
- <param name="edge"></param>
- <param name="ptIndex"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Index.SweepLineSegment.ComputeIntersections(DotSpatial.Topology.GeometriesGraph.Index.SweepLineSegment,DotSpatial.Topology.GeometriesGraph.Index.SegmentIntersector)">
- <summary>
-
- </summary>
- <param name="ss"></param>
- <param name="si"></param>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.Index.SweepLineSegment.MinX">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.Index.SweepLineSegment.MaxX">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.GeometriesGraph.Label">
- <summary>
- A <c>Label</c> indicates the topological relationship of a component
- of a topology graph to a given <c>Geometry</c>.
- This class supports labels for relationships to two <c>Geometry</c>s,
- which is sufficient for algorithms for binary operations.
- Topology graphs support the concept of labeling nodes and edges in the graph.
- The label of a node or edge specifies its topological relationship to one or
- more geometries. (In fact, since NTS operations have only two arguments labels
- are required for only two geometries). A label for a node or edge has one or
- two elements, depending on whether the node or edge occurs in one or both of the
- input <c>Geometry</c>s. Elements contain attributes which categorize the
- topological location of the node or edge relative to the parent
- <c>Geometry</c>; that is, whether the node or edge is in the interior,
- boundary or exterior of the <c>Geometry</c>. Attributes have a value
- from the set <c>{Interior, Boundary, Exterior}</c>. In a node each
- element has a single attribute <c>On</c>. For an edge each element has a
- triplet of attributes <c>Left, On, Right</c>.
- It is up to the client code to associate the 0 and 1 <c>TopologyLocation</c>s
- with specific geometries.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Label.#ctor(DotSpatial.Topology.LocationType)">
- <summary>
- Construct a Label with a single location for both Geometries.
- Initialize the locations to Null.
- </summary>
- <param name="onLoc"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Label.#ctor(System.Int32,DotSpatial.Topology.LocationType)">
- <summary>
- Construct a Label with a single location for both Geometries.
- Initialize the location for the Geometry index.
- </summary>
- <param name="geomIndex"></param>
- <param name="onLoc"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Label.#ctor(DotSpatial.Topology.LocationType,DotSpatial.Topology.LocationType,DotSpatial.Topology.LocationType)">
- <summary>
- Construct a Label with On, Left and Right locations for both Geometries.
- Initialize the locations for both Geometries to the given values.
- </summary>
- <param name="onLoc"></param>
- <param name="leftLoc"></param>
- <param name="rightLoc"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Label.#ctor(System.Int32,DotSpatial.Topology.LocationType,DotSpatial.Topology.LocationType,DotSpatial.Topology.LocationType)">
- <summary>
- Construct a Label with On, Left and Right locations for both Geometries.
- Initialize the locations for the given Geometry index.
- </summary>
- <param name="geomIndex"></param>
- <param name="onLoc"></param>
- <param name="leftLoc"></param>
- <param name="rightLoc"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Label.#ctor(System.Int32,DotSpatial.Topology.GeometriesGraph.TopologyLocation)">
- <summary>
- Construct a Label with the same values as the argument for the
- given Geometry index.
- </summary>
- <param name="geomIndex"></param>
- <param name="gl"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Label.#ctor(DotSpatial.Topology.GeometriesGraph.Label)">
- <summary>
- Construct a Label with the same values as the argument Label.
- </summary>
- <param name="lbl"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Label.ToLineLabel(DotSpatial.Topology.GeometriesGraph.Label)">
- <summary>
- Converts a Label to a Line label (that is, one with no side Locations).
- </summary>
- <param name="label">Label to convert.</param>
- <returns>Label as Line label.</returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Label.Flip">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Label.GetLocation(System.Int32,DotSpatial.Topology.GeometriesGraph.PositionType)">
- <summary>
-
- </summary>
- <param name="geomIndex"></param>
- <param name="posIndex"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Label.GetLocation(System.Int32)">
- <summary>
-
- </summary>
- <param name="geomIndex"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Label.SetLocation(System.Int32,DotSpatial.Topology.GeometriesGraph.PositionType,DotSpatial.Topology.LocationType)">
- <summary>
-
- </summary>
- <param name="geomIndex"></param>
- <param name="posIndex"></param>
- <param name="location"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Label.SetLocation(System.Int32,DotSpatial.Topology.LocationType)">
- <summary>
-
- </summary>
- <param name="geomIndex"></param>
- <param name="location"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Label.SetAllLocations(System.Int32,DotSpatial.Topology.LocationType)">
- <summary>
-
- </summary>
- <param name="geomIndex"></param>
- <param name="location"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Label.SetAllLocationsIfNull(System.Int32,DotSpatial.Topology.LocationType)">
- <summary>
-
- </summary>
- <param name="geomIndex"></param>
- <param name="location"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Label.SetAllLocationsIfNull(DotSpatial.Topology.LocationType)">
- <summary>
-
- </summary>
- <param name="location"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Label.Merge(DotSpatial.Topology.GeometriesGraph.Label)">
- <summary>
- Merge this label with another one.
- Merging updates any null attributes of this label with the attributes from lbl.
- </summary>
- <param name="lbl"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Label.IsNull(System.Int32)">
- <summary>
-
- </summary>
- <param name="geomIndex"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Label.IsAnyNull(System.Int32)">
- <summary>
-
- </summary>
- <param name="geomIndex"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Label.IsArea">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Label.IsArea(System.Int32)">
- <summary>
-
- </summary>
- <param name="geomIndex"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Label.IsLine(System.Int32)">
- <summary>
-
- </summary>
- <param name="geomIndex"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Label.IsEqualOnSide(DotSpatial.Topology.GeometriesGraph.Label,System.Int32)">
- <summary>
-
- </summary>
- <param name="lbl"></param>
- <param name="side"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Label.AllPositionsEqual(System.Int32,DotSpatial.Topology.LocationType)">
- <summary>
-
- </summary>
- <param name="geomIndex"></param>
- <param name="loc"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Label.ToLine(System.Int32)">
- <summary>
- Converts one GeometryLocation to a Line location.
- </summary>
- <param name="geomIndex"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Label.ToString">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.Label.GeometryCount">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.GeometriesGraph.Node">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Node.#ctor(DotSpatial.Topology.Coordinate,DotSpatial.Topology.GeometriesGraph.EdgeEndStar)">
- <summary>
-
- </summary>
- <param name="coord"></param>
- <param name="edges"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Node.ComputeIm(DotSpatial.Topology.IntersectionMatrix)">
- <summary>
- Basic nodes do not compute IMs.
- </summary>
- <param name="im"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Node.Add(DotSpatial.Topology.GeometriesGraph.EdgeEnd)">
- <summary>
- Add the edge to the list of edges at this node.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Node.MergeLabel(DotSpatial.Topology.GeometriesGraph.Node)">
- <summary>
-
- </summary>
- <param name="n"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Node.MergeLabel(DotSpatial.Topology.GeometriesGraph.Label)">
- <summary>
- To merge labels for two nodes,
- the merged location for each LabelElement is computed.
- The location for the corresponding node LabelElement is set to the result,
- as long as the location is non-null.
- </summary>
- <param name="label2"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Node.SetLabel(System.Int32,DotSpatial.Topology.LocationType)">
- <summary>
-
- </summary>
- <param name="argIndex"></param>
- <param name="onLocation"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Node.SetLabelBoundary(System.Int32)">
- <summary>
- Updates the label of a node to BOUNDARY,
- obeying the mod-2 boundaryDetermination rule.
- </summary>
- <param name="argIndex"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Node.ComputeMergedLocation(DotSpatial.Topology.GeometriesGraph.Label,System.Int32)">
- <summary>
- The location for a given eltIndex for a node will be one
- of { Null, Interior, Boundary }.
- A node may be on both the boundary and the interior of a point;
- in this case, the rule is that the node is considered to be in the boundary.
- The merged location is the maximum of the two input values.
- </summary>
- <param name="label2"></param>
- <param name="eltIndex"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Node.Write(System.IO.StreamWriter)">
- <summary>
-
- </summary>
- <param name="outstream"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Node.ToString">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.Node.Coordinate">
- <summary>
- A Coordinate for this node
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.Node.Edges">
- <summary>
- Gets the edges for this node
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.Node.IsIsolated">
- <summary>
- Gets a boolean that is true if this node is isolated
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.GeometriesGraph.NodeFactory">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.NodeFactory.CreateNode(DotSpatial.Topology.Coordinate)">
- <summary>
- The basic node constructor does not allow for incident edges.
- </summary>
- <param name="coord"></param>
- </member>
- <member name="T:DotSpatial.Topology.GeometriesGraph.NodeMap">
- <summary>
- A map of nodes, indexed by the coordinate of the node.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.NodeMap.#ctor(DotSpatial.Topology.GeometriesGraph.NodeFactory)">
- <summary>
-
- </summary>
- <param name="nodeFact"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.NodeMap.AddNode(DotSpatial.Topology.Coordinate)">
- <summary>
- This method expects that a node has a coordinate value.
- </summary>
- <param name="coord"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.NodeMap.AddNode(DotSpatial.Topology.GeometriesGraph.Node)">
- <summary>
-
- </summary>
- <param name="n"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.NodeMap.Add(DotSpatial.Topology.GeometriesGraph.EdgeEnd)">
- <summary>
- Adds a node for the start point of this EdgeEnd
- (if one does not already exist in this map).
- Adds the EdgeEnd to the (possibly new) node.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.NodeMap.Find(DotSpatial.Topology.Coordinate)">
- <returns>
- The node if found; null otherwise.
- </returns>
- <param name="coord"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.NodeMap.GetEnumerator">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.NodeMap.GetBoundaryNodes(System.Int32)">
- <summary>
-
- </summary>
- <param name="geomIndex"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.NodeMap.Write(System.IO.StreamWriter)">
- <summary>
-
- </summary>
- <param name="outstream"></param>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.NodeMap.Values">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.GeometriesGraph.PositionType">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.GeometriesGraph.PositionType.On">
- <summary>
- An indicator that a Location is <c>on</c> a GraphComponent (0)
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.GeometriesGraph.PositionType.Left">
- <summary>
- An indicator that a Location is to the <c>left</c> of a GraphComponent (1)
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.GeometriesGraph.PositionType.Right">
- <summary>
- An indicator that a Location is to the <c>right</c> of a GraphComponent (2)
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.GeometriesGraph.PositionType.Parallel">
- <summary>
- An indicator that a Location is <c>is parallel to x-axis</c> of a GraphComponent (-1)
- /// </summary>
- </member>
- <member name="T:DotSpatial.Topology.GeometriesGraph.Position">
- <summary>
- A Position indicates the position of a Location relative to a graph component
- (Node, Edge, or Area).
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.Position.Opposite(DotSpatial.Topology.GeometriesGraph.PositionType)">
- <summary>
- Returns Positions.Left if the position is Positions.Right,
- Positions.Right if the position is Left, or the position
- otherwise.
- </summary>
- <param name="position"></param>
- </member>
- <member name="T:DotSpatial.Topology.GeometriesGraph.QuadrantOp">
- <summary>
- Utility functions for working with quadrants, which are numbered as follows:
- <para>
- 1 | 0
- --+--
- 2 | 3
- </para>
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.QuadrantOp.#ctor">
- <summary>
- Only static methods!
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.QuadrantOp.Quadrant(System.Double,System.Double)">
- <summary>
- Returns the quadrant of a directed line segment (specified as x and y
- displacements, which cannot both be 0).
- </summary>
- <param name="dx"></param>
- <param name="dy"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.QuadrantOp.Quadrant(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
- Returns the quadrant of a directed line segment from p0 to p1.
- </summary>
- <param name="p0"></param>
- <param name="p1"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.QuadrantOp.IsOpposite(System.Int32,System.Int32)">
- <summary>
- Returns true if the quadrants are 1 and 3, or 2 and 4.
- </summary>
- <param name="quad1"></param>
- <param name="quad2"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.QuadrantOp.CommonHalfPlane(System.Int32,System.Int32)">
- <summary>
- Returns the right-hand quadrant of the halfplane defined by the two quadrants,
- or -1 if the quadrants are opposite, or the quadrant if they are identical.
- </summary>
- <param name="quad1"></param>
- <param name="quad2"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.QuadrantOp.IsInHalfPlane(System.Int32,System.Int32)">
- <summary>
- Returns whether the given quadrant lies within the given halfplane (specified
- by its right-hand quadrant).
- </summary>
- <param name="quad"></param>
- <param name="halfPlane"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.QuadrantOp.IsNorthern(System.Int32)">
- <summary>
- Returns true if the given quadrant is 0 or 1.
- </summary>
- <param name="quad"></param>
- </member>
- <member name="T:DotSpatial.Topology.GeometriesGraph.TopologyLocation">
- <summary>
- A TopologyLocation is the labelling of a
- GraphComponent's topological relationship to a single Geometry.
- If the parent component is an area edge, each side and the edge itself
- have a topological location. These locations are named:
- On: on the edge
- Left: left-hand side of the edge
- Right: right-hand side
- If the parent component is a line edge or node, there is a single
- topological relationship attribute, On.
- The possible values of a topological location are
- { Location.Null, Location.Exterior, Location.Boundary, Location.Interior }
- The labelling is stored in an array location[j] where
- where j has the values On, Left, Right.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.TopologyLocation.#ctor(System.Collections.Generic.ICollection{DotSpatial.Topology.LocationType})">
- <summary>
-
- </summary>
- <param name="location"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.TopologyLocation.#ctor(DotSpatial.Topology.LocationType,DotSpatial.Topology.LocationType,DotSpatial.Topology.LocationType)">
- <summary>
- Constructs a TopologyLocation specifying how points on, to the left of, and to the
- right of some GraphComponent relate to some Geometry. Possible values for the
- parameters are Location.Null, Location.Exterior, Location.Boundary,
- and Location.Interior.
- </summary>
- <param name="on"></param>
- <param name="left"></param>
- <param name="right"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.TopologyLocation.#ctor(DotSpatial.Topology.LocationType)">
- <summary>
-
- </summary>
- <param name="on"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.TopologyLocation.#ctor(DotSpatial.Topology.GeometriesGraph.TopologyLocation)">
- <summary>
-
- </summary>
- <param name="gl"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.TopologyLocation.Init(System.Int32)">
- <summary>
-
- </summary>
- <param name="size"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.TopologyLocation.Get(DotSpatial.Topology.GeometriesGraph.PositionType)">
- <summary>
-
- </summary>
- <param name="posIndex"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.TopologyLocation.IsEqualOnSide(DotSpatial.Topology.GeometriesGraph.TopologyLocation,System.Int32)">
- <summary>
-
- </summary>
- <param name="le"></param>
- <param name="locIndex"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.TopologyLocation.Flip">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.TopologyLocation.SetAllLocations(DotSpatial.Topology.LocationType)">
- <summary>
-
- </summary>
- <param name="locValue"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.TopologyLocation.SetAllLocationsIfNull(DotSpatial.Topology.LocationType)">
- <summary>
-
- </summary>
- <param name="locValue"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.TopologyLocation.SetLocation(DotSpatial.Topology.GeometriesGraph.PositionType,DotSpatial.Topology.LocationType)">
- <summary>
-
- </summary>
- <param name="locIndex"></param>
- <param name="locValue"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.TopologyLocation.SetLocation(DotSpatial.Topology.LocationType)">
- <summary>
-
- </summary>
- <param name="locValue"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.TopologyLocation.GetLocations">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.TopologyLocation.SetLocations(DotSpatial.Topology.LocationType,DotSpatial.Topology.LocationType,DotSpatial.Topology.LocationType)">
- <summary>
-
- </summary>
- <param name="on"></param>
- <param name="left"></param>
- <param name="right"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.TopologyLocation.SetLocations(DotSpatial.Topology.GeometriesGraph.TopologyLocation)">
- <summary>
-
- </summary>
- <param name="gl"></param>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.TopologyLocation.AllPositionsEqual(DotSpatial.Topology.LocationType)">
- <summary>
-
- </summary>
- <param name="loc"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.TopologyLocation.Merge(DotSpatial.Topology.GeometriesGraph.TopologyLocation)">
- <summary>
- Merge updates only the Null attributes of this object
- with the attributes of another.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.TopologyLocation.ToString">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.TopologyLocation.Item(DotSpatial.Topology.GeometriesGraph.PositionType)">
- <summary>
- Get calls Get(Positions posIndex),
- Set calls SetLocation(Positions locIndex, Locations locValue)
- </summary>
- <param name="posIndex"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.TopologyLocation.IsNull">
- <returns>
- <c>true</c> if all locations are Null.
- </returns>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.TopologyLocation.IsAnyNull">
- <returns>
- <c>true</c> if any locations are Null.
- </returns>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.TopologyLocation.IsArea">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.GeometriesGraph.TopologyLocation.IsLine">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.GeometriesGraph.TwoHorizontalEdgesException">
- <summary>
- A TwoHorizontalEdgesException Class
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.GeometriesGraph.TwoHorizontalEdgesException.#ctor">
- <summary>
- Creates a new instance of TwoHorizontalEdgesException
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.LinearRing">
- <summary>
- Basic implementation of <c>LinearRing</c>.
- The first and last point in the coordinate sequence must be equal.
- Either orientation of the ring is allowed.
- A valid ring must not self-intersect.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.LineString">
- <summary>
- Basic implementation of <c>LineString</c>.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.LineString.Empty">
- <summary>
- Represents an empty <c>LineString</c>.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.LineString._points">
- <summary>
- The points of this <c>LineString</c>.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.LineString.#ctor(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate},DotSpatial.Topology.IGeometryFactory)">
- <summary>
-
- </summary>
- <param name="points">
- The points of the linestring, or <c>null</c>
- to create the empty point. Consecutive points may not be equal.
- </param>
- <param name="factory"></param>
- </member>
- <member name="M:DotSpatial.Topology.LineString.#ctor(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate})">
- <summary>
- Creates a new LineString using the default factory
- </summary>
- <param name="points">
- The points of the linestring, or <c>null</c>
- to create the empty point. Consecutive points may not be equal.
- </param>
- </member>
- <member name="M:DotSpatial.Topology.LineString.#ctor(DotSpatial.Topology.IBasicLineString)">
- <summary>
- Creates a new topologically complete LineString from a LineStringBase
- </summary>
- <param name="lineStringBase"></param>
- </member>
- <member name="M:DotSpatial.Topology.LineString.#ctor(DotSpatial.Topology.IBasicLineString,DotSpatial.Topology.IGeometryFactory)">
- <summary>
- Constructor
- </summary>
- <param name="lineString">
- The points of the linestring, or <c>null</c>
- to create the empty point. Consecutive points may not be equal.
- </param>
- <param name="factory"></param>
- </member>
- <member name="M:DotSpatial.Topology.LineString.#ctor(DotSpatial.Topology.IGeometryFactory)">
- <summary>
- Creates an empty linestring using the specified factory.
- </summary>
- <param name="factory">An IGeometryFactory to use when specifying this linestring.</param>
- </member>
- <member name="M:DotSpatial.Topology.LineString.#ctor(System.Collections.Generic.IEnumerable{DotSpatial.Topology.Coordinate})">
- <summary>
- Rather than using the factory trends, this will create a coordinate sequence by simply using the specified list of coordinates.
- </summary>
- <param name="coordinates">The list of coordinates to use as a new ICoordinateSequence</param>
- </member>
- <member name="M:DotSpatial.Topology.LineString.#ctor(System.Collections.Generic.IEnumerable{DotSpatial.Topology.ICoordinate})">
- <summary>
- Rather than using the factory trends, this will create a coordinate sequence by simply using the specified list of coordinates.
- </summary>
- <param name="coordinates">The list of coordinates to use as a new ICoordinateSequence</param>
- </member>
- <member name="M:DotSpatial.Topology.LineString.Apply(DotSpatial.Topology.ICoordinateFilter)">
- <summary>
- Applys a given ICoordinateFilter to this LineString
- </summary>
- <param name="filter"></param>
- </member>
- <member name="M:DotSpatial.Topology.LineString.Apply(DotSpatial.Topology.IGeometryFilter)">
- <summary>
-
- </summary>
- <param name="filter"></param>
- </member>
- <member name="M:DotSpatial.Topology.LineString.Apply(DotSpatial.Topology.IGeometryComponentFilter)">
- <summary>
-
- </summary>
- <param name="filter"></param>
- </member>
- <member name="M:DotSpatial.Topology.LineString.CompareToSameClass(System.Object)">
- <summary>
- Performs a CompareTo opperation assuming that the specified object is a LineString
- </summary>
- <param name="o"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.LineString.EqualsExact(DotSpatial.Topology.IGeometry,System.Double)">
- <summary>
- Tests the coordinates of this LineString against another geometry and returns true if they are identical.
- </summary>
- <param name="other"></param>
- <param name="tolerance"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.LineString.ClosestPoint(DotSpatial.Topology.Coordinate)">
- <summary>
- Given the specified test point, this checks each segment, and will
- return the closest point on the specified segment.
- </summary>
- <param name="testPoint">The point to test.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.LineString.GetPointN(System.Int32)">
- <summary>
- Returns the N'th point as an Implementation of IPoint. The specific
- implementation is just the DotSpatial.Geometries.Point
- </summary>
- <param name="n"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.LineString.IsCoordinate(DotSpatial.Topology.Coordinate)">
- <summary>
- Returns true if the given point is a vertex of this <c>LineString</c>.
- </summary>
- <param name="pt">The <c>Coordinate</c> to check.</param>
- <returns><c>true</c> if <c>pt</c> is one of this <c>LineString</c>'s vertices.</returns>
- </member>
- <member name="M:DotSpatial.Topology.LineString.Normalize">
- <summary>
- Normalizes a <c>LineString</c>. A normalized linestring
- has the first point which is not equal to it's reflected point
- less than the reflected point.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.LineString.Reverse">
- <summary>
- Creates a <see cref="T:DotSpatial.Topology.LineString"/> whose coordinates are in the reverse order of this objects.
- </summary>
- <returns>A <see cref="T:DotSpatial.Topology.LineString"/> with coordinates in the reverse order.</returns>
- </member>
- <member name="M:DotSpatial.Topology.LineString.ComputeEnvelopeInternal">
- <summary>
- Returns the Envelope of this LineString
- </summary>
- <returns>An IEnvelope interface for the envelope containing this LineString</returns>
- </member>
- <member name="M:DotSpatial.Topology.LineString.OnCopy(DotSpatial.Topology.Geometry)">
- <summary>
- Returns a copy of this ILineString
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.LineString.GetCoordinateN(System.Int32)">
- <summary>
- Returns the Nth coordinate of the coordinate sequence making up this LineString
- </summary>
- <param name="n"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.LineString.IsEquivalentClass(DotSpatial.Topology.IGeometry)">
- <summary>
- Tests other and returns true if other is a LineString
- </summary>
- <param name="other"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.LineString.Offset(System.Double)">
- <summary>
- Calculates a new linestring representing a linestring that is offset by
- distance to the left. Negative distances will be to the right. The final
- LineString may be shorter or longer than the original. Left is determined
- by the vector direction of the segment between the 0th and 1st points.
- Outside bends will be circular curves, rather than extended angles.
- </summary>
- <param name="distance">The double distance to create the offset LineString</param>
- <returns>A valid ILineString interface created from calculations performed on this LineString</returns>
- </member>
- <member name="M:DotSpatial.Topology.LineString.Rotate(DotSpatial.Topology.Coordinate,System.Double)">
- <summary>
- Rotates the LineString by the given radian angle around the Origin.
- </summary>
- <param name="Origin">Coordinate the LineString gets rotated around.</param>
- <param name="radAngle">Rotation angle in radian.</param>
- </member>
- <member name="P:DotSpatial.Topology.LineString.Count">
- <summary>
- Gets the integer count of the number of points in this LineString
- </summary>
- <value></value>
- </member>
- <member name="P:DotSpatial.Topology.LineString.Item(System.Int32)">
- <summary>
- Gets the ICoordinate that exists at the Nth index
- </summary>
- <param name="n"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.LineString.Angle">
- <summary>
- Gets the value of the angle between the <see cref="P:DotSpatial.Topology.LineString.StartPoint"/>
- and the <see cref="P:DotSpatial.Topology.LineString.EndPoint"/>.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.LineString.Boundary">
- <summary>
- Gets a MultiPoint geometry that contains the StartPoint and Endpoint
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.LineString.BoundaryDimension">
- <summary>
- Gets False if the LineString is closed, or Point (0) otherwise, representing the endpoints
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.LineString.Coordinate">
- <summary>
- Gets the 0th coordinate
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.LineString.Coordinates">
- <summary>
- Gets a System.Array of the coordinates
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.LineString.Dimension">
- <summary>
- Gets the dimensionality of a Curve(1)
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.LineString.EndPoint">
- <summary>
- Gets the point corresponding to NumPoints-1 and returns it as an IPoint interface
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.LineString.FeatureType">
- <summary>
- This will always contain Line, even if it is technically empty
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.LineString.GeometryType">
- <summary>
- Gets a string that says "LineString"
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.LineString.IsClosed">
- <summary>
- Gets a boolean that is true if the EndPoint is geometrically equal to the StartPoint in 2 Dimensions
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.LineString.IsEmpty">
- <summary>
- Gets a boolean value that returns true if the count of points in this LineString is 0.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.LineString.IsRing">
- <summary>
- Gets a boolean that is true if this LineString is both closed (has the same start and end point)
- and simple (does not self-intersect)
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.LineString.IsSimple">
- <summary>
- Gets a boolean that is false if any part of this LineString intersects with itself.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.LineString.Length">
- <summary>
- Returns the length of this <c>LineString</c>
- </summary>
- <returns>The length of the polygon.</returns>
- </member>
- <member name="P:DotSpatial.Topology.LineString.NumPoints">
- <summary>
- Gets an integer count of the points.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.LineString.StartPoint">
- <summary>
- Gets the 0 index point as a valid implementation of IPoint interface
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.LinearRing.#ctor(System.Collections.Generic.IEnumerable{DotSpatial.Topology.Coordinate})">
- <summary>
- Creates a new instance of a linear ring where the enumerable collection of
- coordinates represents the set of coordinates to add to the ring.
- </summary>
- <param name="coordinates"></param>
- </member>
- <member name="M:DotSpatial.Topology.LinearRing.#ctor(System.Collections.Generic.IEnumerable{DotSpatial.Topology.ICoordinate})">
- <summary>
- Creates a new instance of a linear ring where the enumerable collection of
- coordinates represents the set of coordinates to add to the ring.
- </summary>
- <param name="coordinates"></param>
- </member>
- <member name="M:DotSpatial.Topology.LinearRing.#ctor(DotSpatial.Topology.IBasicLineString)">
- <summary>
- Constructor
- </summary>
- <param name="linestringbase"></param>
- </member>
- <member name="M:DotSpatial.Topology.LinearRing.ValidateConstruction">
- <summary>
- Correct constructions with non-closed sequences.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.LinearRing.GeometryType">
- <summary>
- Geometry Type
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.LinearRing.IsClosed">
- <summary>
- Gets a boolean that is true if the EndPoint is geometrically equal to the StartPoint in 2 Dimensions.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.LinearRing.FeatureType">
- <summary>
- This will always contain Line, even if it is technically empty
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.LineSegment">
- <summary>
- Represents a line segment defined by two <c>Coordinate</c>s.
- Provides methods to compute various geometric properties
- and relationships of line segments.
- This class is designed to be easily mutable (to the extent of
- having its contained points public).
- This supports a common pattern of reusing a single LineSegment
- object as a way of computing segment properties on the
- segments defined by arrays or lists of <c>Coordinate</c>s.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.LineSegment.#ctor(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
- Creates an instance of LineSegment from two coordiantes
- </summary>
- <param name="p0">The first point of the segment</param>
- <param name="p1">The second point of the segment</param>
- </member>
- <member name="M:DotSpatial.Topology.LineSegment.#ctor(DotSpatial.Topology.ILineSegmentBase)">
- <summary>
- Creates a new instance of a LineSegment which implements
- ILineSegment and ILineSegmentBase from an ILineSegmentBase
- </summary>
- <param name="ls"></param>
- </member>
- <member name="M:DotSpatial.Topology.LineSegment.#ctor">
- <summary>
- Creates a new instance of a LineSegment which implements
- ILineSegment and ILineSegmentBase
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.LineSegment.GetCoordinate(System.Int32)">
- <summary>
- Retrieves the i'th coordiante. Since there are only two,
- i can be either 0 or 1.
- </summary>
- <param name="i">Integer, specifies the coordiante</param>
- <returns>A topologically complete ICoordinate</returns>
- </member>
- <member name="M:DotSpatial.Topology.LineSegment.SetCoordinates(DotSpatial.Topology.ILineSegmentBase)">
- <summary>
- Defines a new LineSegment based on the previous line segment
- </summary>
- <param name="ls">The ILineSegmentBase</param>
- </member>
- <member name="M:DotSpatial.Topology.LineSegment.SetCoordinates(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
- Sets the new coordinates using the ICoordinate interfaces specified
- </summary>
- <param name="p0">The first endpoint</param>
- <param name="p1">The second endpoint</param>
- </member>
- <member name="M:DotSpatial.Topology.LineSegment.OrientationIndex(DotSpatial.Topology.ILineSegmentBase)">
- <summary>
- Determines the orientation of a LineSegment relative to this segment.
- The concept of orientation is specified as follows:
- Given two line segments A and L,
- A is to the left of a segment L if A lies wholly in the
- closed half-plane lying to the left of L
- A is to the right of a segment L if A lies wholly in the
- closed half-plane lying to the right of L
- otherwise, A has indeterminate orientation relative to L. This
- happens if A is collinear with L or if A crosses the line determined by L.
- </summary>
- <param name="seg">The <c>LineSegment</c> to compare.</param>
- <returns>
- 1 if <c>seg</c> is to the left of this segment,
- -1 if <c>seg</c> is to the right of this segment,
- 0 if <c>seg</c> has indeterminate orientation relative to this segment.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.LineSegment.Reverse">
- <summary>
- Reverses the direction of the line segment.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.LineSegment.Normalize">
- <summary>
- Puts the line segment into a normalized form.
- This is useful for using line segments in maps and indexes when
- topological equality rather than exact equality is desired.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.LineSegment.Distance(DotSpatial.Topology.ILineSegmentBase)">
- <summary>
- Computes the distance between this line segment and another one.
- </summary>
- <param name="ls"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.LineSegment.Distance(DotSpatial.Topology.Coordinate)">
- <summary>
- Computes the distance between this line segment and a point.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.LineSegment.DistancePerpendicular(DotSpatial.Topology.Coordinate)">
- <summary>
- Computes the perpendicular distance between the (infinite) line defined
- by this line segment and a point.
- </summary>
- <param name="p"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.LineSegment.ProjectionFactor(DotSpatial.Topology.Coordinate)">
- <summary>
- Compute the projection factor for the projection of the point p
- onto this <c>LineSegment</c>. The projection factor is the constant k
- by which the vector for this segment must be multiplied to
- equal the vector for the projection of p.
- </summary>
- <param name="p"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.LineSegment.Project(DotSpatial.Topology.Coordinate)">
- <summary>
- Compute the projection of a point onto the line determined
- by this line segment.
- Notice that the projected point
- may lie outside the line segment. If this is the case,
- the projection factor will lie outside the range [0.0, 1.0].
- </summary>
- <param name="p"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.LineSegment.Project(DotSpatial.Topology.ILineSegmentBase)">
- <summary>
- Project a line segment onto this line segment and return the resulting
- line segment. The returned line segment will be a subset of
- the target line line segment. This subset may be null, if
- the segments are oriented in such a way that there is no projection.
- Notice that the returned line may have zero length (i.e. the same endpoints).
- This can happen for instance if the lines are perpendicular to one another.
- </summary>
- <param name="seg">The line segment to project.</param>
- <returns>The projected line segment, or <c>null</c> if there is no overlap.</returns>
- </member>
- <member name="M:DotSpatial.Topology.LineSegment.ClosestPoint(DotSpatial.Topology.Coordinate)">
- <summary>
- Computes the closest point on this line segment to another point.
- </summary>
- <param name="p">The point to find the closest point to.</param>
- <returns>
- A Coordinate which is the closest point on the line segment to the point p.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.LineSegment.ClosestPoints(DotSpatial.Topology.ILineSegmentBase)">
- <summary>
- Computes the closest points on a line segment.
- </summary>
- <param name="line"></param>
- <returns>
- A pair of Coordinates which are the closest points on the line segments.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.LineSegment.Intersection(DotSpatial.Topology.ILineSegmentBase)">
- <summary>
- Computes an intersection point between two segments, if there is one.
- There may be 0, 1 or many intersection points between two segments.
- If there are 0, null is returned. If there is 1 or more, a single one
- is returned (chosen at the discretion of the algorithm). If
- more information is required about the details of the intersection,
- the {RobustLineIntersector} class should be used.
- </summary>
- <param name="line"></param>
- <returns> An intersection point, or <c>null</c> if there is none.</returns>
- </member>
- <member name="M:DotSpatial.Topology.LineSegment.Intersection(DotSpatial.Topology.Envelope)">
- <summary>
- Performs an intersection of this line segment with the specified envelope
- </summary>
- <param name="inEnvelope">The envelope to compare against</param>
- <returns>An ILineSegment, or null if there is no intersection.</returns>
- </member>
- <member name="M:DotSpatial.Topology.LineSegment.Intersects(DotSpatial.Topology.Envelope)">
- <summary>
- Determines if any portion of this segment intersects the specified extent.
- </summary>
- <param name="inEnvelope">The</param>
- <returns>Boolean, true if this line segment intersects the specified envelope</returns>
- </member>
- <member name="M:DotSpatial.Topology.LineSegment.CompareTo(System.Object)">
- <summary>
- Compares this object with the specified object for order.
- Uses the standard lexicographic ordering for the points in the LineSegment.
- </summary>
- <param name="o">
- The <c>LineSegment</c> with which this <c>LineSegment</c>
- is being compared.
- </param>
- <returns>
- A negative integer, zero, or a positive integer as this <c>LineSegment</c>
- is less than, equal to, or greater than the specified <c>LineSegment</c>.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.LineSegment.EqualsTopologically(DotSpatial.Topology.ILineSegmentBase)">
- <summary>
- Returns <c>true</c> if <c>other</c> is
- topologically equal to this LineSegment (e.g. irrespective
- of orientation).
- </summary>
- <param name="other">
- A <c>LineSegment</c> with which to do the comparison.
- </param>
- <returns>
- <c>true</c> if <c>other</c> is a <c>LineSegment</c>
- with the same values for the x and y ordinates.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.LineSegment.ToString">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.LineSegment.Equals(System.Object)">
- <summary>
- Returns <c>true</c> if <c>o</c> has the same values for its points.
- </summary>
- <param name="o">A <c>LineSegment</c> with which to do the comparison.</param>
- <returns>
- <c>true</c> if <c>o</c> is a <c>LineSegment</c>
- with the same values for the x and y ordinates.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.LineSegment.op_Equality(DotSpatial.Topology.LineSegment,DotSpatial.Topology.ILineSegmentBase)">
- <summary>
-
- </summary>
- <param name="obj1"></param>
- <param name="obj2"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.LineSegment.op_Inequality(DotSpatial.Topology.LineSegment,DotSpatial.Topology.ILineSegmentBase)">
- <summary>
-
- </summary>
- <param name="obj1"></param>
- <param name="obj2"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.LineSegment.GetHashCode">
- <summary>
- Return HashCode.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.LineSegment.P1">
- <summary>
- returns the one of the ICoordinate that defines this linesegment
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.LineSegment.P0">
- <summary>
- returns the ICoordianteBase defining the second endpoint of the segment
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.LineSegment.Length">
- <summary>
- Computes the length of the line segment.
- </summary>
- <returns>The length of the line segment.</returns>
- </member>
- <member name="P:DotSpatial.Topology.LineSegment.IsHorizontal">
- <summary>
- Tests whether the segment is horizontal.
- </summary>
- <returns><c>true</c> if the segment is horizontal.</returns>
- </member>
- <member name="P:DotSpatial.Topology.LineSegment.IsVertical">
- <summary>
- Tests whether the segment is vertical.
- </summary>
- <returns><c>true</c> if the segment is vertical.</returns>
- </member>
- <member name="P:DotSpatial.Topology.LineSegment.Angle">
- <returns>
- The angle this segment makes with the x-axis (in radians).
- </returns>
- </member>
- <member name="T:DotSpatial.Topology.Location">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Location.ToLocationSymbol(DotSpatial.Topology.LocationType)">
- <summary>
- Converts the location value to a location symbol, for example, <c>EXTERIOR => 'e'</c>.
- </summary>
- <param name="locationValue"></param>
- <returns>Either 'e', 'b', 'i' or '-'.</returns>
- </member>
- <member name="T:DotSpatial.Topology.Matrix4">
- <summary>
- Matrix4
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.MatrixD">
- <summary>
- A 4 x 4 matrix is required for transformations in 3 dimensions
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.MatrixD.#ctor(System.Int32)">
- <summary>
- Creates a new squre identity matrix of the specified size
- </summary>
- <param name="m">The size of the matrix to create</param>
- </member>
- <member name="M:DotSpatial.Topology.MatrixD.#ctor(System.Int32,System.Int32)">
- <summary>
- Creates a new instance of Matrix with m rows and n columns
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.MatrixD.#ctor(System.Double[0:,0:])">
- <summary>
- Creates a matrix using the specified values.
- </summary>
- <param name="values"></param>
- </member>
- <member name="M:DotSpatial.Topology.MatrixD.Multiply(DotSpatial.Topology.IMatrixD)">
- <summary>
- Matrix multiplication only works if the number of columns of the first matrix is the same
- as the number of rows of the second matrix. The first matrix is this object, so this
- will only work if inMatrix has the same number of rows as this matrix has columns.
- </summary>
- <param name="inMatrix">The IMatrix to multiply against this matrix</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.MatrixD.Multiply(System.Double)">
- <summary>
- Multiplies this matrix by the specified scalar value.
- </summary>
- <param name="inScalar"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.MatrixD.M">
- <summary>
- Gets the number of rows
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.MatrixD.N">
- <summary>
- Gets the number of columns
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.MatrixD.NumRows">
- <summary>
- Gets the number of rows
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.MatrixD.NumColumns">
- <summary>
- Gets the number of columns
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.MatrixD.Values">
- <summary>
- Gets or sets the values for this matrix
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Matrix4.#ctor">
- <summary>
- Creates a new instance of Matrix4 that is an identity matrix
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Matrix4.RotateX(System.Double)">
- <summary>
- Rotates this matrix by the specified angle in degrees about the X axis.
- </summary>
- <param name="degrees">Specified the angle in degrees to rotate counter clockwise about the positive axis</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Matrix4.RotateY(System.Double)">
- <summary>
- Rotates this matrix by the specified angle in degrees about the Y axis.
- </summary>
- <param name="degrees"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Matrix4.RotateZ(System.Double)">
- <summary>
- Rotates this matrix by the specified angle in degrees about the Z axis.
- </summary>
- <param name="degrees"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Matrix4.Translate(System.Double,System.Double,System.Double)">
- <summary>
- Translates the matrix by the specified amount in each of the directions
- by multiplying by a translation matrix created from the specified values.
- </summary>
- <param name="x">The translation in the X coordinate</param>
- <param name="y">The translation in the Y coordinate</param>
- <param name="z">The translation in the Z coordinate</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Matrix4.RotationX(System.Double)">
- <summary>
- Creates a 4 x 4 matrix that can be used to rotate a 3D vector about the X axis.
- </summary>
- <param name="degrees">The counter-clockwise angle of rotation when looking at the origin from the positive axis</param>
- <returns>A 4x4 rotation matrix</returns>
- </member>
- <member name="M:DotSpatial.Topology.Matrix4.RotationY(System.Double)">
- <summary>
- Creates a 4 x 4 matrix that can be used to rotate a 3D vector about the Y axis.
- </summary>
- <param name="degrees">The counter-clockwise angle of rotation when looking at the origin from the positive axis</param>
- <returns>A 4x4 rotation matrix</returns>
- </member>
- <member name="M:DotSpatial.Topology.Matrix4.RotationZ(System.Double)">
- <summary>
- Creates a 4 x 4 matrix that can be used to rotate a 3D vector about the Z axis.
- </summary>
- <param name="degrees">The counter-clockwise angle of rotation when looking at the origin from the positive axis</param>
- <returns>A 4x4 rotation matrix</returns>
- </member>
- <member name="M:DotSpatial.Topology.Matrix4.Translation(System.Double,System.Double,System.Double)">
- <summary>
- Creates a 4 x 4 matrix where all the values represent an identity matrix except
- that the bottom row has been set to be the translation values. The result is
- that if a 3D vector is transformed by this matrix, the last row will
- control the translation terms.
- </summary>
- <param name="x">The translation in the x direction</param>
- <param name="y">The translation in the y direction</param>
- <param name="z">The translation in the z direction</param>
- <returns>The translation matrix</returns>
- </member>
- <member name="P:DotSpatial.Topology.Matrix4.Identity">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.MultiLineString">
- <summary>
- Basic implementation of <c>MultiLineString</c>.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.MultiLineString.Empty">
- <summary>
- Represents an empty <c>MultiLineString</c>.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.MultiLineString.#ctor(System.Collections.Generic.IEnumerable{DotSpatial.Topology.IBasicLineString})">
- <summary>
- Constructs a multiLineString from the list of IBasicLineStrings, creating new full geometries where necessary.
- </summary>
- <param name="lineStrings">An IBasicLineString that is either a full IGeometry itself, or will be cast into one by this step</param>
- </member>
- <member name="M:DotSpatial.Topology.MultiLineString.#ctor(DotSpatial.Topology.IBasicLineString[],DotSpatial.Topology.IGeometryFactory)">
- <summary>
- Constructs a <c>MultiLineString</c>.
- </summary>
- <param name="lineStrings">
- The <c>LineString</c>s for this <c>MultiLineString</c>,
- or <c>null</c> or an empty array to create the empty
- point. Elements may be empty <c>LineString</c>s,
- but not <c>null</c>s.
- </param>
- <param name="factory"></param>
- </member>
- <member name="M:DotSpatial.Topology.MultiLineString.#ctor(DotSpatial.Topology.IBasicGeometry)">
- <summary>
- This will attempt to create a new MultiLineString from the specified basic geometry.
- </summary>
- <param name="inBasicGeometry">A Basic geometry that shoule be a LineString or MultiLineString</param>
- </member>
- <member name="M:DotSpatial.Topology.MultiLineString.#ctor(DotSpatial.Topology.IBasicGeometry,DotSpatial.Topology.IGeometryFactory)">
- <summary>
- This will attempt to create a new MultiLineString from the specified basic geometry.
- </summary>
- <param name="inBasicGeometry">A Basic geometry that shoule be a LineString or MultiLineString</param>
- <param name="inFactory">Any valid Geometry Factory</param>
- </member>
- <member name="M:DotSpatial.Topology.MultiLineString.#ctor(DotSpatial.Topology.IBasicLineString[])">
- <summary>
- Constructs a <c>MultiLineString</c>.
- </summary>
- <param name="lineStrings">
- The <c>LineString</c>s for this <c>MultiLineString</c>,
- or <c>null</c> or an empty array to create the empty
- point. Elements may be empty <c>LineString</c>s,
- but not <c>null</c>s.
- </param>
- <remarks>
- For create this <see cref="T:DotSpatial.Topology.Geometry"/> is used a standard <see cref="T:DotSpatial.Topology.GeometryFactory"/>
- with <see cref="T:DotSpatial.Topology.PrecisionModel"/> <c> == </c> <see cref="F:DotSpatial.Topology.PrecisionModelType.Floating"/>.
- </remarks>
- </member>
- <member name="M:DotSpatial.Topology.MultiLineString.#ctor">
- <summary>
- Constructor for a MultiLineString that is empty
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.MultiLineString.EqualsExact(DotSpatial.Topology.IGeometry,System.Double)">
- <summary>
-
- </summary>
- <param name="other"></param>
- <param name="tolerance"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.MultiLineString.Reverse">
- <summary>
- Creates a <see cref="T:DotSpatial.Topology.MultiLineString"/> in the reverse order to this object.
- Both the order of the component LineStrings
- and the order of their coordinate sequences are reversed.
- </summary>
- <returns>a <see cref="T:DotSpatial.Topology.MultiLineString"/> in the reverse order.</returns>
- </member>
- <member name="P:DotSpatial.Topology.MultiLineString.IsClosed">
- <summary>
- Gets a value indicating whether this instance is closed.
- </summary>
- <value><c>true</c> if this instance is closed; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:DotSpatial.Topology.MultiLineString.Dimension">
- <summary>
-
- </summary>
- <value></value>
- </member>
- <member name="P:DotSpatial.Topology.MultiLineString.BoundaryDimension">
- <summary>
-
- </summary>
- <value></value>
- </member>
- <member name="P:DotSpatial.Topology.MultiLineString.GeometryType">
- <summary>
-
- </summary>
- <value></value>
- </member>
- <member name="P:DotSpatial.Topology.MultiLineString.IsSimple">
- <summary>
-
- </summary>
- <value></value>
- </member>
- <member name="P:DotSpatial.Topology.MultiLineString.Boundary">
- <summary>
-
- </summary>
- <value></value>
- </member>
- <member name="P:DotSpatial.Topology.MultiLineString.FeatureType">
- <summary>
- Always returns FeatureTypes.Line
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.MultiLineString.Item(System.Int32)">
- <summary>
- Gets the ILineString that corresponds to the specified index
- </summary>
- <param name="index">The integer index to get a linestring</param>
- <returns>An ILineString</returns>
- </member>
- <member name="T:DotSpatial.Topology.MultiPoint">
- <summary>
- Models a collection of <c>Point</c>s.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.MultiPoint.Empty">
- <summary>
- Represents an empty <c>MultiPoint</c>.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.MultiPoint.#ctor(System.Collections.Generic.IEnumerable{DotSpatial.Topology.Coordinate},DotSpatial.Topology.IGeometryFactory)">
- <summary>
- Constructs a <c>MultiPoint</c>.
- </summary>
- <param name="points">
- The <c>Point</c>s for this <c>MultiPoint</c>
- , or <c>null</c> or an empty array to create the empty point.
- Elements may be empty <c>Point</c>s, but not <c>null</c>s.
- </param>
- <param name="factory"></param>
- </member>
- <member name="M:DotSpatial.Topology.MultiPoint.#ctor(DotSpatial.Topology.IBasicGeometry)">
- <summary>
- This will attempt to create a new MultiPoint from the specified basic geometry.
- </summary>
- <param name="inBasicGeometry">A Point or MultiPoint</param>
- </member>
- <member name="M:DotSpatial.Topology.MultiPoint.#ctor(System.Collections.Generic.IEnumerable{DotSpatial.Topology.Coordinate})">
- <summary>
- Creates new Multipoint using interface points
- </summary>
- <param name="points"></param>
- </member>
- <member name="M:DotSpatial.Topology.MultiPoint.#ctor(System.Collections.Generic.IEnumerable{DotSpatial.Topology.ICoordinate})">
- <summary>
- Creates new Multipoint using interface points
- </summary>
- <param name="points"></param>
- </member>
- <member name="M:DotSpatial.Topology.MultiPoint.EqualsExact(DotSpatial.Topology.IGeometry,System.Double)">
- <summary>
-
- </summary>
- <param name="other"></param>
- <param name="tolerance"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.MultiPoint.CastPoints(System.Collections.Generic.IEnumerable{DotSpatial.Topology.Coordinate})">
- <summary>
- Converts an array of point interface variables into local points.
- Eventually I hope to reduce the amount of "casting" necessary, in order
- to allow as much as possible to occur via an interface.
- </summary>
- <param name="rawPoints"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.MultiPoint.CastPoints(System.Collections.Generic.IEnumerable{DotSpatial.Topology.ICoordinate})">
- <summary>
- Converts an array of point interface variables into local points.
- Eventually I hope to reduce the amount of "casting" necessary, in order
- to allow as much as possible to occur via an interface.
- </summary>
- <param name="rawPoints"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.MultiPoint.GetCoordinate(System.Int32)">
- <summary>
- Returns the <c>Coordinate</c> at the given position.
- </summary>
- <param name="n">The index of the <c>Coordinate</c> to retrieve, beginning at 0.
- </param>
- <returns>The <c>n</c>th <c>Coordinate</c>.</returns>
- </member>
- <member name="P:DotSpatial.Topology.MultiPoint.Dimension">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.MultiPoint.BoundaryDimension">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.MultiPoint.GeometryType">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.MultiPoint.FeatureType">
- <inheritdoc />
- </member>
- <member name="P:DotSpatial.Topology.MultiPoint.Boundary">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.MultiPoint.IsSimple">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.MultiPoint.IsValid">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.MultiPoint.Item(System.Int32)">
- <summary>
- Gets or sets the point that resides at the specified index
- </summary>
- <param name="index">A zero-based integer index specifying the point to get or set</param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.MultiPolygon">
- <summary>
- Basic implementation of <c>MultiPolygon</c>.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.MultiPolygon.Empty">
- <summary>
- Represents an empty <c>MultiPolygon</c>.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.MultiPolygon.#ctor(DotSpatial.Topology.Polygon[])">
- <summary>
- Constructs a <c>MultiPolygon</c>.
- </summary>
- <param name="polygons">
- The <c>Polygon</c>s for this <c>MultiPolygon</c>
- , or <c>null</c> or an empty array to create the empty point.
- Elements may be empty <c>Polygon</c>s, but not <c>null</c>
- s. The polygons must conform to the assertions specified in the
- <see href="http://www.opengis.org/techno/specs.htm"/> OpenGIS Simple Features
- Specification for SQL.
- </param>
- <remarks>
- For create this <see cref="T:DotSpatial.Topology.Geometry"/> is used a standard <see cref="T:DotSpatial.Topology.GeometryFactory"/>
- with <see cref="T:DotSpatial.Topology.PrecisionModel"/> <c> == </c> <see cref="F:DotSpatial.Topology.PrecisionModelType.Floating"/>.
- </remarks>
- </member>
- <member name="M:DotSpatial.Topology.MultiPolygon.#ctor(DotSpatial.Topology.IBasicPolygon[])">
- <summary>
- This was added by Ted Dunsford to allow the construction of MultiPolygons
- from an array of basic polygon interfaces.
- </summary>
- <param name="polygons"></param>
- </member>
- <member name="M:DotSpatial.Topology.MultiPolygon.#ctor(DotSpatial.Topology.IBasicGeometry)">
- <summary>
- This will attempt to create a new MultiPolygon from the specified basic geometry.
- </summary>
- <param name="inBasicGeometry">A Polygon or MultiPolygon</param>
- </member>
- <member name="M:DotSpatial.Topology.MultiPolygon.#ctor(DotSpatial.Topology.IBasicGeometry,DotSpatial.Topology.IGeometryFactory)">
- <summary>
- This will attempt to create a new MultiPolygon from the specified basic geometry.
- </summary>
- <param name="inBasicGeometry">A Polygon or MultiPolygon</param>
- <param name="inFactory">An implementation of the IGeometryFactory interface</param>
- </member>
- <member name="M:DotSpatial.Topology.MultiPolygon.#ctor(DotSpatial.Topology.IPolygon[],DotSpatial.Topology.IGeometryFactory)">
- <summary>
- Constructs a <c>MultiPolygon</c>.
- </summary>
- <param name="polygons">
- The <c>Polygon</c>s for this <c>MultiPolygon</c>
- , or <c>null</c> or an empty array to create the empty point.
- Elements may be empty <c>Polygon</c>s, but not <c>null</c>
- s. The polygons must conform to the assertions specified in the
- <see href="http://www.opengis.org/techno/specs.htm"/> OpenGIS Simple Features
- Specification for SQL.
- </param>
- <param name="factory"></param>
- </member>
- <member name="M:DotSpatial.Topology.MultiPolygon.EqualsExact(DotSpatial.Topology.IGeometry,System.Double)">
- <summary>
-
- </summary>
- <param name="other"></param>
- <param name="tolerance"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.MultiPolygon.FromBasicGeometry(DotSpatial.Topology.IBasicGeometry)">
- <summary>
- Presuming that the specified basic geometry describes a MultiPolygon, this will perform the necessary
- casting in order to create a MultiPolygon. If, in fact, it is only a BasicMultiPolygon, this will
- create a new, fully functional MultiPolygon based on the same coordinates.
- </summary>
- <param name="inGeometry">The IBasicGeometry to turn into a MultiPolygon. </param>
- </member>
- <member name="P:DotSpatial.Topology.MultiPolygon.Dimension">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.MultiPolygon.BoundaryDimension">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.MultiPolygon.GeometryType">
- <summary>
- Always returns "MultiPolygon"
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.MultiPolygon.FeatureType">
- <summary>
- Always Polygon
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.MultiPolygon.IsSimple">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.MultiPolygon.Boundary">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Point">
- <summary>
- Basic implementation of Point.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Point.#ctor">
- <summary>
- Creates a null point with X = 0, Y = 0, which can have its properties set later.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Point.#ctor(DotSpatial.Topology.IGeometryFactory)">
- <summary>
- Creates a null point with X = 0, Y = 0 but using the specified factory for
- precision and SRID stuff.
- </summary>
- <param name="factory">The factory to use when creating this geometry.</param>
- </member>
- <member name="M:DotSpatial.Topology.Point.#ctor(DotSpatial.Topology.Coordinate)">
- <summary>
- Initializes a new instance of the Point class.
- </summary>
- <param name="coordinate">The coordinate used for create this <see cref="T:DotSpatial.Topology.Point"/>.</param>
- <remarks>
- For create this <see cref="T:DotSpatial.Topology.Geometry"/> is used a standard <see cref="T:DotSpatial.Topology.GeometryFactory"/>
- with <see cref="T:DotSpatial.Topology.PrecisionModel"/> <c> == </c> <see cref="F:DotSpatial.Topology.PrecisionModelType.Floating"/>.
- </remarks>
- </member>
- <member name="M:DotSpatial.Topology.Point.#ctor(DotSpatial.Topology.ICoordinate)">
- <summary>
- Initializes a new instance of the Point class.
- </summary>
- <param name="coordinate">The coordinate used for create this <see cref="T:DotSpatial.Topology.Point"/>.</param>
- <remarks>
- For create this <see cref="T:DotSpatial.Topology.Geometry"/> is used a standard <see cref="T:DotSpatial.Topology.GeometryFactory"/>
- with <see cref="T:DotSpatial.Topology.PrecisionModel"/> <c> == </c> <see cref="F:DotSpatial.Topology.PrecisionModelType.Floating"/>.
- </remarks>
- </member>
- <member name="M:DotSpatial.Topology.Point.#ctor(DotSpatial.Topology.Coordinate,DotSpatial.Topology.IGeometryFactory)">
- <summary>
- Constructs a <c>Point</c> with the given coordinate.
- </summary>
- <param name="coordinate">
- Contains the single coordinate on which to base this <c>Point</c>,
- or <c>null</c> to create the empty point.
- </param>
- <param name="factory"></param>
- </member>
- <member name="M:DotSpatial.Topology.Point.#ctor(System.Double,System.Double,System.Double)">
- <summary>
- Initializes a new instance of the Point class.
- </summary>
- <param name="x">The x coordinate.</param>
- <param name="y">The y coordinate.</param>
- <param name="z">The z coordinate.</param>
- /// <remarks>
- For create this <see cref="T:DotSpatial.Topology.Geometry"/> is used a standard <see cref="T:DotSpatial.Topology.GeometryFactory"/>
- with <see cref="T:DotSpatial.Topology.PrecisionModel"/> <c> set to </c> <see cref="F:DotSpatial.Topology.PrecisionModelType.Floating"/>.
- </remarks>
- </member>
- <member name="M:DotSpatial.Topology.Point.#ctor(System.Double,System.Double)">
- <summary>
- Initializes a new instance of the Point class.
- </summary>
- <param name="x">The x coordinate.</param>
- <param name="y">The y coordinate.</param>
- /// <remarks>
- For create this <see cref="T:DotSpatial.Topology.Geometry"/> is used a standard <see cref="T:DotSpatial.Topology.GeometryFactory"/>
- with <see cref="T:DotSpatial.Topology.PrecisionModel"/> <c> set to </c> <see cref="F:DotSpatial.Topology.PrecisionModelType.Floating"/>.
- </remarks>
- </member>
- <member name="F:DotSpatial.Topology.Point.Empty">
- <summary>
- Represents an empty <c>Point</c>.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Point.Apply(DotSpatial.Topology.ICoordinateFilter)">
- <summary>
- Performs an operation with or on this <c>Geometry</c>'s
- coordinates. If you are using this method to modify the point, be sure
- to call GeometryChanged() afterwards. Notice that you cannot use this
- method to
- modify this Geometry if its underlying CoordinateSequence's Get method
- returns a copy of the Coordinate, rather than the actual Coordinate stored
- (if it even stores Coordinates at all).
- </summary>
- <param name="filter">The filter to apply to this <c>Geometry</c>'s coordinates</param>
- </member>
- <member name="M:DotSpatial.Topology.Point.Apply(DotSpatial.Topology.IGeometryFilter)">
- <summary>
- Performs an operation with or on this <c>Geometry</c> and its
- subelement <c>Geometry</c>s (if any).
- Only GeometryCollections and subclasses
- have subelement Geometry's.
- </summary>
- <param name="filter">
- The filter to apply to this <c>Geometry</c> (and
- its children, if it is a <c>GeometryCollection</c>).
- </param>
- </member>
- <member name="M:DotSpatial.Topology.Point.Apply(DotSpatial.Topology.IGeometryComponentFilter)">
- <summary>
- Performs an operation with or on this Geometry and its
- component Geometry's. Only GeometryCollections and
- Polygons have component Geometry's; for Polygons they are the LinearRings
- of the shell and holes.
- </summary>
- <param name="filter">The filter to apply to this <c>Geometry</c>.</param>
- </member>
- <member name="M:DotSpatial.Topology.Point.CompareToSameClass(System.Object)">
- <summary>
- Returns whether this <c>Geometry</c> is greater than, equal to,
- or less than another <c>Geometry</c> having the same class.
- </summary>
- <param name="other">A <c>Geometry</c> having the same class as this <c>Geometry</c>.</param>
- <returns>
- A positive number, 0, or a negative number, depending on whether
- this object is greater than, equal to, or less than <c>o</c>, as
- defined in "Normal Form For Geometry" in the NTS Technical
- Specifications.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Point.ClosestPoint(DotSpatial.Topology.Coordinate)">
- <summary>
- Given the specified test point, this returns the closest point in this geometry.
- </summary>
- <param name="testPoint"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Point.EqualsExact(DotSpatial.Topology.IGeometry,System.Double)">
- EqualsExact
- <summary>
- Returns true if the two <c>Geometry</c>s are exactly equal,
- up to a specified tolerance.
- Two Geometries are exactly within a tolerance equal iff:
- they have the same class,
- they have the same values of Coordinates,
- within the given tolerance distance, in their internal
- Coordinate lists, in exactly the same order.
- If this and the other <c>Geometry</c>s are
- composites and any children are not <c>Geometry</c>s, returns
- false.
- </summary>
- <param name="other">The <c>Geometry</c> with which to compare this <c>Geometry</c></param>
- <param name="tolerance">Distance at or below which two Coordinates will be considered equal.</param>
- <returns>
- <c>true</c> if this and the other <c>Geometry</c>
- are of the same class and have equal internal data.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Point.Normalize">
- Normalize
- <summary>
- Converts this <c>Geometry</c> to normal form (or
- canonical form ). Normal form is a unique representation for <c>Geometry</c>
- s. It can be used to test whether two <c>Geometry</c>s are equal
- in a way that is independent of the ordering of the coordinates within
- them. Normal form equality is a stronger condition than topological
- equality, but weaker than pointwise equality. The definitions for normal
- form use the standard lexicographical ordering for coordinates. "Sorted in
- order of coordinates" means the obvious extension of this ordering to
- sequences of coordinates. This does nothing for points.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Point.OnCopy(DotSpatial.Topology.Geometry)">
- <summary>
- Creates a copy of this Point with the same factory
- specifications and values.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Point.ComputeEnvelopeInternal">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Point.Distance(DotSpatial.Topology.Coordinate)">
- <summary>
- Calculates the vector distance. (This is a 2D operation)
- </summary>
- <param name="coord">Any valid implementation of the ICoordinate Interface</param>
- <returns>The Euclidean distance between two points {Sqrt((X2 - X1)^2 + (Y2 - Y1)^2)</returns>
- </member>
- <member name="M:DotSpatial.Topology.Point.HyperDistance(DotSpatial.Topology.Coordinate)">
- <summary>
- Returns the distance that is appropriate for N dimensions. In otherwords, if this point is
- three dimensional, then all three dimensions will be used for calculating the distance.
- </summary>
- <param name="coordinate">The coordinate to compare to this coordinate</param>
- <returns>A double valued distance measure that is invariant to the number of coordinates</returns>
- <exception cref="T:DotSpatial.Topology.CoordinateMismatchException">The number of dimensions does not match between the points.</exception>
- </member>
- <member name="M:DotSpatial.Topology.Point.Equals2D(DotSpatial.Topology.Coordinate)">
- <summary>
- Tests to see if the X coordinate and Y coordinate are the same between this point and the
- specified Coordinate
- </summary>
- <param name="coord">Any valid implementation of the ICoordinate Interface</param>
- <returns>True if the coordinates are equal, false otherwise</returns>
- </member>
- <member name="M:DotSpatial.Topology.Point.Equals3D(DotSpatial.Topology.Coordinate)">
- <summary>
- Tests to see if the X, Y, and Z coordinate are the same between this point and the
- specified Coordinate
- </summary>
- <param name="coord">Any valid implementation of the ICoordinate Interface</param>
- <returns>True if the coordinates are equal, false otherwise</returns>
- </member>
- <member name="M:DotSpatial.Topology.Point.Rotate(DotSpatial.Topology.Coordinate,System.Double)">
- <summary>
- Rotates the point by the given radian angle around the Origin.
- </summary>
- <param name="Origin">Coordinate the point gets rotated around.</param>
- <param name="radAngle">Rotation angle in radian.</param>
- </member>
- <member name="M:DotSpatial.Topology.Point.SetCoordinate(DotSpatial.Topology.Coordinate)">
- <summary>
- Sets the coordinate.
- </summary>
- <param name="value">The value to set.</param>
- </member>
- <member name="M:DotSpatial.Topology.Point.ToArray">
- <summary>
- Creates an array of ordinate values that is the size of NumDimensions. This
- will not include an M value.
- </summary>
- <returns>An Array of double values, with one value for each ordinate.</returns>
- </member>
- <member name="P:DotSpatial.Topology.Point.Item(System.Int32)">
- <summary>
- Gets or sets the double value of the specific ordinate
- </summary>
- <param name="index"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.Point.RecordNumber">
- <summary>
- This is an optional recordnumber index, used specifically for Shapefile points.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Point.Boundary">
- Boundary
- <summary>
- Returns the boundary, or the empty point if this <c>Geometry</c>
- is empty. For a discussion of this function, see the OpenGIS Simple
- Features Specification. As stated in SFS Section 2.1.13.1, "the boundary
- of a Geometry is a set of Geometries of the next lower dimension."
- </summary>
- <returns>The closure of the combinatorial boundary of this <c>Geometry</c>.</returns>
- </member>
- <member name="P:DotSpatial.Topology.Point.BoundaryDimension">
- <summary>
- Returns the dimension of this <c>Geometry</c>s inherent boundary.
- </summary>
- <returns>
- The dimension of the boundary of the class implementing this
- interface, whether or not this object is the empty point. Returns
- <c>Dimension.False</c> if the boundary is the empty point.
- </returns>
- </member>
- <member name="P:DotSpatial.Topology.Point.Coordinate">
- Coordinate
- <summary>
- Returns a vertex of this Geometry
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Point.Coordinates">
- <summary>
- People might access "Coordinates". If we spontaneously generate a list from
- our single coordinate, thne we will have problems.
- They cannot SET the coordinate like myPoint.Coordinates[0].X = 5.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Point.Dimension">
- Dimension
- <summary>
- Gets or sets the DotSpatial.Geometries.Dimensions of this Geometry.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Point.NumOrdinates">
- <summary>
- Gets the number of ordinates that are being used by the underlying coordinate for
- this point.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Point.Envelope">
- <summary>
- Envelope containing this
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Point.FeatureType">
- <summary>
- This will always contain points, even if it is technically empty
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Point.GeometryType">
- <summary>
- returns Point
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Point.IsEmpty">
- IsEmpty
- <summary>
- Returns whether or not the set of points in this geometry is empty
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Point.IsSimple">
- IsSimple
- <summary>
- Returns false if the Geometry not simple. Subclasses provide their own definition
- of "simple". If this Geometry is empty, returns true. In general, the SFS specifications
- of simplicity seem to follow the following rule: A Geometry is simple if the only
- self-intersections are at boundary points. For all empty Geometrys, IsSimple==true.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Point.IsValid">
- IsValid
- <summary>
- Tests the validity of this Geometry. Subclasses provide their own definition of "valid"
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Point.M">
- <summary>
- The measure coordinate
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Point.NumPoints">
- <summary>
- The integer number of points. In this case it is either 1 or 0 if the point is empty.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Point.Values">
- <summary>
- Gets or sets the ordinates directly as an array of double values for this point.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Point.X">
- <summary>
- The X coordinate
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Point.Y">
- <summary>
- The Y coordinate
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Point.Z">
- <summary>
- The Z coordinate
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Polygon">
- <summary>
- Represents a linear polygon, which may include holes.
- The shell and holes of the polygon are represented by {LinearRing}s.
- In a valid polygon, holes may touch the shell or other holes at a single point.
- However, no sequence of touching holes may split the polygon into two pieces.
- The orientation of the rings in the polygon does not matter.
- The shell and holes must conform to the assertions specified in the
- <see href="http://www.opengis.org/techno/specs.htm"/> OpenGIS Simple Features Specification for SQL.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Polygon.#ctor(DotSpatial.Topology.ILinearRing,DotSpatial.Topology.IGeometryFactory)">
- <summary>
- Constructs a <c>Polygon</c> with the given exterior boundary.
- </summary>
- <param name="shell">
- The outer boundary of the new <c>Polygon</c>,
- or <c>null</c> or an empty <c>LinearRing</c> if the empty
- polygon is to be created.
- </param>
- <param name="factory"></param>
- </member>
- <member name="M:DotSpatial.Topology.Polygon.#ctor(DotSpatial.Topology.ILinearRing)">
- <summary>
- Constructs a <c>Polygon</c> with the given exterior boundary.
- </summary>
- <param name="shell">
- The outer boundary of the new <c>Polygon</c>,
- or <c>null</c> or an empty <c>LinearRing</c> if the empty
- polygon is to be created.
- </param>
- </member>
- <member name="M:DotSpatial.Topology.Polygon.#ctor(System.Collections.Generic.IEnumerable{DotSpatial.Topology.Coordinate})">
- <summary>
- Generates a new polygon using the default geometry factory from the specified set of coordinates,
- where the coordinates will become the polygon shell.
- </summary>
- <param name="shell">The shell of the polygon expressed as an enumerable collection of ICoordinate</param>
- </member>
- <member name="M:DotSpatial.Topology.Polygon.#ctor(DotSpatial.Topology.ILinearRing,DotSpatial.Topology.ILinearRing[])">
- <summary>
- Initializes a new instance of the Polygon class.
- </summary>
- <param name="shell">
- The outer boundary of the new <c>Polygon</c>,
- or <c>null</c> or an empty <c>LinearRing</c> if the empty
- point is to be created.
- </param>
- <param name="holes">
- The inner boundaries of the new <c>Polygon</c>
- , or <c>null</c> or empty <c>LinearRing</c>s if the empty
- point is to be created.
- </param>
- <remarks>
- For create this <see cref="T:DotSpatial.Topology.Geometry"/> is used a standard <see cref="T:DotSpatial.Topology.GeometryFactory"/>
- with <see cref="T:DotSpatial.Topology.PrecisionModel"/> <c> == </c> <see cref="F:DotSpatial.Topology.PrecisionModelType.Floating"/>.
- </remarks>
- </member>
- <member name="M:DotSpatial.Topology.Polygon.#ctor(DotSpatial.Topology.ILinearRing,DotSpatial.Topology.ILinearRing[],DotSpatial.Topology.IGeometryFactory)">
- <summary>
- Constructs a <c>Polygon</c> with the given exterior boundary and
- interior boundaries.
- </summary>
- <param name="inShell">
- The outer boundary of the new <c>Polygon</c>,
- or <c>null</c> or an empty <c>LinearRing</c> if the empty
- point is to be created.
- </param>
- <param name="inHoles">
- The inner boundaries of the new <c>Polygon</c>
- , or <c>null</c> or empty <c>LinearRing</c>s if the empty
- point is to be created.
- </param>
- <param name="factory"></param>
- <exception cref="T:DotSpatial.Topology.PolygonException">Holes must not contain null elements</exception>
- </member>
- <member name="M:DotSpatial.Topology.Polygon.#ctor(DotSpatial.Topology.IBasicPolygon)">
- <summary>
- Constructor for a polygon
- </summary>
- <param name="polygonBase">A simpler BasicPolygon to empower with topology functions</param>
- </member>
- <member name="M:DotSpatial.Topology.Polygon.Apply(DotSpatial.Topology.ICoordinateFilter)">
- <summary>
-
- </summary>
- <param name="filter"></param>
- </member>
- <member name="M:DotSpatial.Topology.Polygon.Apply(DotSpatial.Topology.IGeometryFilter)">
- <summary>
-
- </summary>
- <param name="filter"></param>
- </member>
- <member name="M:DotSpatial.Topology.Polygon.Apply(DotSpatial.Topology.IGeometryComponentFilter)">
- <summary>
-
- </summary>
- <param name="filter"></param>
- </member>
- <member name="M:DotSpatial.Topology.Polygon.CompareToSameClass(System.Object)">
- <summary>
-
- </summary>
- <param name="o"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Polygon.ClearEnvelope">
- <summary>
- Clears any cached envelopes
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Polygon.ConvexHull">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Polygon.EqualsExact(DotSpatial.Topology.IGeometry,System.Double)">
- <summary>
-
- </summary>
- <param name="other"></param>
- <param name="tolerance"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Polygon.ClosestPoint(DotSpatial.Topology.Coordinate)">
- <summary>
- Given the specified test point, this checks each segment, and will
- return the closest point on the specified segment.
- </summary>
- <param name="testPoint">The point to test.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Polygon.GetInteriorRingN(System.Int32)">
- <summary>
-
- </summary>
- <param name="n"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Polygon.Normalize">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Polygon.OnCopy(DotSpatial.Topology.Geometry)">
- <summary>
- Occurs during the copy process and ensures that the shell and holes are all duplicated and not direct references
- </summary>
- <param name="copy"></param>
- </member>
- <member name="M:DotSpatial.Topology.Polygon.ComputeEnvelopeInternal">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Polygon.Rotate(DotSpatial.Topology.Coordinate,System.Double)">
- <summary>
- Rotates the polygon by the given radian angle around the Origin.
- </summary>
- <param name="Origin">Coordinate the polygon gets rotated around.</param>
- <param name="radAngle">Rotation angle in radian.</param>
- </member>
- <member name="M:DotSpatial.Topology.Polygon.Normalize(DotSpatial.Topology.ILinearRing,System.Boolean)">
- <summary>
-
- </summary>
- <param name="ring"></param>
- <param name="clockwise"></param>
- </member>
- <member name="M:DotSpatial.Topology.Polygon.SetHoles(System.Collections.Generic.ICollection{DotSpatial.Topology.IBasicLineString})">
- <summary>
- Hole data might actually already be cast appropriately, but it might need to be
- converted into an array of linear rings.
- </summary>
- <param name="holeData"></param>
- </member>
- <member name="F:DotSpatial.Topology.Polygon.Empty">
- <summary>
- Represents an empty <c>Polygon</c>.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Polygon.ExteriorRing">
- <summary>
- This is just the Shell, but modified to work with IBasicPolygon
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Polygon.Area">
- <summary>
- Returns the area of this <c>Polygon</c>
- </summary>
- <returns>Area in Meters (by default) when using projected coordinates.</returns>
- </member>
- <member name="P:DotSpatial.Topology.Polygon.Boundary">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Polygon.BoundaryDimension">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Polygon.Coordinate">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Polygon.Coordinates">
- <summary>
- Gets all the coordinates for the polygon. Setting this assumes that all the coordintes
- belong in the shell.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Polygon.Dimension">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Polygon.FeatureType">
- <summary>
- This will always contain points, even if it is technically empty
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Polygon.GeometryType">
- <summary>
- Specifically returns a Polygon type
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Polygon.Holes">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Polygon.IsEmpty">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Polygon.IsRectangle">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.Polygon.IsSimple">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Polygon.Length">
- <summary>
- Returns the perimeter of this <c>Polygon</c>.
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.Polygon.NumHoles">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Polygon.NumPoints">
- <summary>
- For polygons, this returns the complete number of points, including all the points
- from the outer ring as well as from the interior holes.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Polygon.Shell">
- <summary>
- This returns a full ILinearRing geometry
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.PolygonException">
- <summary>
- PolygonException
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.PolygonException.#ctor(System.String)">
- <summary>
- Creates a new instance of PolygonException
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.PrecisionModel">
- <summary>
- Specifies the precision model of the <c>Coordinate</c>s in a <c>Geometry</c>.
- In other words, specifies the grid of allowable
- points for all <c>Geometry</c>s.
- The <c>makePrecise</c> method allows rounding a coordinate to
- a "precise" value; that is, one whose
- precision is known exactly.
- Coordinates are assumed to be precise in geometries.
- That is, the coordinates are assumed to be rounded to the
- precision model given for the point.
- NTS input routines automatically round coordinates to the precision model
- before creating Geometries.
- All internal operations
- assume that coordinates are rounded to the precision model.
- Constructive methods (such as bool operations) always round computed
- coordinates to the appropriate precision model.
- Currently three types of precision model are supported:
- <para>
- Floating: represents full double precision floating point.
- This is the default precision model used in NTS
- FloatingSingle: represents single precision floating point.
- Fixed: represents a model with a fixed number of decimal places.
- </para>
- A Fixed Precision Model is specified by a scale factor.
- The scale factor specifies the grid which numbers are rounded to.
- Input coordinates are mapped to fixed coordinates according to the following
- equations:
- jtsPt.x = round((inputPt.x * scale ) / scale
- jtsPt.y = round((inputPt.y * scale ) / scale
- Coordinates are represented internally as double-precision values.
- Since .NET uses the IEEE-394 floating point standard, this
- provides 53 bits of precision. (Thus the maximum precisely representable
- integer is 9, 007, 199, 254, 740, 992).
- NTS methods currently do not handle inputs with different precision models.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.PrecisionModel.MAXIMUM_PRECISE_VALUE">
- <summary>
- The maximum precise value representable in a double. Since IEE754
- double-precision numbers allow 53 bits of mantissa, the value is equal to
- 2^53 - 1. This provides <i>almost</i> 16 decimal digits of precision.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.PrecisionModel._modelType">
- <summary>
- The type of PrecisionModel this represents.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.PrecisionModel._scale">
- <summary>
- The scale factor which determines the number of decimal places in fixed precision.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.PrecisionModel.#ctor">
- <summary>
- Creates a <c>PrecisionModel</c> with a default precision
- of Floating.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.PrecisionModel.#ctor(DotSpatial.Topology.PrecisionModelType)">
- <summary>
- Creates a <c>PrecisionModel</c> that specifies
- an explicit precision model type.
- If the model type is Fixed the scale factor will default to 1.
- </summary>
- <param name="modelType">
- The type of the precision model.
- </param>
- </member>
- <member name="M:DotSpatial.Topology.PrecisionModel.#ctor(System.Double)">
- <summary>
- Creates a <c>PrecisionModel</c> that specifies Fixed precision.
- Fixed-precision coordinates are represented as precise internal coordinates,
- which are rounded to the grid defined by the scale factor.
- </summary>
- <param name="scale">
- Amount by which to multiply a coordinate after subtracting
- the offset, to obtain a precise coordinate.
- </param>
- </member>
- <member name="M:DotSpatial.Topology.PrecisionModel.#ctor(DotSpatial.Topology.PrecisionModel)">
- <summary>
- Copy constructor to create a new <c>PrecisionModel</c>
- from an existing one.
- </summary>
- <param name="pm"></param>
- </member>
- <member name="M:DotSpatial.Topology.PrecisionModel.CompareTo(System.Object)">
- <summary>
- Compares this <c>PrecisionModel</c> object with the specified object for order.
- A PrecisionModel is greater than another if it provides greater precision.
- The comparison is based on the value returned by the
- {getMaximumSignificantDigits) method.
- This comparison is not strictly accurate when comparing floating precision models
- to fixed models; however, it is correct when both models are either floating or fixed.
- </summary>
- <param name="o">
- The <c>PrecisionModel</c> with which this <c>PrecisionModel</c>
- is being compared.
- </param>
- <returns>
- A negative integer, zero, or a positive integer as this <c>PrecisionModel</c>
- is less than, equal to, or greater than the specified <c>PrecisionModel</c>.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.PrecisionModel.GetHashCode">
- <summary>
- Return HashCode.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.PrecisionModel.GetPrecisionModelType">
- <summary>
- Gets the type of this PrecisionModel.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.PrecisionModel.ToInternal(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
- Sets <c>internal</c> to the precise representation of <c>external</c>.
- </summary>
- <param name="cexternal">The original coordinate.</param>
- <param name="cinternal">
- The coordinate whose values will be changed to the
- precise representation of <c>external</c>.
- </param>
- </member>
- <member name="M:DotSpatial.Topology.PrecisionModel.ToInternal(DotSpatial.Topology.Coordinate)">
- <summary>
- Returns the precise representation of <c>external</c>.
- </summary>
- <param name="cexternal">The original coordinate.</param>
- <returns>
- The coordinate whose values will be changed to the precise
- representation of <c>external</c>
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.PrecisionModel.ToExternal(DotSpatial.Topology.Coordinate)">
- <summary>
- Returns the external representation of <c>internal</c>.
- </summary>
- <param name="cinternal">The original coordinate.</param>
- <returns>
- The coordinate whose values will be changed to the
- external representation of <c>internal</c>.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.PrecisionModel.ToExternal(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
- Sets <c>external</c> to the external representation of <c>internal</c>.
- </summary>
- <param name="cinternal">The original coordinate.</param>
- <param name="cexternal">
- The coordinate whose values will be changed to the
- external representation of <c>internal</c>.
- </param>
- </member>
- <member name="M:DotSpatial.Topology.PrecisionModel.MakePrecise(System.Double)">
- <summary>
- Rounds a numeric value to the PrecisionModel grid.
- Symmetric Arithmetic Rounding is used, to provide
- uniform rounding behaviour no matter where the number is
- on the number line.
- </summary>
- <param name="val"></param>
- </member>
- <member name="M:DotSpatial.Topology.PrecisionModel.MakePrecise(DotSpatial.Topology.Coordinate)">
- <summary>
- Rounds a Coordinate to the PrecisionModel grid.
- </summary>
- <param name="coord"></param>
- </member>
- <member name="M:DotSpatial.Topology.PrecisionModel.ToString">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.PrecisionModel.Equals(System.Object)">
- <summary>
-
- </summary>
- <param name="other"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.PrecisionModel.op_Equality(DotSpatial.Topology.PrecisionModel,DotSpatial.Topology.PrecisionModel)">
- <summary>
-
- </summary>
- <param name="obj1"></param>
- <param name="obj2"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.PrecisionModel.op_Inequality(DotSpatial.Topology.PrecisionModel,DotSpatial.Topology.PrecisionModel)">
- <summary>
-
- </summary>
- <param name="obj1"></param>
- <param name="obj2"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.PrecisionModel.IsFloating">
- <summary>
- Tests whether the precision model supports floating point.
- </summary>
- <returns><c>true</c> if the precision model supports floating point.</returns>
- </member>
- <member name="P:DotSpatial.Topology.PrecisionModel.MaximumSignificantDigits">
- <summary>
- Returns the maximum number of significant digits provided by this
- precision model.
- Intended for use by routines which need to print out precise values.
- </summary>
- <returns>
- The maximum number of decimal places provided by this precision model.
- </returns>
- </member>
- <member name="P:DotSpatial.Topology.PrecisionModel.Scale">
- <summary>
- Returns the multiplying factor used to obtain a precise coordinate.
- This method is private because PrecisionModel is intended to
- be an immutable (value) type.
- </summary>
- <returns>
- the amount by which to multiply a coordinate after subtracting
- the offset.
- </returns>
- </member>
- <member name="P:DotSpatial.Topology.PrecisionModel.OffsetX">
- <summary>
- Returns the x-offset used to obtain a precise coordinate.
- </summary>
- <returns>
- The amount by which to subtract the x-coordinate before
- multiplying by the scale.
- </returns>
- </member>
- <member name="P:DotSpatial.Topology.PrecisionModel.OffsetY">
- <summary>
- Returns the y-offset used to obtain a precise coordinate.
- </summary>
- <returns>
- The amount by which to subtract the y-coordinate before
- multiplying by the scale
- </returns>
- </member>
- <member name="T:DotSpatial.Topology.SizeD">
- <summary>
- SizeD is just like a Size class except that it has double valued measures,
- and expresses sizes in three dimensions.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.SizeD.#ctor">
- <summary>
- Creates a new instance of SizeD
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.SizeD.#ctor(System.Double,System.Double,System.Double)">
- <summary>
- Creates a new SizeD structure.
- </summary>
- <param name="xSize">X or longitude size</param>
- <param name="ySize">Y or latitude size</param>
- <param name="zSize">Z or altitude size</param>
- </member>
- <member name="P:DotSpatial.Topology.SizeD.XSize">
- <summary>
- Gets or sets the size in the x direction or longitude
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.SizeD.YSize">
- <summary>
- Gets or sets the size in the y direction or latitude
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.SizeD.ZSize">
- <summary>
- Gets or sets the size in the z direction or altitude
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.TopologyException">
- <summary>
- Indicates an invalid or inconsistent topological situation encountered during processing
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.TopologyException.#ctor(System.String)">
- <summary>
-
- </summary>
- <param name="msg"></param>
- </member>
- <member name="M:DotSpatial.Topology.TopologyException.#ctor(System.String,DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="msg"></param>
- <param name="pt"></param>
- </member>
- <member name="M:DotSpatial.Topology.TopologyException.MsgWithCoord(System.String,DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="msg"></param>
- <param name="pt"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.TopologyException.Coordinate">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Triangle">
- <summary>
- Represents a planar triangle, and provides methods for calculating various
- properties of triangles.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Triangle.#ctor(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="p0"></param>
- <param name="p1"></param>
- <param name="p2"></param>
- </member>
- <member name="P:DotSpatial.Topology.Triangle.P2">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Triangle.P1">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Triangle.P0">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Triangle.InCentre">
- <summary>
- The inCentre of a triangle is the point which is equidistant
- from the sides of the triangle. This is also the point at which the bisectors
- of the angles meet.
- </summary>
- <returns>
- The point which is the InCentre of the triangle.
- </returns>
- </member>
- <member name="T:DotSpatial.Topology.Utilities.GeometryTransformer">
- <summary>
- A framework for processes which transform an input <c>Geometry</c> into
- an output <c>Geometry</c>, possibly changing its structure and type(s).
- This class is a framework for implementing subclasses
- which perform transformations on
- various different Geometry subclasses.
- It provides an easy way of applying specific transformations
- to given point types, while allowing unhandled types to be simply copied.
- Also, the framework handles ensuring that if subcomponents change type
- the parent geometries types change appropriately to maintain valid structure.
- Subclasses will override whichever <c>TransformX</c> methods
- they need to to handle particular Geometry types.
- A typically usage would be a transformation that may transform Polygons into
- Polygons, LineStrings
- or Points. This class would likely need to override the TransformMultiPolygon
- method to ensure that if input Polygons change type the result is a GeometryCollection,
- not a MultiPolygon.
- The default behaviour of this class is to simply recursively transform
- each Geometry component into an identical object by copying.
- Notice that all <c>TransformX</c> methods may return <c>null</c>,
- to avoid creating empty point objects. This will be handled correctly
- by the transformer.
- The Transform method itself will always
- return a point object.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Utilities.GeometryTransformer.PRUNE_EMPTY_GEOMETRY">
- <summary>
- <c>true</c> if empty geometries should not be included in the result.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Utilities.GeometryTransformer.PRESERVE_TYPE">
- <summary>
- <c>true</c> if the type of the input should be preserved.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Utilities.GeometryTransformer._factory">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.GeometryTransformer.Transform(DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="anInputGeom"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.GeometryTransformer.CreateCoordinateSequence(DotSpatial.Topology.Coordinate[])">
- <summary>
- Convenience method which provides standard way of
- creating a <c>CoordinateSequence</c>.
- </summary>
- <param name="coords">The coordinate array to copy.</param>
- <returns>A coordinate sequence for the array.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.GeometryTransformer.Copy(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate})">
- <summary>
- Convenience method which provides statndard way of copying {CoordinateSequence}s
- </summary>
- <param name="seq">The sequence to copy.</param>
- <returns>A deep copy of the sequence.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.GeometryTransformer.TransformCoordinates(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate},DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="coords"></param>
- <param name="parent"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.GeometryTransformer.TransformPoint(DotSpatial.Topology.IPoint)">
- <summary>
-
- </summary>
- <param name="geom"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.GeometryTransformer.TransformMultiPoint(DotSpatial.Topology.IMultiPoint)">
- <summary>
-
- </summary>
- <param name="geom"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.GeometryTransformer.TransformLinearRing(DotSpatial.Topology.ILinearRing)">
- <summary>
-
- </summary>
- <param name="geom"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.GeometryTransformer.TransformLineString(DotSpatial.Topology.ILineString)">
- <summary>
-
- </summary>
- <param name="geom"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.GeometryTransformer.TransformMultiLineString(DotSpatial.Topology.IMultiLineString)">
- <summary>
-
- </summary>
- <param name="geom"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.GeometryTransformer.TransformPolygon(DotSpatial.Topology.IPolygon,DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="geom"></param>
- <param name="parent"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.GeometryTransformer.TransformMultiPolygon(DotSpatial.Topology.IMultiPolygon)">
- <summary>
-
- </summary>
- <param name="geom"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.GeometryTransformer.TransformGeometryCollection(DotSpatial.Topology.IGeometryCollection,DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="geom"></param>
- <param name="parent"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.Utilities.GeometryTransformer.InputGeometry">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Utilities.LinearComponentExtracter">
- <summary>
- Extracts all the 1-dimensional (<c>LineString</c>) components from a <c>Geometry</c>.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.LinearComponentExtracter.#ctor(System.Collections.IList)">
- <summary>
- Constructs a LineExtracterFilter with a list in which to store LineStrings found.
- </summary>
- <param name="lines"></param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.LinearComponentExtracter.Filter(DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="geom"></param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.LinearComponentExtracter.GetLines(DotSpatial.Topology.IGeometry)">
- <summary>
- Extracts the linear components from a single point.
- If more than one point is to be processed, it is more
- efficient to create a single <c>LineExtracterFilter</c> instance
- and pass it to multiple geometries.
- </summary>
- <param name="geom">The point from which to extract linear components.</param>
- <returns>The list of linear components.</returns>
- </member>
- <member name="T:DotSpatial.Topology.Utilities.PointExtracter">
- <summary>
- Extracts all the 0-dimensional (<c>Point</c>) components from a <c>Geometry</c>.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.PointExtracter.#ctor(System.Collections.IList)">
- <summary>
- Constructs a PointExtracterFilter with a list in which to store Points found.
- </summary>
- <param name="pts"></param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.PointExtracter.Filter(DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="geom"></param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.PointExtracter.GetPoints(DotSpatial.Topology.IGeometry)">
- <summary>
- Returns the Point components from a single point.
- If more than one point is to be processed, it is more
- efficient to create a single <c>PointExtracterFilter</c> instance
- and pass it to multiple geometries.
- </summary>
- <param name="geom"></param>
- </member>
- <member name="T:DotSpatial.Topology.Utilities.PolygonExtracter">
- <summary>
- Extracts all the 2-dimensional (<c>Polygon</c>) components from a <c>Geometry</c>.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.PolygonExtracter.#ctor(System.Collections.IList)">
- <summary>
- Constructs a PolygonExtracterFilter with a list in which to store Polygons found.
- </summary>
- <param name="comps"></param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.PolygonExtracter.Filter(DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="geom"></param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.PolygonExtracter.GetPolygons(DotSpatial.Topology.IGeometry)">
- <summary>
- Returns the Polygon components from a single point.
- If more than one point is to be processed, it is more
- efficient to create a single <c>PolygonExtracterFilter</c> instance
- and pass it to multiple geometries.
- </summary>
- <param name="geom"></param>
- </member>
- <member name="T:DotSpatial.Topology.Utilities.ShortCircuitedGeometryVisitor">
- <summary>
- A visitor to Geometry elements which can
- be short-circuited by a given condition.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.ShortCircuitedGeometryVisitor.ApplyTo(DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="geom"></param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.ShortCircuitedGeometryVisitor.Visit(DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="element"></param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.ShortCircuitedGeometryVisitor.IsDone">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.UnsupportedGeometryException">
- <summary>
- Unsupported geometry Exception
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.UnsupportedGeometryException.#ctor">
- <summary>
- Creates a new instance of the unsupported geometry exception
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Vector">
- <summary>
- Contains a magnitude and direction
- Supports more fundamental calculations than LineSegment, rather than topological functions
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Vector.#ctor">
- <summary>
- Creates a new empty vector
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Vector.#ctor(DotSpatial.Topology.Coordinate)">
- <summary>
- Creates a new instance of a vector where the X, Y and Z terms are the same as the
- specified coordinate.
- </summary>
- <param name="coord">The ICoordinate to use</param>
- </member>
- <member name="M:DotSpatial.Topology.Vector.#ctor(DotSpatial.Topology.ICoordinate)">
- <summary>
- Creates a new vector from the Point, assuming the tail of the vector is the origin
- </summary>
- <param name="inPoint">The Point to create a vector from</param>
- </member>
- <member name="M:DotSpatial.Topology.Vector.#ctor(DotSpatial.Topology.ILineSegmentBase)">
- <summary>
- Creates a new vector from a line segment, assuming that the direction is from the start point to the end point
- </summary>
- <param name="inLineSegment">A Topology.LineSegment object to turn into a vector</param>
- </member>
- <member name="M:DotSpatial.Topology.Vector.#ctor(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
- Creates a vector that points from the start coordinate to the end coordinate and
- uses the distance between the two coordinates to form its length.
- </summary>
- <param name="startCoord">The start coordinate</param>
- <param name="endCoord">The end coordinate for the vector</param>
- </member>
- <member name="M:DotSpatial.Topology.Vector.#ctor(System.Double,System.Double,System.Double,System.Double,System.Double,System.Double)">
- <summary>
- Creates a mathematical vector from X1, Y1 to X2, Y2
- </summary>
- <param name="x1">Double, The X coordinate of the start point for the vector</param>
- <param name="y1">Double, The Y coordinate of the start point for the vector </param>
- <param name="z1">Double, the Z coordinate of the start point for the vector</param>
- <param name="x2">Double, The X coordinate of the end point for the vector</param>
- <param name="y2">Double, The Y coordinate of the end point for the vector</param>
- <param name="z2">Double, the Z coordinate of the end point for the vector</param>
- </member>
- <member name="M:DotSpatial.Topology.Vector.#ctor(System.Double,System.Double,System.Double)">
- <summary>
- Creates a mathemtacal vector from the origin to the x, y, z coordinates
- </summary>
- <param name="x">Double, the X coordinate from the origin</param>
- <param name="y">Double, the Y coordinate from the origin</param>
- <param name="z">Double, the Z coordinate from the origin</param>
- </member>
- <member name="M:DotSpatial.Topology.Vector.#ctor(System.Double,DotSpatial.Topology.Angle,DotSpatial.Topology.Angle)">
- <summary>
- Creates a mathematical vector from the origin with the new magnitude and directions specified
- </summary>
- <param name="newMagnitude">Double, the length of the vector</param>
- <param name="theta">The angle in the x-y plane</param>
- <param name="phi">The angle in the z direction</param>
- </member>
- <member name="M:DotSpatial.Topology.Vector.#ctor(System.Double,DotSpatial.Topology.Angle)">
- <summary>
- Creates a mathematical vector in the X-Y plane with angle Theta
- </summary>
- <param name="newMagnitude">Double, The magnitude of the vector</param>
- <param name="theta">Angle, The direction measured counterclockwise from Positive X Axis </param>
- </member>
- <member name="M:DotSpatial.Topology.Vector.#ctor(DotSpatial.Topology.Vector)">
- <summary>
- Creates a new vector from a vector that can be longer or shorter than 3 ordinates.
- If an X, Y or Z value is not specified, it will become 0. Values greater than
- the Z ordinate are lost.
- </summary>
- <param name="vect"></param>
- </member>
- <member name="M:DotSpatial.Topology.Vector.#ctor(DotSpatial.Topology.IMatrixD)">
- <summary>
- Creates a new vector based on the first three values on the first row of the
- matrix. This is useful for working with the result of a transformation matrix.
- </summary>
- <param name="mat">An IMatrixD that should represent the vector</param>
- </member>
- <member name="M:DotSpatial.Topology.Vector.Add(DotSpatial.Topology.Vector)">
- <summary>
- Adds each of the elements of V to the elements of this vector
- </summary>
- <param name="v">Vector, the vector to add to this vector</param>
- <returns>A vector result from the addition</returns>
- </member>
- <member name="M:DotSpatial.Topology.Vector.Norm2">
- <summary>
- Returns the square of the distance of the vector without taking the square root
- This is the same as doting the vector with itself
- </summary>
- <returns>Double, the square of the distance between the vectors</returns>
- </member>
- <member name="M:DotSpatial.Topology.Vector.RotateX(System.Double)">
- <summary>
- Rotates the vector about the X axis as though the tail of the vector were at the origin
- </summary>
- <param name="degrees">The angle in degrees to rotate counter-clockwise when looking at the origin from the positive axis.</param>
- <returns>A new Vector that has been rotated</returns>
- </member>
- <member name="M:DotSpatial.Topology.Vector.RotateY(System.Double)">
- <summary>
- Rotates the vector about the Y axis as though the tail of the vector were at the origin
- </summary>
- <param name="degrees">The angle in degrees to rotate counter-clockwise when looking at the origin from the positive axis.</param>
- <returns>A new Vector that has been rotated</returns>
- </member>
- <member name="M:DotSpatial.Topology.Vector.RotateZ(System.Double)">
- <summary>
- Rotates the vector about the Z axis as though the tail of the vector were at the origin
- </summary>
- <param name="degrees">The angle in degrees to rotate counter-clockwise when looking at the origin from the positive axis.</param>
- <returns>A new Vector that has been rotated</returns>
- </member>
- <member name="M:DotSpatial.Topology.Vector.ToPoint">
- <summary>
- Assuming the vector starts at the origin of 0, 0, 0, this function returns
- a Point representing the tip of the vector.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Vector.ToLineSegment">
- <summary>
- Returns a new segment from this vector, where the StartPoint is 0, 0, 0
- and the End Point is the tip of this vector
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Vector.ToCoordinate">
- <summary>
- Returns an ICoordinate from this vector, where the X, Y and Z value match the values in this vector
- </summary>
- <returns>an ICoordinate, where the X, Y and Z value match the values in this vector</returns>
- </member>
- <member name="M:DotSpatial.Topology.Vector.TransformCoordinate(DotSpatial.Topology.IMatrix4)">
- <summary>
- Transforms a point that has 3 dimensions by multiplying it by the
- specified 3 x 3 matrix in the upper left, but treats the
- bottom row as supplying the translation coordinates.
- </summary>
- <param name="transformMatrix"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Vector.ToMatrix">
- <summary>
- Rotations and transformations work by applying matrix mathematics,
- so this creates a 1 x 4 version of this vector. The 4th value
- is always 1, and allows for the translation terms to work.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Vector.Subtract(DotSpatial.Topology.Vector)">
- <summary>
- Subtracts each element of V from each element of this vector
- </summary>
- <param name="v">Vector, the vector to subtract from this vector</param>
- <returns>A vector result from the subtraction</returns>
- </member>
- <member name="M:DotSpatial.Topology.Vector.Normalize">
- <summary>
- Normalizes the vector.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Vector.Cross(DotSpatial.Topology.Vector)">
- <summary>
- Returns the cross product of this vector with the specified vector V
- </summary>
- <param name="v">The vector to perform a cross product against</param>
- <returns>A vector result from the inner product</returns>
- </member>
- <member name="M:DotSpatial.Topology.Vector.Dot(DotSpatial.Topology.Vector)">
- <summary>
- Returns the dot product of this vector with V2
- </summary>
- <param name="v">The vector to perform an inner product against</param>
- <returns>A Double result from the inner product</returns>
- </member>
- <member name="M:DotSpatial.Topology.Vector.Intersects(DotSpatial.Topology.Vector)">
- <summary>
- Compares the values of each element, and if all the elements are equal, returns true.
- </summary>
- <param name="v">The vector to compare against this vector.</param>
- <returns>Boolean, true if all the elements have the same value.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Vector.Equals(DotSpatial.Topology.Vector)">
- <summary>
- Override for definition of equality for vectors
- </summary>
- <param name="v">A vector to compare with</param>
- <returns>true if the X, Y, and Z coordinates are all equal</returns>
- </member>
- <member name="M:DotSpatial.Topology.Vector.Equals(System.Object)">
- <summary>
- Checks first to make sure that both objects are vectors. If they are,
- then it checks to determine whether or not the X, Y and Z values are equal.
- </summary>
- <param name="vect">The object to test against</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Vector.GetHashCode">
- <summary>
- Returns the hash code.. or something
- </summary>
- <returns>A hash code I guess</returns>
- </member>
- <member name="M:DotSpatial.Topology.Vector.Multiply(System.Double)">
- <summary>
- Returns the scalar product of this vector against a scalar
- </summary>
- <param name="scalar">Double, a value to multiply against all the members of this vector</param>
- <returns>A vector multiplied by the scalar</returns>
- </member>
- <member name="M:DotSpatial.Topology.Vector.Add(DotSpatial.Topology.Vector,DotSpatial.Topology.Vector)">
- <summary>
- Adds the vectors U and V using vector addition, which adds the corresponding components
- </summary>
- <param name="u">One vector to be added</param>
- <param name="v">A second vector to be added</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Vector.CrossProduct(DotSpatial.Topology.Vector,DotSpatial.Topology.Vector)">
- <summary>
- Returns the Cross Product of two vectors U and V
- </summary>
- <param name="u">Vector, the first input vector</param>
- <param name="v">Vector, the second input vector</param>
- <returns>A Vector containing the cross product of U and V</returns>
- </member>
- <member name="M:DotSpatial.Topology.Vector.Divide(DotSpatial.Topology.Vector,System.Double)">
- <summary>
- Multiplies each component of vector U by the Scalar value
- </summary>
- <param name="u">A vector representing the vector to be multiplied</param>
- <param name="scalar">Double, the scalar value to mulitiply the vector components by</param>
- <returns>A Vector representing the vector product of vector U and the Scalar</returns>
- </member>
- <member name="M:DotSpatial.Topology.Vector.DotProduct(DotSpatial.Topology.Vector,DotSpatial.Topology.Vector)">
- <summary>
- Returns the Inner Product also known as the dot product of two vectors, U and V
- </summary>
- <param name="u">The input vector</param>
- <param name="v">The vector to take the inner product against U</param>
- <returns>a Double containing the dot product of U and V</returns>
- </member>
- <member name="M:DotSpatial.Topology.Vector.Norm2(DotSpatial.Topology.Vector)">
- <summary>
- Non-static version of taking the square distance for a vector
- </summary>
- <param name="u">The vector to find the square of the distance of</param>
- <returns>Double, the square of the distance</returns>
- </member>
- <member name="M:DotSpatial.Topology.Vector.Multiply(DotSpatial.Topology.Vector,System.Double)">
- <summary>
- Multiplies each component of vector U by the Scalar value
- </summary>
- <param name="u">A vector representing the vector to be multiplied</param>
- <param name="scalar">Double, the scalar value to mulitiply the vector components by</param>
- <returns>A Vector representing the vector product of vector U and the Scalar</returns>
- </member>
- <member name="M:DotSpatial.Topology.Vector.Subtract(DotSpatial.Topology.Vector,DotSpatial.Topology.Vector)">
- <summary>
- Subtracts Vector V from Vector U
- </summary>
- <param name="u">A Vector to subtract from</param>
- <param name="v">A Vector to subtract</param>
- <returns>The Vector difference U - V</returns>
- </member>
- <member name="M:DotSpatial.Topology.Vector.op_Addition(DotSpatial.Topology.Vector,DotSpatial.Topology.Vector)">
- <summary>
- Adds the vectors U and V using vector addition, which adds the corresponding components
- </summary>
- <param name="u">One vector to be added</param>
- <param name="v">A second vector to be added</param>
- <returns>The sum of the vectors</returns>
- </member>
- <member name="M:DotSpatial.Topology.Vector.op_Equality(DotSpatial.Topology.Vector,DotSpatial.Topology.Vector)">
- <summary>
- Tests equality of the X, Y, and Z members.
- </summary>
- <param name="u">The left hand side vector to test for equality.</param>
- <param name="v">The right hand side vector to test for equality.</param>
- <returns>Returns true if X, Y and Z are equal.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Vector.op_Inequality(DotSpatial.Topology.Vector,DotSpatial.Topology.Vector)">
- <summary>
- Tests inequality of the X, Y and Z members.
- </summary>
- <param name="u">The left hand side vector to test inequality for.</param>
- <param name="v">The right hand side vector to test inequality for</param>
- <returns>Returns true if X, Y and Z are equal</returns>
- </member>
- <member name="M:DotSpatial.Topology.Vector.op_ExclusiveOr(DotSpatial.Topology.Vector,DotSpatial.Topology.Vector)">
- <summary>
- Returns the Cross Product of two vectors U and V
- </summary>
- <param name="u">Vector, the first input vector</param>
- <param name="v">Vector, the second input vector</param>
- <returns>A Vector containing the cross product of U and V</returns>
- </member>
- <member name="M:DotSpatial.Topology.Vector.op_Multiply(DotSpatial.Topology.Vector,DotSpatial.Topology.Vector)">
- <summary>
- Returns the Inner Product also known as the dot product of two vectors, U and V
- </summary>
- <param name="u">The input vector</param>
- <param name="v">The vector to take the inner product against U</param>
- <returns>a Double containing the dot product of U and V</returns>
- </member>
- <member name="M:DotSpatial.Topology.Vector.op_Multiply(System.Double,DotSpatial.Topology.Vector)">
- <summary>
- Multiplies the vectors U and V using vector multiplication,
- which adds the corresponding components
- </summary>
- <param name="scalar">A scalar to multpy to the vector</param>
- <param name="v">A vector to be multiplied</param>
- <returns>The scalar product for the vectors</returns>
- </member>
- <member name="M:DotSpatial.Topology.Vector.op_Multiply(DotSpatial.Topology.Vector,System.Double)">
- <summary>
- Multiplies each component of vector U by the Scalar value
- </summary>
- <param name="u">A vector representing the vector to be multiplied</param>
- <param name="scalar">Double, the scalar value to mulitiply the vector components by</param>
- <returns>A Vector representing the vector product of vector U and the Scalar</returns>
- </member>
- <member name="M:DotSpatial.Topology.Vector.op_Subtraction(DotSpatial.Topology.Vector,DotSpatial.Topology.Vector)">
- <summary>
- Subtracts Vector V from Vector U
- </summary>
- <param name="u">A Vector to subtract from</param>
- <param name="v">A Vector to subtract</param>
- <returns>The Vector difference U - V</returns>
- </member>
- <member name="P:DotSpatial.Topology.Vector.Length">
- <summary>
- The Euclidean distance from the origin to the tip of the 3 dimensional vector
- Setting the magntiude won't change the direction.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Vector.Length2D">
- <summary>
- Returns the magnitude of the projection of the vector onto the base.X-Y plane
- Setting this magnitude will not affect Z, which should be adjusted separately
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Vector.Phi">
- <summary>
- Obtains the angle above the X-Y plane. Positive towards positive Z.
- Values are in radians from -Pi/2 to Pi/2
- Setting this value when no magnitude exists results in a unit vector with angle phi in the X direction.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Vector.Theta">
- <summary>
- Represents the angle in the X-Y plane. 0 along the positive X axis, and increasing counterclockwise
- Values are in Radians. Setting this value when no X-Y magnitude exists results in a unit vector
- between X and Y, but does not affect Z, so you may have something other than a unit vector in 3-D.
- Set theta before phi in order to obtain a unit vector in 3-D space.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Utilities.WkbGeometryType">
- <summary>
- WkbGeometryTypes
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Utilities.WkbGeometryType.Point">
- <summary>
- Point.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Utilities.WkbGeometryType.LineString">
- <summary>
- LineString.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Utilities.WkbGeometryType.Polygon">
- <summary>
- Polygon.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Utilities.WkbGeometryType.MultiPoint">
- <summary>
- MultiPoint.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Utilities.WkbGeometryType.MultiLineString">
- <summary>
- MultiLineString.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Utilities.WkbGeometryType.MultiPolygon">
- <summary>
- MultiPolygon.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Utilities.WkbGeometryType.GeometryCollection">
- <summary>
- GeometryCollection.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Utilities.WkbWriter">
- <summary>
- Writes a Well-Known Binary byte data representation of a <c>Geometry</c>.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Utilities.WkbWriter.INIT_COUNT">
- <summary>
- Standard byte size for each complex point.
- Each complex point (LineString, Polygon, ...) contains:
- 1 byte for ByteOrder and
- 4 bytes for WKBType.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WkbWriter.#ctor">
- <summary>
- Initializes writer with LittleIndian byte order.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WkbWriter.#ctor(DotSpatial.Topology.Utilities.ByteOrder)">
- <summary>
- Initializes writer with the specified byte order.
- </summary>
- <param name="encodingType">Encoding type</param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WkbWriter.Write(DotSpatial.Topology.IGeometry)">
- <summary>
- Writes a WKB representation of a given point.
- </summary>
- <param name="geometry"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WkbWriter.Write(DotSpatial.Topology.IGeometry,System.IO.Stream)">
- <summary>
- Writes a WKB representation of a given point.
- </summary>
- <param name="geometry"></param>
- <param name="stream"></param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WkbWriter.Write(DotSpatial.Topology.IGeometry,System.IO.BinaryWriter)">
- <summary>
-
- </summary>
- <param name="geometry"></param>
- <param name="writer"></param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WkbWriter.WriteByteOrder(System.IO.BinaryWriter)">
- <summary>
- Writes LittleIndian ByteOrder.
- </summary>
- <param name="writer"></param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WkbWriter.Write(DotSpatial.Topology.IPoint,System.IO.BinaryWriter)">
- <summary>
-
- </summary>
- <param name="point"></param>
- <param name="writer"></param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WkbWriter.Write(DotSpatial.Topology.ILineString,System.IO.BinaryWriter)">
- <summary>
-
- </summary>
- <param name="lineString"></param>
- <param name="writer"></param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WkbWriter.Write(DotSpatial.Topology.IPolygon,System.IO.BinaryWriter)">
- <summary>
-
- </summary>
- <param name="polygon"></param>
- <param name="writer"></param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WkbWriter.Write(DotSpatial.Topology.IMultiPoint,System.IO.BinaryWriter)">
- <summary>
-
- </summary>
- <param name="multiPoint"></param>
- <param name="writer"></param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WkbWriter.Write(DotSpatial.Topology.IMultiLineString,System.IO.BinaryWriter)">
- <summary>
-
- </summary>
- <param name="multiLineString"></param>
- <param name="writer"></param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WkbWriter.Write(DotSpatial.Topology.IMultiPolygon,System.IO.BinaryWriter)">
- <summary>
-
- </summary>
- <param name="multiPolygon"></param>
- <param name="writer"></param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WkbWriter.Write(DotSpatial.Topology.IGeometryCollection,System.IO.BinaryWriter)">
- <summary>
-
- </summary>
- <param name="geomCollection"></param>
- <param name="writer"></param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WkbWriter.Write(DotSpatial.Topology.Coordinate,System.IO.BinaryWriter)">
- <summary>
-
- </summary>
- <param name="coordinate"></param>
- <param name="writer"></param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WkbWriter.Write(DotSpatial.Topology.ILinearRing,System.IO.BinaryWriter)">
- <summary>
-
- </summary>
- <param name="ring"></param>
- <param name="writer"></param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WkbWriter.GetBytes(DotSpatial.Topology.IGeometry)">
- <summary>
- Sets corrent length for Byte Stream.
- </summary>
- <param name="geometry"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WkbWriter.SetByteStream(DotSpatial.Topology.IGeometry)">
- <summary>
- Sets corrent length for Byte Stream.
- </summary>
- <param name="geometry"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WkbWriter.SetByteStream(DotSpatial.Topology.IGeometryCollection)">
- <summary>
-
- </summary>
- <param name="geometry"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WkbWriter.SetByteStream(DotSpatial.Topology.IMultiPolygon)">
- <summary>
-
- </summary>
- <param name="geometry"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WkbWriter.SetByteStream(DotSpatial.Topology.IMultiLineString)">
- <summary>
-
- </summary>
- <param name="geometry"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WkbWriter.SetByteStream(DotSpatial.Topology.IMultiPoint)">
- <summary>
-
- </summary>
- <param name="geometry"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WkbWriter.SetByteStream(DotSpatial.Topology.IPolygon)">
- <summary>
-
- </summary>
- <param name="geometry"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WkbWriter.SetByteStream(DotSpatial.Topology.ILineString)">
- <summary>
-
- </summary>
- <param name="geometry"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WkbWriter.SetByteStream(DotSpatial.Topology.IPoint)">
- <summary>
-
- </summary>
- <param name="geometry"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.Utilities.WktWriter">
- <summary>
- Outputs the textual representation of a Geometry.
- The WktWriter outputs coordinates rounded to the precision
- model. No more than the maximum number of necessary decimal places will be
- output.
- The Well-known Text format is defined in the OpenGIS Simple Features Specification
- (http://www.opengis.org/techno/specs.htm) for SQL.
- A non-standard "LINEARRING" tag is used for LinearRings. The WKT spec does
- not define a special tag for LinearRings. The standard tag to use is
- "LINESTRING".
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WktWriter.ToPoint(DotSpatial.Topology.Coordinate)">
- <summary>
- Generates the WKT for a <c>Point</c>.
- </summary>
- <param name="p0">The point coordinate.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WktWriter.ToLineString(DotSpatial.Topology.ICoordinateSequence)">
- <summary>
- Generates the WKT for a N-point <c>LineString</c>.
- </summary>
- <param name="seq">The sequence to output.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WktWriter.ToLineString(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
- Generates the WKT for a 2-point <c>LineString</c>.
- </summary>
- <param name="p0">The first coordinate.</param>
- <param name="p1">The second coordinate.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WktWriter.CreateFormatter(DotSpatial.Topology.PrecisionModel)">
- <summary>
- Creates the <c>NumberFormatInfo</c> used to write <c>double</c>s
- with a sufficient number of decimal places.
- </summary>
- <param name="precisionModel">
- The <c>PrecisionModel</c> used to determine
- the number of decimal places to write.
- </param>
- <returns>
- A <c>NumberFormatInfo</c> that write <c>double</c>
- s without scientific notation.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WktWriter.StringOfChar(System.Char,System.Int32)">
- <summary>
- Returns a <c>String</c> of repeated characters.
- </summary>
- <param name="ch">The character to repeat.</param>
- <param name="count">The number of times to repeat the character.</param>
- <returns>A <c>string</c> of characters.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WktWriter.Write(DotSpatial.Topology.Geometry)">
- <summary>
- Converts a <c>Geometry</c> to its Well-known Text representation.
- </summary>
- <param name="geometry">A <c>Geometry</c> to process.</param>
- <returns>A Geometry Tagged Text string (see the OpenGIS Simple Features Specification).</returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WktWriter.Write(DotSpatial.Topology.Geometry,System.IO.TextWriter)">
- <summary>
- Converts a <c>Geometry</c> to its Well-known Text representation.
- </summary>
- <param name="geometry">A <c>Geometry</c> to process.</param>
- <param name="writer"></param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WktWriter.WriteFormatted(DotSpatial.Topology.Geometry)">
- <summary>
- Same as <c>write</c>, but with newlines and spaces to make the
- well-known text more readable.
- </summary>
- <param name="geometry">A <c>Geometry</c> to process</param>
- <returns>
- A "Geometry Tagged Text" string (see the OpenGIS Simple
- Features Specification), with newlines and spaces.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WktWriter.WriteFormatted(DotSpatial.Topology.Geometry,System.IO.TextWriter)">
- <summary>
- Same as <c>write</c>, but with newlines and spaces to make the
- well-known text more readable.
- </summary>
- <param name="geometry">A <c>Geometry</c> to process</param>
- <param name="writer"></param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WktWriter.WriteFormatted(DotSpatial.Topology.IGeometry,System.Boolean,System.IO.TextWriter)">
- <summary>
- Converts a <c>Geometry</c> to its Well-known Text representation.
- </summary>
- <param name="geometry">A <c>Geometry</c> to process</param>
- <param name="isFormatted"></param>
- <param name="writer"></param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WktWriter.AppendGeometryTaggedText(DotSpatial.Topology.IGeometry,System.Int32,System.IO.TextWriter)">
- <summary>
- Converts a <c>Geometry</c> to <Geometry Tagged Text format,
- then appends it to the writer.
- </summary>
- <param name="geometry">/he <c>Geometry</c> to process.</param>
- <param name="level"></param>
- <param name="writer">/he output writer to append to.</param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WktWriter.AppendPointTaggedText(DotSpatial.Topology.Coordinate,System.IO.TextWriter)">
- <summary>
- Converts a <c>Coordinate</c> to Point Tagged Text format,
- then appends it to the writer.
- </summary>
- <param name="coordinate">The <c>Coordinate</c> to process.</param>
- <param name="writer">The output writer to append to.</param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WktWriter.AppendLineStringTaggedText(DotSpatial.Topology.IBasicLineString,System.Int32,System.IO.TextWriter)">
- <summary>
- Converts a <c>LineString</c> to <LineString Tagged Text
- format, then appends it to the writer.
- </summary>
- <param name="lineString">The <c>LineString</c> to process.</param>
- <param name="level"></param>
- <param name="writer">The output writer to append to.</param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WktWriter.AppendLinearRingTaggedText(DotSpatial.Topology.ILinearRing,System.Int32,System.IO.TextWriter)">
- <summary>
- Converts a <c>LinearRing</c> to <LinearRing Tagged Text
- format, then appends it to the writer.
- </summary>
- <param name="linearRing">The <c>LinearRing</c> to process.</param>
- <param name="level"></param>
- <param name="writer">The output writer to append to.</param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WktWriter.AppendPolygonTaggedText(DotSpatial.Topology.IPolygon,System.Int32,System.IO.TextWriter)">
- <summary>
- Converts a <c>Polygon</c> to Polygon Tagged Text format,
- then appends it to the writer.
- </summary>
- <param name="polygon">The <c>Polygon</c> to process.</param>
- <param name="level"></param>
- <param name="writer">The output writer to append to.</param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WktWriter.AppendMultiPointTaggedText(DotSpatial.Topology.IMultiPoint,System.IO.TextWriter)">
- <summary>
- Converts a <c>MultiPoint</c> to <MultiPoint Tagged Text
- format, then appends it to the writer.
- </summary>
- <param name="multipoint">The <c>MultiPoint</c> to process.</param>
- <param name="writer">The output writer to append to.</param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WktWriter.AppendMultiLineStringTaggedText(DotSpatial.Topology.IMultiLineString,System.Int32,System.IO.TextWriter)">
- <summary>
- Converts a <c>MultiLineString</c> to MultiLineString Tagged
- Text format, then appends it to the writer.
- </summary>
- <param name="multiLineString">The <c>MultiLineString</c> to process.</param>
- <param name="level"></param>
- <param name="writer">The output writer to append to.</param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WktWriter.AppendMultiPolygonTaggedText(DotSpatial.Topology.IMultiPolygon,System.Int32,System.IO.TextWriter)">
- <summary>
- Converts a <c>MultiPolygon</c> to MultiPolygon Tagged Text
- format, then appends it to the writer.
- </summary>
- <param name="multiPolygon">The <c>MultiPolygon</c> to process.</param>
- <param name="level"></param>
- <param name="writer">The output writer to append to.</param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WktWriter.AppendGeometryCollectionTaggedText(DotSpatial.Topology.IGeometryCollection,System.Int32,System.IO.TextWriter)">
- <summary>
- Converts a <c>GeometryCollection</c> to GeometryCollection
- Tagged Text format, then appends it to the writer.
- </summary>
- <param name="geometryCollection">The <c>GeometryCollection</c> to process.</param>
- <param name="level"></param>
- <param name="writer">The output writer to append to.</param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WktWriter.AppendPointText(DotSpatial.Topology.Coordinate,System.IO.TextWriter)">
- <summary>
- Converts a <c>Coordinate</c> to Point Text format, then
- appends it to the writer.
- </summary>
- <param name="coordinate">The <c>Coordinate</c> to process.</param>
- <param name="writer">The output writer to append to.</param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WktWriter.AppendCoordinate(DotSpatial.Topology.Coordinate,System.IO.TextWriter)">
- <summary>
- Converts a <c>Coordinate</c> to Point format, then appends
- it to the writer.
- </summary>
- <param name="coordinate">The <c>Coordinate</c> to process.</param>
- <param name="writer">The output writer to append to.</param>
- The <c>PrecisionModel</c> to use to convert
- from a precise coordinate to an external coordinate.
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WktWriter.WriteNumber(System.Double)">
- <summary>
- Converts a <see cref="T:System.Double"/> to a <see cref="T:System.String"/>,
- not in scientific notation.
- </summary>
- <param name="d">The <see cref="T:System.Double"/> to convert.</param>
- <returns>
- The <see cref="T:System.Double"/> as a <see cref="T:System.String"/>,
- not in scientific notation.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WktWriter.AppendLineStringText(DotSpatial.Topology.IBasicLineString,System.Int32,System.Boolean,System.IO.TextWriter)">
- <summary>
- Converts a <c>LineString</c> to <LineString Text format, then
- appends it to the writer.
- </summary>
- <param name="lineString">The <c>LineString</c> to process.</param>
- <param name="level"></param>
- <param name="doIndent"></param>
- <param name="writer">The output writer to append to.</param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WktWriter.AppendPolygonText(DotSpatial.Topology.IPolygon,System.Int32,System.Boolean,System.IO.TextWriter)">
- <summary>
- Converts a <c>Polygon</c> to Polygon Text format, then
- appends it to the writer.
- </summary>
- <param name="polygon">The <c>Polygon</c> to process.</param>
- <param name="level"></param>
- <param name="indentFirst"></param>
- <param name="writer">The output writer to append to.</param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WktWriter.AppendMultiPointText(DotSpatial.Topology.IGeometry,System.IO.TextWriter)">
- <summary>
- Converts a <c>MultiPoint</c> to <MultiPoint Text format, then
- appends it to the writer.
- </summary>
- <param name="multiPoint">The <c>MultiPoint</c> to process.</param>
- <param name="writer">The output writer to append to.</param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WktWriter.AppendMultiLineStringText(DotSpatial.Topology.IMultiLineString,System.Int32,System.Boolean,System.IO.TextWriter)">
- <summary>
- Converts a <c>MultiLineString</c> to <MultiLineString Text
- format, then appends it to the writer.
- </summary>
- <param name="multiLineString">The <c>MultiLineString</c> to process.</param>
- <param name="level"></param>
- <param name="indentFirst"></param>
- <param name="writer">The output writer to append to.</param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WktWriter.AppendMultiPolygonText(DotSpatial.Topology.IMultiPolygon,System.Int32,System.IO.TextWriter)">
- <summary>
- Converts a <c>MultiPolygon</c> to <MultiPolygon Text format,
- then appends it to the writer.
- </summary>
- <param name="multiPolygon">The <c>MultiPolygon</c> to process.</param>
- <param name="level"></param>
- <param name="writer">The output writer to append to.</param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WktWriter.AppendGeometryCollectionText(DotSpatial.Topology.IGeometryCollection,System.Int32,System.IO.TextWriter)">
- <summary>
- Converts a <c>GeometryCollection</c> to GeometryCollectionText
- format, then appends it to the writer.
- </summary>
- <param name="geometryCollection">The <c>GeometryCollection</c> to process.</param>
- <param name="level"></param>
- <param name="writer">The output writer to append to.</param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.WktWriter.Indent(System.Int32,System.IO.TextWriter)">
- <summary>
-
- </summary>
- <param name="level"></param>
- <param name="writer"></param>
- </member>
- <member name="T:DotSpatial.Topology.TopologyText">
- <summary>
- A strongly-typed resource class, for looking up localized strings, etc.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.TopologyText.ResourceManager">
- <summary>
- Returns the cached ResourceManager instance used by this class.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.TopologyText.Culture">
- <summary>
- Overrides the current thread's CurrentUICulture property for all
- resource lookups using this strongly typed resource class.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.TopologyText.ArgumentCannotBeNegative_S">
- <summary>
- Looks up a localized string similar to The argument %S cannot be negative..
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.TopologyText.ArgumentCouldNotBeCast_S1_S2">
- <summary>
- Looks up a localized string similar to The argument %S1 could not be successfully cast into %S2..
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.TopologyText.ArgumentOutOfRangeException_S">
- <summary>
- Looks up a localized string similar to The argument %S was outside the range of accepted values..
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.TopologyText.ClassNotSupportedException_S">
- <summary>
- Looks up a localized string similar to The class %S is not supported..
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.TopologyText.CoordinateMismatchException">
- <summary>
- Looks up a localized string similar to The number of ordinates did not match between the dimensions, so the hyperdistance cannot be accurately calculated..
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.TopologyText.DuplicateEdgeException">
- <summary>
- Looks up a localized string similar to The same directed edge appeared more than once..
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.TopologyText.GeometryCollectionNotSupportedException">
- <summary>
- Looks up a localized string similar to Geometry collections are not supported for this method..
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.TopologyText.InsufficientDimensions">
- <summary>
- Looks up a localized string similar to The number of dimensions in at least one argument is insufficient for this calculation..
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.TopologyText.InsufficientDimensions_S">
- <summary>
- Looks up a localized string similar to The number of dimensions in %S is insufficient for this calculation..
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.TopologyText.InvalidOctantException_S">
- <summary>
- Looks up a localized string similar to An invalid octant was specified: %S.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.TopologyText.KeyDuplicateException">
- <summary>
- Looks up a localized string similar to The specified key already exists in the tree..
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.TopologyText.KeyMissingException">
- <summary>
- Looks up a localized string similar to The specified key could not be found in the tree..
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.TopologyText.KeySizeException">
- <summary>
- Looks up a localized string similar to The size of the key did not match the size of the tree..
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.TopologyText.NullEdgeException">
- <summary>
- Looks up a localized string similar to Found null Directed Edge in ring.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.TopologyText.PolygonException_HoleElementNull">
- <summary>
- Looks up a localized string similar to Holes must not contain null elements.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.TopologyText.PolygonException_ShellEmptyButHolesNot">
- <summary>
- Looks up a localized string similar to Shell is empty but holes are not.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.TopologyText.ReadOnlyException">
- <summary>
- Looks up a localized string similar to The ICollection is read-only..
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.TopologyText.ShellHoleIdentityException">
- <summary>
- Looks up a localized string similar to Points in shell and hole appear to be equal.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.TopologyText.ShouldNeverReachHereException">
- <summary>
- Looks up a localized string similar to The code execution should never have reached this location..
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.TopologyText.SideLocationConflict">
- <summary>
- Looks up a localized string similar to Side location conflict at.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.TopologyText.SingleNullSide">
- <summary>
- Looks up a localized string similar to Found single null side at.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.TopologyText.TopologyException_Depth">
- <summary>
- Looks up a localized string similar to Assigned depths do not match.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.TopologyText.TwoHorizontalEdgesException">
- <summary>
- Looks up a localized string similar to Found two horizontal edges incident on node..
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.TopologyText.UnsupportedGeometryException">
- <summary>
- Looks up a localized string similar to Unsupported Geometry classes should be caught in the GeometryEditorOperation..
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Algorithm.CentroidArea">
- <summary>
- Computes the centroid of an area point.
- Algorithm:
- Based on the usual algorithm for calculating
- the centroid as a weighted sum of the centroids
- of a decomposition of the area into (possibly overlapping) triangles.
- The algorithm has been extended to handle holes and multi-polygons.
- See <see href="http://www.faqs.org/faqs/graphics/algorithms-faq"/>
- for further details of the basic approach.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.CentroidArea.Add(DotSpatial.Topology.IGeometry)">
- <summary>
- Adds the area defined by a Geometry to the centroid total.
- If the point has no area it does not contribute to the centroid.
- </summary>
- <param name="geom">The point to add.</param>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.CentroidArea.Add(DotSpatial.Topology.Coordinate[])">
- <summary>
- Adds the area defined by an array of
- coordinates. The array must be a ring;
- i.e. end with the same coordinate as it starts with.
- </summary>
- <param name="ring">An array of Coordinates.</param>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.CentroidArea.Add(DotSpatial.Topology.IPolygon)">
- <summary>
-
- </summary>
- <param name="poly"></param>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.CentroidArea.AddShell(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate})">
- <summary>
-
- </summary>
- <param name="pts"></param>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.CentroidArea.AddHole(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate})">
- <summary>
-
- </summary>
- <param name="pts"></param>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.CentroidArea.AddTriangle(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,System.Boolean)">
- <summary>
-
- </summary>
- <param name="p0"></param>
- <param name="p1"></param>
- <param name="p2"></param>
- <param name="isPositiveArea"></param>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.CentroidArea.Centroid3(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate@)">
- <summary>
- Returns three times the centroid of the triangle p1-p2-p3.
- The factor of 3 is
- left in to permit division to be avoided until later.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.CentroidArea.Area2(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
- Returns twice the signed area of the triangle p1-p2-p3,
- positive if a, b, c are oriented Ccw, and negative if cw.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Algorithm.CentroidArea.Centroid">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Algorithm.CentroidArea.BasePoint">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Algorithm.CentroidLine">
- <summary>
- Computes the centroid of a linear point.
- Algorithm:
- Compute the average of the midpoints
- of all line segments weighted by the segment length.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.CentroidLine.Add(DotSpatial.Topology.IGeometry)">
- <summary>
- Adds the linestring(s) defined by a Geometry to the centroid total.
- If the point is not linear it does not contribute to the centroid.
- </summary>
- <param name="geom">The point to add.</param>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.CentroidLine.Add(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate})">
- <summary>
- Adds the length defined by an array of coordinates.
- </summary>
- <param name="pts">An array of <c>Coordinates</c>.</param>
- </member>
- <member name="P:DotSpatial.Topology.Algorithm.CentroidLine.Centroid">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Algorithm.CentroidPoint">
- <summary>
- Computes the centroid of a point point.
- Algorithm:
- Compute the average of all points.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.CentroidPoint.Add(DotSpatial.Topology.IGeometry)">
- <summary>
- Adds the point(s) defined by a Geometry to the centroid total.
- If the point is not of dimension 0 it does not contribute to the centroid.
- </summary>
- <param name="geom">The point to add.</param>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.CentroidPoint.Add(DotSpatial.Topology.Coordinate)">
- <summary>
- Adds the length defined by a coordinate.
- </summary>
- <param name="pt">A coordinate.</param>
- </member>
- <member name="P:DotSpatial.Topology.Algorithm.CentroidPoint.Centroid">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Algorithm.CgAlgorithms">
- <summary>
- Specifies and implements various fundamental Computational Geometric algorithms.
- The algorithms supplied in this class are robust for double-precision floating point.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Algorithm.CgAlgorithms.CLOCKWISE">
- <summary>
- A value that indicates an orientation of clockwise, or a right turn.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Algorithm.CgAlgorithms.RIGHT">
- <summary>
- A value that indicates an orientation of clockwise, or a right turn.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Algorithm.CgAlgorithms.COUNTER_CLOCKWISE">
- <summary>
- A value that indicates an orientation of counterclockwise, or a left turn.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Algorithm.CgAlgorithms.LEFT">
- <summary>
- A value that indicates an orientation of counterclockwise, or a left turn.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Algorithm.CgAlgorithms.COLLINEAR">
- <summary>
- A value that indicates an orientation of collinear, or no turn (straight).
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Algorithm.CgAlgorithms.STRAIGHT">
- <summary>
- A value that indicates an orientation of collinear, or no turn (straight).
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.CgAlgorithms.OrientationIndex(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
- Returns the index of the direction of the point <c>q</c>
- relative to a vector specified by <c>p1-p2</c>.
- </summary>
- <param name="p1">The origin point of the vector.</param>
- <param name="p2">The final point of the vector.</param>
- <param name="q">The point to compute the direction to.</param>
- <returns>
- 1 if q is counter-clockwise (left) from p1-p2,
- -1 if q is clockwise (right) from p1-p2,
- 0 if q is collinear with p1-p2.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.CgAlgorithms.IsPointInRing(DotSpatial.Topology.Coordinate,System.Collections.Generic.IList{DotSpatial.Topology.Coordinate})">
- <summary>
- Test whether a point lies inside a ring.
- The ring may be oriented in either direction.
- If the point lies on the ring boundary the result of this method is unspecified.
- This algorithm does not attempt to first check the point against the envelope
- of the ring.
- </summary>
- <param name="p">Point to check for ring inclusion.</param>
- <param name="ring">Assumed to have first point identical to last point.</param>
- <returns><c>true</c> if p is inside ring.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.CgAlgorithms.IsOnLine(DotSpatial.Topology.Coordinate,System.Collections.Generic.IList{DotSpatial.Topology.Coordinate})">
- <summary>
- Test whether a point lies on the line segments defined by a
- list of coordinates.
- </summary>
- <param name="p"></param>
- <param name="pt"></param>
- <returns>
- <c>true</c> true if
- the point is a vertex of the line or lies in the interior of a line
- segment in the linestring.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.CgAlgorithms.IsCounterClockwise(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate})">
- <summary>
- Computes whether a ring defined by an array of <see cref="T:DotSpatial.Topology.Coordinate"/>s is oriented counter-clockwise.
- The list of points is assumed to have the first and last points equal.
- This will handle coordinate lists which contain repeated points.
- This algorithm is only guaranteed to work with valid rings.
- If the ring is invalid (e.g. self-crosses or touches),
- the computed result may not be correct.
- </summary>>
- <param name="ring"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.CgAlgorithms.ComputeOrientation(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
- Computes the orientation of a point q to the directed line segment p1-p2.
- The orientation of a point relative to a directed line segment indicates
- which way you turn to get to q after travelling from p1 to p2.
- </summary>
- <param name="p1"></param>
- <param name="p2"></param>
- <param name="q"></param>
- <returns>
- 1 if q is counter-clockwise from p1-p2,
- -1 if q is clockwise from p1-p2,
- 0 if q is collinear with p1-p2-
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.CgAlgorithms.DistancePointLine(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
- Computes the distance from a point p to a line segment AB.
- Notice: NON-ROBUST!
- </summary>
- <param name="p">The point to compute the distance for.</param>
- <param name="a">One point of the line.</param>
- <param name="b">Another point of the line (must be different to A).</param>
- <returns> The distance from p to line segment AB.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.CgAlgorithms.DistancePointLinePerpendicular(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
- Computes the perpendicular distance from a point p
- to the (infinite) line containing the points AB
- </summary>
- <param name="p">The point to compute the distance for.</param>
- <param name="a">One point of the line.</param>
- <param name="b">Another point of the line (must be different to A).</param>
- <returns>The perpendicular distance from p to line AB.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.CgAlgorithms.DistanceLineLine(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
- Computes the distance from a line segment AB to a line segment CD.
- Notice: NON-ROBUST!
- </summary>
- <param name="a">A point of one line.</param>
- <param name="b">The second point of the line (must be different to A).</param>
- <param name="c">One point of the line.</param>
- <param name="d">Another point of the line (must be different to A).</param>
- <returns>The distance from line segment AB to line segment CD.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.CgAlgorithms.SignedArea(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate})">
- <summary>
- Returns the signed area for a ring. The area is positive if the ring is oriented CW.
- </summary>
- <param name="ring"></param>
- <returns>Area in Meters (by default) when using projected coordinates.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.CgAlgorithms.Length(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate})">
- <summary>
- Computes the length of a linestring specified by a sequence of points.
- </summary>
- <param name="pts">The points specifying the linestring.</param>
- <returns>The length of the linestring.</returns>
- </member>
- <member name="T:DotSpatial.Topology.Algorithm.ConvexHull">
- <summary>
- Computes the convex hull of a <see cref="T:DotSpatial.Topology.Geometry"/>.
- The convex hull is the smallest convex Geometry that contains all the
- points in the input Geometry.
- Uses the Graham Scan algorithm.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.ConvexHull.#ctor(DotSpatial.Topology.IGeometry)">
- <summary>
- Create a new convex hull construction for the input <c>Geometry</c>.
- </summary>
- <param name="geometry"></param>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.ConvexHull.#ctor(DotSpatial.Topology.Coordinate[],DotSpatial.Topology.IGeometryFactory)">
- <summary>
- Create a new convex hull construction for the input <see cref="T:DotSpatial.Topology.Coordinate"/> array.
- </summary>
- <param name="pts"></param>
- <param name="geomFactory"></param>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.ConvexHull.ExtractCoordinates(DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="geom"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.ConvexHull.GetConvexHull">
- <summary>
- Returns a <c>Geometry</c> that represents the convex hull of the input point.
- The point will contain the minimal number of points needed to
- represent the convex hull. In particular, no more than two consecutive
- points will be collinear.
- </summary>
- <returns>
- If the convex hull contains 3 or more points, a <c>Polygon</c>;
- 2 points, a <c>LineString</c>;
- 1 point, a <c>Point</c>;
- 0 points, an empty <c>GeometryCollection</c>.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.ConvexHull.Reduce(DotSpatial.Topology.Coordinate[])">
- <summary>
- Uses a heuristic to reduce the number of points scanned to compute the hull.
- The heuristic is to find a polygon guaranteed to
- be in (or on) the hull, and eliminate all points inside it.
- A quadrilateral defined by the extremal points
- in the four orthogonal directions
- can be used, but even more inclusive is
- to use an octilateral defined by the points in the 8 cardinal directions.
- Notice that even if the method used to determine the polygon vertices
- is not 100% robust, this does not affect the robustness of the convex hull.
- </summary>
- <param name="pts"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.ConvexHull.PreSort(DotSpatial.Topology.Coordinate[])">
- <summary>
-
- </summary>
- <param name="pts"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.ConvexHull.GrahamScan(DotSpatial.Topology.Coordinate[])">
- <summary>
-
- </summary>
- <param name="c"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.ConvexHull.ReverseStack(System.Collections.Generic.Stack{DotSpatial.Topology.Coordinate})">
- <summary>
-
- </summary>
- <param name="ps"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.ConvexHull.IsBetween(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="c1"></param>
- <param name="c2"></param>
- <param name="c3"></param>
- <returns>
- Whether the three coordinates are collinear
- and c2 lies between c1 and c3 inclusive.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.ConvexHull.ComputeOctRing(DotSpatial.Topology.Coordinate[])">
- <summary>
-
- </summary>
- <param name="inputPts"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.ConvexHull.ComputeOctPts(DotSpatial.Topology.Coordinate[])">
- <summary>
-
- </summary>
- <param name="inputPts"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.ConvexHull.LineOrPolygon(DotSpatial.Topology.Coordinate[])">
- <summary>
-
- </summary>
- <param name="coordinates"> The vertices of a linear ring, which may or may not be flattened (i.e. vertices collinear).</param>
- <returns>A 2-vertex <c>LineString</c> if the vertices are collinear;
- otherwise, a <c>Polygon</c> with unnecessary (collinear) vertices removed. </returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.ConvexHull.CleanRing(DotSpatial.Topology.Coordinate[])">
- <summary>
-
- </summary>
- <param name="original">The vertices of a linear ring, which may or may not be flattened (i.e. vertices collinear).</param>
- <returns>The coordinates with unnecessary (collinear) vertices removed.</returns>
- </member>
- <member name="T:DotSpatial.Topology.Algorithm.ConvexHull.RadialComparator">
- <summary>
- Compares <see cref="T:DotSpatial.Topology.Coordinate"/>s for their angle and distance
- relative to an origin.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.ConvexHull.RadialComparator.#ctor(DotSpatial.Topology.Coordinate)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Topology.Algorithm.ConvexHull.RadialComparator"/> class.
- </summary>
- <param name="origin"></param>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.ConvexHull.RadialComparator.Compare(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="p1"></param>
- <param name="p2"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.ConvexHull.RadialComparator.PolarCompare(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="o"></param>
- <param name="p"></param>
- <param name="q"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.Algorithm.HCoordinate">
- <summary>
- Represents a homogeneous coordinate for 2-D coordinates.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.HCoordinate.#ctor">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.HCoordinate.#ctor(System.Double,System.Double,System.Double)">
- <summary>
-
- </summary>
- <param name="x"></param>
- <param name="y"></param>
- <param name="w"></param>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.HCoordinate.#ctor(DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="p"></param>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.HCoordinate.#ctor(DotSpatial.Topology.Algorithm.HCoordinate,DotSpatial.Topology.Algorithm.HCoordinate)">
- <summary>
-
- </summary>
- <param name="p1"></param>
- <param name="p2"></param>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.HCoordinate.Intersection(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
- Computes the (approximate) intersection point between two line segments
- using homogeneous coordinates.
- Notice that this algorithm is
- not numerically stable; i.e. it can produce intersection points which
- lie outside the envelope of the line segments themselves. In order
- to increase the precision of the calculation input points should be normalized
- before passing them to this routine.
- </summary>
- <param name="p1"></param>
- <param name="p2"></param>
- <param name="q1"></param>
- <param name="q2"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.HCoordinate.GetX">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.HCoordinate.GetY">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.Algorithm.HCoordinate.X">
- <summary>
- Direct access to x private field
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Algorithm.HCoordinate.Y">
- <summary>
- Direct access to y private field
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Algorithm.HCoordinate.W">
- <summary>
- Direct access to w private field
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Algorithm.HCoordinate.Coordinate">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Algorithm.InteriorPointArea">
- <summary>
- Computes a point in the interior of an area point.
- Algorithm:
- Find the intersections between the point
- and the horizontal bisector of the area's envelope
- Pick the midpoint of the largest intersection (the intersections
- will be lines and points)
- Notice: If a fixed precision model is used,
- in some cases this method may return a point
- which does not lie in the interior.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.InteriorPointArea.#ctor(DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="g"></param>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.InteriorPointArea.Avg(System.Double,System.Double)">
- <summary>
-
- </summary>
- <param name="a"></param>
- <param name="b"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.InteriorPointArea.Add(DotSpatial.Topology.IGeometry)">
- <summary>
- Tests the interior vertices (if any)
- defined by a linear Geometry for the best inside point.
- If a Geometry is not of dimension 1 it is not tested.
- </summary>
- <param name="geom">The point to add.</param>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.InteriorPointArea.AddPolygon(DotSpatial.Topology.IGeometry)">
- <summary>
- Adds a polygon.
- </summary>
- <param name="geometry">The polygon to add.</param>>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.InteriorPointArea.WidestGeometry(DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="geometry"></param>
- <returns>
- If point is a collection, the widest sub-point; otherwise,
- the point itself.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.InteriorPointArea.WidestGeometry(DotSpatial.Topology.IGeometryCollection)">
- <summary>
-
- </summary>
- <param name="gc"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.InteriorPointArea.HorizontalBisector(DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="geometry"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.InteriorPointArea.Centre(DotSpatial.Topology.IEnvelope)">
- <summary>
- Returns the centre point of the envelope.
- </summary>
- <param name="envelope">The envelope to analyze.</param>
- <returns> The centre of the envelope.</returns>
- </member>
- <member name="P:DotSpatial.Topology.Algorithm.InteriorPointArea.InteriorPoint">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Algorithm.InteriorPointLine">
- <summary>
- Computes a point in the interior of an linear point.
- Algorithm:
- Find an interior vertex which is closest to
- the centroid of the linestring.
- If there is no interior vertex, find the endpoint which is
- closest to the centroid.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.InteriorPointLine.#ctor(DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="g"></param>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.InteriorPointLine.AddInterior(DotSpatial.Topology.IGeometry)">
- <summary>
- Tests the interior vertices (if any)
- defined by a linear Geometry for the best inside point.
- If a Geometry is not of dimension 1 it is not tested.
- </summary>
- <param name="geom">The point to add.</param>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.InteriorPointLine.AddInterior(System.Collections.Generic.IEnumerable{DotSpatial.Topology.Coordinate})">
- <summary>
-
- </summary>
- <param name="pts"></param>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.InteriorPointLine.AddEndpoints(DotSpatial.Topology.IGeometry)">
- <summary>
- Tests the endpoint vertices
- defined by a linear Geometry for the best inside point.
- If a Geometry is not of dimension 1 it is not tested.
- </summary>
- <param name="geom">The point to add.</param>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.InteriorPointLine.AddEndpoints(System.Collections.Generic.IEnumerable{DotSpatial.Topology.Coordinate})">
- <summary>
-
- </summary>
- <param name="pts"></param>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.InteriorPointLine.Add(DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="point"></param>
- </member>
- <member name="P:DotSpatial.Topology.Algorithm.InteriorPointLine.InteriorPoint">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Algorithm.InteriorPointPoint">
- <summary>
- Computes a point in the interior of an point point.
- Algorithm:
- Find a point which is closest to the centroid of the point.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.InteriorPointPoint.#ctor(DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="g"></param>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.InteriorPointPoint.Add(DotSpatial.Topology.IGeometry)">
- <summary>
- Tests the point(s) defined by a Geometry for the best inside point.
- If a Geometry is not of dimension 0 it is not tested.
- </summary>
- <param name="geom">The point to add.</param>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.InteriorPointPoint.Add(DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="point"></param>
- </member>
- <member name="P:DotSpatial.Topology.Algorithm.InteriorPointPoint.InteriorPoint">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Algorithm.IntersectionType">
- <summary>
- IntersectionTypes
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Algorithm.IntersectionType.NoIntersection">
- <summary>
- No intersection occurs
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Algorithm.IntersectionType.PointIntersection">
- <summary>
- The lines intersect in a single point
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Algorithm.IntersectionType.Collinear">
- <summary>
- The lines intersect by overlapping
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Algorithm.IPointInRing">
- <summary>
- An interface for classes which test whether a <c>Coordinate</c> lies inside a ring.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.IPointInRing.IsInside(DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="pt"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.Algorithm.LineIntersector">
- <summary>
- A LineIntersector is an algorithm that can both test whether
- two line segments intersect and compute the intersection point
- if they do.
- The intersection point may be computed in a precise or non-precise manner.
- Computing it precisely involves rounding it to an integer. (This assumes
- that the input coordinates have been made precise by scaling them to
- an integer grid.)
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Algorithm.LineIntersector._intLineIndex">
- <summary>
- The indexes of the endpoints of the intersection lines, in order along
- the corresponding line
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Algorithm.LineIntersector._precisionModel">
- <summary>
- If MakePrecise is true, computed intersection coordinates will be made precise
- using <c>Coordinate.MakePrecise</c>.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.LineIntersector.#ctor">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.LineIntersector.ComputeEdgeDistance(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
- Computes the "edge distance" of an intersection point p along a segment.
- The edge distance is a metric of the point along the edge.
- The metric used is a robust and easy to compute metric function.
- It is not equivalent to the usual Euclidean metric.
- It relies on the fact that either the x or the y ordinates of the
- points in the edge are unique, depending on whether the edge is longer in
- the horizontal or vertical direction.
- Notice: This function may produce incorrect distances
- for inputs where p is not precisely on p1-p2
- (E.g. p = (139, 9) p1 = (139, 10), p2 = (280, 1) produces distanct 0.0, which is incorrect.
- My hypothesis is that the function is safe to use for points which are the
- result of rounding points which lie on the line, but not safe to use for truncated points.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.LineIntersector.NonRobustComputeEdgeDistance(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
- This function is non-robust, since it may compute the square of large numbers.
- Currently not sure how to improve this.
- </summary>
- <param name="p"></param>
- <param name="p1"></param>
- <param name="p2"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.LineIntersector.ComputeIntersection(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
- Compute the intersection of a point p and the line p1-p2.
- This function computes the bool value of the hasIntersection test.
- The actual value of the intersection (if there is one)
- is equal to the value of <c>p</c>.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.LineIntersector.ComputeIntersection(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
- Computes the intersection of the lines p1-p2 and p3-p4.
- This function computes both the bool value of the hasIntersection test
- and the (approximate) value of the intersection point itself (if there is one).
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.LineIntersector.ComputeIntersect(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="p1"></param>
- <param name="p2"></param>
- <param name="q1"></param>
- <param name="q2"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.LineIntersector.ToString">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.LineIntersector.GetIntersection(System.Int32)">
- <summary>
- Returns the intIndex'th intersection point.
- </summary>
- <param name="intIndex">is 0 or 1.</param>
- <returns>The intIndex'th intersection point.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.LineIntersector.ComputeIntLineIndex">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.LineIntersector.IsIntersection(DotSpatial.Topology.Coordinate)">
- <summary>
- Test whether a point is a intersection point of two line segments.
- Notice that if the intersection is a line segment, this method only tests for
- equality with the endpoints of the intersection segment.
- It does not return true if the input point is internal to the intersection segment.
- </summary>
- <returns><c>true</c> if the input point is one of the intersection points.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.LineIntersector.IsInteriorIntersection">
- <summary>
- Tests whether either intersection point is an interior point of one of the input segments.
- </summary>
- <returns>
- <c>true</c> if either intersection point is in the interior of one of the input segment.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.LineIntersector.IsInteriorIntersection(System.Int32)">
- <summary>
- Tests whether either intersection point is an interior point of the specified input segment.
- </summary>
- <returns>
- <c>true</c> if either intersection point is in the interior of the input segment.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.LineIntersector.GetIntersectionAlongSegment(System.Int32,System.Int32)">
- <summary>
- Computes the coordinate of the intIndex'th intersection point in the direction of
- a specified input line segment.
- </summary>
- <param name="segmentIndex">The segment index from 0 to 1.</param>
- <param name="intIndex">The integer intersection index from 0 to 1.</param>
- <returns>
- The coordinate of the intIndex'th intersection point in the direction of the specified input line segment.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.LineIntersector.GetIndexAlongSegment(System.Int32,System.Int32)">
- <summary>
- Computes the index of the intIndex'th intersection point in the direction of
- a specified input line segment, and returns the integer index.
- </summary>
- <param name="segmentIndex">The integer segment index from 0 to 1.</param>
- <param name="intIndex">The integer intersection index from 0 to 1.</param>
- <returns>
- The integer index of the intersection point along the segment (0 or 1).
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.LineIntersector.ComputeIntLineIndex(System.Int32)">
- <summary>
- Computes the integer line index of the specified integer segment index.
- </summary>
- <param name="segmentIndex">The integer index of the segment.</param>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.LineIntersector.GetEdgeDistance(System.Int32,System.Int32)">
- <summary>
- Computes the "edge distance" of an intersection point along the specified input line segment.
- </summary>
- <param name="segmentIndex">The integer segment index from 0 to 1.</param>
- <param name="intIndex">The integer intersection index from 0 to 1.</param>
- <returns>The edge distance of the intersection point.</returns>
- </member>
- <member name="P:DotSpatial.Topology.Algorithm.LineIntersector.PointA">
- <summary>
- Gets or sets the first intersection coordinate, if any.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Algorithm.LineIntersector.PointB">
- <summary>
- Gets or sets the second intersection coordiante, if any.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Algorithm.LineIntersector.MakePrecise">
- <summary>
- Force computed intersection to be rounded to a given precision model
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Algorithm.LineIntersector.PrecisionModel">
- <summary>
- Force computed intersection to be rounded to a given precision model.
- No getter is provided, because the precision model is not required to be specified.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Algorithm.LineIntersector.HasIntersection">
- <summary>
- Tests whether the input geometries intersect.
- </summary>
- <returns><c>true</c> if the input geometries intersect.</returns>
- </member>
- <member name="P:DotSpatial.Topology.Algorithm.LineIntersector.IntersectionNum">
- <summary>
- Returns the number of intersection points found. This will be either 0, 1 or 2.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Algorithm.LineIntersector.IntersectionPoints">
- <summary>
- Gets the array of intersection points
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Algorithm.LineIntersector.InputLines">
- <summary>
- Gets or sets a two dimensional array of coordinates representing the input lines for the calculation
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Algorithm.LineIntersector.IsCollinear">
- <summary>
- This is true if the intersection forms a line
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Algorithm.LineIntersector.IsEndPoint">
- <summary>
- Gets Whether this is both propper and has an intersection
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Algorithm.LineIntersector.IsProper">
- <summary>
- Tests whether an intersection is proper.
- The intersection between two line segments is considered proper if
- they intersect in a single point in the interior of both segments
- (e.g. the intersection is a single point and is not equal to any of the endpoints).
- The intersection between a point and a line segment is considered proper
- if the point lies in the interior of the segment (e.g. is not equal to either of the endpoints).
- </summary>
- <returns><c>true</c> if the intersection is proper.</returns>
- </member>
- <member name="P:DotSpatial.Topology.Algorithm.LineIntersector.Result">
- <summary>
- Gets or sets the integer result
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Algorithm.McPointInRing">
- <summary>
- Implements <c>IPointInRing</c>
- using a <c>MonotoneChain</c>s and a <c>BinTree</c> index to increase performance.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.McPointInRing.#ctor(DotSpatial.Topology.ILinearRing)">
- <summary>
-
- </summary>
- <param name="ring"></param>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.McPointInRing.IsInside(DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="pt"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.McPointInRing.BuildIndex">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.McPointInRing.TestMonotoneChain(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.Index.Chain.MonotoneChainSelectAction,DotSpatial.Topology.Index.Chain.MonotoneChain)">
- <summary>
-
- </summary>
- <param name="rayEnv"></param>
- <param name="mcSelecter"></param>
- <param name="mc"></param>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.McPointInRing.TestLineSegment(DotSpatial.Topology.Coordinate,DotSpatial.Topology.ILineSegmentBase)">
- <summary>
-
- </summary>
- <param name="p"></param>
- <param name="seg"></param>
- </member>
- <member name="T:DotSpatial.Topology.Algorithm.McPointInRing.McSelecter">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Index.Chain.MonotoneChainSelectAction">
- <summary>
- The action for the internal iterator for performing
- envelope select queries on a MonotoneChain.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Index.Chain.MonotoneChainSelectAction.TempEnv1">
- <summary>
- These envelopes are used during the MonotoneChain search process.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Chain.MonotoneChainSelectAction.Select(DotSpatial.Topology.Index.Chain.MonotoneChain,System.Int32)">
- <summary>
- This function can be overridden if the original chain is needed.
- </summary>
- <param name="mc"></param>
- <param name="start"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Chain.MonotoneChainSelectAction.Select(DotSpatial.Topology.LineSegment)">
- <summary>
- This is a convenience function which can be overridden to obtain the actual
- line segment which is selected.
- </summary>
- <param name="seg"></param>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.McPointInRing.McSelecter.#ctor(DotSpatial.Topology.Algorithm.McPointInRing,DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="container"></param>
- <param name="p"></param>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.McPointInRing.McSelecter.Select(DotSpatial.Topology.LineSegment)">
- <summary>
-
- </summary>
- <param name="ls"></param>
- </member>
- <member name="T:DotSpatial.Topology.Algorithm.MinimumDiameter">
- <summary>
- Computes the minimum diameter of a <c>Geometry</c>.
- The minimum diameter is defined to be the
- width of the smallest band that contains the point,
- where a band is a strip of the plane defined
- by two parallel lines.
- This can be thought of as the smallest hole that the point can be
- moved through, with a single rotation.
- The first step in the algorithm is computing the convex hull of the Geometry.
- If the input Geometry is known to be convex, a hint can be supplied to
- avoid this computation.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.MinimumDiameter.#ctor(DotSpatial.Topology.IGeometry)">
- <summary>
- Compute a minimum diameter for a giver <c>Geometry</c>.
- </summary>
- <param name="inputGeom">a Geometry.</param>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.MinimumDiameter.#ctor(DotSpatial.Topology.IGeometry,System.Boolean)">
- <summary>
- Compute a minimum diameter for a giver <c>Geometry</c>,
- with a hint if
- the Geometry is convex
- (e.g. a convex Polygon or LinearRing,
- or a two-point LineString, or a Point).
- </summary>
- <param name="inputGeom">a Geometry which is convex.</param>
- <param name="isConvex"><c>true</c> if the input point is convex.</param>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.MinimumDiameter.ComputeMinimumDiameter">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.MinimumDiameter.ComputeWidthConvex(DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="geom"></param>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.MinimumDiameter.ComputeConvexRingMinDiameter(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate})">
- <summary>
- Compute the width information for a ring of <c>Coordinate</c>s.
- Leaves the width information in the instance variables.
- </summary>
- <param name="pts"></param>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.MinimumDiameter.FindMaxPerpDistance(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate},DotSpatial.Topology.ILineSegment,System.Int32)">
- <summary>
-
- </summary>
- <param name="pts"></param>
- <param name="seg"></param>
- <param name="startIndex"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.MinimumDiameter.NextIndex(System.Collections.Generic.ICollection{DotSpatial.Topology.Coordinate},System.Int32)">
- <summary>
-
- </summary>
- <param name="pts"></param>
- <param name="index"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.Algorithm.MinimumDiameter.Length">
- <summary>
- Gets the length of the minimum diameter of the input Geometry.
- </summary>
- <returns>The length of the minimum diameter.</returns>
- </member>
- <member name="P:DotSpatial.Topology.Algorithm.MinimumDiameter.WidthCoordinate">
- <summary>
- Gets the <c>Coordinate</c> forming one end of the minimum diameter.
- </summary>
- <returns>A coordinate forming one end of the minimum diameter.</returns>
- </member>
- <member name="P:DotSpatial.Topology.Algorithm.MinimumDiameter.SupportingSegment">
- <summary>
- Gets the segment forming the base of the minimum diameter.
- </summary>
- <returns>The segment forming the base of the minimum diameter.</returns>
- </member>
- <member name="P:DotSpatial.Topology.Algorithm.MinimumDiameter.Diameter">
- <summary>
- Gets a <c>LineString</c> which is a minimum diameter.
- </summary>
- <returns>A <c>LineString</c> which is a minimum diameter.</returns>
- </member>
- <member name="T:DotSpatial.Topology.Algorithm.NonRobustCgAlgorithms">
- <summary>
- Non-robust versions of various fundamental Computational Geometric algorithms,
- FOR TESTING PURPOSES ONLY!.
- The non-robustness is due to rounding error in floating point computation.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.NonRobustCgAlgorithms.IsPointInRing(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate[])">
- <summary>
-
- </summary>
- <param name="p"></param>
- <param name="ring"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.NonRobustCgAlgorithms.IsCcw(DotSpatial.Topology.Coordinate[])">
- <summary>
- Computes whether a ring defined by an array of <c>Coordinate</c> is
- oriented counter-clockwise.
- This will handle coordinate lists which contain repeated points.
- </summary>
- <param name="ring">an array of coordinates forming a ring.</param>
- <returns>
- <c>true</c> if the ring is oriented counter-clockwise.
- throws <c>ArgumentException</c> if the ring is degenerate (does not contain 3 different points)
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.NonRobustCgAlgorithms.ComputeOrientation(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="p1"></param>
- <param name="p2"></param>
- <param name="q"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.Algorithm.NonRobustLineIntersector">
- <summary>
- A non-robust version of <c>LineIntersector</c>.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.NonRobustLineIntersector.IsSameSignAndNonZero(System.Double,System.Double)">
- <summary>
-
- </summary>
- <param name="a"></param>
- <param name="b"></param>
- <returns>
- <c>true</c> if both numbers are positive or if both numbers are negative,
- <c>false</c> if both numbers are zero.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.NonRobustLineIntersector.ComputeIntersection(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="p"></param>
- <param name="p1"></param>
- <param name="p2"></param>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.NonRobustLineIntersector.ComputeIntersect(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="p1"></param>
- <param name="p2"></param>
- <param name="p3"></param>
- <param name="p4"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.NonRobustLineIntersector.ComputeCollinearIntersection(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="p1"></param>
- <param name="p2"></param>
- <param name="p3"></param>
- <param name="p4"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.NonRobustLineIntersector.RParameter(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
- RParameter computes the parameter for the point p
- in the parameterized equation
- of the line from p1 to p2.
- This is equal to the 'distance' of p along p1-p2.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Algorithm.NotRepresentableException">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.NotRepresentableException.#ctor">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Algorithm.PointLocator">
- <summary>
- Computes the topological relationship (Location) of a single point to a Geometry.
- The algorithm obeys the SFS boundaryDetermination rule to correctly determine
- whether the point lies on the boundary or not.
- Notice that instances of this class are not reentrant.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.PointLocator.Intersects(DotSpatial.Topology.Coordinate,DotSpatial.Topology.IGeometry)">
- <summary>
- Convenience method to test a point for intersection with a Geometry
- </summary>
- <param name="p">The coordinate to test.</param>
- <param name="geom">The Geometry to test.</param>
- <returns><c>true</c> if the point is in the interior or boundary of the Geometry.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.PointLocator.Locate(DotSpatial.Topology.Coordinate,DotSpatial.Topology.IGeometry)">
- <summary>
- Computes the topological relationship ({Location}) of a single point to a Geometry.
- It handles both single-element and multi-element Geometries.
- The algorithm for multi-part Geometries takes into account the boundaryDetermination rule.
- </summary>
- <returns>The Location of the point relative to the input Geometry.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.PointLocator.ComputeLocation(DotSpatial.Topology.Coordinate,DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="p"></param>
- <param name="geom"></param>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.PointLocator.UpdateLocationInfo(DotSpatial.Topology.LocationType)">
- <summary>
-
- </summary>
- <param name="loc"></param>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.PointLocator.LocateInLineString(DotSpatial.Topology.Coordinate,DotSpatial.Topology.ILineString)">
- <summary>
-
- </summary>
- <param name="p"></param>
- <param name="l"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.PointLocator.LocateInPolygonRing(DotSpatial.Topology.Coordinate,DotSpatial.Topology.IBasicGeometry)">
- <summary>
-
- </summary>
- <param name="p"></param>
- <param name="ring"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.PointLocator.LocateInPolygon(DotSpatial.Topology.Coordinate,DotSpatial.Topology.IPolygon)">
- <summary>
-
- </summary>
- <param name="p"></param>
- <param name="poly"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.Algorithm.RobustDeterminant">
- <summary>
- Implements an algorithm to compute the
- sign of a 2x2 determinant for double precision values robustly.
- It is a direct translation of code developed by Olivier Devillers.
-
- The original code carries the following copyright notice:
- ************************************************************************
- Author : Olivier Devillers
- Olivier.Devillers@sophia.inria.fr
- http:/www.inria.fr:/prisme/personnel/devillers/anglais/determinant.html
- *************************************************************************
- *************************************************************************
- Copyright (c) 1995 by INRIA Prisme Project
- BP 93 06902 Sophia Antipolis Cedex, France.
- All rights reserved
- *************************************************************************
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.RobustDeterminant.SignOfDet2X2(System.Double,System.Double,System.Double,System.Double)">
- <summary>
-
- </summary>
- <param name="x1"></param>
- <param name="y1"></param>
- <param name="x2"></param>
- <param name="y2"></param>
- <returns>
- returns -1 if the determinant is negative,
- returns 1 if the determinant is positive,
- retunrs 0 if the determinant is null.
- </returns>
- </member>
- <member name="T:DotSpatial.Topology.Algorithm.RobustLineIntersector">
- <summary>
- A robust version of <c>LineIntersector</c>.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.RobustLineIntersector.ComputeIntersection(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="p"></param>
- <param name="p1"></param>
- <param name="p2"></param>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.RobustLineIntersector.ComputeIntersect(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="p1"></param>
- <param name="p2"></param>
- <param name="q1"></param>
- <param name="q2"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.RobustLineIntersector.ComputeCollinearIntersection(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="p1"></param>
- <param name="p2"></param>
- <param name="q1"></param>
- <param name="q2"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.RobustLineIntersector.Intersection(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
- This method computes the actual value of the intersection point.
- To obtain the maximum precision from the intersection calculation,
- the coordinates are normalized by subtracting the minimum
- ordinate values (in absolute value). This has the effect of
- removing common significant digits from the calculation to
- maintain more bits of precision.
- </summary>
- <param name="p1"></param>
- <param name="p2"></param>
- <param name="q1"></param>
- <param name="q2"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.RobustLineIntersector.NormalizeToEnvCentre(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
- Normalize the supplied coordinates to
- so that the midpoint of their intersection envelope
- lies at the origin.
- </summary>
- <param name="n00"></param>
- <param name="n01"></param>
- <param name="n10"></param>
- <param name="n11"></param>
- <param name="normPt"></param>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.RobustLineIntersector.IsInSegmentEnvelopes(DotSpatial.Topology.Coordinate)">
- <summary>
- Test whether a point lies in the envelopes of both input segments.
- A correctly computed intersection point should return <c>true</c>
- for this test.
- Since this test is for debugging purposes only, no attempt is
- made to optimize the envelope test.
- </summary>
- <param name="intPt"></param>
- <returns><c>true</c> if the input point lies within both input segment envelopes.</returns>
- </member>
- <member name="T:DotSpatial.Topology.Algorithm.SimplePointInAreaLocator">
- <summary>
- Computes whether a point
- lies in the interior of an area <c>Geometry</c>.
- The algorithm used is only guaranteed to return correct results
- for points which are not on the boundary of the Geometry.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.SimplePointInAreaLocator.#ctor">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.SimplePointInAreaLocator.Locate(DotSpatial.Topology.Coordinate,DotSpatial.Topology.IGeometry)">
- <summary>
- Locate is the main location function. It handles both single-element
- and multi-element Geometries. The algorithm for multi-element Geometries
- is more complex, since it has to take into account the boundaryDetermination rule.
- </summary>
- <param name="p">The coordinate to locate.</param>
- <param name="geom">The Geometry to locate the coordinate in.</param>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.SimplePointInAreaLocator.ContainsPoint(DotSpatial.Topology.Coordinate,DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="p"></param>
- <param name="geom"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.SimplePointInAreaLocator.ContainsPointInPolygon(DotSpatial.Topology.Coordinate,DotSpatial.Topology.IPolygon)">
- <summary>
-
- </summary>
- <param name="p"></param>
- <param name="poly"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.Algorithm.SimplePointInRing">
- <summary>
- Tests whether a <c>Coordinate</c> lies inside
- a ring, using a linear-time algorithm.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Algorithm.SimplePointInRing._pts">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.SimplePointInRing.#ctor(DotSpatial.Topology.IBasicGeometry)">
- <summary>
-
- </summary>
- <param name="ring"></param>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.SimplePointInRing.IsInside(DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="pt"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.Algorithm.SiRtreePointInRing">
- <summary>
- Implements <c>PointInRing</c> using a <c>SIRtree</c> index to increase performance.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.SiRtreePointInRing.#ctor(DotSpatial.Topology.LinearRing)">
- <summary>
-
- </summary>
- <param name="ring"></param>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.SiRtreePointInRing.IsInside(DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="pt"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.SiRtreePointInRing.BuildIndex">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Algorithm.SiRtreePointInRing.TestLineSegment(DotSpatial.Topology.Coordinate,DotSpatial.Topology.ILineSegmentBase)">
- <summary>
-
- </summary>
- <param name="p"></param>
- <param name="seg"></param>
- </member>
- <member name="T:DotSpatial.Topology.ClassNotSupportedException">
- <summary>
- A ClassNotSupportedException Class
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.ClassNotSupportedException.#ctor(System.String)">
- <summary>
- Creates a new instance of ClassNotSupportedException
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Index.ArrayListVisitor">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Index.IItemVisitor">
- <summary>
- A visitor for items in an index.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.IItemVisitor.VisitItem(System.Object)">
- <summary>
-
- </summary>
- <param name="item"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.ArrayListVisitor.VisitItem(System.Object)">
- <summary>
-
- </summary>
- <param name="item"></param>
- </member>
- <member name="P:DotSpatial.Topology.Index.ArrayListVisitor.Items">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Index.Bintree.Bintree">
- <summary>
- An <c>BinTree</c> (or "Binary Interval Tree")
- is a 1-dimensional version of a quadtree.
- It indexes 1-dimensional intervals (which of course may
- be the projection of 2-D objects on an axis).
- It supports range searching
- (where the range may be a single point).
- This implementation does not require specifying the extent of the inserted
- items beforehand. It will automatically expand to accomodate any extent
- of dataset.
- This index is different to the Interval Tree of Edelsbrunner
- or the Segment Tree of Bentley.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Bintree.Bintree.#ctor">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Bintree.Bintree.EnsureExtent(DotSpatial.Topology.Index.Bintree.Interval,System.Double)">
- <summary>
- Ensure that the Interval for the inserted item has non-zero extents.
- Use the current minExtent to pad it, if necessary.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Bintree.Bintree.Insert(DotSpatial.Topology.Index.Bintree.Interval,System.Object)">
- <summary>
-
- </summary>
- <param name="itemInterval"></param>
- <param name="item"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Bintree.Bintree.GetEnumerator">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Bintree.Bintree.Query(System.Double)">
- <summary>
-
- </summary>
- <param name="x"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Bintree.Bintree.Query(DotSpatial.Topology.Index.Bintree.Interval)">
- <summary>
- min and max may be the same value.
- </summary>
- <param name="interval"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Bintree.Bintree.Query(DotSpatial.Topology.Index.Bintree.Interval,System.Collections.IList)">
- <summary>
-
- </summary>
- <param name="interval"></param>
- <param name="foundItems"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Bintree.Bintree.CollectStats(DotSpatial.Topology.Index.Bintree.Interval)">
- <summary>
-
- </summary>
- <param name="interval"></param>
- </member>
- <member name="P:DotSpatial.Topology.Index.Bintree.Bintree.Depth">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Bintree.Bintree.Count">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Bintree.Bintree.NodeSize">
- <summary>
- Compute the total number of nodes in the tree.
- </summary>
- <returns>The number of nodes in the tree.</returns>
- </member>
- <member name="T:DotSpatial.Topology.Index.Bintree.Interval">
- <summary>
- Represents an (1-dimensional) closed interval on the Real number line.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Bintree.Interval.#ctor">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Bintree.Interval.#ctor(System.Double,System.Double)">
- <summary>
-
- </summary>
- <param name="min"></param>
- <param name="max"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Bintree.Interval.#ctor(DotSpatial.Topology.Index.Bintree.Interval)">
- <summary>
-
- </summary>
- <param name="interval"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Bintree.Interval.Init(System.Double,System.Double)">
- <summary>
-
- </summary>
- <param name="min"></param>
- <param name="max"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Bintree.Interval.ExpandToInclude(DotSpatial.Topology.Index.Bintree.Interval)">
- <summary>
-
- </summary>
- <param name="interval"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Bintree.Interval.Overlaps(DotSpatial.Topology.Index.Bintree.Interval)">
- <summary>
-
- </summary>
- <param name="interval"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Bintree.Interval.Overlaps(System.Double,System.Double)">
- <summary>
-
- </summary>
- <param name="min"></param>
- <param name="max"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Bintree.Interval.Contains(DotSpatial.Topology.Index.Bintree.Interval)">
- <summary>
-
- </summary>
- <param name="interval"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Bintree.Interval.Contains(System.Double,System.Double)">
- <summary>
-
- </summary>
- <param name="min"></param>
- <param name="max"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Bintree.Interval.Contains(System.Double)">
- <summary>
-
- </summary>
- <param name="p"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.Index.Bintree.Interval.Min">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Bintree.Interval.Max">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Bintree.Interval.Width">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Index.Bintree.Key">
- <summary>
- A Key is a unique identifier for a node in a tree.
- It contains a lower-left point and a level number. The level number
- is the power of two for the size of the node envelope.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Bintree.Key.#ctor(DotSpatial.Topology.Index.Bintree.Interval)">
- <summary>
-
- </summary>
- <param name="interval"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Bintree.Key.ComputeLevel(DotSpatial.Topology.Index.Bintree.Interval)">
- <summary>
-
- </summary>
- <param name="interval"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Bintree.Key.ComputeKey(DotSpatial.Topology.Index.Bintree.Interval)">
- <summary>
- Return a square envelope containing the argument envelope,
- whose extent is a power of two and which is based at a power of 2.
- </summary>
- <param name="itemInterval"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Bintree.Key.ComputeInterval(System.Int32,DotSpatial.Topology.Index.Bintree.Interval)">
- <summary>
-
- </summary>
- <param name="level"></param>
- <param name="itemInterval"></param>
- </member>
- <member name="P:DotSpatial.Topology.Index.Bintree.Key.Point">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Bintree.Key.Level">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Bintree.Key.Interval">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Index.Bintree.Node">
- <summary>
- A node of a <c>Bintree</c>.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Index.Bintree.NodeBase">
- <summary>
- The base class for nodes in a <c>Bintree</c>.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Index.Bintree.NodeBase._subnode">
- <summary>
- Subnodes are numbered as follows:
- 0 | 1
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Bintree.NodeBase.Add(System.Object)">
- <summary>
- Adds the specified object to the items list for this node. This will not affect child nodes.
- </summary>
- <param name="item">The object item to add to the list.</param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Bintree.NodeBase.AddAllItems(System.Collections.IList)">
- <summary>
-
- </summary>
- <param name="items"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Bintree.NodeBase.AddAllItemsFromOverlapping(DotSpatial.Topology.Index.Bintree.Interval,System.Collections.IList)">
- <summary>
-
- </summary>
- <param name="interval"></param>
- <param name="resultItems"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Bintree.NodeBase.IsSearchMatch(DotSpatial.Topology.Index.Bintree.Interval)">
- <summary>
-
- </summary>
- <param name="interval"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Bintree.NodeBase.GetSubnodeIndex(DotSpatial.Topology.Index.Bintree.Interval,System.Double)">
- <summary>
- Returns the index of the subnode that wholely contains the given interval.
- If none does, returns -1.
- </summary>
- <param name="interval"></param>
- <param name="centre"></param>
- </member>
- <member name="P:DotSpatial.Topology.Index.Bintree.NodeBase.Count">
- <summary>
- Gets the count of all the items in this node, plus all the items in all of the child nodes
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Bintree.NodeBase.Depth">
- <summary>
- Gets an integer representing the maximum levels needed to be decended to account for all the child nodes
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Bintree.NodeBase.Items">
- <summary>
- Gets a list of all the items currently stored in this node. This does not include
- any items from child nodes.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Bintree.NodeBase.NodeCount">
- <summary>
- Gets the count of this node plus all of the child nodes
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Bintree.NodeBase.Nodes">
- <summary>
- Gets the array of all the sub-nodes below this node.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Bintree.Node.#ctor(DotSpatial.Topology.Index.Bintree.Interval,System.Int32)">
- <summary>
-
- </summary>
- <param name="interval"></param>
- <param name="level"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Bintree.Node.CreateNode(DotSpatial.Topology.Index.Bintree.Interval)">
- <summary>
-
- </summary>
- <param name="itemInterval"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Bintree.Node.CreateExpanded(DotSpatial.Topology.Index.Bintree.Node,DotSpatial.Topology.Index.Bintree.Interval)">
- <summary>
-
- </summary>
- <param name="node"></param>
- <param name="addInterval"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Bintree.Node.IsSearchMatch(DotSpatial.Topology.Index.Bintree.Interval)">
- <summary>
-
- </summary>
- <param name="itemInterval"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Bintree.Node.GetNode(DotSpatial.Topology.Index.Bintree.Interval)">
- <summary>
- Returns the subnode containing the envelope.
- Creates the node if
- it does not already exist.
- </summary>
- <param name="searchInterval"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Bintree.Node.Find(DotSpatial.Topology.Index.Bintree.Interval)">
- <summary>
- Returns the smallest existing
- node containing the envelope.
- </summary>
- <param name="searchInterval"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Bintree.Node.Insert(DotSpatial.Topology.Index.Bintree.Node)">
- <summary>
-
- </summary>
- <param name="node"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Bintree.Node.GetSubnode(System.Int32)">
- <summary>
- Get the subnode for the index.
- If it doesn't exist, create it.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Bintree.Node.CreateSubnode(System.Int32)">
- <summary>
-
- </summary>
- <param name="index"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.Index.Bintree.Node.Interval">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Index.Bintree.Root">
- <summary>
- The root node of a single <c>Bintree</c>.
- It is centred at the origin,
- and does not have a defined extent.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Bintree.Root.Insert(DotSpatial.Topology.Index.Bintree.Interval,System.Object)">
- <summary>
- Insert an item into the tree this is the root of.
- </summary>
- <param name="itemInterval"></param>
- <param name="item"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Bintree.Root.InsertContained(DotSpatial.Topology.Index.Bintree.Node,DotSpatial.Topology.Index.Bintree.Interval,System.Object)">
- <summary>
- Insert an item which is known to be contained in the tree rooted at
- the given Node. Lower levels of the tree will be created
- if necessary to hold the item.
- </summary>
- <param name="tree"></param>
- <param name="itemInterval"></param>
- <param name="item"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Bintree.Root.IsSearchMatch(DotSpatial.Topology.Index.Bintree.Interval)">
- <summary>
- The root node matches all searches.
- </summary>
- <param name="interval"></param>
- </member>
- <member name="T:DotSpatial.Topology.Index.Chain.MonotoneChain">
- <summary>
- MonotoneChains are a way of partitioning the segments of a linestring to
- allow for fast searching of intersections.
- They have the following properties:
- the segments within a monotone chain will never intersect each other
- the envelope of any contiguous subset of the segments in a monotone chain
- is equal to the envelope of the endpoints of the subset.
- Property 1 means that there is no need to test pairs of segments from within
- the same monotone chain for intersection.
- Property 2 allows
- binary search to be used to find the intersection points of two monotone chains.
- For many types of real-world data, these properties eliminate a large number of
- segment comparisons, producing substantial speed gains.
- One of the goals of this implementation of MonotoneChains is to be
- as space and time efficient as possible. One design choice that aids this
- is that a MonotoneChain is based on a subarray of a list of points.
- This means that new arrays of points (potentially very large) do not
- have to be allocated.
- MonotoneChains support the following kinds of queries:
- Envelope select: determine all the segments in the chain which
- intersect a given envelope.
- Overlap: determine all the pairs of segments in two chains whose
- envelopes overlap.
- This implementation of MonotoneChains uses the concept of internal iterators
- to return the resultsets for the above queries.
- This has time and space advantages, since it
- is not necessary to build lists of instantiated objects to represent the segments
- returned by the query.
- However, it does mean that the queries are not thread-safe.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Chain.MonotoneChain.#ctor(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate},System.Int32,System.Int32,System.Object)">
- <summary>
-
- </summary>
- <param name="pts"></param>
- <param name="start"></param>
- <param name="end"></param>
- <param name="context"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Chain.MonotoneChain.GetLineSegment(System.Int32)">
- <summary>
- Gets a copy of the line segment located at the specified index.
- </summary>
- <param name="index"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Chain.MonotoneChain.Select(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.Index.Chain.MonotoneChainSelectAction)">
- <summary>
- Determine all the line segments in the chain whose envelopes overlap
- the searchEnvelope, and process them.
- </summary>
- <param name="searchEnv"></param>
- <param name="mcs"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Chain.MonotoneChain.ComputeSelect(DotSpatial.Topology.IEnvelope,System.Int32,System.Int32,DotSpatial.Topology.Index.Chain.MonotoneChainSelectAction)">
- <summary>
-
- </summary>
- <param name="searchEnv"></param>
- <param name="start0"></param>
- <param name="end0"></param>
- <param name="mcs"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Chain.MonotoneChain.ComputeOverlaps(DotSpatial.Topology.Index.Chain.MonotoneChain,DotSpatial.Topology.Index.Chain.MonotoneChainOverlapAction)">
- <summary>
-
- </summary>
- <param name="mc"></param>
- <param name="mco"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Chain.MonotoneChain.ComputeOverlaps(System.Int32,System.Int32,DotSpatial.Topology.Index.Chain.MonotoneChain,System.Int32,System.Int32,DotSpatial.Topology.Index.Chain.MonotoneChainOverlapAction)">
- <summary>
-
- </summary>
- <param name="start0"></param>
- <param name="end0"></param>
- <param name="mc"></param>
- <param name="start1"></param>
- <param name="end1"></param>
- <param name="mco"></param>
- </member>
- <member name="P:DotSpatial.Topology.Index.Chain.MonotoneChain.Id">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Chain.MonotoneChain.Context">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Chain.MonotoneChain.Envelope">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Chain.MonotoneChain.StartIndex">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Chain.MonotoneChain.EndIndex">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Chain.MonotoneChain.Coordinates">
- <summary>
- Return the subsequence of coordinates forming this chain.
- Allocates a new array to hold the Coordinates.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Index.Chain.MonotoneChainBuilder">
- <summary>
- A MonotoneChainBuilder implements static functions
- to determine the monotone chains in a sequence of points.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Chain.MonotoneChainBuilder.#ctor">
- <summary>
- Only static methods!
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Chain.MonotoneChainBuilder.ToIntArray(System.Collections.IList)">
- <summary>
-
- </summary>
- <param name="list"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Chain.MonotoneChainBuilder.GetChains(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate})">
- <summary>
-
- </summary>
- <param name="pts"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Chain.MonotoneChainBuilder.GetChains(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate},System.Object)">
- <summary>
- Return a list of the <c>MonotoneChain</c>s
- for the given list of coordinates.
- </summary>
- <param name="pts"></param>
- <param name="context"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Chain.MonotoneChainBuilder.GetChainStartIndices(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate})">
- <summary>
- Return an array containing lists of start/end indexes of the monotone chains
- for the given list of coordinates.
- The last entry in the array points to the end point of the point array,
- for use as a sentinel.
- </summary>
- <param name="pts"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Chain.MonotoneChainBuilder.FindChainEnd(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate},System.Int32)">
- <summary>
-
- </summary>
- <param name="pts"></param>
- <param name="start"></param>
- <returns>
- The index of the last point in the monotone chain starting at <c>start</c>.
- </returns>
- </member>
- <member name="T:DotSpatial.Topology.Index.Chain.MonotoneChainOverlapAction">
- <summary>
- The action for the internal iterator for performing
- overlap queries on a MonotoneChain.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Chain.MonotoneChainOverlapAction.Overlap(DotSpatial.Topology.Index.Chain.MonotoneChain,System.Int32,DotSpatial.Topology.Index.Chain.MonotoneChain,System.Int32)">
- <summary>
- This function can be overridden if the original chains are needed.
- </summary>
- <param name="mc1"></param>
- <param name="start1">The index of the start of the overlapping segment from mc1.</param>
- <param name="mc2"></param>
- <param name="start2">The index of the start of the overlapping segment from mc2.</param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Chain.MonotoneChainOverlapAction.Overlap(DotSpatial.Topology.LineSegment,DotSpatial.Topology.LineSegment)">
- <summary>
- This is a convenience function which can be overridden to obtain the actual
- line segments which overlap.
- </summary>
- <param name="seg1"></param>
- <param name="seg2"></param>
- </member>
- <member name="P:DotSpatial.Topology.Index.Chain.MonotoneChainOverlapAction.TempEnv1">
- <summary>
- This envelope is used during the MonotoneChain search process.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Chain.MonotoneChainOverlapAction.TempEnv2">
- <summary>
- This envelope is used during the MonotoneChain search process.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Chain.MonotoneChainOverlapAction.OverlapSeg1">
- <summary>
- One overlapping segment.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Chain.MonotoneChainOverlapAction.OverlapSeg2">
- <summary>
- The other overlapping segment.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Index.IIndexVisitor">
- <summary>
- A visitor for nodes and items in an index.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.IIndexVisitor.VisitItem(System.Object)">
- <summary>
-
- </summary>
- <param name="item"></param>
- </member>
- <member name="T:DotSpatial.Topology.Index.ISpatialIndex">
- <summary>
- The basic insertion and query operations supported by classes
- implementing spatial index algorithms.
- A spatial index typically provides a primary filter for range rectangle queries. A
- secondary filter is required to test for exact intersection. Of course, this
- secondary filter may consist of other tests besides intersection, such as
- testing other kinds of spatial relationships.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.ISpatialIndex.Insert(DotSpatial.Topology.IEnvelope,System.Object)">
- <summary>
- Adds a spatial item with an extent specified by the given <c>Envelope</c> to the index.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.ISpatialIndex.Query(DotSpatial.Topology.IEnvelope)">
- <summary>
- Queries the index for all items whose extents intersect the given search <c>Envelope</c>
- Notice that some kinds of indexes may also return objects which do not in fact
- intersect the query envelope.
- </summary>
- <param name="searchEnv">The envelope to query for.</param>
- <returns>A list of the items found by the query.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.ISpatialIndex.Query(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.Index.IItemVisitor)">
- <summary>
- Queries the index for all items whose extents intersect the given search <see cref="T:DotSpatial.Topology.Envelope"/>,
- and applies an <see cref="T:DotSpatial.Topology.Index.IItemVisitor"/> to them.
- Notice that some kinds of indexes may also return objects which do not in fact
- intersect the query envelope.
- </summary>
- <param name="searchEnv">The envelope to query for.</param>
- <param name="visitor">A visitor object to apply to the items found.</param>
- </member>
- <member name="M:DotSpatial.Topology.Index.ISpatialIndex.Remove(DotSpatial.Topology.IEnvelope,System.Object)">
- <summary>
- Removes a single item from the tree.
- </summary>
- <param name="itemEnv">The Envelope of the item to remove.</param>
- <param name="item">The item to remove.</param>
- <returns> <c>true</c> if the item was found.</returns>
- </member>
- <member name="T:DotSpatial.Topology.KDTree.FarthestNeighborList">
- <summary>
- Bjoern Heckel's solution to the KD-Tree n-nearest-neighbor problem
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.FarthestNeighborList.#ctor(System.Int32)">
- <summary>
- Creates a new NearestNeighborList
- </summary>
- <param name="capacity">An integer indicating the maximum size for the cue</param>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.FarthestNeighborList.Insert(System.Object,System.Double)">
- <summary>
- Inserts an object with a given priority
- </summary>
- <param name="obj"></param>
- <param name="priority"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.FarthestNeighborList.RemoveFarthest">
- <summary>
- Removes the highest member from the cue and returns that object.
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.KDTree.FarthestNeighborList.MinimumPriority">
- <summary>
- Gets the minimum priority, or distance. Since we are looking for the maximum distance, or the
- n maximum distances, we want to determine quickly the lowest distance currently contained
- in the cue.
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.KDTree.FarthestNeighborList.IsCapacityReached">
- <summary>
- Gets whether or not the length of the cue has reached the capacity
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.KDTree.FarthestNeighborList.Farthest">
- <summary>
- Gets the highest object in the nearest neighbor list
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.KDTree.FarthestNeighborList.IsEmpty">
- <summary>
- Gets a boolean indicating whether or not the cue is empty
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.KDTree.FarthestNeighborList.Size">
- <summary>
- Gets the length of the current list
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.KDTree.HPoint">
- <summary>
- Hyper-Point class supporting KdTree class
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.HPoint.#ctor(System.Int32)">
- <summary>
- Constructs a new HyperPoint where numDimensions indicates the size of the array for the coordinates
- </summary>
- <param name="numDimensions">The number of dimensions</param>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.HPoint.#ctor(System.Double[])">
- <summary>
- Constructs a new HyperPoint where the specified array of doubles defines the internal coordinate values.
- </summary>
- <param name="inCoord">The in coordinate to use when constructing this hyper point.</param>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.HPoint.SquareDistance(DotSpatial.Topology.KDTree.HPoint,DotSpatial.Topology.KDTree.HPoint)">
- <summary>
- A Static method for returning the square distance between two coordinates
- </summary>
- <param name="x">One coordinate</param>
- <param name="y">A second coordinate</param>
- <returns>A double representing the square distance</returns>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.HPoint.EuclideanDistance(DotSpatial.Topology.KDTree.HPoint,DotSpatial.Topology.KDTree.HPoint)">
- <summary>
- Calculates the Euclidean distance between the two coordinates
- </summary>
- <param name="x">An ICoordinate</param>
- <param name="y">Another ICoordinate</param>
- <returns>A double representing the distance</returns>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.HPoint.HyperDistance(DotSpatial.Topology.KDTree.HPoint)">
- <summary>
- Calculates the distance in comparison with any coordinate. The coordinate with fewer dimensions
- will determine the dimensionality for the comparison.
- </summary>
- <param name="p"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.HPoint.SquareHyperDistance(DotSpatial.Topology.KDTree.HPoint)">
- <summary>
- Calculates the square of the Euclidean distance between this point and the other point.
- </summary>
- <param name="p">Any valid implementation of ICoordinate</param>
- <returns>A double representing the distances.</returns>
- </member>
- <member name="P:DotSpatial.Topology.KDTree.HPoint.Values">
- <summary>
- Gets or sets the actual values for this class.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.KDTree.HRect">
- <summary>
- Hyper-Rectangle class supporting KdTree class
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.KDTree.HRect.Max">
- <summary>
- Maximum values
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.KDTree.HRect.Min">
- <summary>
- Minimum values
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.HRect.#ctor(System.Int32)">
- <summary>
- Constructs a new instance of a rectangle binding structure based on a specified number of dimensions
- </summary>
- <param name="numDimensions">An integer representing the number of dimensions. For X, Y coordinates, this should be 2.</param>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.HRect.#ctor(DotSpatial.Topology.KDTree.HPoint,DotSpatial.Topology.KDTree.HPoint)">
- <summary>
- Creates a new bounding rectangle based on the two coordinates specified. It is assumed that
- the vmin and vmax coordinates have already been correctly calculated.
- </summary>
- <param name="vmin"></param>
- <param name="vmax"></param>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.HRect.Clone">
- <summary>
- Creates a duplicate of this object
- </summary>
- <returns>An object duplicate of this object</returns>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.HRect.Copy">
- <summary>
- Creates a duplicate of this bounding box using the existing minimum and maximum.
- </summary>
- <returns>An HRect duplicate of this object</returns>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.HRect.Closest(DotSpatial.Topology.KDTree.HPoint)">
- <summary>
- Calculates the closest point on the hyper-extent to the specified point.
- from Moore's eqn. 6.6
- </summary>
- <param name="t"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.HRect.Farthest(DotSpatial.Topology.KDTree.HPoint)">
- <summary>
- This method calculates the furthest point on the rectangle
- from the specified point. This is to determine if it is
- possible for any of the members of the closer rectangle
- to be positioned further away from the test point than
- the points in the hyper-extent that is further from the point.
- </summary>
- <param name="t"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.HRect.InfiniteHRect(System.Int32)">
- <summary>
- Calculates a new HRect object that has a nearly infinite bounds.
- </summary>
- <param name="d">THe number of dimensions to use</param>
- <returns>A new HRect where the minimum is negative infinity, and the maximum is positive infinity</returns>
- <remarks>Used in initial conditions of KdTree.nearest()</remarks>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.HRect.Intersection(DotSpatial.Topology.KDTree.HRect)">
- <summary>
- If the specified HRect does not intersect this HRect, this returns null. Otherwise,
- this will return a smaller rectangular region that represents the intersection
- of the two bounding regions.
- </summary>
- <param name="region">Another HRect object to intersect with this one.</param>
- <returns>The HRect that represents the intersection area for the two bounding boxes.</returns>
- <remarks>currently unused</remarks>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.HRect.ToString">
- <summary>
- Creates a string that represents this bounding box
- </summary>
- <returns>A String</returns>
- </member>
- <member name="P:DotSpatial.Topology.KDTree.HRect.HyperVolume">
- <summary>
- Gets the current hyper-volume. For 1D, this is Length. For 2D this is Area. For 3D this is Volume.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.KDTree.HRect.Minimum">
- <summary>
- Gets or sets the minimum coordinate (containing the smaller value) in all dimensions.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.KDTree.HRect.Maximum">
- <summary>
- Gets or sets the maximum coordinate
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.KDTree.HRect.NumOrdinates">
- <summary>
- Gets the number of ordinates for this rectangular structure (based on the minimum HPoint)
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.KDTree.KdNode">
- <summary>
- K-D Tree node class
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.KdNode.#ctor(DotSpatial.Topology.KDTree.HPoint,System.Object)">
- <summary>
- Constructs a new instance of the KDNode.
- </summary>
- <param name="key">A Hyper Point representing the key to use for storing this value</param>
- <param name="value">A valid object value to use for copying this.</param>
- <remarks>The constructor is used only by class; other methods are static</remarks>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.KdNode.ToString(System.Int32)">
- <summary>
- Creates a string representation of this node
- </summary>
- <param name="depth">The depth of child nodes to search when creating the string.</param>
- <returns>A string representation of this node.</returns>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.KdNode.Insert(DotSpatial.Topology.KDTree.HPoint,System.Object,DotSpatial.Topology.KDTree.KdNode,System.Int32,System.Int32)">
- <summary>
- Inserts a
- </summary>
- <param name="key"></param>
- <param name="value"></param>
- <param name="t"></param>
- <param name="lev"></param>
- <param name="k"></param>
- <returns></returns>
- <remarks> Method ins translated from 352.ins.c of Gonnet and Baeza-Yates</remarks>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.KdNode.Search(DotSpatial.Topology.KDTree.HPoint,DotSpatial.Topology.KDTree.KdNode,System.Int32)">
- <summary>
- Searches for a specific value
- </summary>
- <param name="key"></param>
- <param name="t"></param>
- <param name="k"></param>
- <returns></returns>
- <remarks>Method srch translated from 352.srch.c of Gonnet and Baeza-Yates</remarks>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.KdNode.SearchRange(DotSpatial.Topology.KDTree.HPoint,DotSpatial.Topology.KDTree.HPoint,DotSpatial.Topology.KDTree.KdNode,System.Int32,System.Int32,System.Collections.Generic.List{DotSpatial.Topology.KDTree.KdNode})">
- <summary>
- Searches for values in a range
- </summary>
- <param name="lowk"></param>
- <param name="uppk"></param>
- <param name="t"></param>
- <param name="lev"></param>
- <param name="k"></param>
- <param name="v"></param>
- <remarks>Method rsearch translated from 352.range.c of Gonnet and Baeza-Yates</remarks>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.KdNode.Nnbr(DotSpatial.Topology.KDTree.KdNode,DotSpatial.Topology.KDTree.HPoint,DotSpatial.Topology.KDTree.HRect,System.Double,System.Int32,System.Int32,DotSpatial.Topology.KDTree.NearestNeighborList)">
- <summary>
- Method Nearest Neighbor from Andrew Moore's thesis. Numbered
- comments are direct quotes from there. Step "SDL" is added to
- make the algorithm work correctly. NearestNeighborList solution
- courtesy of Bjoern Heckel.
- </summary>
- <param name="kd"></param>
- <param name="target"></param>
- <param name="hr"></param>
- <param name="maxDistSqd"></param>
- <param name="lev"></param>
- <param name="k"></param>
- <param name="nnl"></param>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.KdNode.FarthestNeighbor(DotSpatial.Topology.KDTree.KdNode,DotSpatial.Topology.KDTree.HPoint,DotSpatial.Topology.KDTree.HRect,System.Double,System.Int32,System.Int32,DotSpatial.Topology.KDTree.FarthestNeighborList)">
- <summary>
- This method was written by Ted Dunsford by restructuring the nearest neighbor
- algorithm presented by Andrew and Bjoern
- </summary>
- <param name="kd">Since this is recursive, this represents the current node</param>
- <param name="target">The target is the HPoint that we are trying to calculate the farthest distance from</param>
- <param name="hr">In this case, the hr is the hyper rectangle bounding the region that must contain the furthest point.</param>
- <param name="maxDistSqd">The maximum distance that we have calculated thus far, and will therefore be testing against.</param>
- <param name="lev">The integer based level of that we have recursed to in the tree</param>
- <param name="k">The dimensionality of the kd tree</param>
- <param name="fnl">A list to contain the output, prioritized by distance</param>
- </member>
- <member name="P:DotSpatial.Topology.KDTree.KdNode.IsDeleted">
- <summary>
- Gets or sets whether this node has been _isDeleted
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.KDTree.KdTree">
- <summary>
- This is an adaptation of the Java KdTree library implemented by Levy
- and Heckel. This simplified version is written by Marco A. Alvarez
-
- KdTree is a class supporting KD-tree insertion, deletion, equality
- search, range search, and nearest neighbor(s) using double-precision
- floating-point keys. Splitting dimension is chosen naively, by
- depth modulo K. Semantics are as follows:
-
- Two different keys containing identical numbers should retrieve the
- same value from a given KD-tree. Therefore keys are cloned when a
- node is inserted.
-
- As with Hashtables, values inserted into a KD-tree are <I>not</I>
- cloned. Modifying a value between insertion and retrieval will
- therefore modify the value stored in the tree.
-
-
- @author Simon Levy, Bjoern Heckel
- Translation by Marco A. Alvarez
- Adapted by Ted Dunsford to better suite the dot net framework by
- changing comments to work in intellisense and extending some of the
- basic objects to work more tightly with MapWindow.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.KdTree.#ctor(System.Int32)">
- <summary>
- Creates a new tree with the specified number of dimensions.
- </summary>
- <param name="k">An integer value specifying how many ordinates each key should have.</param>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.KdTree.Insert(System.Double[],System.Object)">
- <summary>
- Insert a node into the KD-tree.
- </summary>
- <param name="key">The array of double valued keys marking the position to insert this object into the tree</param>
- <param name="value">The object value to insert into the tree</param>
- <exception cref="T:DotSpatial.Topology.KDTree.KeySizeException"> if key.length mismatches the dimension of the tree (K)</exception>
- <exception cref="T:DotSpatial.Topology.KDTree.KeyDuplicateException"> if the key already exists in the tree</exception>
- <remarks>
- Uses algorithm translated from 352.ins.c of
- @Book{GonnetBaezaYates1991,
- author = {G.H. Gonnet and R. Baeza-Yates},
- title = {Handbook of Algorithms and Data Structures},
- publisher = {Addison-Wesley},
- year = {1991}
- </remarks>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.KdTree.Search(System.Double[])">
- <summary>
- Find the KD-tree node whose key is identical to the specified key.
- This uses the algorithm translated from 352.srch.c of Connet and Baeza-Yates.
- </summary>
- <param name="key">The key identifying the node to search for</param>
- <returns>An object that is the node with a matching key, or null if no key was found.</returns>
- <exception cref="T:DotSpatial.Topology.KDTree.KeySizeException"> if key.length mismatches the dimension of the tree (K)</exception>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.KdTree.Delete(System.Double[])">
- <summary>
- Deletes a node from the KD-tree. Instead of actually deleting the node and
- rebuilding the tree, it marks the node as deleted. Hence, it is up to the
- caller to rebuild the tree as needed for efficiency.
- </summary>
- <param name="key">The key to use to identify the node to delete</param>
- <exception cref="T:DotSpatial.Topology.KDTree.KeySizeException"> if key.length mismatches the dimension of the tree (K)</exception>
- <exception cref="T:DotSpatial.Topology.KDTree.KeyMissingException"> if the key was not found in the tree</exception>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.KdTree.Nearest(System.Double[])">
- <summary>
- Find KD-tree node whose key is nearest neighbor to key.
- Implements the Nearest Neighbor algorithm (Table 6.4) of
- </summary>
- <param name="key">key for KD-tree node</param>
- <returns>object at node nearest to key, or null on failure</returns>
- <exception cref="T:DotSpatial.Topology.KDTree.KeySizeException"> if key.length mismatches the dimensions of the tree (K)</exception>
- <remarks>
- @techreport{AndrewMooreNearestNeighbor,
- author = {Andrew Moore},
- title = {An introductory tutorial on kd-trees},
- institution = {Robotics Institute, Carnegie Mellon University},
- year = {1991},
- number = {Technical Report No. 209, Computer Laboratory,
- University of Cambridge},
- address = {Pittsburgh, PA}
- </remarks>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.KdTree.Nearest(System.Double[],System.Int32)">
- <summary>
- Find KD-tree nodes whose keys are <I>n</I> nearest neighbors to
- key. Uses algorithm above. Neighbors are returned in ascending
- order of distance to key.
- </summary>
- <param name="key">key for KD-tree node</param>
- <param name="numNeighbors">The Integer showing how many neighbors to find</param>
- <returns>An array of objects at the node nearest to the key</returns>
- <exception cref="T:DotSpatial.Topology.KDTree.KeySizeException">Mismatch if key length doesn't match the dimension for the tree</exception>
- <exception cref="T:DotSpatial.Topology.KDTree.NeighborsOutOfRangeException">if <I>n</I> is negative or exceeds tree size </exception>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.KdTree.Farthest(System.Double[])">
- <summary>
- Reverses the conventional nearest neighbor in order to obtain the furthest neighbor instead.
- </summary>
- <param name="key">The key for the KD-tree node</param>
- <returns>The object that corresponds to the furthest object</returns>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.KdTree.Farthest(System.Double[],System.Int32)">
- <summary>
- Find KD-tree nodes whose keys are <I>n</I> farthest neighbors from
- key. Neighbors are returned in descending order of distance to key.
- </summary>
- <param name="key">key for KD-tree node</param>
- <param name="numNeighbors">The Integer showing how many neighbors to find</param>
- <returns>An array of objects at the node nearest to the key</returns>
- <exception cref="T:DotSpatial.Topology.KDTree.KeySizeException">Mismatch if key length doesn't match the dimension for the tree</exception>
- <exception cref="T:DotSpatial.Topology.KDTree.NeighborsOutOfRangeException">if <I>n</I> is negative or exceeds tree size </exception>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.KdTree.SearchRange(System.Double[],System.Double[])">
- <summary>
- Search a range in the KD-tree.
- </summary>
- <param name="lowKey">The lower bound in all ordinates for keys</param>
- <param name="highKey">Teh upper bound in all ordinates for keys</param>
- <returns>An array of objects whose keys fall in range [lowk, uppk]</returns>
- <remarks> Range search in a KD-tree. Uses algorithm translated from 352.range.c of Gonnet and Baeza-Yates.</remarks>
- <exception cref="T:DotSpatial.Topology.KDTree.KeySizeException">Mismatch of the specified parameters compared with the tree or each other.</exception>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.KdTree.ToString">
- <summary>
- Converts the value to a string
- </summary>
- <returns>A string</returns>
- </member>
- <member name="P:DotSpatial.Topology.KDTree.KdTree.Count">
- <summary>
- Gets the number of members in this tree.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.KDTree.KdTree.K">
- <summary>
- Gets the actual number of dimensions for this tree.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.KDTree.KeyDuplicateException">
- <summary>
- KeyDuplicateException is thrown when the <TT>KdTree.insert</TT> method
- is invoked on a key already in the KdTree.
-
- @author Simon Levy
- Translation by Marco A. Alvarez
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.KeyDuplicateException.#ctor">
- <summary>
- KeyDuplicateException
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.KDTree.KeyMissingException">
- <summary>
- Key-size mismatch exception supporting KdTree class
-
- @author Simon Levy
- Translation by Marco A. Alvarez
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.KeyMissingException.#ctor">
- <summary>
- KeyMissing Exception
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.KDTree.KeySizeException">
- <summary>
- KeySizeException is thrown when a KdTree method is invoked on a
- key whose size (array length) mismatches the one used in the that
- KdTree's constructor.
-
- @author Simon Levy
- Translation by Marco A. Alvarez
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.KeySizeException.#ctor">
- <summary>
- KeySizeException
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.KDTree.NearestNeighborList">
- <summary>
- Bjoern Heckel's solution to the KD-Tree n-nearest-neighbor problem
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.KDTree.NearestNeighborList.REMOVE_HIGHEST">
- <summary>
- Indicates whether removal should occur from the highest value or lowest value
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.KDTree.NearestNeighborList.REMOVE_LOWEST">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.NearestNeighborList.#ctor(System.Int32)">
- <summary>
- Creates a new NearestNeighborList
- </summary>
- <param name="capacity">An integer indicating the maximum size for the cue</param>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.NearestNeighborList.Insert(System.Object,System.Double)">
- <summary>
- Inserts an item with a given priority
- </summary>
- <param name="item"></param>
- <param name="priority"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.NearestNeighborList.RemoveHighest">
- <summary>
- Removes the highest member from the cue and returns that object.
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.KDTree.NearestNeighborList.MaxPriority">
- <summary>
- Gets the maximum priority
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.KDTree.NearestNeighborList.IsCapacityReached">
- <summary>
- Gets whether or not the length fo the cue has reached the capacity
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.KDTree.NearestNeighborList.Highest">
- <summary>
- Gets the highest object in the nearest neighbor list
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.KDTree.NearestNeighborList.IsEmpty">
- <summary>
- Gets a boolean indicating whether or not the cue is empty
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.KDTree.NearestNeighborList.Size">
- <summary>
- Gets the length of the current list
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.KDTree.NeighborsOutOfRangeException">
- <summary>
- NeighborsOutOfRangeException
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.NeighborsOutOfRangeException.#ctor">
- <summary>
- Creates a new NeighborsOutOfRangeException
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.KDTree.PriorityQueue">
- <summary>
- This class implements a PriorityQueue. This class
- is implemented in such a way that objects are added using an
- add function. The add function takes
- two parameters an object and a long.
-
- The object represents an item in the queue, the long indicates
- its priority in the queue. The remove function in this class
- returns the object first in the queue and that object is removed
- from the queue permanently.
-
- @author Simon Levy
- Translation by Marco A. Alvarez
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.KDTree.PriorityQueue._maxPriority">
- The maximum priority possible in this priority queue.
- </member>
- <member name="F:DotSpatial.Topology.KDTree.PriorityQueue._count">
- Holds the number of elements currently in the queue.
- </member>
- <member name="F:DotSpatial.Topology.KDTree.PriorityQueue._data">
- This contains the list of objects in the queue.
- </member>
- <member name="F:DotSpatial.Topology.KDTree.PriorityQueue._value">
- This contains the list of prioritys in the queue.
- </member>
- <member name="M:DotSpatial.Topology.KDTree.PriorityQueue.#ctor">
- Creates a new <code>PriorityQueue</code> object. The
- <code>PriorityQueue</code> object allows objects to be
- entered into the queue and to leave in the order of
- priority i.e the highest priority get's to leave first.
- </member>
- <member name="M:DotSpatial.Topology.KDTree.PriorityQueue.#ctor(System.Int32)">
- Creates a new <code>PriorityQueue</code> object. The
- <code>PriorityQueue</code> object allows objects to
- be entered into the queue an to leave in the order of
- priority i.e the highest priority get's to leave first.
-
- @param capacity the initial capacity of the queue before
- a resize
- </member>
- <member name="M:DotSpatial.Topology.KDTree.PriorityQueue.#ctor(System.Int32,System.Double)">
- Creates a new <code>PriorityQueue</code> object. The
- <code>PriorityQueue</code> object allows objects to
- be entered into the queue an to leave in the order of
- priority i.e the highest priority get's to leave first.
-
- @param capacity the initial capacity of the queue before
- a resize
- @param maxPriority is the maximum possible priority for
- an object
- </member>
- <member name="M:DotSpatial.Topology.KDTree.PriorityQueue.Init(System.Int32)">
- This is an initializer for the object. It basically initializes
- an array of long called value to represent the prioritys of
- the objects, it also creates an array of objects to be used
- in parallel with the array of longs, to represent the objects
- entered, these can be used to sequence the data.
-
- @param size the initial capacity of the queue, it can be
- resized
- </member>
- <member name="M:DotSpatial.Topology.KDTree.PriorityQueue.Add(System.Object,System.Double)">
- This function adds the given object into the <code>PriorityQueue</code>,
- its priority is the long priority. The way in which priority can be
- associated with the elements of the queue is by keeping the priority
- and the elements array entrys parallel.
-
- @param element is the object that is to be entered into this
- <code>PriorityQueue</code>
- @param priority this is the priority that the object holds in the
- <code>PriorityQueue</code>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.PriorityQueue.Remove">
- Remove is a function to remove the element in the queue with the
- maximum priority. Once the element is removed then it can never be
- recovered from the queue with further calls. The lowest priority
- object will leave last.
-
- @return the object with the highest priority or if it's empty
- null
- </member>
- <member name="M:DotSpatial.Topology.KDTree.PriorityQueue.BubbleDown(System.Int32)">
- Bubble down is used to put the element at subscript 'pos' into
- it's rightful place in the heap (i.e heap is another name
- for <code>PriorityQueue</code>). If the priority of an element
- at subscript 'pos' is less than it's children then it must
- be put under one of these children, i.e the ones with the
- maximum priority must come first.
-
- @param pos is the position within the arrays of the element
- and priority
- </member>
- <member name="M:DotSpatial.Topology.KDTree.PriorityQueue.BubbleUp(System.Int32)">
- Bubble up is used to place an element relatively low in the
- queue to it's rightful place higher in the queue, but only
- if it's priority allows it to do so, similar to bubbleDown
- only in the other direction this swaps out its parents.
-
- @param pos the position in the arrays of the object
- to be bubbled up
- </member>
- <member name="M:DotSpatial.Topology.KDTree.PriorityQueue.ExpandCapacity">
- This ensures that there is enough space to keep adding elements
- to the priority queue. It is however advised to make the capacity
- of the queue large enough so that this will not be used as it is
- an expensive method. This will copy across from 0 as 'off' equals
- 0 is contains some important data.
- </member>
- <member name="M:DotSpatial.Topology.KDTree.PriorityQueue.Clear">
- This method will empty the queue. This also helps garbage
- collection by releasing any reference it has to the elements
- in the queue. This starts from offset 1 as off equals 0
- for the elements array.
- </member>
- <member name="M:DotSpatial.Topology.KDTree.PriorityQueue.Length">
- The number of elements in the queue. The length
- indicates the number of elements that are currently
- in the queue.
-
- @return the number of elements in the queue
- </member>
- <member name="T:DotSpatial.Topology.Index.Quadtree.DoubleBits">
- <summary>
- DoubleBits manipulates Double numbers
- by using bit manipulation and bit-field extraction.
- For some operations (such as determining the exponent)
- this is more accurate than using mathematical operations
- (which suffer from round-off error).
- The algorithms and constants in this class
- apply only to IEEE-754 double-precision floating point format.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Index.Quadtree.DoubleBits.EXPONENT_BIAS">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.DoubleBits.#ctor(System.Double)">
- <summary>
-
- </summary>
- <param name="x"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.DoubleBits.PowerOf2(System.Int32)">
- <summary>
-
- </summary>
- <param name="exp"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.DoubleBits.GetExponent(System.Double)">
- <summary>
-
- </summary>
- <param name="d"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.DoubleBits.TruncateToPowerOfTwo(System.Double)">
- <summary>
-
- </summary>
- <param name="d"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.DoubleBits.ToBinaryString(System.Double)">
- <summary>
-
- </summary>
- <param name="d"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.DoubleBits.MaximumCommonMantissa(System.Double,System.Double)">
- <summary>
-
- </summary>
- <param name="d1"></param>
- <param name="d2"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.DoubleBits.ZeroLowerBits(System.Int32)">
- <summary>
-
- </summary>
- <param name="nBits"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.DoubleBits.GetBit(System.Int32)">
- <summary>
-
- </summary>
- <param name="i"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.DoubleBits.NumCommonMantissaBits(DotSpatial.Topology.Index.Quadtree.DoubleBits)">
- <summary>
- This computes the number of common most-significant bits in the mantissa.
- It does not count the hidden bit, which is always 1.
- It does not determine whether the numbers have the same exponent - if they do
- not, the value computed by this function is meaningless.
- </summary>
- <param name="db"></param>
- <returns> The number of common most-significant mantissa bits.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.DoubleBits.ToString">
- <summary>
- A representation of the Double bits formatted for easy readability.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Quadtree.DoubleBits.Double">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Quadtree.DoubleBits.BiasedExponent">
- <summary>
- Determines the exponent for the number.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Quadtree.DoubleBits.Exponent">
- <summary>
- Determines the exponent for the number.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Index.Quadtree.IntervalSize">
- <summary>
- Provides a test for whether an interval is
- so small it should be considered as zero for the purposes of
- inserting it into a binary tree.
- The reason this check is necessary is that round-off error can
- cause the algorithm used to subdivide an interval to fail, by
- computing a midpoint value which does not lie strictly between the
- endpoints.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Index.Quadtree.IntervalSize.MIN_BINARY_EXPONENT">
- <summary>
- This value is chosen to be a few powers of 2 less than the
- number of bits available in the double representation (i.e. 53).
- This should allow enough extra precision for simple computations to be correct,
- at least for comparison purposes.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.IntervalSize.IsZeroWidth(System.Double,System.Double)">
- <summary>
- Computes whether the interval [min, max] is effectively zero width.
- I.e. the width of the interval is so much less than the
- location of the interval that the midpoint of the interval cannot be
- represented precisely.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Index.Quadtree.Key">
- <summary>
- A Key is a unique identifier for a node in a quadtree.
- It contains a lower-left point and a level number. The level number
- is the power of two for the size of the node envelope.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.Key.#ctor(DotSpatial.Topology.IEnvelope)">
- <summary>
-
- </summary>
- <param name="itemEnv"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.Key.ComputeQuadLevel(DotSpatial.Topology.IEnvelope)">
- <summary>
-
- </summary>
- <param name="env"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.Key.ComputeKey(DotSpatial.Topology.IEnvelope)">
- <summary>
- Return a square envelope containing the argument envelope,
- whose extent is a power of two and which is based at a power of 2.
- </summary>
- <param name="itemEnv"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.Key.ComputeKey(System.Int32,DotSpatial.Topology.IEnvelope)">
- <summary>
-
- </summary>
- <param name="level"></param>
- <param name="itemEnv"></param>
- </member>
- <member name="P:DotSpatial.Topology.Index.Quadtree.Key.Point">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Quadtree.Key.Level">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Quadtree.Key.Envelope">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Quadtree.Key.Centre">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Index.Quadtree.Node">
- <summary>
- Represents a node of a <c>Quadtree</c>. Nodes contain
- items which have a spatial extent corresponding to the node's position
- in the quadtree.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Index.Quadtree.NodeBase">
- <summary>
- The base class for nodes in a <c>Quadtree</c>.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Index.Quadtree.NodeBase._subnode">
- <summary>
- subquads are numbered as follows:
- 2 | 3
- --+--
- 0 | 1
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.NodeBase.Add(System.Object)">
- <summary>
- Adds a new item to this node.
- </summary>
- <param name="item">The item to add to this node</param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.NodeBase.AddAllItems(System.Collections.IList@)">
- <summary>
- Insert items in <c>this</c> into the parameter!
- </summary>
- <param name="resultItems">IList for adding items.</param>
- <returns>Parameter IList with <c>this</c> items.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.NodeBase.AddAllItemsFromOverlapping(DotSpatial.Topology.IEnvelope,System.Collections.IList@)">
- <summary>
-
- </summary>
- <param name="searchEnv"></param>
- <param name="resultItems"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.NodeBase.Remove(DotSpatial.Topology.IEnvelope,System.Object)">
- <summary>
- Removes a single item from this subtree.
- </summary>
- <param name="itemEnv">The envelope containing the item.</param>
- <param name="item">The item to remove.</param>
- <returns><c>true</c> if the item was found and removed.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.NodeBase.Visit(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.Index.IItemVisitor)">
- <summary>
-
- </summary>
- <param name="searchEnv"></param>
- <param name="visitor"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.NodeBase.IsSearchMatch(DotSpatial.Topology.IEnvelope)">
- <summary>
-
- </summary>
- <param name="searchEnv"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.NodeBase.VisitItems(DotSpatial.Topology.Index.IItemVisitor)">
- <summary>
-
- </summary>
- <param name="visitor"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.NodeBase.GetSubnodeIndex(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.Coordinate)">
- <summary>
- Returns the index of the subquad that wholly contains the given envelope.
- If none does, returns -1.
- </summary>
- <param name="env"></param>
- <param name="centre"></param>
- </member>
- <member name="P:DotSpatial.Topology.Index.Quadtree.NodeBase.Count">
- <summary>
- Because more than one item can be stored in each node, this returns the total count of
- items contained by this node and its child nodes.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Quadtree.NodeBase.Depth">
- <summary>
- Gets an integer representing how deem the deepest child of this node extends.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Quadtree.NodeBase.Nodes">
- <summary>
- Gets or sets the array of 4 nodes represnting the spatial quadrants being used as children
- 2 | 3
- --+--
- 0 | 1
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Quadtree.NodeBase.HasChildren">
- <summary>
- Gets a boolean indicating whehter or not this node links to any nodes below it in the tree
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Quadtree.NodeBase.HasItems">
- <summary>
- Each node can store multiple items. This tests whether or not there are items in this node.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Quadtree.NodeBase.IsPrunable">
- <summary>
- If this node has no childern or items, then it can be pruned
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Quadtree.NodeBase.IsEmpty">
- <summary>
- If this node has an item, or if any of the children of this node has an item, then this is false.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Quadtree.NodeBase.Items">
- <summary>
- Gets or sets the list of items that are stored in this node
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Quadtree.NodeBase.NodeCount">
- <summary>
- Gets an integer representing this node and the count of all of the children in its subnodes
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.Node.#ctor(DotSpatial.Topology.IEnvelope,System.Int32)">
- <summary>
-
- </summary>
- <param name="env"></param>
- <param name="level"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.Node.CreateNode(DotSpatial.Topology.IEnvelope)">
- <summary>
-
- </summary>
- <param name="env"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.Node.CreateExpanded(DotSpatial.Topology.Index.Quadtree.Node,DotSpatial.Topology.IEnvelope)">
- <summary>
-
- </summary>
- <param name="node"></param>
- <param name="addEnv"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.Node.IsSearchMatch(DotSpatial.Topology.IEnvelope)">
- <summary>
-
- </summary>
- <param name="searchEnv"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.Node.GetNode(DotSpatial.Topology.IEnvelope)">
- <summary>
- Returns the subquad containing the envelope.
- Creates the subquad if
- it does not already exist.
- </summary>
- <param name="searchEnv"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.Node.Find(DotSpatial.Topology.IEnvelope)">
- <summary>
- Returns the smallest <i>existing</i>
- node containing the envelope.
- </summary>
- <param name="searchEnv"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.Node.InsertNode(DotSpatial.Topology.Index.Quadtree.Node)">
- <summary>
-
- </summary>
- <param name="node"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.Node.GetSubnode(System.Int32)">
- <summary>
- Get the subquad for the index.
- If it doesn't exist, create it.
- </summary>
- <param name="index"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.Node.CreateSubnode(System.Int32)">
- <summary>
-
- </summary>
- <param name="index"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.Index.Quadtree.Node.Envelope">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Index.Quadtree.Quadtree">
- <summary>
- A Quadtree is a spatial index structure for efficient querying
- of 2D rectangles. If other kinds of spatial objects
- need to be indexed they can be represented by their
- envelopes
- The quadtree structure is used to provide a primary filter
- for range rectangle queries. The Query() method returns a list of
- all objects which may intersect the query rectangle. Notice that
- it may return objects which do not in fact intersect.
- A secondary filter is required to test for exact intersection.
- Of course, this secondary filter may consist of other tests besides
- intersection, such as testing other kinds of spatial relationships.
- This implementation does not require specifying the extent of the inserted
- items beforehand. It will automatically expand to accomodate any extent
- of dataset.
- This data structure is also known as an <c>MX-CIF quadtree</c>
- following the usage of Samet and others.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Index.Quadtree.Quadtree.Root">
- <summary>
- Root of Quadtree
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Index.Quadtree.Quadtree._minExtent">
- <summary>
- minExtent is the minimum envelope extent of all items
- inserted into the tree so far. It is used as a heuristic value
- to construct non-zero envelopes for features with zero X and/or Y extent.
- Start with a non-zero extent, in case the first feature inserted has
- a zero extent in both directions. This value may be non-optimal, but
- only one feature will be inserted with this value.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.Quadtree.#ctor">
- <summary>
- Constructs a Quadtree with zero items.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.Quadtree.Insert(DotSpatial.Topology.IEnvelope,System.Object)">
- <summary>
-
- </summary>
- <param name="itemEnv"></param>
- <param name="item"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.Quadtree.Remove(DotSpatial.Topology.IEnvelope,System.Object)">
- <summary>
- Removes a single item from the tree.
- </summary>
- <param name="itemEnv">The Envelope of the item to remove.</param>
- <param name="item">The item to remove.</param>
- <returns><c>true</c> if the item was found.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.Quadtree.Query(DotSpatial.Topology.IEnvelope)">
- <summary>
-
- </summary>
- <param name="searchEnv"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.Quadtree.Query(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.Index.IItemVisitor)">
- <summary>
-
- </summary>
- <param name="searchEnv"></param>
- <param name="visitor"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.Quadtree.EnsureExtent(DotSpatial.Topology.IEnvelope,System.Double)">
- <summary>
- Ensure that the envelope for the inserted item has non-zero extents.
- Use the current minExtent to pad the envelope, if necessary.
- </summary>
- <param name="itemEnv"></param>
- <param name="minExtent"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.Quadtree.QueryAll">
- <summary>
- Return a list of all items in the Quadtree.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.Quadtree.CollectStats(DotSpatial.Topology.IRectangle)">
- <summary>
-
- </summary>
- <param name="itemEnv"></param>
- </member>
- <member name="P:DotSpatial.Topology.Index.Quadtree.Quadtree.Depth">
- <summary>
- Returns the number of levels in the tree.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Quadtree.Quadtree.Count">
- <summary>
- Returns the number of items in the tree.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Index.Quadtree.Root">
- <summary>
- QuadRoot is the root of a single Quadtree.
- It is centred at the origin,
- and does not have a defined extent.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.Root.Insert(DotSpatial.Topology.IEnvelope,System.Object)">
- <summary>
- Insert an item into the quadtree this is the root of.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.Root.InsertContained(DotSpatial.Topology.Index.Quadtree.Node,DotSpatial.Topology.IEnvelope,System.Object)">
- <summary>
- Insert an item which is known to be contained in the tree rooted at
- the given QuadNode root. Lower levels of the tree will be created
- if necessary to hold the item.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Quadtree.Root.IsSearchMatch(DotSpatial.Topology.IEnvelope)">
- <summary>
-
- </summary>
- <param name="searchEnv"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.Index.Strtree.AbstractNode">
- <summary>
- A node of the STR tree. The children of this node are either more nodes
- (AbstractNodes) or real data (ItemBoundables). If this node contains real data
- (rather than nodes), then we say that this node is a "leaf node".
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Index.Strtree.IBoundable">
- <summary>
- A spatial object in an AbstractSTRtree.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Strtree.IBoundable.Bounds">
- <summary>
- Returns a representation of space that encloses this Boundable, preferably
- not much bigger than this Boundable's boundary yet fast to test for intersection
- with the bounds of other Boundables. The class of object returned depends
- on the subclass of AbstractSTRtree.
- </summary>
- <returns>
- An Envelope (for STRtrees), an Interval (for SIRtrees), or other object
- (for other subclasses of AbstractSTRtree).
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.AbstractNode.#ctor(System.Int32)">
- <summary>
- Constructs an AbstractNode at the given level in the tree
- </summary>
- <param name="level">
- 0 if this node is a leaf, 1 if a parent of a leaf, and so on; the
- root node will have the highest level.
- </param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.AbstractNode.ComputeBounds">
- <summary>
- Returns a representation of space that encloses this Boundable,
- preferably not much bigger than this Boundable's boundary yet fast to
- test for intersection with the bounds of other Boundables. The class of
- object returned depends on the subclass of AbstractSTRtree.
- </summary>
- <returns>
- An Envelope (for STRtrees), an Interval (for SIRtrees), or other
- object (for other subclasses of AbstractSTRtree).
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.AbstractNode.AddChildBoundable(DotSpatial.Topology.Index.Strtree.IBoundable)">
- <summary>
- Adds either an AbstractNode, or if this is a leaf node, a data object
- (wrapped in an ItemBoundable).
- </summary>
- <param name="childBoundable"></param>
- </member>
- <member name="P:DotSpatial.Topology.Index.Strtree.AbstractNode.ChildBoundables">
- <summary>
- Returns either child AbstractNodes, or if this is a leaf node, real data (wrapped
- in ItemBoundables).
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Strtree.AbstractNode.Level">
- <summary>
- Returns 0 if this node is a leaf, 1 if a parent of a leaf, and so on; the
- root node will have the highest level.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Strtree.AbstractNode.Bounds">
- <summary>
- Returns object fromComputeBounds()
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Index.Strtree.AbstractStRtree">
- <summary>
- Base class for STRtree and SIRtree. STR-packed R-trees are described in:
- P. Rigaux, Michel Scholl and Agnes Voisard. Spatial Databases With
- Application To GIS. Morgan Kaufmann, San Francisco, 2002.
- <para>
- This implementation is based on Boundables rather than just AbstractNodes,
- because the STR algorithm operates on both nodes and
- data, both of which are treated here as Boundables.
- </para>
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.AbstractStRtree.#ctor(System.Int32)">
- <summary>
- Constructs an AbstractSTRtree with the specified maximum number of child
- nodes that a node may have.
- </summary>
- <param name="nodeCapacity"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.AbstractStRtree.Build">
- <summary>
- Creates parent nodes, grandparent nodes, and so forth up to the root
- node, for the data that has been inserted into the tree. Can only be
- called once, and thus can be called only after all of the data has been
- inserted into the tree.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.AbstractStRtree.CreateNode(System.Int32)">
- <summary>
-
- </summary>
- <param name="level"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.AbstractStRtree.CreateParentBoundables(System.Collections.IList,System.Int32)">
- <summary>
- Sorts the childBoundables then divides them into groups of size M, where
- M is the node capacity.
- </summary>
- <param name="childBoundables"></param>
- <param name="newLevel"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.AbstractStRtree.LastNode(System.Collections.IList)">
- <summary>
-
- </summary>
- <param name="nodes"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.AbstractStRtree.CompareDoubles(System.Double,System.Double)">
- <summary>
-
- </summary>
- <param name="a"></param>
- <param name="b"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.AbstractStRtree.CreateHigherLevels(System.Collections.IList,System.Int32)">
- <summary>
- Creates the levels higher than the given level.
- </summary>
- <param name="boundablesOfALevel">The level to build on.</param>
- <param name="level">the level of the Boundables, or -1 if the boundables are item
- boundables (that is, below level 0).</param>
- <returns>The root, which may be a ParentNode or a LeafNode.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.AbstractStRtree.GetSize(DotSpatial.Topology.Index.Strtree.AbstractNode)">
- <summary>
-
- </summary>
- <param name="node"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.AbstractStRtree.GetDepth(DotSpatial.Topology.Index.Strtree.AbstractNode)">
- <summary>
-
- </summary>
- <param name="node"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.AbstractStRtree.Insert(System.Object,System.Object)">
- <summary>
-
- </summary>
- <param name="bounds"></param>
- <param name="item"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.AbstractStRtree.Query(System.Object)">
- <summary>
- Also builds the tree, if necessary.
- </summary>
- <param name="searchBounds"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.AbstractStRtree.Query(System.Object,DotSpatial.Topology.Index.IItemVisitor)">
- <summary>
- Also builds the tree, if necessary.
- </summary>
- <param name="searchBounds"></param>
- <param name="visitor"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.AbstractStRtree.Query(System.Object,DotSpatial.Topology.Index.Strtree.AbstractNode,System.Collections.IList)">
- <summary>
-
- </summary>
- <param name="searchBounds"></param>
- <param name="node"></param>
- <param name="matches"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.AbstractStRtree.Query(System.Object,DotSpatial.Topology.Index.Strtree.AbstractNode,DotSpatial.Topology.Index.IItemVisitor)">
- <summary>
-
- </summary>
- <param name="searchBounds"></param>
- <param name="node"></param>
- <param name="visitor"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.AbstractStRtree.Remove(System.Object,System.Object)">
- <summary>
- Also builds the tree, if necessary.
- </summary>
- <param name="searchBounds"></param>
- <param name="item"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.AbstractStRtree.RemoveItem(DotSpatial.Topology.Index.Strtree.AbstractNode,System.Object)">
- <summary>
-
- </summary>
- <param name="node"></param>
- <param name="item"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.AbstractStRtree.Remove(System.Object,DotSpatial.Topology.Index.Strtree.AbstractNode,System.Object)">
- <summary>
-
- </summary>
- <param name="searchBounds"></param>
- <param name="node"></param>
- <param name="item"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.AbstractStRtree.BoundablesAtLevel(System.Int32)">
- <summary>
-
- </summary>
- <param name="level"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.AbstractStRtree.BoundablesAtLevel(System.Int32,DotSpatial.Topology.Index.Strtree.AbstractNode,System.Collections.IList@)">
- <summary>
-
- </summary>
- <param name="level">-1 to get items.</param>
- <param name="top"></param>
- <param name="boundables"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.AbstractStRtree.GetComparer">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.Index.Strtree.AbstractStRtree.Root">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Strtree.AbstractStRtree.NodeCapacity">
- <summary>
- Returns the maximum number of child nodes that a node may have.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Strtree.AbstractStRtree.Count">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Strtree.AbstractStRtree.Depth">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Strtree.AbstractStRtree.IntersectsOp">
- <returns>
- A test for intersection between two bounds, necessary because subclasses
- of AbstractSTRtree have different implementations of bounds.
- </returns>
- </member>
- <member name="T:DotSpatial.Topology.Index.Strtree.AbstractStRtree.IIntersectsOp">
- <returns>
- A test for intersection between two bounds, necessary because subclasses
- of AbstractSTRtree have different implementations of bounds.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.AbstractStRtree.IIntersectsOp.Intersects(System.Object,System.Object)">
- <summary>
- For STRtrees, the bounds will be Envelopes;
- for SIRtrees, Intervals;
- for other subclasses of AbstractSTRtree, some other class.
- </summary>
- <param name="aBounds">The bounds of one spatial object.</param>
- <param name="bBounds">The bounds of another spatial object.</param>
- <returns>Whether the two bounds intersect.</returns>
- </member>
- <member name="T:DotSpatial.Topology.Index.Strtree.Interval">
- <summary>
- A contiguous portion of 1D-space. Used internally by SIRtree.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.Interval.#ctor(DotSpatial.Topology.Index.Strtree.Interval)">
- <summary>
-
- </summary>
- <param name="other"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.Interval.#ctor(System.Double,System.Double)">
- <summary>
-
- </summary>
- <param name="min"></param>
- <param name="max"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.Interval.ExpandToInclude(DotSpatial.Topology.Index.Strtree.Interval)">
- <summary>
-
- </summary>
- <param name="other"></param>
- <returns><c>this</c></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.Interval.Intersects(DotSpatial.Topology.Index.Strtree.Interval)">
- <summary>
-
- </summary>
- <param name="other"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.Interval.Equals(System.Object)">
- <summary>
-
- </summary>
- <param name="o"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.Interval.GetHashCode">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.Index.Strtree.Interval.Centre">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Index.Strtree.ItemBoundable">
- <summary>
- Boundable wrapper for a non-Boundable spatial object. Used internally by
- AbstractSTRtree.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.ItemBoundable.#ctor(System.Object,System.Object)">
- <summary>
-
- </summary>
- <param name="bounds"></param>
- <param name="item"></param>
- </member>
- <member name="P:DotSpatial.Topology.Index.Strtree.ItemBoundable.Item">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Strtree.ItemBoundable.Bounds">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Index.Strtree.SiRtree">
- <summary>
- One-dimensional version of an STR-packed R-tree. SIR stands for
- "Sort-Interval-Recursive". STR-packed R-trees are described in:
- P. Rigaux, Michel Scholl and Agnes Voisard. Spatial Databases With
- Application To GIS. Morgan Kaufmann, San Francisco, 2002.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.SiRtree.#ctor">
- <summary>
- Constructs an SIRtree with the default (10) node capacity.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.SiRtree.#ctor(System.Int32)">
- <summary>
- Constructs an SIRtree with the given maximum number of child nodes that
- a node may have.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.SiRtree.CreateNode(System.Int32)">
- <summary>
-
- </summary>
- <param name="level"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.SiRtree.Insert(System.Double,System.Double,System.Object)">
- <summary>
- Inserts an item having the given bounds into the tree.
- </summary>
- <param name="x1"></param>
- <param name="x2"></param>
- <param name="item"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.SiRtree.Query(System.Double)">
- <summary>
- Returns items whose bounds intersect the given value.
- </summary>
- <param name="x"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.SiRtree.Query(System.Double,System.Double)">
- <summary>
- Returns items whose bounds intersect the given bounds.
- </summary>
- <param name="x1">Possibly equal to x2.</param>
- <param name="x2">Possibly equal to x1.</param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.SiRtree.GetComparer">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.Index.Strtree.SiRtree.IntersectsOp">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Index.Strtree.SiRtree.AnnonymousComparerImpl">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.SiRtree.AnnonymousComparerImpl.Compare(System.Object,System.Object)">
- <summary>
-
- </summary>
- <param name="o1"></param>
- <param name="o2"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.Index.Strtree.SiRtree.AnonymousAbstractNodeImpl">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.SiRtree.AnonymousAbstractNodeImpl.#ctor(System.Int32)">
- <summary>
-
- </summary>
- <param name="nodeCapacity"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.SiRtree.AnonymousAbstractNodeImpl.ComputeBounds">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.Index.Strtree.SiRtree.AnonymousIntersectsOpImpl">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.SiRtree.AnonymousIntersectsOpImpl.Intersects(System.Object,System.Object)">
- <summary>
-
- </summary>
- <param name="aBounds"></param>
- <param name="bBounds"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.Index.Strtree.StRtree">
- <summary>
- A query-only R-tree created using the Sort-Tile-Recursive (STR) algorithm.
- For two-dimensional spatial data.
- The STR packed R-tree is simple to implement and maximizes space
- utilization; that is, as many leaves as possible are filled to capacity.
- Overlap between nodes is far less than in a basic R-tree. However, once the
- tree has been built (explicitly or on the first call to #query), items may
- not be added or removed.
- Described in: P. Rigaux, Michel Scholl and Agnes Voisard. Spatial Databases With
- Application To GIS. Morgan Kaufmann, San Francisco, 2002.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.StRtree.#ctor">
- <summary>
- Constructs an STRtree with the default (10) node capacity.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.StRtree.#ctor(System.Int32)">
- <summary>
- Constructs an STRtree with the given maximum number of child nodes that
- a node may have.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.StRtree.Insert(DotSpatial.Topology.IEnvelope,System.Object)">
- <summary>
- Inserts an item having the given bounds into the tree.
- </summary>
- <param name="itemEnv"></param>
- <param name="item"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.StRtree.Query(DotSpatial.Topology.IEnvelope)">
- <summary>
- Returns items whose bounds intersect the given envelope.
- </summary>
- <param name="searchEnv"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.StRtree.Query(DotSpatial.Topology.IEnvelope,DotSpatial.Topology.Index.IItemVisitor)">
- <summary>
- Returns items whose bounds intersect the given envelope.
- </summary>
- <param name="searchEnv"></param>
- <param name="visitor"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.StRtree.Remove(DotSpatial.Topology.IEnvelope,System.Object)">
- <summary>
- Removes a single item from the tree.
- </summary>
- <param name="itemEnv">The Envelope of the item to remove.</param>
- <param name="item">The item to remove.</param>
- <returns><c>true</c> if the item was found.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.StRtree.Avg(System.Double,System.Double)">
- <summary>
-
- </summary>
- <param name="a"></param>
- <param name="b"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.StRtree.CentreX(DotSpatial.Topology.IEnvelope)">
- <summary>
-
- </summary>
- <param name="e"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.StRtree.CentreY(DotSpatial.Topology.IEnvelope)">
- <summary>
-
- </summary>
- <param name="e"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.StRtree.CreateParentBoundables(System.Collections.IList,System.Int32)">
- <summary>
- Creates the parent level for the given child level. First, orders the items
- by the x-values of the midpoints, and groups them into vertical slices.
- For each slice, orders the items by the y-values of the midpoints, and
- group them into runs of size M (the node capacity). For each run, creates
- a new (parent) node.
- </summary>
- <param name="childBoundables"></param>
- <param name="newLevel"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.StRtree.CreateParentBoundablesFromVerticalSlices(System.Collections.IList[],System.Int32)">
- <summary>
-
- </summary>
- <param name="verticalSlices"></param>
- <param name="newLevel"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.StRtree.CreateParentBoundablesFromVerticalSlice(System.Collections.IList,System.Int32)">
- <summary>
-
- </summary>
- <param name="childBoundables"></param>
- <param name="newLevel"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.StRtree.VerticalSlices(System.Collections.IList,System.Int32)">
- <summary>
-
- </summary>
- <param name="childBoundables">Must be sorted by the x-value of the envelope midpoints.</param>
- <param name="sliceCount"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.StRtree.CreateNode(System.Int32)">
- <summary>
-
- </summary>
- <param name="level"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.StRtree.GetComparer">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.Index.Strtree.StRtree.IntersectsOp">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Index.Strtree.StRtree.AnonymousAbstractNodeImpl">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.StRtree.AnonymousAbstractNodeImpl.#ctor(System.Int32)">
- <summary>
-
- </summary>
- <param name="nodeCapacity"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.StRtree.AnonymousAbstractNodeImpl.ComputeBounds">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.Index.Strtree.StRtree.AnonymousIntersectsOpImpl">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.StRtree.AnonymousIntersectsOpImpl.Intersects(System.Object,System.Object)">
- <summary>
-
- </summary>
- <param name="aBounds"></param>
- <param name="bBounds"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.Index.Strtree.StRtree.AnonymousXComparerImpl">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.StRtree.AnonymousXComparerImpl.#ctor(DotSpatial.Topology.Index.Strtree.StRtree)">
- <summary>
-
- </summary>
- <param name="container"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.StRtree.AnonymousXComparerImpl.Compare(System.Object,System.Object)">
- <summary>
-
- </summary>
- <param name="o1"></param>
- <param name="o2"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.Index.Strtree.StRtree.AnonymousYComparerImpl">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.StRtree.AnonymousYComparerImpl.#ctor(DotSpatial.Topology.Index.Strtree.StRtree)">
- <summary>
-
- </summary>
- <param name="container"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Strtree.StRtree.AnonymousYComparerImpl.Compare(System.Object,System.Object)">
- <summary>
-
- </summary>
- <param name="o1"></param>
- <param name="o2"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.Index.Sweepline.ISweepLineOverlapAction">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Sweepline.ISweepLineOverlapAction.Overlap(DotSpatial.Topology.Index.Sweepline.SweepLineInterval,DotSpatial.Topology.Index.Sweepline.SweepLineInterval)">
- <summary>
-
- </summary>
- <param name="s0"></param>
- <param name="s1"></param>
- </member>
- <member name="T:DotSpatial.Topology.Index.Sweepline.SweepLineEvent">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Sweepline.SweepLineEvent.#ctor(System.Double,DotSpatial.Topology.Index.Sweepline.SweepLineEvent,DotSpatial.Topology.Index.Sweepline.SweepLineInterval)">
- <summary>
-
- </summary>
- <param name="x"></param>
- <param name="insertEvent"></param>
- <param name="sweepInt"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Sweepline.SweepLineEvent.CompareTo(System.Object)">
- <summary>
- ProjectionEvents are ordered first by their x-value, and then by their eventType.
- It is important that Insert events are sorted before Delete events, so that
- items whose Insert and Delete events occur at the same x-value will be
- correctly handled.
- </summary>
- <param name="o"></param>
- </member>
- <member name="P:DotSpatial.Topology.Index.Sweepline.SweepLineEvent.IsInsert">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Sweepline.SweepLineEvent.IsDelete">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Sweepline.SweepLineEvent.InsertEvent">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Sweepline.SweepLineEvent.DeleteEventIndex">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Sweepline.SweepLineEvent.Interval">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Index.Sweepline.SweepLineEvent.SweepLineEventType">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Index.Sweepline.SweepLineEvent.SweepLineEventType.Insert">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Index.Sweepline.SweepLineEvent.SweepLineEventType.Delete">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Index.Sweepline.SweepLineIndex">
- <summary>
- A sweepline implements a sorted index on a set of intervals.
- It is used to compute all overlaps between the interval in the index.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Sweepline.SweepLineIndex.Add(DotSpatial.Topology.Index.Sweepline.SweepLineInterval)">
- <summary>
-
- </summary>
- <param name="sweepInt"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Sweepline.SweepLineIndex.BuildIndex">
- <summary>
- Because Delete Events have a link to their corresponding Insert event,
- it is possible to compute exactly the range of events which must be
- compared to a given Insert event object.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Sweepline.SweepLineIndex.ComputeOverlaps(DotSpatial.Topology.Index.Sweepline.ISweepLineOverlapAction)">
- <summary>
-
- </summary>
- <param name="action"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Sweepline.SweepLineIndex.ProcessOverlaps(System.Int32,System.Int32,DotSpatial.Topology.Index.Sweepline.SweepLineInterval,DotSpatial.Topology.Index.Sweepline.ISweepLineOverlapAction)">
- <summary>
-
- </summary>
- <param name="start"></param>
- <param name="end"></param>
- <param name="s0"></param>
- <param name="action"></param>
- </member>
- <member name="T:DotSpatial.Topology.Index.Sweepline.SweepLineInterval">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Index.Sweepline.SweepLineInterval.#ctor(System.Double,System.Double)">
- <summary>
-
- </summary>
- <param name="min"></param>
- <param name="max"></param>
- </member>
- <member name="M:DotSpatial.Topology.Index.Sweepline.SweepLineInterval.#ctor(System.Double,System.Double,System.Object)">
- <summary>
-
- </summary>
- <param name="min"></param>
- <param name="max"></param>
- <param name="item"></param>
- </member>
- <member name="P:DotSpatial.Topology.Index.Sweepline.SweepLineInterval.Min">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Sweepline.SweepLineInterval.Max">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Index.Sweepline.SweepLineInterval.Item">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.KDTree.NegativeArgumentException">
- <summary>
- NegativeInvalidException
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.KDTree.NegativeArgumentException.#ctor(System.String)">
- <summary>
- This creates a new instance of an exception that occurs if a negative value was passed as an argument and this is invalid
- </summary>
- <param name="parameterName">The name of the parameter that was negative</param>
- </member>
- <member name="T:DotSpatial.Topology.Noding.INoder">
- <summary>
- Computes all intersections between segments in a set of <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s.
- Intersections found are represented as <see cref="T:DotSpatial.Topology.Noding.SegmentNode"/>s and added to the
- <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s in which they occur.
- As a final step in the noding a new set of segment strings split at the nodes may be returned.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Noding.INoder.ComputeNodes(System.Collections.IList)">
- <summary>
- Computes the noding for a collection of <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s.
- Some Noders may add all these nodes to the input <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s;
- others may only add some or none at all.
- </summary>
- <param name="segStrings"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.INoder.GetNodedSubstrings">
- <summary>
- Returns a <see cref="T:System.Collections.IList"/> of fully noded <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s.
- The <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s have the same context as their parent.
- </summary>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.Noding.IntersectionAdder">
- <summary>
- Computes the intersections between two line segments in <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s
- and adds them to each string.
- The <see cref="T:DotSpatial.Topology.Noding.ISegmentIntersector"/> is passed to a <see cref="T:DotSpatial.Topology.Noding.INoder"/>.
- The <see cref="M:DotSpatial.Topology.Noding.SegmentString.AddIntersections(DotSpatial.Topology.Algorithm.LineIntersector,System.Int32)"/> method is called whenever the <see cref="T:DotSpatial.Topology.Noding.INoder"/>
- detects that two <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s might intersect.
- This class is an example of the Strategy pattern.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Noding.ISegmentIntersector">
- <summary>
- Computes the intersections between two line segments in <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s
- and adds them to each string.
- The <see cref="T:DotSpatial.Topology.Noding.ISegmentIntersector"/> is passed to a <see cref="T:DotSpatial.Topology.Noding.INoder"/>.
- The <see cref="M:DotSpatial.Topology.Noding.SegmentString.AddIntersections(DotSpatial.Topology.Algorithm.LineIntersector,System.Int32)"/> method is called whenever the <see cref="T:DotSpatial.Topology.Noding.INoder"/>
- detects that two <see cref="T:DotSpatial.Topology.Noding.SegmentString"/> s might intersect.
- This class is an example of the Strategy pattern.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Noding.ISegmentIntersector.ProcessIntersections(DotSpatial.Topology.Noding.SegmentString,System.Int32,DotSpatial.Topology.Noding.SegmentString,System.Int32)">
- <summary>
- This method is called by clients
- of the <see cref="T:DotSpatial.Topology.Noding.ISegmentIntersector"/> interface to process
- intersections for two segments of the <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s being intersected.
- </summary>
- <param name="e0"></param>
- <param name="segIndex0"></param>
- <param name="e1"></param>
- <param name="segIndex1"></param>
- </member>
- <member name="F:DotSpatial.Topology.Noding.IntersectionAdder._li">
- These variables keep track of what types of intersections were
- found during ALL edges that have been intersected.
- </member>
- <member name="F:DotSpatial.Topology.Noding.IntersectionAdder.NumInteriorIntersections">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Noding.IntersectionAdder.#ctor(DotSpatial.Topology.Algorithm.LineIntersector)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Topology.Noding.IntersectionAdder"/> class.
- </summary>
- <param name="li"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.IntersectionAdder.ProcessIntersections(DotSpatial.Topology.Noding.SegmentString,System.Int32,DotSpatial.Topology.Noding.SegmentString,System.Int32)">
- <summary>
- This method is called by clients
- of the <see cref="T:DotSpatial.Topology.Noding.ISegmentIntersector"/> class to process
- intersections for two segments of the <see cref="T:DotSpatial.Topology.Noding.SegmentString"/> being intersected.
- Notice that some clients (such as <see cref="T:DotSpatial.Topology.Index.Chain.MonotoneChain"/>s) may optimize away
- this call for segment pairs which they have determined do not intersect
- (e.g. by an disjoint envelope test).
- </summary>
- <param name="e0"></param>
- <param name="segIndex0"></param>
- <param name="e1"></param>
- <param name="segIndex1"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.IntersectionAdder.IsAdjacentSegments(System.Int32,System.Int32)">
- <summary>
-
- </summary>
- <param name="i1"></param>
- <param name="i2"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Noding.IntersectionAdder.IsTrivialIntersection(DotSpatial.Topology.Noding.SegmentString,System.Int32,DotSpatial.Topology.Noding.SegmentString,System.Int32)">
- <summary>
- A trivial intersection is an apparent self-intersection which in fact
- is simply the point shared by adjacent line segments.
- Notice that closed edges require a special check for the point shared by the beginning and end segments.
- </summary>
- <param name="e0"></param>
- <param name="segIndex0"></param>
- <param name="e1"></param>
- <param name="segIndex1"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.Noding.IntersectionAdder.LineIntersector">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Noding.IntersectionAdder.HasIntersection">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Noding.IntersectionAdder.HasProperIntersection">
- <summary>
- A proper intersection is an intersection which is interior to at least two
- line segments. Notice that a proper intersection is not necessarily
- in the interior of the entire <see cref="T:DotSpatial.Topology.Geometry"/>, since another edge may have
- an endpoint equal to the intersection, which according to SFS semantics
- can result in the point being on the Boundary of the <see cref="T:DotSpatial.Topology.Geometry"/>.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Noding.IntersectionAdder.HasProperInteriorIntersection">
- <summary>
- A proper interior intersection is a proper intersection which is not
- contained in the set of boundary nodes set for this <see cref="T:DotSpatial.Topology.Noding.ISegmentIntersector"/>.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Noding.IntersectionAdder.HasInteriorIntersection">
- <summary>
- An interior intersection is an intersection which is
- in the interior of some segment.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Noding.IntersectionFinderAdder">
- <summary>
- Finds proper and interior intersections in a set of <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s,
- and adds them as nodes.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Noding.IntersectionFinderAdder.#ctor(DotSpatial.Topology.Algorithm.LineIntersector)">
- <summary>
- Creates an intersection finder which finds all proper intersections.
- </summary>
- <param name="li">The <see cref="T:DotSpatial.Topology.Algorithm.LineIntersector"/> to use.</param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.IntersectionFinderAdder.ProcessIntersections(DotSpatial.Topology.Noding.SegmentString,System.Int32,DotSpatial.Topology.Noding.SegmentString,System.Int32)">
- <summary>
- This method is called by clients
- of the <see cref="T:DotSpatial.Topology.Noding.ISegmentIntersector"/> class to process
- intersections for two segments of the <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s being intersected.
- Notice that some clients (such as <see cref="T:DotSpatial.Topology.Index.Chain.MonotoneChain"/>s) may optimize away
- this call for segment pairs which they have determined do not intersect
- (e.g. by an disjoint envelope test).
- </summary>
- <param name="e0"></param>
- <param name="segIndex0"></param>
- <param name="e1"></param>
- <param name="segIndex1"></param>
- </member>
- <member name="P:DotSpatial.Topology.Noding.IntersectionFinderAdder.InteriorIntersections">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Noding.InvalidOctantException">
- <summary>
- A InvalidOctantException Class
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Noding.InvalidOctantException.#ctor(System.String)">
- <summary>
- Creates a new instance of InvalidOctantException
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Noding.IteratedNoder">
- <summary>
- Nodes a set of <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s completely.
- The set of <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s is fully noded;
- i.e. noding is repeated until no further intersections are detected.
- <para>
- Iterated noding using a <see cref="F:DotSpatial.Topology.PrecisionModelType.Floating"/> precision model is not guaranteed to converge,
- due to roundoff error. This problem is detected and an exception is thrown.
- Clients can choose to rerun the noding using a lower precision model.
- </para>
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Noding.IteratedNoder.MAX_ITERATIONS">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Noding.IteratedNoder.#ctor(DotSpatial.Topology.PrecisionModel)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Topology.Noding.IteratedNoder"/> class.
- </summary>
- <param name="pm"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.IteratedNoder.GetNodedSubstrings">
- <summary>
- Returns a <see cref="T:System.Collections.IList"/> of fully noded <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s.
- The <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s have the same context as their parent.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Noding.IteratedNoder.ComputeNodes(System.Collections.IList)">
- <summary>
- Fully nodes a list of <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s, i.e. peforms noding iteratively
- until no intersections are found between segments.
- Maintains labelling of edges correctly through the noding.
- </summary>
- <param name="segStrings">A collection of SegmentStrings to be noded.</param>
- <exception cref="T:DotSpatial.Topology.TopologyException">If the iterated noding fails to converge.</exception>
- </member>
- <member name="M:DotSpatial.Topology.Noding.IteratedNoder.Node(System.Collections.IList,System.Int32[])">
- <summary>
- Node the input segment strings once
- and create the split edges between the nodes.
- </summary>
- <param name="segStrings"></param>
- <param name="numInteriorIntersections"></param>
- </member>
- <member name="P:DotSpatial.Topology.Noding.IteratedNoder.MaximumIterations">
- <summary>
- Gets/Sets the maximum number of noding iterations performed before
- the noding is aborted. Experience suggests that this should rarely need to be changed
- from the default. The default is <see cref="F:DotSpatial.Topology.Noding.IteratedNoder.MAX_ITERATIONS"/>.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Noding.McIndexNoder">
- <summary>
- Nodes a set of <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s using a index based
- on <see cref="T:DotSpatial.Topology.Index.Chain.MonotoneChain"/>s and a <see cref="T:DotSpatial.Topology.Index.ISpatialIndex"/>.
- The <see cref="T:DotSpatial.Topology.Index.ISpatialIndex"/> used should be something that supports
- envelope (range) queries efficiently (such as a <see cref="T:DotSpatial.Topology.Index.Quadtree.Quadtree"/>
- or <see cref="T:DotSpatial.Topology.Index.Strtree.StRtree"/>.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Noding.SinglePassNoder">
- <summary>
- Base class for <see cref="T:DotSpatial.Topology.Noding.INoder"/>s which make a single pass to find intersections.
- This allows using a custom <see cref="T:DotSpatial.Topology.Noding.ISegmentIntersector"/>
- (which for instance may simply identify intersections, rather than insert them).
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Noding.SinglePassNoder.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Topology.Noding.SinglePassNoder"/> class.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Noding.SinglePassNoder.#ctor(DotSpatial.Topology.Noding.ISegmentIntersector)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Topology.Noding.SinglePassNoder"/> class.
- </summary>
- <param name="segInt">The <see cref="T:DotSpatial.Topology.Noding.ISegmentIntersector"/> to use.</param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.SinglePassNoder.ComputeNodes(System.Collections.IList)">
- <summary>
- Computes the noding for a collection of <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s.
- Some Noders may add all these nodes to the input <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s;
- others may only add some or none at all.
- </summary>
- <param name="segStrings"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.SinglePassNoder.GetNodedSubstrings">
- <summary>
- Returns a <see cref="T:System.Collections.IList"/> of fully noded <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s.
- The <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s have the same context as their parent.
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.Noding.SinglePassNoder.SegmentIntersector">
- <summary>
- Gets/sets the <see cref="T:DotSpatial.Topology.Noding.ISegmentIntersector"/> to use with this noder.
- A <see cref="T:DotSpatial.Topology.Noding.ISegmentIntersector"/> will normally add intersection nodes
- to the input segment strings, but it may not - it may
- simply record the presence of intersections.
- However, some <see cref="T:DotSpatial.Topology.Noding.INoder"/>s may require that intersections be added.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Noding.McIndexNoder.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Topology.Noding.McIndexNoder"/> class.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Noding.McIndexNoder.#ctor(DotSpatial.Topology.Noding.ISegmentIntersector)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Topology.Noding.McIndexNoder"/> class.
- </summary>
- <param name="segInt">The <see cref="T:DotSpatial.Topology.Noding.ISegmentIntersector"/> to use.</param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.McIndexNoder.GetNodedSubstrings">
- <summary>
- Returns a <see cref="T:System.Collections.IList"/> of fully noded <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s.
- The <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s have the same context as their parent.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Noding.McIndexNoder.ComputeNodes(System.Collections.IList)">
- <summary>
- Computes the noding for a collection of <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s.
- Some Noders may add all these nodes to the input <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s;
- others may only add some or none at all.
- </summary>
- <param name="inputSegStrings"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.McIndexNoder.IntersectChains">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Noding.McIndexNoder.Add(DotSpatial.Topology.Noding.SegmentString)">
- <summary>
-
- </summary>
- <param name="segStr"></param>
- </member>
- <member name="P:DotSpatial.Topology.Noding.McIndexNoder.MonotoneChains">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Noding.McIndexNoder.Index">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Noding.McIndexNoder.SegmentOverlapAction">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Noding.McIndexNoder.SegmentOverlapAction.#ctor(DotSpatial.Topology.Noding.ISegmentIntersector)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Topology.Noding.McIndexNoder.SegmentOverlapAction"/> class.
- </summary>
- <param name="si">The <see cref="T:DotSpatial.Topology.Noding.ISegmentIntersector"/></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.McIndexNoder.SegmentOverlapAction.Overlap(DotSpatial.Topology.Index.Chain.MonotoneChain,System.Int32,DotSpatial.Topology.Index.Chain.MonotoneChain,System.Int32)">
- <summary>
-
- </summary>
- <param name="mc1"></param>
- <param name="start1"></param>
- <param name="mc2"></param>
- <param name="start2"></param>
- </member>
- <member name="T:DotSpatial.Topology.Noding.NodingValidator">
- <summary>
- Validates that a collection of <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s is correctly noded.
- Throws an appropriate exception if an noding error is found.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Noding.NodingValidator.#ctor(System.Collections.IList)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Topology.Noding.NodingValidator"/> class.
- </summary>
- <param name="segStrings">The seg strings.</param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.NodingValidator.CheckValid">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Noding.NodingValidator.CheckCollapses">
- <summary>
- Checks if a segment string contains a segment pattern a-b-a (which implies a self-intersection).
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Noding.NodingValidator.CheckCollapses(DotSpatial.Topology.Noding.SegmentString)">
- <summary>
-
- </summary>
- <param name="ss"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.NodingValidator.CheckCollapse(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="p0"></param>
- <param name="p1"></param>
- <param name="p2"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.NodingValidator.CheckInteriorIntersections">
- <summary>
- Checks all pairs of segments for intersections at an interior point of a segment.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Noding.NodingValidator.CheckInteriorIntersections(DotSpatial.Topology.Noding.SegmentString,DotSpatial.Topology.Noding.SegmentString)">
- <summary>
-
- </summary>
- <param name="ss0"></param>
- <param name="ss1"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.NodingValidator.CheckInteriorIntersections(DotSpatial.Topology.Noding.SegmentString,System.Int32,DotSpatial.Topology.Noding.SegmentString,System.Int32)">
- <summary>
-
- </summary>
- <param name="e0"></param>
- <param name="segIndex0"></param>
- <param name="e1"></param>
- <param name="segIndex1"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.NodingValidator.HasInteriorIntersection(DotSpatial.Topology.Algorithm.LineIntersector,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="li"></param>
- <param name="p0"></param>
- <param name="p1"></param>
- <returns><c>true</c> if there is an intersection point which is not an endpoint of the segment p0-p1.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Noding.NodingValidator.CheckEndPtVertexIntersections">
- <summary>
- Checks for intersections between an endpoint of a segment string
- and an interior vertex of another segment string
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Noding.NodingValidator.CheckEndPtVertexIntersections(DotSpatial.Topology.Coordinate,System.Collections.IList)">
- <summary>
-
- </summary>
- <param name="testPt"></param>
- <param name="segStrings"></param>
- </member>
- <member name="T:DotSpatial.Topology.Noding.OctantDirection">
- <summary>
- Octants in the Cartesian plane.
- Octants are numbered as follows:
- <para>
- \2|1/
- 3 \|/ 0
- ---+--
- 4 /|\ 7
- /5|6\
- </para>
- If line segments lie along a coordinate axis, the octant is the lower of the two possible values.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Noding.OctantDirection.Null">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Noding.OctantDirection.Zero">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Noding.OctantDirection.One">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Noding.OctantDirection.Two">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Noding.OctantDirection.Three">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Noding.OctantDirection.Four">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Noding.OctantDirection.Five">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Noding.OctantDirection.Six">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Noding.OctantDirection.Seven">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Noding.Octant">
- <summary>
- Methods for computing and working with <see cref="T:DotSpatial.Topology.Noding.OctantDirection"/> of the Cartesian plane.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Noding.Octant.GetOctant(System.Double,System.Double)">
- <summary>
- Returns the octant of a directed line segment (specified as x and y
- displacements, which cannot both be 0).
- </summary>
- <param name="dx"></param>
- <param name="dy"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Noding.Octant.GetOctant(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
- Returns the octant of a directed line segment from p0 to p1.
- </summary>
- <param name="p0"></param>
- <param name="p1"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.Noding.OrientedCoordinateArray">
- <summary>
- Allows comparing <see cref="T:DotSpatial.Topology.Coordinate"/> arrays in an orientation-independent way.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Noding.OrientedCoordinateArray.#ctor(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate})">
- <summary>
- Creates a new <see cref="T:DotSpatial.Topology.Noding.OrientedCoordinateArray"/>}
- for the given <see cref="T:DotSpatial.Topology.Coordinate"/> array.
- </summary>
- <param name="pts"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.OrientedCoordinateArray.CompareTo(System.Object)">
- <summary>
- Compares two <see cref="T:DotSpatial.Topology.Noding.OrientedCoordinateArray"/>s for their relative order.
- </summary>
- <param name="o1"></param>
- <returns>
- -1 this one is smaller, or
- 0 the two objects are equal, or
- 1 this one is greater.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Noding.OrientedCoordinateArray.Orientation(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate})">
- <summary>
- Computes the canonical orientation for a coordinate array.
- </summary>
- <param name="pts"></param>
- <returns>
- <c>true</c> if the points are oriented forwards, or
- <c>false</c>if the points are oriented in reverse.
- </returns>
- </member>
- <member name="T:DotSpatial.Topology.Noding.ScaledNoder">
- <summary>
- Wraps a <see cref="T:DotSpatial.Topology.Noding.INoder"/> and transforms its input into the integer domain.
- This is intended for use with Snap-Rounding noders,
- which typically are only intended to work in the integer domain.
- Offsets can be provided to increase the number of digits of available precision.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Noding.ScaledNoder.#ctor(DotSpatial.Topology.Noding.INoder,System.Double)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Topology.Noding.ScaledNoder"/> class.
- </summary>
- <param name="noder"></param>
- <param name="scaleFactor"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.ScaledNoder.#ctor(DotSpatial.Topology.Noding.INoder,System.Double,System.Double,System.Double)">
- <summary>
-
- </summary>
- <param name="noder"></param>
- <param name="scaleFactor"></param>
- <param name="offsetX"></param>
- <param name="offsetY"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.ScaledNoder.GetNodedSubstrings">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Noding.ScaledNoder.ComputeNodes(System.Collections.IList)">
- <summary>
-
- </summary>
- <param name="inputSegStrings"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.ScaledNoder.Scale(System.Collections.ICollection)">
- <summary>
-
- </summary>
- <param name="segStrings"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Noding.ScaledNoder.Scale(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate})">
- <summary>
-
- </summary>
- <param name="pts"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Noding.ScaledNoder.Rescale(System.Collections.ICollection)">
- <summary>
-
- </summary>
- <param name="segStrings"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.ScaledNoder.Rescale(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate})">
- <summary>
-
- </summary>
- <param name="pts"></param>
- </member>
- <member name="P:DotSpatial.Topology.Noding.ScaledNoder.IsIntegerPrecision">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Noding.SegmentNode">
- <summary>
- Represents an intersection point between two <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Noding.SegmentNode.Coordinate">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Noding.SegmentNode.SegmentIndex">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Noding.SegmentNode.#ctor(DotSpatial.Topology.Noding.SegmentString,DotSpatial.Topology.Coordinate,System.Int32,DotSpatial.Topology.Noding.OctantDirection)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Topology.Noding.SegmentNode"/> class.
- </summary>
- <param name="segString"></param>
- <param name="coord"></param>
- <param name="segmentIndex"></param>
- <param name="segmentOctant"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.SegmentNode.CompareTo(System.Object)">
- <summary>
- </summary>
- <param name="obj"></param>
- <returns>
- -1 this SegmentNode is located before the argument location, or
- 0 this SegmentNode is at the argument location, or
- 1 this SegmentNode is located after the argument location.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Noding.SegmentNode.IsEndPoint(System.Int32)">
- <summary>
-
- </summary>
- <param name="maxSegmentIndex"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Noding.SegmentNode.Write(System.IO.StreamWriter)">
- <summary>
-
- </summary>
- <param name="outstream"></param>
- </member>
- <member name="P:DotSpatial.Topology.Noding.SegmentNode.IsInterior">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.Noding.SegmentNodeList">
- <summary>
- A list of the <see cref="T:DotSpatial.Topology.Noding.SegmentNode"/>s present along a noded <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Noding.SegmentNodeList.#ctor(DotSpatial.Topology.Noding.SegmentString)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Topology.Noding.SegmentNodeList"/> class.
- </summary>
- <param name="edge">The edge.</param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.SegmentNodeList.GetEnumerator">
- <summary>
- Returns an iterator of SegmentNodes.
- </summary>
- <returns>An iterator of SegmentNodes.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Noding.SegmentNodeList.Add(DotSpatial.Topology.Coordinate,System.Int32)">
- <summary>
- Adds an intersection into the list, if it isn't already there.
- The input segmentIndex and dist are expected to be normalized.
- </summary>
- <param name="intPt"></param>
- <param name="segmentIndex"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.SegmentNodeList.AddEndPoints">
- <summary>
- Adds nodes for the first and last points of the edge.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Noding.SegmentNodeList.AddCollapsedNodes">
- <summary>
- Adds nodes for any collapsed edge pairs.
- Collapsed edge pairs can be caused by inserted nodes, or they can be
- pre-existing in the edge vertex list.
- In order to provide the correct fully noded semantics,
- the vertex at the base of a collapsed pair must also be added as a node.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Noding.SegmentNodeList.FindCollapsesFromExistingVertices(System.Collections.IList)">
- <summary>
- Adds nodes for any collapsed edge pairs
- which are pre-existing in the vertex list.
- </summary>
- <param name="collapsedVertexIndexes"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.SegmentNodeList.FindCollapsesFromInsertedNodes(System.Collections.IList)">
- <summary>
- Adds nodes for any collapsed edge pairs caused by inserted nodes
- Collapsed edge pairs occur when the same coordinate is inserted as a node
- both before and after an existing edge vertex.
- To provide the correct fully noded semantics,
- the vertex must be added as a node as well.
- </summary>
- <param name="collapsedVertexIndexes"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.SegmentNodeList.FindCollapseIndex(DotSpatial.Topology.Noding.SegmentNode,DotSpatial.Topology.Noding.SegmentNode,System.Int32[])">
- <summary>
-
- </summary>
- <param name="ei0"></param>
- <param name="ei1"></param>
- <param name="collapsedVertexIndex"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Noding.SegmentNodeList.AddSplitEdges(System.Collections.IList)">
- <summary>
- Creates new edges for all the edges that the intersections in this
- list split the parent edge into.
- Adds the edges to the provided argument list
- (this is so a single list can be used to accumulate all split edges
- for a set of <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s).
- </summary>
- <param name="edgeList"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.SegmentNodeList.CreateSplitEdge(DotSpatial.Topology.Noding.SegmentNode,DotSpatial.Topology.Noding.SegmentNode)">
- <summary>
- Create a new "split edge" with the section of points between
- (and including) the two intersections.
- The label for the new edge is the same as the label for the parent edge.
- </summary>
- <param name="ei0"></param>
- <param name="ei1"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Noding.SegmentNodeList.Write(System.IO.StreamWriter)">
- <summary>
-
- </summary>
- <param name="outstream"></param>
- </member>
- <member name="P:DotSpatial.Topology.Noding.SegmentNodeList.Edge">
- <summary>
-
- </summary>
- <value></value>
- </member>
- <member name="T:DotSpatial.Topology.Noding.NodeVertexIterator">
- <summary>
- INCOMPLETE!!!
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Noding.NodeVertexIterator.MoveNext">
- <summary>
- Consente di spostare l'enumeratore all'elemento successivo dell'insieme.
- </summary>
- <returns>
- true se l'enumeratore è stato spostato correttamente in avanti in corrispondenza dell'elemento successivo; false se l'enumeratore ha raggiunto la fine dell'insieme.
- </returns>
- <exception cref="T:System.InvalidOperationException">L'insieme è stato modificato dopo la creazione dell'enumeratore. </exception>
- </member>
- <member name="M:DotSpatial.Topology.Noding.NodeVertexIterator.Reset">
- <summary>
- Imposta l'enumeratore sulla propria posizione iniziale, ovvero prima del primo elemento nell'insieme.
- </summary>
- <exception cref="T:System.InvalidOperationException">L'insieme è stato modificato dopo la creazione dell'enumeratore. </exception>
- </member>
- <member name="M:DotSpatial.Topology.Noding.NodeVertexIterator.Remove">
- <summary>
- Not implemented.
- </summary>
- <exception cref="T:System.NotSupportedException">This method is not implemented.</exception>
- </member>
- <member name="P:DotSpatial.Topology.Noding.NodeVertexIterator.Current">
- <summary>
- Ottiene l'elemento corrente dell'insieme.
- </summary>
- <value></value>
- <returns>Elemento corrente nell'insieme.</returns>
- <exception cref="T:System.InvalidOperationException">L'enumeratore è posizionato prima del primo elemento o dopo l'ultimo elemento dell'insieme. </exception>
- </member>
- <member name="T:DotSpatial.Topology.Noding.SegmentPointComparator">
- <summary>
- Implements a robust method of comparing the relative position of two points along the same segment.
- The coordinates are assumed to lie "near" the segment.
- This means that this algorithm will only return correct results
- if the input coordinates have the same precision and correspond to rounded values
- of exact coordinates lying on the segment.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Noding.SegmentPointComparator.Compare(DotSpatial.Topology.Noding.OctantDirection,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
- Compares two <see cref="T:DotSpatial.Topology.Coordinate"/>s for their relative position along a segment
- lying in the specified <see cref="T:DotSpatial.Topology.Noding.Octant"/>.
- </summary>
- <param name="octant"></param>
- <param name="p0"></param>
- <param name="p1"></param>
- <returns>
- -1 if node0 occurs first, or
- 0 if the two nodes are equal, or
- 1 if node1 occurs first.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Noding.SegmentPointComparator.RelativeSign(System.Double,System.Double)">
- <summary>
-
- </summary>
- <param name="x0"></param>
- <param name="x1"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Noding.SegmentPointComparator.CompareValue(System.Int32,System.Int32)">
- <summary>
-
- </summary>
- <param name="compareSign0"></param>
- <param name="compareSign1"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.Noding.SegmentString">
- <summary>
- Represents a list of contiguous line segments, and supports noding the segments.
- The line segments are represented by an array of <see cref="T:DotSpatial.Topology.Coordinate"/>s.
- Intended to optimize the noding of contiguous segments by
- reducing the number of allocated objects.
- <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s can carry a context object, which is useful
- for preserving topological or parentage information.
- All noded substrings are initialized with the same context object.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Noding.SegmentString.GetNodedSubstrings(System.Collections.IList)">
- <summary>
-
- </summary>
- <param name="segStrings"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Noding.SegmentString.GetNodedSubstrings(System.Collections.IList,System.Collections.IList)">
- <summary>
-
- </summary>
- <param name="segStrings"></param>
- <param name="resultEdgelist"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.SegmentString.#ctor(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate},System.Object)">
- <summary>
- Creates a new segment string from a list of vertices.
- </summary>
- <param name="pts">The vertices of the segment string.</param>
- <param name="data">The user-defined data of this segment string (may be null).</param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.SegmentString.GetCoordinate(System.Int32)">
- <summary>
-
- </summary>
- <param name="i"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Noding.SegmentString.GetSegmentOctant(System.Int32)">
- <summary>
- Gets the octant of the segment starting at vertex <c>index</c>.
- </summary>
- <param name="index">
- The index of the vertex starting the segment.
- Must not be the last index in the vertex list
- </param>
- <returns>The octant of the segment at the vertex</returns>
- </member>
- <member name="M:DotSpatial.Topology.Noding.SegmentString.AddIntersections(DotSpatial.Topology.Algorithm.LineIntersector,System.Int32)">
- <summary>
- Adds EdgeIntersections for one or both
- intersections found for a segment of an edge to the edge intersection list.
- </summary>
- <param name="li"></param>
- <param name="segmentIndex"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.SegmentString.AddIntersection(DotSpatial.Topology.Algorithm.LineIntersector,System.Int32,System.Int32)">
- <summary>
- Add an <see cref="T:DotSpatial.Topology.Noding.SegmentNode"/> for intersection intIndex.
- An intersection that falls exactly on a vertex
- of the <see cref="T:DotSpatial.Topology.Noding.SegmentString"/> is normalized
- to use the higher of the two possible segmentIndexes.
- </summary>
- <param name="li"></param>
- <param name="segmentIndex"></param>
- <param name="intIndex"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.SegmentString.AddIntersection(DotSpatial.Topology.Coordinate,System.Int32)">
- <summary>
-
- </summary>
- <param name="intPt"></param>
- <param name="segmentIndex"></param>
- </member>
- <member name="P:DotSpatial.Topology.Noding.SegmentString.Data">
- <summary>
- Gets/Sets the user-defined data for this segment string.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Noding.SegmentString.NodeList">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Noding.SegmentString.Count">
- <summary>
-
- </summary>
- <value></value>
- </member>
- <member name="P:DotSpatial.Topology.Noding.SegmentString.Coordinates">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Noding.SegmentString.IsClosed">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Noding.SegmentStringDissolver">
- <summary>
- Dissolves a noded collection of <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s to produce
- a set of merged linework with unique segments.
- A custom merging strategy can be applied when two identical (up to orientation)
- strings are dissolved together.
- The default merging strategy is simply to discard the merged string.
- <para>
- A common use for this class is to merge noded edges
- while preserving topological labelling.
- </para>
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Noding.SegmentStringDissolver.#ctor(DotSpatial.Topology.Noding.SegmentStringDissolver.ISegmentStringMerger)">
- <summary>
- Creates a dissolver with a user-defined merge strategy.
- </summary>
- <param name="merger"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.SegmentStringDissolver.#ctor">
- <summary>
- Creates a dissolver with the default merging strategy.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Noding.SegmentStringDissolver.Dissolve(System.Collections.ICollection)">
- <summary>
- Dissolve all <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s in the input <see cref="T:System.Collections.ICollection"/>.
- </summary>
- <param name="segStrings"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.SegmentStringDissolver.Add(DotSpatial.Topology.Noding.OrientedCoordinateArray,DotSpatial.Topology.Noding.SegmentString)">
- <summary>
-
- </summary>
- <param name="oca"></param>
- <param name="segString"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.SegmentStringDissolver.Dissolve(DotSpatial.Topology.Noding.SegmentString)">
- <summary>
- Dissolve the given <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>.
- </summary>
- <param name="segString"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.SegmentStringDissolver.FindMatching(DotSpatial.Topology.Noding.OrientedCoordinateArray)">
- <summary>
-
- </summary>
- <param name="oca"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.Noding.SegmentStringDissolver.Dissolved">
- <summary>
- Gets the collection of dissolved (i.e. unique) <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Noding.SegmentStringDissolver.ISegmentStringMerger">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Noding.SegmentStringDissolver.ISegmentStringMerger.Merge(DotSpatial.Topology.Noding.SegmentString,DotSpatial.Topology.Noding.SegmentString,System.Boolean)">
- <summary>
- Updates the context data of a <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>
- when an identical (up to orientation) one is found during dissolving.
- </summary>
- <param name="mergeTarget">The segment string to update.</param>
- <param name="ssToMerge">The segment string being dissolved.</param>
- <param name="isSameOrientation">
- <c>true</c> if the strings are in the same direction,
- <c>false</c> if they are opposite.
- </param>
- </member>
- <member name="T:DotSpatial.Topology.Noding.SimpleNoder">
- <summary>
- Nodes a set of <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s by
- performing a brute-force comparison of every segment to every other one.
- This has n^2 performance, so is too slow for use on large numbers of segments.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Noding.SimpleNoder.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Topology.Noding.SimpleNoder"/> class.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Noding.SimpleNoder.#ctor(DotSpatial.Topology.Noding.ISegmentIntersector)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Topology.Noding.SimpleNoder"/> class.
- </summary>
- <param name="segInt"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.SimpleNoder.GetNodedSubstrings">
- <summary>
- Returns a <see cref="T:System.Collections.IList"/> of fully noded <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s.
- The <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s have the same context as their parent.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Noding.SimpleNoder.ComputeNodes(System.Collections.IList)">
- <summary>
- Computes the noding for a collection of <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s.
- Some Noders may add all these nodes to the input <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s;
- others may only add some or none at all.
- </summary>
- <param name="inputSegStrings"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.SimpleNoder.ComputeIntersects(DotSpatial.Topology.Noding.SegmentString,DotSpatial.Topology.Noding.SegmentString)">
- <summary>
-
- </summary>
- <param name="e0"></param>
- <param name="e1"></param>
- </member>
- <member name="T:DotSpatial.Topology.Noding.Snapround.HotPixel">
- <summary>
- Implements a "hot pixel" as used in the Snap Rounding algorithm.
- A hot pixel contains the interior of the tolerance square and the boundary
- minus the top and right segments.
- The hot pixel operations are all computed in the integer domain
- to avoid rounding problems.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Noding.Snapround.HotPixel.#ctor(DotSpatial.Topology.Coordinate,System.Double,DotSpatial.Topology.Algorithm.LineIntersector)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Topology.Noding.Snapround.HotPixel"/> class.
- </summary>
- <param name="pt"></param>
- <param name="scaleFactor"></param>
- <param name="li"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.Snapround.HotPixel.GetSafeEnvelope">
- <summary>
- Returns a "safe" envelope that is guaranteed to contain the hot pixel.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Noding.Snapround.HotPixel.InitCorners(DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="pt"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.Snapround.HotPixel.Scale(System.Double)">
- <summary>
-
- </summary>
- <param name="val"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Noding.Snapround.HotPixel.Intersects(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="p0"></param>
- <param name="p1"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Noding.Snapround.HotPixel.CopyScaled(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="p"></param>
- <param name="pScaled"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.Snapround.HotPixel.IntersectsScaled(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="p0"></param>
- <param name="p1"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Noding.Snapround.HotPixel.IntersectsToleranceSquare(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
- Tests whether the segment p0-p1 intersects the hot pixel tolerance square.
- Because the tolerance square point set is partially open (along the
- top and right) the test needs to be more sophisticated than
- simply checking for any intersection. However, it
- can take advantage of the fact that because the hot pixel edges
- do not lie on the coordinate grid. It is sufficient to check
- if there is at least one of:
- - a proper intersection with the segment and any hot pixel edge.
- - an intersection between the segment and both the left and bottom edges.
- - an intersection between a segment endpoint and the hot pixel coordinate.
- </summary>
- <param name="p0"></param>
- <param name="p1"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.Noding.Snapround.HotPixel.Coordinate">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Noding.Snapround.McIndexPointSnapper">
- <summary>
- "Snaps" all <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s in a <see cref="T:DotSpatial.Topology.Index.ISpatialIndex"/> containing
- <see cref="T:DotSpatial.Topology.Index.Chain.MonotoneChain"/>s to a given <see cref="T:DotSpatial.Topology.Noding.Snapround.HotPixel"/>.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Noding.Snapround.McIndexPointSnapper.#ctor(DotSpatial.Topology.Index.ISpatialIndex)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Topology.Noding.Snapround.McIndexPointSnapper"/> class.
- </summary>
- <param name="index"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.Snapround.McIndexPointSnapper.Snap(DotSpatial.Topology.Noding.Snapround.HotPixel,DotSpatial.Topology.Noding.SegmentString,System.Int32)">
- <summary>
- Snaps (nodes) all interacting segments to this hot pixel.
- The hot pixel may represent a vertex of an edge,
- in which case this routine uses the optimization
- of not noding the vertex itself
- </summary>
- <param name="hotPixel">The hot pixel to snap to.</param>
- <param name="parentEdge">The edge containing the vertex, if applicable, or <c>null</c>.</param>
- <param name="vertexIndex"></param>
- <returns><c>true</c> if a node was added for this pixel.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Noding.Snapround.McIndexPointSnapper.Snap(DotSpatial.Topology.Noding.Snapround.HotPixel)">
- <summary>
-
- </summary>
- <param name="hotPixel"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.Noding.Snapround.McIndexPointSnapper.HotPixelSnapAction">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Noding.Snapround.McIndexPointSnapper.HotPixelSnapAction.#ctor(DotSpatial.Topology.Noding.Snapround.HotPixel,DotSpatial.Topology.Noding.SegmentString,System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Topology.Noding.Snapround.McIndexPointSnapper.HotPixelSnapAction"/> class.
- </summary>
- <param name="hotPixel"></param>
- <param name="parentEdge"></param>
- <param name="vertexIndex"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.Snapround.McIndexPointSnapper.HotPixelSnapAction.Select(DotSpatial.Topology.Index.Chain.MonotoneChain,System.Int32)">
- <summary>
-
- </summary>
- <param name="mc"></param>
- <param name="startIndex"></param>
- </member>
- <member name="P:DotSpatial.Topology.Noding.Snapround.McIndexPointSnapper.HotPixelSnapAction.IsNodeAdded">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Noding.Snapround.McIndexPointSnapper.QueryVisitor">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Noding.Snapround.McIndexPointSnapper.QueryVisitor.#ctor(DotSpatial.Topology.Envelope,DotSpatial.Topology.Noding.Snapround.McIndexPointSnapper.HotPixelSnapAction)">
- <summary>
-
- </summary>
- <param name="env"></param>
- <param name="action"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.Snapround.McIndexPointSnapper.QueryVisitor.VisitItem(System.Object)">
- <summary>
- </summary>
- <param name="item"></param>
- </member>
- <member name="T:DotSpatial.Topology.Noding.Snapround.McIndexSnapRounder">
- <summary>
- Uses Snap Rounding to compute a rounded,
- fully noded arrangement from a set of {@link SegmentString}s.
- Implements the Snap Rounding technique described in Hobby, Guibas and Marimont, and Goodrich et al.
- Snap Rounding assumes that all vertices lie on a uniform grid
- (hence the precision model of the input must be fixed precision,
- and all the input vertices must be rounded to that precision).
- <para>
- This implementation uses a monotone chains and a spatial index to
- speed up the intersection tests.
- This implementation appears to be fully robust using an integer precision model.
- It will function with non-integer precision models, but the
- results are not 100% guaranteed to be correctly noded.
- </para>
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Noding.Snapround.McIndexSnapRounder.#ctor(DotSpatial.Topology.PrecisionModel)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Topology.Noding.Snapround.McIndexSnapRounder"/> class.
- </summary>
- <param name="pm">The <see cref="T:DotSpatial.Topology.PrecisionModel"/> to use.</param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.Snapround.McIndexSnapRounder.GetNodedSubstrings">
- <summary>
- Returns a <see cref="T:System.Collections.IList"/> of fully noded <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s.
- The <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s have the same context as their parent.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Noding.Snapround.McIndexSnapRounder.ComputeNodes(System.Collections.IList)">
- <summary>
- Computes the noding for a collection of <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s.
- Some Noders may add all these nodes to the input <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s;
- others may only add some or none at all.
- </summary>
- <param name="inputSegmentStrings"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.Snapround.McIndexSnapRounder.SnapRound(System.Collections.IList,DotSpatial.Topology.Algorithm.LineIntersector)">
- <summary>
-
- </summary>
- <param name="segStrings"></param>
- <param name="li"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.Snapround.McIndexSnapRounder.FindInteriorIntersections(System.Collections.IList,DotSpatial.Topology.Algorithm.LineIntersector)">
- <summary>
- Computes all interior intersections in the collection of <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s,
- and returns their <see cref="T:DotSpatial.Topology.Coordinate"/>s.
-
- Does NOT node the segStrings.
- </summary>
- <param name="segStrings"></param>
- <param name="li"></param>
- <returns>A list of Coordinates for the intersections.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Noding.Snapround.McIndexSnapRounder.ComputeIntersectionSnaps(System.Collections.IList)">
- <summary>
- Computes nodes introduced as a result of snapping segments to snap points (hot pixels).
- </summary>
- <param name="snapPts"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.Snapround.McIndexSnapRounder.ComputeVertexSnaps(System.Collections.IList)">
- <summary>
- Computes nodes introduced as a result of
- snapping segments to vertices of other segments.
- </summary>
- <param name="edges"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.Snapround.McIndexSnapRounder.ComputeVertexSnaps(DotSpatial.Topology.Noding.SegmentString)">
- <summary>
- Performs a brute-force comparison of every segment in each <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>.
- This has n^2 performance.
- </summary>
- <param name="e"></param>
- </member>
- <member name="T:DotSpatial.Topology.Noding.Snapround.SimpleSnapRounder">
- <summary>
- Uses Snap Rounding to compute a rounded,
- fully noded arrangement from a set of <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s.
- Implements the Snap Rounding technique described in Hobby, Guibas and Marimont, and Goodrich et al.
- Snap Rounding assumes that all vertices lie on a uniform grid
- (hence the precision model of the input must be fixed precision,
- and all the input vertices must be rounded to that precision).
- <para>
- This implementation uses simple iteration over the line segments.
- This implementation appears to be fully robust using an integer precision model.
- It will function with non-integer precision models, but the
- results are not 100% guaranteed to be correctly noded.
- </para>
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Noding.Snapround.SimpleSnapRounder.#ctor(DotSpatial.Topology.PrecisionModel)">
- <summary>
- Initializes a new instance of the <see cref="T:DotSpatial.Topology.Noding.Snapround.SimpleSnapRounder"/> class.
- </summary>
- <param name="pm">The <see cref="T:DotSpatial.Topology.PrecisionModel"/> to use.</param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.Snapround.SimpleSnapRounder.GetNodedSubstrings">
- <summary>
- Returns a <see cref="T:System.Collections.IList"/> of fully noded <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s.
- The <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s have the same context as their parent.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Noding.Snapround.SimpleSnapRounder.ComputeNodes(System.Collections.IList)">
- <summary>
- Computes the noding for a collection of <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s.
- Some Noders may add all these nodes to the input <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s;
- others may only add some or none at all.
- </summary>
- <param name="inputSegmentStrings"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.Snapround.SimpleSnapRounder.SnapRound(System.Collections.IList,DotSpatial.Topology.Algorithm.LineIntersector)">
- <summary>
-
- </summary>
- <param name="segStrings"></param>
- <param name="li"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.Snapround.SimpleSnapRounder.FindInteriorIntersections(System.Collections.IList,DotSpatial.Topology.Algorithm.LineIntersector)">
- <summary>
- Computes all interior intersections in the collection of <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>s,
- and returns their <see cref="T:DotSpatial.Topology.Coordinate"/>s.
- Does NOT node the segStrings.
- </summary>
- <param name="segStrings"></param>
- <param name="li"></param>
- <returns>A list of <see cref="T:DotSpatial.Topology.Coordinate"/>s for the intersections.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Noding.Snapround.SimpleSnapRounder.ComputeSnaps(System.Collections.IList,System.Collections.IList)">
- <summary>
- Computes nodes introduced as a result of snapping segments to snap points (hot pixels).
- </summary>
- <param name="segStrings"></param>
- <param name="snapPts"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.Snapround.SimpleSnapRounder.ComputeSnaps(DotSpatial.Topology.Noding.SegmentString,System.Collections.IList)">
- <summary>
-
- </summary>
- <param name="ss"></param>
- <param name="snapPts"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.Snapround.SimpleSnapRounder.ComputeVertexSnaps(System.Collections.IList)">
- <summary>
- Computes nodes introduced as a result of
- snapping segments to vertices of other segments.
- </summary>
- <param name="edges"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.Snapround.SimpleSnapRounder.ComputeVertexSnaps(DotSpatial.Topology.Noding.SegmentString,DotSpatial.Topology.Noding.SegmentString)">
- <summary>
- Performs a brute-force comparison of every segment in each <see cref="T:DotSpatial.Topology.Noding.SegmentString"/>.
- This has n^2 performance.
- </summary>
- <param name="e0"></param>
- <param name="e1"></param>
- </member>
- <member name="M:DotSpatial.Topology.Noding.Snapround.SimpleSnapRounder.AddSnappedNode(DotSpatial.Topology.Noding.Snapround.HotPixel,DotSpatial.Topology.Noding.SegmentString,System.Int32)">
- <summary>
- Adds a new node (equal to the snap pt) to the segment
- if the segment passes through the hot pixel.
- </summary>
- <param name="hotPix"></param>
- <param name="segStr"></param>
- <param name="segIndex"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Buffer.BufferBuilder">
- <summary>
- Builds the buffer point for a given input point and precision model.
- Allows setting the level of approximation for circular arcs,
- and the precision model in which to carry out the computation.
- When computing buffers in floating point double-precision
- it can happen that the process of iterated noding can fail to converge (terminate).
- In this case a TopologyException will be thrown.
- Retrying the computation in a fixed precision
- can produce more robust results.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.BufferBuilder.DepthDelta(DotSpatial.Topology.GeometriesGraph.Label)">
- <summary>
- Compute the change in depth as an edge is crossed from R to L.
- </summary>
- <param name="label"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.BufferBuilder.Buffer(DotSpatial.Topology.IGeometry,System.Double)">
- <summary>
-
- </summary>
- <param name="g"></param>
- <param name="distance"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.BufferBuilder.GetNoder(DotSpatial.Topology.PrecisionModel)">
- <summary>
-
- </summary>
- <param name="precisionModel"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.BufferBuilder.ComputeNodedEdges(System.Collections.IList,DotSpatial.Topology.PrecisionModel)">
- <summary>
-
- </summary>
- <param name="bufferSegStrList"></param>
- <param name="precisionModel"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.BufferBuilder.InsertEdge(DotSpatial.Topology.GeometriesGraph.Edge)">
- <summary>
- Inserted edges are checked to see if an identical edge already exists.
- If so, the edge is not inserted, but its label is merged
- with the existing edge.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.BufferBuilder.BuildSubgraphs(System.Collections.IList,DotSpatial.Topology.Operation.Overlay.PolygonBuilder)">
- <summary>
- Completes the building of the input subgraphs by depth-labelling them,
- and adds them to the <see cref="T:DotSpatial.Topology.Operation.Overlay.PolygonBuilder"/>.
- The subgraph list must be sorted in rightmost-coordinate order.
- </summary>
- <param name="subgraphList">The subgraphs to build.</param>
- <param name="polyBuilder">The PolygonBuilder which will build the final polygons.</param>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Buffer.BufferBuilder.QuadrantSegments">
- <summary>
- Gets/Sets the number of segments used to approximate a angle fillet.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Buffer.BufferBuilder.WorkingPrecisionModel">
- <summary>
- Gets/Sets the precision model to use during the curve computation and noding,
- if it is different to the precision model of the Geometry.
- If the precision model is less than the precision of the Geometry precision model,
- the Geometry must have previously been rounded to that precision.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Buffer.BufferBuilder.EndCapStyle">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Buffer.BufferOp">
- <summary>
- Computes the buffer of a point, for both positive and negative buffer distances.
- In GIS, the buffer of a point is defined as
- the Minkowski sum or difference of the point
- with a circle with radius equal to the absolute value of the buffer distance.
- In the CAD/CAM world buffers are known as offset curves.
- Since true buffer curves may contain circular arcs,
- computed buffer polygons can only be approximations to the true point.
- The user can control the accuracy of the curve approximation by specifying
- the number of linear segments with which to approximate a curve.
- The end cap endCapStyle of a linear buffer may be specified. The
- following end cap styles are supported:
- <para>
- {CAP_ROUND} - the usual round end caps
- {CAP_BUTT} - end caps are truncated flat at the line ends
- {CAP_SQUARE} - end caps are squared off at the buffer distance beyond the line ends
- </para>
- The computation uses an algorithm involving iterated noding and precision reduction
- to provide a high degree of robustness.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.BufferOp.#ctor(DotSpatial.Topology.IGeometry)">
- <summary>
- Initializes a buffer computation for the given point.
- </summary>
- <param name="g">The point to buffer.</param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.BufferOp.PrecisionScaleFactor(DotSpatial.Topology.IGeometry,System.Double,System.Int32)">
- <summary>
- Compute a reasonable scale factor to limit the precision of
- a given combination of Geometry and buffer distance.
- The scale factor is based on a heuristic.
- </summary>
- <param name="g">The Geometry being buffered.</param>
- <param name="distance">The buffer distance.</param>
- <param name="maxPrecisionDigits">The mzx # of digits that should be allowed by
- the precision determined by the computed scale factor.</param>
- <returns>A scale factor that allows a reasonable amount of precision for the buffer computation.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.BufferOp.Buffer(DotSpatial.Topology.IGeometry,System.Double)">
- <summary>
- Computes the buffer of a point for a given buffer distance.
- </summary>
- <param name="g">The point to buffer.</param>
- <param name="distance">The buffer distance.</param>
- <returns> The buffer of the input point.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.BufferOp.Buffer(DotSpatial.Topology.Geometry,System.Double,DotSpatial.Topology.BufferStyle)">
- <summary>
- Computes the buffer of a point for a given buffer distance,
- using the given Cap Style for borders of the point.
- </summary>
- <param name="g">The point to buffer.</param>
- <param name="distance">The buffer distance.</param>
- <param name="endCapStyle">Cap Style to use for compute buffer.</param>
- <returns> The buffer of the input point.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.BufferOp.Buffer(DotSpatial.Topology.Geometry,System.Double,System.Int32)">
- <summary>
- Computes the buffer for a point for a given buffer distance
- and accuracy of approximation.
- </summary>
- <param name="g">The point to buffer.</param>
- <param name="distance">The buffer distance.</param>
- <param name="quadrantSegments">The number of segments used to approximate a quarter circle.</param>
- <returns>The buffer of the input point.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.BufferOp.Buffer(DotSpatial.Topology.IGeometry,System.Double,System.Int32,DotSpatial.Topology.BufferStyle)">
- <summary>
- Computes the buffer for a point for a given buffer distance
- and accuracy of approximation.
- </summary>
- <param name="g">The point to buffer.</param>
- <param name="distance">The buffer distance.</param>
- <param name="quadrantSegments">The number of segments used to approximate a quarter circle.</param>
- <param name="endCapStyle">Cap Style to use for compute buffer.</param>
- <returns>The buffer of the input point.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.BufferOp.GetResultGeometry(System.Double)">
- <summary>
-
- </summary>
- <param name="distance"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.BufferOp.GetResultGeometry(System.Double,System.Int32)">
- <summary>
-
- </summary>
- <param name="distance"></param>
- <param name="quadrantSegments"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.BufferOp.ComputeGeometry">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.BufferOp.BufferOriginalPrecision">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.BufferOp.BufferFixedPrecision(System.Int32)">
- <summary>
-
- </summary>
- <param name="precisionDigits"></param>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Buffer.BufferOp.EndCapStyle">
- <summary>
- Specifies the end cap endCapStyle of the generated buffer.
- The styles supported are CapRound, CapButt, and CapSquare.
- The default is CapRound.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Buffer.BufferOp.QuadrantSegments">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Buffer.BufferSubgraph">
- <summary>
- A connected subset of the graph of
- <c>DirectedEdges</c> and <c>Node</c>s.
- Its edges will generate either
- a single polygon in the complete buffer, with zero or more holes, or
- one or more connected holes.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.BufferSubgraph.#ctor">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.BufferSubgraph.CompareTo(System.Object)">
- <summary>
- BufferSubgraphs are compared on the x-value of their rightmost Coordinate.
- This defines a partial ordering on the graphs such that:
- g1 >= g2 - Ring(g2) does not contain Ring(g1)
- where Polygon(g) is the buffer polygon that is built from g.
- This relationship is used to sort the BufferSubgraphs so that shells are guaranteed to
- be built before holes.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.BufferSubgraph.Create(DotSpatial.Topology.GeometriesGraph.Node)">
- <summary>
- Creates the subgraph consisting of all edges reachable from this node.
- Finds the edges in the graph and the rightmost coordinate.
- </summary>
- <param name="node">A node to start the graph traversal from.</param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.BufferSubgraph.AddReachable(DotSpatial.Topology.GeometriesGraph.Node)">
- <summary>
- Adds all nodes and edges reachable from this node to the subgraph.
- Uses an explicit stack to avoid a large depth of recursion.
- </summary>
- <param name="startNode">A node known to be in the subgraph.</param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.BufferSubgraph.Add(DotSpatial.Topology.GeometriesGraph.Node,System.Collections.Stack)">
- <summary>
- Adds the argument node and all its out edges to the subgraph
- </summary>
- <param name="node">The node to add.</param>
- <param name="nodeStack">The current set of nodes being traversed.</param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.BufferSubgraph.ClearVisitedEdges">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.BufferSubgraph.ComputeDepth(System.Int32)">
- <summary>
-
- </summary>
- <param name="outsideDepth"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.BufferSubgraph.ComputeDepths(DotSpatial.Topology.GeometriesGraph.DirectedEdge)">
- <summary>
- Compute depths for all dirEdges via breadth-first traversal of nodes in graph.
- </summary>
- <param name="startEdge">Edge to start processing with.</param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.BufferSubgraph.ComputeNodeDepth(DotSpatial.Topology.GeometriesGraph.Node)">
- <summary>
-
- </summary>
- <param name="n"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.BufferSubgraph.CopySymDepths(DotSpatial.Topology.GeometriesGraph.DirectedEdge)">
- <summary>
-
- </summary>
- <param name="de"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.BufferSubgraph.FindResultEdges">
- <summary>
- Find all edges whose depths indicates that they are in the result area(s).
- Since we want polygon shells to be
- oriented CW, choose dirEdges with the interior of the result on the RHS.
- Mark them as being in the result.
- Interior Area edges are the result of dimensional collapses.
- They do not form part of the result area boundary.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Buffer.BufferSubgraph.DirectedEdges">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Buffer.BufferSubgraph.Nodes">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Buffer.BufferSubgraph.RightMostCoordinate">
- <summary>
- Gets the rightmost coordinate in the edges of the subgraph.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Buffer.OffsetCurveBuilder">
- <summary>
- Computes the raw offset curve for a
- single <c>Geometry</c> component (ring, line or point).
- A raw offset curve line is not noded -
- it may contain self-intersections (and usually will).
- The final buffer polygon is computed by forming a topological graph
- of all the noded raw curves and tracing outside contours.
- The points in the raw curve are rounded to the required precision model.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Operation.Buffer.OffsetCurveBuilder.DEFAULT_QUADRANT_SEGMENTS">
- <summary>
- The default number of facets into which to divide a fillet of 90 degrees.
- A value of 8 gives less than 2% max error in the buffer distance.
- For a max error smaller of 1%, use QS = 12
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.OffsetCurveBuilder.#ctor(DotSpatial.Topology.PrecisionModel)">
- <summary>
-
- </summary>
- <param name="precisionModel"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.OffsetCurveBuilder.#ctor(DotSpatial.Topology.PrecisionModel,System.Int32)">
- <summary>
-
- </summary>
- <param name="precisionModel"></param>
- <param name="quadrantSegments"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.OffsetCurveBuilder.GetLineCurve(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate},System.Double)">
- <summary>
- This method handles single points as well as lines.
- Lines are assumed to not be closed (the function will not
- fail for closed lines, but will generate superfluous line caps).
- </summary>
- <param name="inputPts"></param>
- <param name="distance"></param>
- <returns> A List of Coordinate[].</returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.OffsetCurveBuilder.GetRingCurve(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate},DotSpatial.Topology.GeometriesGraph.PositionType,System.Double)">
- <summary>
- This method handles the degenerate cases of single points and lines,
- as well as rings.
- </summary>
- <returns>A List of Coordinate[].</returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.OffsetCurveBuilder.CopyCoordinates(System.Collections.Generic.IEnumerable{DotSpatial.Topology.Coordinate})">
- <summary>
-
- </summary>
- <param name="pts"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.OffsetCurveBuilder.Init(System.Double)">
- <summary>
-
- </summary>
- <param name="distance"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.OffsetCurveBuilder.ComputeLineBufferCurve(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate})">
- <summary>
-
- </summary>
- <param name="inputPts"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.OffsetCurveBuilder.ComputeRingBufferCurve(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate},DotSpatial.Topology.GeometriesGraph.PositionType)">
- <summary>
-
- </summary>
- <param name="inputPts"></param>
- <param name="side"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.OffsetCurveBuilder.AddPt(DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="pt"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.OffsetCurveBuilder.ClosePts">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.OffsetCurveBuilder.InitSideSegments(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.GeometriesGraph.PositionType)">
- <summary>
-
- </summary>
- <param name="s1"></param>
- <param name="s2"></param>
- <param name="side"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.OffsetCurveBuilder.AddNextSegment(DotSpatial.Topology.Coordinate,System.Boolean)">
- <summary>
-
- </summary>
- <param name="p"></param>
- <param name="addStartPoint"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.OffsetCurveBuilder.AddLastSegment">
- <summary>
- Add last offset point.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.OffsetCurveBuilder.ComputeOffsetSegment(DotSpatial.Topology.ILineSegmentBase,DotSpatial.Topology.GeometriesGraph.PositionType,System.Double,DotSpatial.Topology.ILineSegmentBase)">
- <summary>
- Compute an offset segment for an input segment on a given side and at a given distance.
- The offset points are computed in full double precision, for accuracy.
- </summary>
- <param name="seg">The segment to offset.</param>
- <param name="side">The side of the segment the offset lies on.</param>
- <param name="distance">The offset distance.</param>
- <param name="offset">The points computed for the offset segment.</param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.OffsetCurveBuilder.AddLineEndCap(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
- Add an end cap around point p1, terminating a line segment coming from p0.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.OffsetCurveBuilder.AddFillet(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,System.Int32,System.Double)">
- <summary>
-
- </summary>
- <param name="p">Base point of curve.</param>
- <param name="p0">Start point of fillet curve.</param>
- <param name="p1">Endpoint of fillet curve.</param>
- <param name="direction"></param>
- <param name="distance"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.OffsetCurveBuilder.AddFillet(DotSpatial.Topology.Coordinate,System.Double,System.Double,System.Int32,System.Double)">
- <summary>
- Adds points for a fillet. The start and end point for the fillet are not added -
- the caller must add them if required.
- </summary>
- <param name="p"></param>
- <param name="startAngle"></param>
- <param name="endAngle"></param>
- <param name="direction">Is -1 for a CW angle, 1 for a CCW angle.</param>
- <param name="distance"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.OffsetCurveBuilder.AddCircle(DotSpatial.Topology.Coordinate,System.Double)">
- <summary>
- Adds a CW circle around a point.
- </summary>
- <param name="p"></param>
- <param name="distance"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.OffsetCurveBuilder.AddSquare(DotSpatial.Topology.Coordinate,System.Double)">
- <summary>
- Adds a CW square around a point
- </summary>
- <param name="p"></param>
- <param name="distance"></param>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Buffer.OffsetCurveBuilder.EndCapStyle">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Buffer.OffsetCurveBuilder.Coordinates">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Buffer.OffsetCurveSetBuilder">
- <summary>
- Creates all the raw offset curves for a buffer of a <c>Geometry</c>.
- Raw curves need to be noded together and polygonized to form the final buffer area.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.OffsetCurveSetBuilder.#ctor(DotSpatial.Topology.IGeometry,System.Double,DotSpatial.Topology.Operation.Buffer.OffsetCurveBuilder)">
- <summary>
-
- </summary>
- <param name="inputGeom"></param>
- <param name="distance"></param>
- <param name="curveBuilder"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.OffsetCurveSetBuilder.GetCurves">
- <summary>
- Computes the set of raw offset curves for the buffer.
- Each offset curve has an attached {Label} indicating
- its left and right location.
- </summary>
- <returns>A Collection of SegmentStrings representing the raw buffer curves.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.OffsetCurveSetBuilder.AddCurves(System.Collections.IEnumerable,DotSpatial.Topology.LocationType,DotSpatial.Topology.LocationType)">
- <summary>
-
- </summary>
- <param name="lineList"></param>
- <param name="leftLoc"></param>
- <param name="rightLoc"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.OffsetCurveSetBuilder.AddCurve(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate},DotSpatial.Topology.LocationType,DotSpatial.Topology.LocationType)">
- <summary>
- Creates a {SegmentString} for a coordinate list which is a raw offset curve,
- and adds it to the list of buffer curves.
- The SegmentString is tagged with a Label giving the topology of the curve.
- The curve may be oriented in either direction.
- If the curve is oriented CW, the locations will be:
- Left: Location.Exterior.
- Right: Location.Interior.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.OffsetCurveSetBuilder.Add(DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="g"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.OffsetCurveSetBuilder.AddCollection(DotSpatial.Topology.IGeometryCollection)">
- <summary>
-
- </summary>
- <param name="gc"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.OffsetCurveSetBuilder.AddPoint(DotSpatial.Topology.IPoint)">
- <summary>
- Add a Point to the graph.
- </summary>
- <param name="p"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.OffsetCurveSetBuilder.AddLineString(DotSpatial.Topology.ILineString)">
- <summary>
-
- </summary>
- <param name="line"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.OffsetCurveSetBuilder.AddPolygon(DotSpatial.Topology.IPolygon)">
- <summary>
-
- </summary>
- <param name="p"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.OffsetCurveSetBuilder.AddPolygonRing(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate},System.Double,DotSpatial.Topology.GeometriesGraph.PositionType,DotSpatial.Topology.LocationType,DotSpatial.Topology.LocationType)">
- <summary>
- Add an offset curve for a ring.
- The side and left and right topological location arguments
- assume that the ring is oriented CW.
- If the ring is in the opposite orientation,
- the left and right locations must be interchanged and the side flipped.
- </summary>
- <param name="coord">The coordinates of the ring (must not contain repeated points).</param>
- <param name="offsetDistance">The distance at which to create the buffer.</param>
- <param name="side">The side of the ring on which to construct the buffer line.</param>
- <param name="cwLeftLoc">The location on the L side of the ring (if it is CW).</param>
- <param name="cwRightLoc">The location on the R side of the ring (if it is CW).</param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.OffsetCurveSetBuilder.IsErodedCompletely(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate},System.Double)">
- <summary>
- The ringCoord is assumed to contain no repeated points.
- It may be degenerate (i.e. contain only 1, 2, or 3 points).
- In this case it has no area, and hence has a minimum diameter of 0.
- </summary>
- <param name="ringCoord"></param>
- <param name="bufferDistance"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.OffsetCurveSetBuilder.IsTriangleErodedCompletely(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate},System.Double)">
- <summary>
- Tests whether a triangular ring would be eroded completely by the given
- buffer distance.
- This is a precise test. It uses the fact that the inner buffer of a
- triangle converges on the inCentre of the triangle (the point
- equidistant from all sides). If the buffer distance is greater than the
- distance of the inCentre from a side, the triangle will be eroded completely.
- This test is important, since it removes a problematic case where
- the buffer distance is slightly larger than the inCentre distance.
- In this case the triangle buffer curve "inverts" with incorrect topology,
- producing an incorrect hole in the buffer.
- </summary>
- <param name="triangleCoord"></param>
- <param name="bufferDistance"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Buffer.RightmostEdgeFinder">
- <summary>
- A RightmostEdgeFinder find the DirectedEdge in a list which has the highest coordinate,
- and which is oriented L to R at that point. (I.e. the right side is on the RHS of the edge.)
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.RightmostEdgeFinder.FindEdge(System.Collections.IList)">
- <summary>
-
- </summary>
- <param name="dirEdgeList"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.RightmostEdgeFinder.FindRightmostEdgeAtNode">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.RightmostEdgeFinder.FindRightmostEdgeAtVertex">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.RightmostEdgeFinder.CheckForRightmostCoordinate(DotSpatial.Topology.GeometriesGraph.DirectedEdge)">
- <summary>
-
- </summary>
- <param name="de"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.RightmostEdgeFinder.GetRightmostSide(DotSpatial.Topology.GeometriesGraph.DirectedEdge,System.Int32)">
- <summary>
-
- </summary>
- <param name="de"></param>
- <param name="index"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.RightmostEdgeFinder.GetRightmostSideOfSegment(DotSpatial.Topology.GeometriesGraph.EdgeEnd,System.Int32)">
- <summary>
-
- </summary>
- <param name="de"></param>
- <param name="i"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Buffer.RightmostEdgeFinder.Edge">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Buffer.RightmostEdgeFinder.Coordinate">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Buffer.SubgraphDepthLocater">
- <summary>
- Locates a subgraph inside a set of subgraphs,
- in order to determine the outside depth of the subgraph.
- The input subgraphs are assumed to have had depths
- already calculated for their edges.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.SubgraphDepthLocater.#ctor(System.Collections.IList)">
- <summary>
-
- </summary>
- <param name="subgraphs"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.SubgraphDepthLocater.GetDepth(DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="p"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.SubgraphDepthLocater.FindStabbedSegments(DotSpatial.Topology.Coordinate)">
- <summary>
- Finds all non-horizontal segments intersecting the stabbing line.
- The stabbing line is the ray to the right of stabbingRayLeftPt.
- </summary>
- <param name="stabbingRayLeftPt">The left-hand origin of the stabbing line.</param>
- <returns>A List of {DepthSegments} intersecting the stabbing line.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.SubgraphDepthLocater.FindStabbedSegments(DotSpatial.Topology.Coordinate,System.Collections.IEnumerable,System.Collections.IList)">
- <summary>
- Finds all non-horizontal segments intersecting the stabbing line
- in the list of dirEdges.
- The stabbing line is the ray to the right of stabbingRayLeftPt.
- </summary>
- <param name="stabbingRayLeftPt">The left-hand origin of the stabbing line.</param>
- <param name="dirEdges"></param>
- <param name="stabbedSegments">The current list of DepthSegments intersecting the stabbing line.</param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.SubgraphDepthLocater.FindStabbedSegments(DotSpatial.Topology.Coordinate,DotSpatial.Topology.GeometriesGraph.DirectedEdge,System.Collections.IList)">
- <summary>
- Finds all non-horizontal segments intersecting the stabbing line
- in the input dirEdge.
- The stabbing line is the ray to the right of stabbingRayLeftPt.
- </summary>
- <param name="stabbingRayLeftPt">The left-hand origin of the stabbing line.</param>
- <param name="dirEdge"></param>
- <param name="stabbedSegments">The current list of DepthSegments intersecting the stabbing line.</param>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Buffer.SubgraphDepthLocater.DepthSegment">
- <summary>
- A segment from a directed edge which has been assigned a depth value
- for its sides.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.SubgraphDepthLocater.DepthSegment.#ctor(DotSpatial.Topology.ILineSegmentBase,System.Int32)">
- <summary>
-
- </summary>
- <param name="seg"></param>
- <param name="depth"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.SubgraphDepthLocater.DepthSegment.CompareTo(System.Object)">
- <summary>
- Defines a comparision operation on DepthSegments
- which orders them left to right:
- DS1 smaller DS2 if DS1.seg is left of DS2.seg.
- DS1 bigger DS2 if DS1.seg is right of DS2.seg.
- </summary>
- <param name="obj"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Buffer.SubgraphDepthLocater.DepthSegment.CompareX(DotSpatial.Topology.ILineSegmentBase,DotSpatial.Topology.ILineSegmentBase)">
- <summary>
- Compare two collinear segments for left-most ordering.
- If segs are vertical, use vertical ordering for comparison.
- If segs are equal, return 0.
- Segments are assumed to be directed so that the second coordinate is >= to the first
- (e.g. up and to the right).
- </summary>
- <param name="seg0">The left hand side segment to compare.</param>
- <param name="seg1">The riht hand side segment to compare.</param>
- <returns>An integer, -1 if seg0 is less, 0 if they are the same, and 1 if seg0 is greater.</returns>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Buffer.SubgraphDepthLocater.DepthSegment.LeftDepth">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Distance.ConnectedElementLocationFilter">
- <summary>
- A ConnectedElementPointFilter extracts a single point
- from each connected element in a Geometry
- (e.g. a polygon, linestring or point)
- and returns them in a list. The elements of the list are
- <c>com.vividsolutions.jts.operation.distance.GeometryLocation</c>s.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Distance.ConnectedElementLocationFilter.#ctor(System.Collections.IList)">
- <summary>
-
- </summary>
- <param name="locations"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Distance.ConnectedElementLocationFilter.Filter(DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="geom"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Distance.ConnectedElementLocationFilter.GetLocations(DotSpatial.Topology.IGeometry)">
- <summary>
- Returns a list containing a point from each Polygon, LineString, and Point
- found inside the specified point. Thus, if the specified point is
- not a GeometryCollection, an empty list will be returned. The elements of the list
- are <c>com.vividsolutions.jts.operation.distance.GeometryLocation</c>s.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Distance.ConnectedElementPointFilter">
- <summary>
- Extracts a single point
- from each connected element in a Geometry
- (e.g. a polygon, linestring or point)
- and returns them in a list
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Distance.ConnectedElementPointFilter.#ctor(System.Collections.IList)">
- <summary>
-
- </summary>
- <param name="pts"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Distance.ConnectedElementPointFilter.Filter(DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="geom"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Distance.ConnectedElementPointFilter.GetCoordinates(DotSpatial.Topology.Geometry)">
- <summary>
- Returns a list containing a Coordinate from each Polygon, LineString, and Point
- found inside the specified point. Thus, if the specified point is
- not a GeometryCollection, an empty list will be returned.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Distance.DistanceOp">
- <summary>
- Computes the distance and
- closest points between two <c>Geometry</c>s.
- The distance computation finds a pair of points in the input geometries
- which have minimum distance between them. These points may
- not be vertices of the geometries, but may lie in the interior of
- a line segment. In this case the coordinate computed is a close
- approximation to the exact point.
- The algorithms used are straightforward O(n^2)
- comparisons. This worst-case performance could be improved on
- by using Voronoi techniques.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Distance.DistanceOp.#ctor(DotSpatial.Topology.IGeometry,DotSpatial.Topology.IGeometry)">
- <summary>
- Constructs a <see cref="T:DotSpatial.Topology.Operation.Distance.DistanceOp"/> that computes the distance and closest points between
- the two specified geometries.
- </summary>
- <param name="g0"></param>
- <param name="g1"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Distance.DistanceOp.#ctor(DotSpatial.Topology.IGeometry,DotSpatial.Topology.IGeometry,System.Double)">
- <summary>
- Constructs a <see cref="T:DotSpatial.Topology.Operation.Distance.DistanceOp"/> that computes the distance and closest points between
- the two specified geometries.
- </summary>
- <param name="g0"></param>
- <param name="g1"></param>
- <param name="terminateDistance">The distance on which to terminate the search.</param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Distance.DistanceOp.Distance(DotSpatial.Topology.IGeometry,DotSpatial.Topology.IGeometry)">
- <summary>
- Compute the distance between the closest points of two geometries.
- </summary>
- <param name="g0">A <c>Geometry</c>.</param>
- <param name="g1">Another <c>Geometry</c>.</param>
- <returns>The distance between the geometries.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Distance.DistanceOp.IsWithinDistance(DotSpatial.Topology.IGeometry,DotSpatial.Topology.IGeometry,System.Double)">
- <summary>
- Test whether two geometries lie within a given distance of each other.
- </summary>
- <param name="g0"></param>
- <param name="g1"></param>
- <param name="distance"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Distance.DistanceOp.ClosestPoints(DotSpatial.Topology.IGeometry,DotSpatial.Topology.IGeometry)">
- <summary>
- Compute the the closest points of two geometries.
- The points are presented in the same order as the input Geometries.
- </summary>
- <param name="g0">A <c>Geometry</c>.</param>
- <param name="g1">Another <c>Geometry</c>.</param>
- <returns>The closest points in the geometries.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Distance.DistanceOp.Distance">
- <summary>
- Report the distance between the closest points on the input geometries.
- </summary>
- <returns>The distance between the geometries.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Distance.DistanceOp.ClosestPoints">
- <summary>
- Report the coordinates of the closest points in the input geometries.
- The points are presented in the same order as the input Geometries.
- </summary>
- <returns>A pair of <c>Coordinate</c>s of the closest points.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Distance.DistanceOp.ClosestLocations">
- <summary>
- Report the locations of the closest points in the input geometries.
- The locations are presented in the same order as the input Geometries.
- </summary>
- <returns>A pair of {GeometryLocation}s for the closest points.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Distance.DistanceOp.UpdateMinDistance(DotSpatial.Topology.Operation.Distance.GeometryLocation[],System.Boolean)">
- <summary>
-
- </summary>
- <param name="locGeom"></param>
- <param name="flip"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Distance.DistanceOp.ComputeMinDistance">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Distance.DistanceOp.ComputeContainmentDistance">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Distance.DistanceOp.ComputeInside(System.Collections.IList,System.Collections.IList,DotSpatial.Topology.Operation.Distance.GeometryLocation[])">
- <summary>
-
- </summary>
- <param name="locs"></param>
- <param name="polys"></param>
- <param name="locPtPoly"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Distance.DistanceOp.ComputeInside(DotSpatial.Topology.Operation.Distance.GeometryLocation,DotSpatial.Topology.IGeometry,DotSpatial.Topology.Operation.Distance.GeometryLocation[])">
- <summary>
-
- </summary>
- <param name="ptLoc"></param>
- <param name="poly"></param>
- <param name="locPtPoly"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Distance.DistanceOp.ComputeLineDistance">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Distance.DistanceOp.ComputeMinDistanceLines(System.Collections.IList,System.Collections.IList,DotSpatial.Topology.Operation.Distance.GeometryLocation[])">
- <summary>
-
- </summary>
- <param name="lines0"></param>
- <param name="lines1"></param>
- <param name="locGeom"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Distance.DistanceOp.ComputeMinDistancePoints(System.Collections.IList,System.Collections.IList,DotSpatial.Topology.Operation.Distance.GeometryLocation[])">
- <summary>
-
- </summary>
- <param name="points0"></param>
- <param name="points1"></param>
- <param name="locGeom"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Distance.DistanceOp.ComputeMinDistanceLinesPoints(System.Collections.IList,System.Collections.IList,DotSpatial.Topology.Operation.Distance.GeometryLocation[])">
- <summary>
-
- </summary>
- <param name="lines"></param>
- <param name="points"></param>
- <param name="locGeom"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Distance.DistanceOp.ComputeMinDistance(DotSpatial.Topology.ILineString,DotSpatial.Topology.ILineString,DotSpatial.Topology.Operation.Distance.GeometryLocation[])">
- <summary>
-
- </summary>
- <param name="line0"></param>
- <param name="line1"></param>
- <param name="locGeom"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Distance.DistanceOp.ComputeMinDistance(DotSpatial.Topology.ILineString,DotSpatial.Topology.Point,DotSpatial.Topology.Operation.Distance.GeometryLocation[])">
- <summary>
-
- </summary>
- <param name="line"></param>
- <param name="pt"></param>
- <param name="locGeom"></param>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Distance.GeometryLocation">
- <summary>
- Represents the location of a point on a Geometry.
- Maintains both the actual point location (which of course
- may not be exact) as well as information about the component
- and segment index where the point occurs.
- Locations inside area Geometrys will not have an associated segment index,
- so in this case the segment index will have the sentinel value of InsideArea.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Operation.Distance.GeometryLocation.INSIDE_AREA">
- <summary>
- Special value of segment-index for locations inside area geometries. These
- locations do not have an associated segment index.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Distance.GeometryLocation.#ctor(DotSpatial.Topology.IGeometry,System.Int32,DotSpatial.Topology.Coordinate)">
- <summary>
- Constructs a GeometryLocation specifying a point on a point, as well as the
- segment that the point is on (or InsideArea if the point is not on a segment).
- </summary>
- <param name="component"></param>
- <param name="segIndex"></param>
- <param name="pt"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Distance.GeometryLocation.#ctor(DotSpatial.Topology.IGeometry,DotSpatial.Topology.Coordinate)">
- <summary>
- Constructs a GeometryLocation specifying a point inside an area point.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Distance.GeometryLocation.GeometryComponent">
- <summary>
- Returns the point associated with this location.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Distance.GeometryLocation.SegmentIndex">
- <summary>
- Returns the segment index for this location. If the location is inside an
- area, the index will have the value InsideArea;
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Distance.GeometryLocation.Coordinate">
- <summary>
- Returns the location.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Distance.GeometryLocation.IsInsideArea">
- <summary>
- Returns whether this GeometryLocation represents a point inside an area point.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Operation.GeometryGraphOperation">
- <summary>
- The base class for operations that require <c>GeometryGraph</c>s.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Operation.GeometryGraphOperation.Arg">
- <summary>
- The operation args into an array so they can be accessed by index.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.GeometryGraphOperation.#ctor(DotSpatial.Topology.IGeometry,DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="g0"></param>
- <param name="g1"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.GeometryGraphOperation.#ctor(DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="g0"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.GeometryGraphOperation.GetArgGeometry(System.Int32)">
- <summary>
-
- </summary>
- <param name="i"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.Operation.GeometryGraphOperation.LineIntersector">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Operation.GeometryGraphOperation.ResultPrecisionModel">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Operation.GeometryGraphOperation.ComputationPrecision">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Operation.IsSimpleOp">
- <summary>
- Tests whether a <c>Geometry</c> is simple.
- Only <c>Geometry</c>s whose definition allows them
- to be simple or non-simple are tested. (E.g. Polygons must be simple
- by definition, so no test is provided. To test whether a given Polygon is valid,
- use <c>Geometry.IsValid</c>)
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.IsSimpleOp.IsSimple(DotSpatial.Topology.LineString)">
- <summary>
-
- </summary>
- <param name="geom"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.IsSimpleOp.IsSimple(DotSpatial.Topology.MultiLineString)">
- <summary>
-
- </summary>
- <param name="geom"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.IsSimpleOp.IsSimple(DotSpatial.Topology.MultiPoint)">
- <summary>
- A MultiPoint is simple if it has no repeated points.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.IsSimpleOp.IsSimpleLinearGeometry(DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="geom"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.IsSimpleOp.HasNonEndpointIntersection(DotSpatial.Topology.GeometriesGraph.GeometryGraph)">
- <summary>
- For all edges, check if there are any intersections which are NOT at an endpoint.
- The Geometry is not simple if there are intersections not at endpoints.
- </summary>
- <param name="graph"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.IsSimpleOp.HasClosedEndpointIntersection(DotSpatial.Topology.GeometriesGraph.GeometryGraph)">
- <summary>
- Test that no edge intersection is the
- endpoint of a closed line. To check this we compute the
- degree of each endpoint. The degree of endpoints of closed lines
- must be exactly 2.
- </summary>
- <param name="graph"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.IsSimpleOp.AddEndpoint(System.Collections.IDictionary,DotSpatial.Topology.Coordinate,System.Boolean)">
- <summary>
- Add an endpoint to the map, creating an entry for it if none exists.
- </summary>
- <param name="endPoints"></param>
- <param name="p"></param>
- <param name="isClosed"></param>
- </member>
- <member name="T:DotSpatial.Topology.Operation.IsSimpleOp.EndpointInfo">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.IsSimpleOp.EndpointInfo.#ctor(DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="pt"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.IsSimpleOp.EndpointInfo.AddEndpoint(System.Boolean)">
- <summary>
-
- </summary>
- <param name="isClosed"></param>
- </member>
- <member name="P:DotSpatial.Topology.Operation.IsSimpleOp.EndpointInfo.Point">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Operation.IsSimpleOp.EndpointInfo.IsClosed">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Operation.IsSimpleOp.EndpointInfo.Degree">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Linemerge.EdgeString">
- <summary>
- A sequence of <c>LineMergeDirectedEdge</c>s forming one of the lines that will
- be output by the line-merging process.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Linemerge.EdgeString.#ctor(DotSpatial.Topology.IGeometryFactory)">
- <summary>
- Constructs an EdgeString with the given factory used to convert this EdgeString
- to a LineString.
- </summary>
- <param name="factory"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Linemerge.EdgeString.Add(DotSpatial.Topology.Operation.Linemerge.LineMergeDirectedEdge)">
- <summary>
- Adds a directed edge which is known to form part of this line.
- </summary>
- <param name="directedEdge"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Linemerge.EdgeString.ToLineString">
- <summary>
- Converts this EdgeString into a LineString.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Linemerge.EdgeString.Coordinates">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Linemerge.LineMergeDirectedEdge">
- <summary>
- A <c>com.vividsolutions.jts.planargraph.DirectedEdge</c> of a <c>LineMergeGraph</c>.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Planargraph.DirectedEdge">
- <summary>
- Represents a directed edge in a <c>PlanarGraph</c>. A DirectedEdge may or
- may not have a reference to a parent Edge (some applications of
- planar graphs may not require explicit Edge objects to be created). Usually
- a client using a <c>PlanarGraph</c> will subclass <c>DirectedEdge</c>
- to add its own application-specific data and methods.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Planargraph.GraphComponent">
- <summary>
- The base class for all graph component classes.
- Maintains flags of use in generic graph algorithms.
- Provides two flags:
- marked - typically this is used to indicate a state that persists
- for the course of the graph's lifetime. For instance, it can be
- used to indicate that a component has been logically deleted from the graph.
- visited - this is used to indicate that a component has been processed
- or visited by an single graph algorithm. For instance, a breadth-first traversal of the
- graph might use this to indicate that a node has already been traversed.
- The visited flag may be set and cleared many times during the lifetime of a graph.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.GraphComponent.SetVisited(System.Collections.IEnumerator,System.Boolean)">
- <summary>
- Sets the <see cref="P:DotSpatial.Topology.Planargraph.GraphComponent.IsVisited"/> state
- for all <see cref="T:DotSpatial.Topology.Planargraph.GraphComponent"/>s in an <see cref="T:System.Collections.IEnumerator"/>.
- </summary>
- <param name="i">A <see cref="T:System.Collections.IEnumerator"/> to scan.</param>
- <param name="visited">The state to set the <see cref="P:DotSpatial.Topology.Planargraph.GraphComponent.IsVisited"/> flag to.</param>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.GraphComponent.SetMarked(System.Collections.IEnumerator,System.Boolean)">
- <summary>
- Sets the <see cref="P:DotSpatial.Topology.Planargraph.GraphComponent.IsMarked"/> state
- for all <see cref="T:DotSpatial.Topology.Planargraph.GraphComponent"/>s in an <see cref="T:System.Collections.IEnumerator"/>.
- </summary>
- <param name="i">A <see cref="T:System.Collections.IEnumerator"/> to scan.</param>
- <param name="marked">The state to set the <see cref="P:DotSpatial.Topology.Planargraph.GraphComponent.IsMarked"/> flag to.</param>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.GraphComponent.GetComponentWithVisitedState(System.Collections.IEnumerator,System.Boolean)">
- <summary>
- Finds the first <see cref="T:DotSpatial.Topology.Planargraph.GraphComponent"/>
- in a <see cref="T:System.Collections.IEnumerator"/> set
- which has the specified <see cref="P:DotSpatial.Topology.Planargraph.GraphComponent.IsVisited"/> state.
- </summary>
- <param name="i">A <see cref="T:System.Collections.IEnumerator"/> to scan.</param>
- <param name="visitedState">The <see cref="P:DotSpatial.Topology.Planargraph.GraphComponent.IsVisited"/> state to test.</param>
- <returns>The first <see cref="T:DotSpatial.Topology.Planargraph.GraphComponent"/> found, or <c>null</c> if none found.</returns>
- </member>
- <member name="P:DotSpatial.Topology.Planargraph.GraphComponent.IsVisited">
- <summary>
- Tests if a component has been visited during the course of a graph algorithm.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Planargraph.GraphComponent.IsMarked">
- <summary>
- Tests if a component has been marked at some point during the processing
- involving this graph.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Planargraph.GraphComponent.IsRemoved">
- <summary>
- Tests whether this component has been removed from its containing graph.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.DirectedEdge.#ctor(DotSpatial.Topology.Planargraph.Node,DotSpatial.Topology.Planargraph.Node,DotSpatial.Topology.Coordinate,System.Boolean)">
- <summary>
- Constructs a DirectedEdge connecting the <c>from</c> node to the
- <c>to</c> node.
- </summary>
- <param name="inFrom"></param>
- <param name="inTo"></param>
- <param name="directionPt">
- Specifies this DirectedEdge's direction (given by an imaginary
- line from the <c>from</c> node to <c>directionPt</c>).
- </param>
- <param name="inEdgeDirection">
- Whether this DirectedEdge's direction is the same as or
- opposite to that of the parent Edge (if any).
- </param>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.DirectedEdge.CompareTo(System.Object)">
- <summary>
- Returns 1 if this DirectedEdge has a greater angle with the
- positive x-axis than b", 0 if the DirectedEdges are collinear, and -1 otherwise.
- Using the obvious algorithm of simply computing the angle is not robust,
- since the angle calculation is susceptible to roundoff. A robust algorithm
- is:
- first compare the quadrants. If the quadrants are different, it it
- trivial to determine which vector is "greater".
- if the vectors lie in the same quadrant, the robust
- <c>RobustCgAlgorithms.ComputeOrientation(Coordinate, Coordinate, Coordinate)</c>
- function can be used to decide the relative orientation of the vectors.
- </summary>
- <param name="obj"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.DirectedEdge.ToEdges(System.Collections.IList)">
- <summary>
- Returns a List containing the parent Edge (possibly null) for each of the given
- DirectedEdges.
- </summary>
- <param name="dirEdges"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.DirectedEdge.CompareDirection(DotSpatial.Topology.Planargraph.DirectedEdge)">
- <summary>
- Returns 1 if this DirectedEdge has a greater angle with the
- positive x-axis than b", 0 if the DirectedEdges are collinear, and -1 otherwise.
- Using the obvious algorithm of simply computing the angle is not robust,
- since the angle calculation is susceptible to roundoff. A robust algorithm
- is:
- first compare the quadrants. If the quadrants are different, it it
- trivial to determine which vector is "greater".
- if the vectors lie in the same quadrant, the robust
- <c>RobustCgAlgorithms.ComputeOrientation(Coordinate, Coordinate, Coordinate)</c>
- function can be used to decide the relative orientation of the vectors.
- </summary>
- <param name="e"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.DirectedEdge.Write(System.IO.StreamWriter)">
- <summary>
- Writes a detailed string representation of this DirectedEdge to the given PrintStream.
- </summary>
- <param name="outstream"></param>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.DirectedEdge.Remove">
- <summary>
- Removes this directed edge from its containing graph.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.DirectedEdge.ToString">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.Planargraph.DirectedEdge.Edge">
- <summary>
- Returns this DirectedEdge's parent Edge, or null if it has none.
- Associates this DirectedEdge with an Edge (possibly null, indicating no associated
- Edge).
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Planargraph.DirectedEdge.Quadrant">
- <summary>
- Returns 0, 1, 2, or 3, indicating the quadrant in which this DirectedEdge's
- orientation lies.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Planargraph.DirectedEdge.StartPoint">
- <summary>
- returns a point representing the starting point for a line being drawn
- in order to indicate the directed edges vector direction.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Planargraph.DirectedEdge.EndPoint">
- <summary>
- Returns a point to which an imaginary line is drawn from the from-node to
- specify this DirectedEdge's orientation.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Planargraph.DirectedEdge.EdgeDirection">
- <summary>
- Returns whether the direction of the parent Edge (if any) is the same as that
- of this Directed Edge.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Planargraph.DirectedEdge.FromNode">
- <summary>
- Returns the node from which this DirectedEdge leaves.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Planargraph.DirectedEdge.ToNode">
- <summary>
- Returns the node to which this DirectedEdge goes.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Planargraph.DirectedEdge.Coordinate">
- <summary>
- Returns the coordinate of the from-node.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Planargraph.DirectedEdge.Angle">
- <summary>
- Returns the angle that the start of this DirectedEdge makes with the
- positive x-axis, in radians.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Planargraph.DirectedEdge.Sym">
- <summary>
- Returns the symmetric DirectedEdge -- the other DirectedEdge associated with
- this DirectedEdge's parent Edge.
- Sets this DirectedEdge's symmetric DirectedEdge, which runs in the opposite
- direction.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Planargraph.DirectedEdge.IsRemoved">
- <summary>
- Tests whether this component has been removed from its containing graph.
- </summary>
- <value></value>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Linemerge.LineMergeDirectedEdge.#ctor(DotSpatial.Topology.Planargraph.Node,DotSpatial.Topology.Planargraph.Node,DotSpatial.Topology.Coordinate,System.Boolean)">
- <summary>
- Constructs a LineMergeDirectedEdge connecting the <c>from</c> node to the <c>to</c> node.
- </summary>
- <param name="from"></param>
- <param name="to"></param>
- <param name="directionPt">
- specifies this DirectedEdge's direction (given by an imaginary
- line from the <c>from</c> node to <c>directionPt</c>).
- </param>
- <param name="edgeDirection">
- whether this DirectedEdge's direction is the same as or
- opposite to that of the parent Edge (if any).
- </param>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Linemerge.LineMergeDirectedEdge.Next">
- <summary>
- Returns the directed edge that starts at this directed edge's end point, or null
- if there are zero or multiple directed edges starting there.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Linemerge.LineMergeEdge">
- <summary>
- An edge of a <c>LineMergeGraph</c>. The <c>marked</c> field indicates
- whether this Edge has been logically deleted from the graph.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Planargraph.Edge">
- <summary>
- Represents an undirected edge of a {PlanarGraph}. An undirected edge
- in fact simply acts as a central point of reference for two opposite
- <c>DirectedEdge</c>s.
- Usually a client using a <c>PlanarGraph</c> will subclass <c>Edge</c>
- to add its own application-specific data and methods.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.Edge.#ctor">
- <summary>
- Constructs an Edge whose DirectedEdges are not yet set. Be sure to call
- <c>SetDirectedEdges(DirectedEdge, DirectedEdge)</c>.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.Edge.#ctor(DotSpatial.Topology.Planargraph.DirectedEdge,DotSpatial.Topology.Planargraph.DirectedEdge)">
- <summary>
- Constructs an Edge initialized with the given DirectedEdges, and for each
- DirectedEdge: sets the Edge, sets the symmetric DirectedEdge, and adds
- this Edge to its from-Node.
- </summary>
- <param name="de0"></param>
- <param name="de1"></param>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.Edge.SetDirectedEdges(DotSpatial.Topology.Planargraph.DirectedEdge,DotSpatial.Topology.Planargraph.DirectedEdge)">
- <summary>
- Initializes this Edge's two DirectedEdges, and for each DirectedEdge: sets the
- Edge, sets the symmetric DirectedEdge, and adds this Edge to its from-Node.
- </summary>
- <param name="de0"></param>
- <param name="de1"></param>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.Edge.GetDirEdge(System.Int32)">
- <summary>
- Returns one of the DirectedEdges associated with this Edge.
- </summary>
- <param name="i">0 or 1.</param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.Edge.GetDirEdge(DotSpatial.Topology.Planargraph.Node)">
- <summary>
- Returns the DirectedEdge that starts from the given node, or null if the
- node is not one of the two nodes associated with this Edge.
- </summary>
- <param name="fromNode"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.Edge.GetOppositeNode(DotSpatial.Topology.Planargraph.Node)">
- <summary>
- If <c>node</c> is one of the two nodes associated with this Edge,
- returns the other node; otherwise returns null.
- </summary>
- <param name="node"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.Edge.Remove">
- <summary>
- Removes this edge from its containing graph.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Planargraph.Edge.DirEdge">
- <summary>
- The two DirectedEdges associated with this Edge.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Planargraph.Edge.IsRemoved">
- <summary>
- Tests whether this component has been removed from its containing graph.
- </summary>
- <value></value>
- </member>
- <member name="P:DotSpatial.Topology.Planargraph.Edge.IsVisited">
- <summary>
- The line sequencer class seems to need to se this directly
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Linemerge.LineMergeEdge.#ctor(DotSpatial.Topology.LineString)">
- <summary>
- Constructs a LineMergeEdge with vertices given by the specified LineString.
- </summary>
- <param name="line"></param>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Linemerge.LineMergeEdge.Line">
- <summary>
- Returns the LineString specifying the vertices of this edge.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Linemerge.LineMergeGraph">
- <summary>
- A planar graph of edges that is analyzed to sew the edges together. The
- <c>marked</c> flag on <c>com.vividsolutions.planargraph.Edge</c>s
- and <c>com.vividsolutions.planargraph.Node</c>s indicates whether they have been
- logically deleted from the graph.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Planargraph.PlanarGraph">
- <summary>
- Represents a directed graph which is embeddable in a planar surface.
- This class and the other classes in this package serve as a framework for
- building planar graphs for specific algorithms. This class must be
- subclassed to expose appropriate methods to construct the graph. This allows
- controlling the types of graph components ({DirectedEdge}s,
- <c>Edge</c>s and <c>Node</c>s) which can be added to the graph. An
- application which uses the graph framework will almost always provide
- subclasses for one or more graph components, which hold application-specific
- data and graph algorithms.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.PlanarGraph.FindNode(DotSpatial.Topology.Coordinate)">
- <summary>
- Returns the Node at the given location, or null if no Node was there.
- </summary>
- <param name="pt"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.PlanarGraph.Add(DotSpatial.Topology.Planargraph.Node)">
- <summary>
- Adds a node to the map, replacing any that is already at that location.
- Only subclasses can add Nodes, to ensure Nodes are of the right type.
- </summary>
- <param name="node"></param>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.PlanarGraph.Add(DotSpatial.Topology.Planargraph.Edge)">
- <summary>
- Adds the Edge and its DirectedEdges with this PlanarGraph.
- Assumes that the Edge has already been created with its associated DirectEdges.
- Only subclasses can add Edges, to ensure the edges added are of the right class.
- </summary>
- <param name="edge"></param>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.PlanarGraph.Add(DotSpatial.Topology.Planargraph.DirectedEdge)">
- <summary>
- Adds the Edge to this PlanarGraph; only subclasses can add DirectedEdges,
- to ensure the edges added are of the right class.
- </summary>
- <param name="dirEdge"></param>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.PlanarGraph.GetNodeEnumerator">
- <summary>
- Returns an IEnumerator over the Nodes in this PlanarGraph.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.PlanarGraph.GetDirEdgeEnumerator">
- <summary>
- Returns an Iterator over the DirectedEdges in this PlanarGraph, in the order in which they
- were added.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.PlanarGraph.GetEdgeEnumerator">
- <summary>
- Returns an Iterator over the Edges in this PlanarGraph, in the order in which they
- were added.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.PlanarGraph.Remove(DotSpatial.Topology.Planargraph.Edge)">
- <summary>
- Removes an Edge and its associated DirectedEdges from their from-Nodes and
- from this PlanarGraph. Notice: This method does not remove the Nodes associated
- with the Edge, even if the removal of the Edge reduces the degree of a
- Node to zero.
- </summary>
- <param name="edge"></param>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.PlanarGraph.Remove(DotSpatial.Topology.Planargraph.DirectedEdge)">
- <summary>
- Removes DirectedEdge from its from-Node and from this PlanarGraph. Notice:
- This method does not remove the Nodes associated with the DirectedEdge,
- even if the removal of the DirectedEdge reduces the degree of a Node to
- zero.
- </summary>
- <param name="de"></param>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.PlanarGraph.Remove(DotSpatial.Topology.Planargraph.Node)">
- <summary>
- Removes a node from the graph, along with any associated DirectedEdges and
- Edges.
- </summary>
- <param name="node"></param>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.PlanarGraph.FindNodesOfDegree(System.Int32)">
- <summary>
- Returns all Nodes with the given number of Edges around it.
- </summary>
- <param name="degree"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.Planargraph.PlanarGraph.DirectedEdges">
- <summary>
- Gets or sets the IList of directed edges
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Planargraph.PlanarGraph.Nodes">
- <summary>
- Returns the Nodes in this PlanarGraph.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Planargraph.PlanarGraph.Edges">
- <summary>
- Returns the Edges that have been added to this PlanarGraph.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Linemerge.LineMergeGraph.AddEdge(DotSpatial.Topology.LineString)">
- <summary>
- Adds an Edge, DirectedEdges, and Nodes for the given LineString representation
- of an edge.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Linemerge.LineMergeGraph.GetNode(DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="coordinate"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Linemerge.LineMerger">
- <summary>
- Sews together a set of fully noded LineStrings. Sewing stops at nodes of degree 1
- or 3 or more -- the exception is an isolated loop, which only has degree-2 nodes,
- in which case a node is simply chosen as a starting point. The direction of each
- merged LineString will be that of the majority of the LineStrings from which it
- was derived.
- Any dimension of Geometry is handled -- the constituent linework is extracted to
- form the edges. The edges must be correctly noded; that is, they must only meet
- at their endpoints. The LineMerger will still run on incorrectly noded input
- but will not form polygons from incorrected noded edges.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Linemerge.LineMerger.Add(System.Collections.IList)">
- <summary>
- Adds a collection of Geometries to be processed. May be called multiple times.
- Any dimension of Geometry may be added; the constituent linework will be
- extracted.
- </summary>
- <param name="geometries"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Linemerge.LineMerger.Add(DotSpatial.Topology.Geometry)">
- <summary>
- Adds a Geometry to be processed. May be called multiple times.
- Any dimension of Geometry may be added; the constituent linework will be
- extracted.
- </summary>
- <param name="geometry"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Linemerge.LineMerger.Add(DotSpatial.Topology.LineString)">
- <summary>
-
- </summary>
- <param name="lineString"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Linemerge.LineMerger.Merge">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Linemerge.LineMerger.BuildEdgeStringsForObviousStartNodes">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Linemerge.LineMerger.BuildEdgeStringsForIsolatedLoops">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Linemerge.LineMerger.BuildEdgeStringsForUnprocessedNodes">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Linemerge.LineMerger.BuildEdgeStringsForNonDegree2Nodes">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Linemerge.LineMerger.BuildEdgeStringsStartingAt(DotSpatial.Topology.Planargraph.Node)">
- <summary>
-
- </summary>
- <param name="node"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Linemerge.LineMerger.BuildEdgeStringStartingWith(DotSpatial.Topology.Operation.Linemerge.LineMergeDirectedEdge)">
- <summary>
-
- </summary>
- <param name="start"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Linemerge.LineMerger.MergedLineStrings">
- <summary>
- Returns the LineStrings built by the merging process.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Linemerge.LineMerger.AnonymousGeometryComponentFilterImpl">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Linemerge.LineMerger.AnonymousGeometryComponentFilterImpl.#ctor(DotSpatial.Topology.Operation.Linemerge.LineMerger)">
- <summary>
-
- </summary>
- <param name="container"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Linemerge.LineMerger.AnonymousGeometryComponentFilterImpl.Filter(DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="component"></param>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Overlay.EdgeSetNoder">
- <summary>
- Nodes a set of edges.
- Takes one or more sets of edges and constructs a
- new set of edges consisting of all the split edges created by
- noding the input edges together.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.EdgeSetNoder.#ctor(DotSpatial.Topology.Algorithm.LineIntersector)">
- <summary>
-
- </summary>
- <param name="li"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.EdgeSetNoder.AddEdges(System.Collections.IList)">
- <summary>
-
- </summary>
- <param name="edges"></param>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Overlay.EdgeSetNoder.NodedEdges">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Overlay.LineBuilder">
- <summary>
- Forms NTS LineStrings out of a the graph of <c>DirectedEdge</c>s
- created by an <c>OverlayOp</c>.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.LineBuilder.#ctor(DotSpatial.Topology.Operation.Overlay.OverlayOp,DotSpatial.Topology.IGeometryFactory,DotSpatial.Topology.Algorithm.PointLocator)">
- <summary>
-
- </summary>
- <param name="op"></param>
- <param name="geometryFactory"></param>
- <param name="ptLocator"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.LineBuilder.Build(DotSpatial.Topology.Operation.Overlay.SpatialFunction)">
- <summary>
-
- </summary>
- <param name="opCode"></param>
- <returns>
- A list of the LineStrings in the result of the specified overlay operation.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.LineBuilder.FindCoveredLineEdges">
- <summary>
- Find and mark L edges which are "covered" by the result area (if any).
- L edges at nodes which also have A edges can be checked by checking
- their depth at that node.
- L edges at nodes which do not have A edges can be checked by doing a
- point-in-polygon test with the previously computed result areas.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.LineBuilder.CollectLines(DotSpatial.Topology.Operation.Overlay.SpatialFunction)">
- <summary>
-
- </summary>
- <param name="opCode"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.LineBuilder.CollectLineEdge(DotSpatial.Topology.GeometriesGraph.DirectedEdge,DotSpatial.Topology.Operation.Overlay.SpatialFunction,System.Collections.IList)">
- <summary>
-
- </summary>
- <param name="de"></param>
- <param name="opCode"></param>
- <param name="edges"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.LineBuilder.CollectBoundaryTouchEdge(DotSpatial.Topology.GeometriesGraph.DirectedEdge,DotSpatial.Topology.Operation.Overlay.SpatialFunction,System.Collections.IList)">
- <summary>
- Collect edges from Area inputs which should be in the result but
- which have not been included in a result area.
- This happens ONLY:
- during an intersection when the boundaries of two
- areas touch in a line segment
- OR as a result of a dimensional collapse.
- </summary>
- <param name="de"></param>
- <param name="opCode"></param>
- <param name="edges"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.LineBuilder.BuildLines(DotSpatial.Topology.Operation.Overlay.SpatialFunction)">
- <summary>
-
- </summary>
- <param name="opCode"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.LineBuilder.LabelIsolatedLines(System.Collections.IList)">
- <summary>
-
- </summary>
- <param name="edgesList"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.LineBuilder.LabelIsolatedLine(DotSpatial.Topology.GeometriesGraph.Edge,System.Int32)">
- <summary>
- Label an isolated node with its relationship to the target point.
- </summary>
- <param name="e"></param>
- <param name="targetIndex"></param>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Overlay.MaximalEdgeRing">
- <summary>
- A ring of edges which may contain nodes of degree > 2.
- A MaximalEdgeRing may represent two different spatial entities:
- a single polygon possibly containing inversions (if the ring is oriented CW)
- a single hole possibly containing exversions (if the ring is oriented CCW)
- If the MaximalEdgeRing represents a polygon,
- the interior of the polygon is strongly connected.
- These are the form of rings used to define polygons under some spatial data models.
- However, under the OGC SFS model, MinimalEdgeRings are required.
- A MaximalEdgeRing can be converted to a list of MinimalEdgeRings using the
- <c>BuildMinimalRings()</c> method.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.MaximalEdgeRing.#ctor(DotSpatial.Topology.GeometriesGraph.DirectedEdge,DotSpatial.Topology.IGeometryFactory)">
- <summary>
-
- </summary>
- <param name="start"></param>
- <param name="geometryFactory"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.MaximalEdgeRing.GetNext(DotSpatial.Topology.GeometriesGraph.DirectedEdge)">
- <summary>
-
- </summary>
- <param name="de"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.MaximalEdgeRing.SetEdgeRing(DotSpatial.Topology.GeometriesGraph.DirectedEdge,DotSpatial.Topology.GeometriesGraph.EdgeRing)">
- <summary>
-
- </summary>
- <param name="de"></param>
- <param name="er"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.MaximalEdgeRing.LinkDirectedEdgesForMinimalEdgeRings">
- <summary>
- For all nodes in this EdgeRing,
- link the DirectedEdges at the node to form minimalEdgeRings
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.MaximalEdgeRing.BuildMinimalRings">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Overlay.MinimalEdgeRing">
- <summary>
- A ring of edges with the property that no node
- has degree greater than 2. These are the form of rings required
- to represent polygons under the OGC SFS spatial data model.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.MinimalEdgeRing.#ctor(DotSpatial.Topology.GeometriesGraph.DirectedEdge,DotSpatial.Topology.IGeometryFactory)">
- <summary>
-
- </summary>
- <param name="start"></param>
- <param name="geometryFactory"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.MinimalEdgeRing.GetNext(DotSpatial.Topology.GeometriesGraph.DirectedEdge)">
- <summary>
-
- </summary>
- <param name="de"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.MinimalEdgeRing.SetEdgeRing(DotSpatial.Topology.GeometriesGraph.DirectedEdge,DotSpatial.Topology.GeometriesGraph.EdgeRing)">
- <summary>
-
- </summary>
- <param name="de"></param>
- <param name="er"></param>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Overlay.OverlayNodeFactory">
- <summary>
- Creates nodes for use in the <c>PlanarGraph</c>s constructed during
- overlay operations.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.OverlayNodeFactory.CreateNode(DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="coord"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Overlay.SpatialFunction">
- <summary>
- The spatial functions supported by this class.
- These operations implement various bool combinations of the resultants of the overlay.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Operation.Overlay.SpatialFunction.Intersection">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Operation.Overlay.SpatialFunction.Union">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Operation.Overlay.SpatialFunction.Difference">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Operation.Overlay.SpatialFunction.SymDifference">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Overlay.OverlayOp">
- <summary>
- Computes the overlay of two <c>Geometry</c>s. The overlay
- can be used to determine any bool combination of the geometries.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.OverlayOp.#ctor(DotSpatial.Topology.IGeometry,DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="g0"></param>
- <param name="g1"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.OverlayOp.Overlay(DotSpatial.Topology.IGeometry,DotSpatial.Topology.IGeometry,DotSpatial.Topology.Operation.Overlay.SpatialFunction)">
- <summary>
-
- </summary>
- <param name="geom0"></param>
- <param name="geom1"></param>
- <param name="opCode"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.OverlayOp.IsResultOfOp(DotSpatial.Topology.GeometriesGraph.Label,DotSpatial.Topology.Operation.Overlay.SpatialFunction)">
- <summary>
-
- </summary>
- <param name="label"></param>
- <param name="opCode"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.OverlayOp.IsResultOfOp(DotSpatial.Topology.LocationType,DotSpatial.Topology.LocationType,DotSpatial.Topology.Operation.Overlay.SpatialFunction)">
- <summary>
- This method will handle arguments of Location.NULL correctly.
- </summary>
- <returns><c>true</c> if the locations correspond to the opCode.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.OverlayOp.GetResultGeometry(DotSpatial.Topology.Operation.Overlay.SpatialFunction)">
- <summary>
-
- </summary>
- <param name="funcCode"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.OverlayOp.ComputeOverlay(DotSpatial.Topology.Operation.Overlay.SpatialFunction)">
- <summary>
-
- </summary>
- <param name="opCode"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.OverlayOp.InsertUniqueEdges(System.Collections.IEnumerable)">
- <summary>
-
- </summary>
- <param name="edges"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.OverlayOp.InsertUniqueEdge(DotSpatial.Topology.GeometriesGraph.Edge)">
- <summary>
- Insert an edge from one of the noded input graphs.
- Checks edges that are inserted to see if an
- identical edge already exists.
- If so, the edge is not inserted, but its label is merged
- with the existing edge.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.OverlayOp.ComputeLabelsFromDepths">
- <summary>
- Update the labels for edges according to their depths.
- For each edge, the depths are first normalized.
- Then, if the depths for the edge are equal,
- this edge must have collapsed into a line edge.
- If the depths are not equal, update the label
- with the locations corresponding to the depths
- (i.e. a depth of 0 corresponds to a Location of Exterior,
- a depth of 1 corresponds to Interior)
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.OverlayOp.ReplaceCollapsedEdges">
- <summary>
- If edges which have undergone dimensional collapse are found,
- replace them with a new edge which is a L edge
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.OverlayOp.CopyPoints(System.Int32)">
- <summary>
- Copy all nodes from an arg point into this graph.
- The node label in the arg point overrides any previously computed
- label for that argIndex.
- (E.g. a node may be an intersection node with
- a previously computed label of Boundary,
- but in the original arg Geometry it is actually
- in the interior due to the Boundary Determination Rule)
- </summary>
- <param name="argIndex"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.OverlayOp.ComputeLabelling">
- <summary>
- Compute initial labelling for all DirectedEdges at each node.
- In this step, DirectedEdges will acquire a complete labelling
- (i.e. one with labels for both Geometries)
- only if they
- are incident on a node which has edges for both Geometries
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.OverlayOp.MergeSymLabels">
- <summary>
- For nodes which have edges from only one Geometry incident on them,
- the previous step will have left their dirEdges with no labelling for the other
- Geometry. However, the sym dirEdge may have a labelling for the other
- Geometry, so merge the two labels.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.OverlayOp.UpdateNodeLabelling">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.OverlayOp.LabelIncompleteNodes">
- <summary>
- Incomplete nodes are nodes whose labels are incomplete.
- (e.g. the location for one Geometry is null).
- These are either isolated nodes,
- or nodes which have edges from only a single Geometry incident on them.
- Isolated nodes are found because nodes in one graph which don't intersect
- nodes in the other are not completely labelled by the initial process
- of adding nodes to the nodeList.
- To complete the labelling we need to check for nodes that lie in the
- interior of edges, and in the interior of areas.
- When each node labelling is completed, the labelling of the incident
- edges is updated, to complete their labelling as well.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.OverlayOp.LabelIncompleteNode(DotSpatial.Topology.GeometriesGraph.Node,System.Int32)">
- <summary>
- Label an isolated node with its relationship to the target point.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.OverlayOp.FindResultAreaEdges(DotSpatial.Topology.Operation.Overlay.SpatialFunction)">
- <summary>
- Find all edges whose label indicates that they are in the result area(s),
- according to the operation being performed. Since we want polygon shells to be
- oriented CW, choose dirEdges with the interior of the result on the RHS.
- Mark them as being in the result.
- Interior Area edges are the result of dimensional collapses.
- They do not form part of the result area boundary.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.OverlayOp.CancelDuplicateResultEdges">
- <summary>
- If both a dirEdge and its sym are marked as being in the result, cancel
- them out.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.OverlayOp.IsCoveredByLa(DotSpatial.Topology.Coordinate)">
- <summary>
- This method is used to decide if a point node should be included in the result or not.
- </summary>
- <returns><c>true</c> if the coord point is covered by a result Line or Area point.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.OverlayOp.IsCoveredByA(DotSpatial.Topology.Coordinate)">
- <summary>
- This method is used to decide if an L edge should be included in the result or not.
- </summary>
- <returns><c>true</c> if the coord point is covered by a result Area point.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.OverlayOp.IsCovered(DotSpatial.Topology.Coordinate,System.Collections.IEnumerable)">
- <returns>
- <c>true</c> if the coord is located in the interior or boundary of
- a point in the list.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.OverlayOp.ComputeGeometry(System.Collections.IList,System.Collections.IList,System.Collections.IList)">
- <summary>
-
- </summary>
- <param name="resultPointList"></param>
- <param name="resultLineList"></param>
- <param name="resultPolyList"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Overlay.OverlayOp.Graph">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Overlay.PointBuilder">
- <summary>
- Constructs <c>Point</c>s from the nodes of an overlay graph.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.PointBuilder.#ctor(DotSpatial.Topology.Operation.Overlay.OverlayOp,DotSpatial.Topology.IGeometryFactory)">
- <summary>
-
- </summary>
- <param name="op"></param>
- <param name="geometryFactory"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.PointBuilder.Build(DotSpatial.Topology.Operation.Overlay.SpatialFunction)">
- <summary>
-
- </summary>
- <param name="opCode"></param>
- <returns>
- A list of the Points in the result of the specified overlay operation.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.PointBuilder.CollectNodes(DotSpatial.Topology.Operation.Overlay.SpatialFunction)">
- <summary>
-
- </summary>
- <param name="opCode"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.PointBuilder.SimplifyPoints(System.Collections.IEnumerable)">
- <summary>
- This method simplifies the resultant Geometry by finding and eliminating
- "covered" points.
- A point is covered if it is contained in another element Geometry
- with higher dimension (e.g. a point might be contained in a polygon,
- in which case the point can be eliminated from the resultant).
- </summary>
- <param name="resultNodeList"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Overlay.PolygonBuilder">
- <summary>
- Forms <c>Polygon</c>s out of a graph of {DirectedEdge}s.
- The edges to use are marked as being in the result Area.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.PolygonBuilder.#ctor(DotSpatial.Topology.IGeometryFactory)">
- <summary>
-
- </summary>
- <param name="geometryFactory"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.PolygonBuilder.Add(DotSpatial.Topology.GeometriesGraph.PlanarGraph)">
- <summary>
- Add a complete graph.
- The graph is assumed to contain one or more polygons,
- possibly with holes.
- </summary>
- <param name="graph"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.PolygonBuilder.Add(System.Collections.IList,System.Collections.IList)">
- <summary>
- Add a set of edges and nodes, which form a graph.
- The graph is assumed to contain one or more polygons,
- possibly with holes.
- </summary>
- <param name="dirEdges"></param>
- <param name="nodes"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.PolygonBuilder.BuildMaximalEdgeRings(System.Collections.IEnumerable)">
- <summary>
- For all DirectedEdges in result, form them into MaximalEdgeRings.
- </summary>
- <param name="dirEdges"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.PolygonBuilder.BuildMinimalEdgeRings(System.Collections.IEnumerable,System.Collections.IList,System.Collections.IList)">
- <summary>
-
- </summary>
- <param name="maxEdgeRings"></param>
- <param name="shellList"></param>
- <param name="freeHoleList"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.PolygonBuilder.FindShell(System.Collections.IEnumerable)">
- <summary>
- This method takes a list of MinimalEdgeRings derived from a MaximalEdgeRing,
- and tests whether they form a Polygon. This is the case if there is a single shell
- in the list. In this case the shell is returned.
- The other possibility is that they are a series of connected holes, in which case
- no shell is returned.
- </summary>
- <returns>The shell EdgeRing, if there is one.</returns>
- <returns><c>null</c>, if all the rings are holes.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.PolygonBuilder.PlacePolygonHoles(DotSpatial.Topology.GeometriesGraph.EdgeRing,System.Collections.IEnumerable)">
- <summary>
- This method assigns the holes for a Polygon (formed from a list of
- MinimalEdgeRings) to its shell.
- Determining the holes for a MinimalEdgeRing polygon serves two purposes:
- it is faster than using a point-in-polygon check later on.
- it ensures correctness, since if the PIP test was used the point
- chosen might lie on the shell, which might return an incorrect result from the
- PIP test.
- </summary>
- <param name="shell"></param>
- <param name="minEdgeRings"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.PolygonBuilder.SortShellsAndHoles(System.Collections.IEnumerable,System.Collections.IList,System.Collections.IList)">
- <summary>
- For all rings in the input list,
- determine whether the ring is a shell or a hole
- and add it to the appropriate list.
- Due to the way the DirectedEdges were linked,
- a ring is a shell if it is oriented CW, a hole otherwise.
- </summary>
- <param name="edgeRings"></param>
- <param name="shellList"></param>
- <param name="freeHoleList"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.PolygonBuilder.PlaceFreeHoles(System.Collections.IEnumerable,System.Collections.IEnumerable)">
- <summary>
- This method determines finds a containing shell for all holes
- which have not yet been assigned to a shell.
- These "free" holes should
- all be properly contained in their parent shells, so it is safe to use the
- <c>findEdgeRingContaining</c> method.
- (This is the case because any holes which are NOT
- properly contained (i.e. are connected to their
- parent shell) would have formed part of a MaximalEdgeRing
- and been handled in a previous step).
- </summary>
- <param name="shellList"></param>
- <param name="freeHoleList"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.PolygonBuilder.FindEdgeRingContaining(DotSpatial.Topology.GeometriesGraph.EdgeRing,System.Collections.IEnumerable)">
- <summary>
- Find the innermost enclosing shell EdgeRing containing the argument EdgeRing, if any.
- The innermost enclosing ring is the <i>smallest</i> enclosing ring.
- The algorithm used depends on the fact that:
- ring A contains ring B iff envelope(ring A) contains envelope(ring B).
- This routine is only safe to use if the chosen point of the hole
- is known to be properly contained in a shell
- (which is guaranteed to be the case if the hole does not touch its shell).
- </summary>
- <param name="testEr"></param>
- <param name="shellList"></param>
- <returns>Containing EdgeRing, if there is one, OR
- null if no containing EdgeRing is found.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.PolygonBuilder.ComputePolygons(System.Collections.IEnumerable)">
- <summary>
-
- </summary>
- <param name="shellList"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Overlay.PolygonBuilder.ContainsPoint(DotSpatial.Topology.Coordinate)">
- <summary>
- Checks the current set of shells (with their associated holes) to
- see if any of them contain the point.
- </summary>
- <param name="p"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Overlay.PolygonBuilder.Polygons">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Polygonize.DuplicateEdgeException">
- <summary>
- This exception occurs when the same directed edge appears more than once in the same list
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Polygonize.DuplicateEdgeException.#ctor">
- <summary>
- Creates a new instance of the Duplicate Edge Exception
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Polygonize.EdgeRing">
- <summary>
- Represents a ring of <c>PolygonizeDirectedEdge</c>s which form
- a ring of a polygon. The ring may be either an outer shell or a hole.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Polygonize.EdgeRing.#ctor(DotSpatial.Topology.IGeometryFactory)">
- <summary>
-
- </summary>
- <param name="factory"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Polygonize.EdgeRing.FindEdgeRingContaining(DotSpatial.Topology.Operation.Polygonize.EdgeRing,System.Collections.IList)">
- <summary>
- Find the innermost enclosing shell EdgeRing containing the argument EdgeRing, if any.
- The innermost enclosing ring is the <i>smallest</i> enclosing ring.
- The algorithm used depends on the fact that:
- ring A contains ring B iff envelope(ring A) contains envelope(ring B).
- This routine is only safe to use if the chosen point of the hole
- is known to be properly contained in a shell
- (which is guaranteed to be the case if the hole does not touch its shell).
- </summary>
- <param name="testEr">The EdgeRing to test.</param>
- <param name="shellList">The list of shells to test.</param>
- <returns>Containing EdgeRing, if there is one, OR
- null if no containing EdgeRing is found.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Polygonize.EdgeRing.PtNotInList(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate},System.Collections.Generic.IList{DotSpatial.Topology.Coordinate})">
- <summary>
- Finds a point in a list of points which is not contained in another list of points.
- </summary>
- <param name="testPts">The <c>Coordinate</c>s to test.</param>
- <param name="pts">An array of <c>Coordinate</c>s to test the input points against.</param>
- <returns>A <c>Coordinate</c> from <c>testPts</c> which is not in <c>pts</c>,
- or <c>null</c>.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Polygonize.EdgeRing.IsInList(DotSpatial.Topology.Coordinate,System.Collections.Generic.IList{DotSpatial.Topology.Coordinate})">
- <summary>
- Tests whether a given point is in an array of points.
- Uses a value-based test.
- </summary>
- <param name="pt">A <c>Coordinate</c> for the test point.</param>
- <param name="pts">An array of <c>Coordinate</c>s to test,</param>
- <returns><c>true</c> if the point is in the array.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Polygonize.EdgeRing.Add(DotSpatial.Topology.Planargraph.DirectedEdge)">
- <summary>
- Adds a DirectedEdge which is known to form part of this ring.
- </summary>
- <param name="de">The DirectedEdge to add.</param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Polygonize.EdgeRing.AddHole(DotSpatial.Topology.ILinearRing)">
- <summary>
- Adds a hole to the polygon formed by this ring.
- </summary>
- <param name="hole">The LinearRing forming the hole.</param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Polygonize.EdgeRing.AddEdge(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate},System.Boolean,DotSpatial.Topology.CoordinateList)">
- <summary>
-
- </summary>
- <param name="coords"></param>
- <param name="isForward"></param>
- <param name="coordList"></param>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Polygonize.EdgeRing.IsHole">
- <summary>
- Tests whether this ring is a hole.
- Due to the way the edges in the polyongization graph are linked,
- a ring is a hole if it is oriented counter-clockwise.
- </summary>
- <returns><c>true</c> if this ring is a hole.</returns>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Polygonize.EdgeRing.Polygon">
- <summary>
- Computes and returns the Polygon formed by this ring and any contained holes.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Polygonize.EdgeRing.IsValid">
- <summary>
- Tests if the LinearRing ring formed by this edge ring is topologically valid.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Polygonize.EdgeRing.Coordinates">
- <summary>
- Computes and returns the list of coordinates which are contained in this ring.
- The coordinatea are computed once only and cached.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Polygonize.EdgeRing.LineString">
- <summary>
- Gets the coordinates for this ring as a <c>LineString</c>.
- Used to return the coordinates in this ring
- as a valid point, when it has been detected that the ring is topologically
- invalid.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Polygonize.EdgeRing.Ring">
- <summary>
- Returns this ring as a LinearRing, or null if an Exception occurs while
- creating it (such as a topology problem). Details of problems are written to
- standard output.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Polygonize.LineStringAdder">
- <summary>
- Add every linear element in a point into the polygonizer graph.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Polygonize.LineStringAdder.#ctor(DotSpatial.Topology.Operation.Polygonize.Polygonizer)">
- <summary>
- Creates a new instance of LineStringAdder
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Polygonize.LineStringAdder.Filter(DotSpatial.Topology.IGeometry)">
- <summary>
- Applies the Filter to the specified geometry
- </summary>
- <param name="g"></param>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Polygonize.NullEdgeException">
- <summary>
- A null directed edge exception
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Polygonize.NullEdgeException.#ctor">
- <summary>
- An exception for when the directed edge was null
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Polygonize.PolygonizeDirectedEdge">
- <summary>
- A <c>DirectedEdge</c> of a <c>PolygonizeGraph</c>, which represents
- an edge of a polygon formed by the graph.
- May be logically deleted from the graph by setting the <c>marked</c> flag.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Polygonize.PolygonizeDirectedEdge.#ctor(DotSpatial.Topology.Planargraph.Node,DotSpatial.Topology.Planargraph.Node,DotSpatial.Topology.Coordinate,System.Boolean)">
- <summary>
- Constructs a directed edge connecting the <c>from</c> node to the
- <c>to</c> node.
- </summary>
- <param name="from"></param>
- <param name="to"></param>
- <param name="directionPt">
- Specifies this DirectedEdge's direction (given by an imaginary
- line from the <c>from</c> node to <c>directionPt</c>).
- </param>
- <param name="edgeDirection">
- Whether this DirectedEdge's direction is the same as or
- opposite to that of the parent Edge (if any).
- </param>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Polygonize.PolygonizeDirectedEdge.Label">
- <summary>
- Returns the identifier attached to this directed edge.
- Attaches an identifier to this directed edge.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Polygonize.PolygonizeDirectedEdge.Next">
- <summary>
- Returns the next directed edge in the EdgeRing that this directed edge is a member of.
- Sets the next directed edge in the EdgeRing that this directed edge is a member of.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Polygonize.PolygonizeDirectedEdge.IsInRing">
- <summary>
- Returns the ring of directed edges that this directed edge is
- a member of, or null if the ring has not been set.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Polygonize.PolygonizeDirectedEdge.Ring">
- <summary>
- Gets/Sets the ring of directed edges that this directed edge is
- a member of.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Polygonize.PolygonizeEdge">
- <summary>
- An edge of a polygonization graph.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Polygonize.PolygonizeEdge.#ctor(DotSpatial.Topology.LineString)">
- <summary>
-
- </summary>
- <param name="line"></param>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Polygonize.PolygonizeEdge.Line">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Polygonize.PolygonizeGraph">
- <summary>
- Represents a planar graph of edges that can be used to compute a
- polygonization, and implements the algorithms to compute the
- EdgeRings formed by the graph.
- The marked flag on DirectedEdges is used to indicate that a directed edge
- has be logically deleted from the graph.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Polygonize.PolygonizeGraph.#ctor(DotSpatial.Topology.IGeometryFactory)">
- <summary>
- Create a new polygonization graph.
- </summary>
- <param name="factory"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Polygonize.PolygonizeGraph.GetDegreeNonDeleted(DotSpatial.Topology.Planargraph.Node)">
- <summary>
-
- </summary>
- <param name="node"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Polygonize.PolygonizeGraph.GetDegree(DotSpatial.Topology.Planargraph.Node,System.Int64)">
- <summary>
-
- </summary>
- <param name="node"></param>
- <param name="label"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Polygonize.PolygonizeGraph.DeleteAllEdges(DotSpatial.Topology.Planargraph.Node)">
- <summary>
- Deletes all edges at a node.
- </summary>
- <param name="node"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Polygonize.PolygonizeGraph.AddEdge(DotSpatial.Topology.LineString)">
- <summary>
- Add a <c>LineString</c> forming an edge of the polygon graph.
- </summary>
- <param name="line">The line to add.</param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Polygonize.PolygonizeGraph.GetNode(DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="pt"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Polygonize.PolygonizeGraph.ComputeNextCwEdges">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Polygonize.PolygonizeGraph.ConvertMaximalToMinimalEdgeRings(System.Collections.IEnumerable)">
- <summary>
- Convert the maximal edge rings found by the initial graph traversal
- into the minimal edge rings required by NTS polygon topology rules.
- </summary>
- <param name="ringEdges">The list of start edges for the edgeRings to convert.</param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Polygonize.PolygonizeGraph.FindIntersectionNodes(DotSpatial.Topology.Operation.Polygonize.PolygonizeDirectedEdge,System.Int64)">
- <summary>
- Finds all nodes in a maximal edgering which are self-intersection nodes
- </summary>
- <param name="startDe"></param>
- <param name="label"></param>
- <returns>
- The list of intersection nodes found,
- or null if no intersection nodes were found.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Polygonize.PolygonizeGraph.GetEdgeRings">
- <summary>
- Computes the EdgeRings formed by the edges in this graph.
- </summary>
- <returns>A list of the{EdgeRings found by the polygonization process.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Polygonize.PolygonizeGraph.FindLabeledEdgeRings(System.Collections.IEnumerable)">
- <summary>
-
- </summary>
- <param name="dirEdges">A List of the DirectedEdges in the graph.</param>
- <returns>A List of DirectedEdges, one for each edge ring found.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Polygonize.PolygonizeGraph.DeleteCutEdges">
- <summary>
- Finds and removes all cut edges from the graph.
- </summary>
- <returns>A list of the <c>LineString</c>s forming the removed cut edges.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Polygonize.PolygonizeGraph.Label(System.Collections.IEnumerable,System.Int64)">
- <summary>
-
- </summary>
- <param name="dirEdges"></param>
- <param name="label"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Polygonize.PolygonizeGraph.ComputeNextCwEdges(DotSpatial.Topology.Planargraph.Node)">
- <summary>
-
- </summary>
- <param name="node"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Polygonize.PolygonizeGraph.ComputeNextCcwEdges(DotSpatial.Topology.Planargraph.Node,System.Int64)">
- <summary>
- Computes the next edge pointers going CCW around the given node, for the
- given edgering label.
- This algorithm has the effect of converting maximal edgerings into minimal edgerings
- </summary>
- <param name="node"></param>
- <param name="label"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Polygonize.PolygonizeGraph.FindDirEdgesInRing(DotSpatial.Topology.Operation.Polygonize.PolygonizeDirectedEdge)">
- <summary>
- Traverse a ring of DirectedEdges, accumulating them into a list.
- This assumes that all dangling directed edges have been removed
- from the graph, so that there is always a next dirEdge.
- </summary>
- <param name="startDe">The DirectedEdge to start traversing at.</param>
- <returns>A List of DirectedEdges that form a ring.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Polygonize.PolygonizeGraph.FindEdgeRing(DotSpatial.Topology.Operation.Polygonize.PolygonizeDirectedEdge)">
- <summary>
-
- </summary>
- <param name="startDe"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Polygonize.PolygonizeGraph.DeleteDangles">
- <summary>
- Marks all edges from the graph which are "dangles".
- Dangles are which are incident on a node with degree 1.
- This process is recursive, since removing a dangling edge
- may result in another edge becoming a dangle.
- In order to handle large recursion depths efficiently,
- an explicit recursion stack is used.
- </summary>
- <returns>A List containing the LineStrings that formed dangles.</returns>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Polygonize.Polygonizer">
- <summary>
- Polygonizes a set of Geometrys which contain linework that
- represents the edges of a planar graph.
- Any dimension of Geometry is handled - the constituent linework is extracted
- to form the edges.
- The edges must be correctly noded; that is, they must only meet
- at their endpoints. The Polygonizer will still run on incorrectly noded input
- but will not form polygons from incorrected noded edges.
- The Polygonizer reports the follow kinds of errors:
- Dangles - edges which have one or both ends which are not incident on another edge endpoint
- Cut Edges - edges which are connected at both ends but which do not form part of polygon
- Invalid Ring Lines - edges which form rings which are invalid
- (e.g. the component lines contain a self-intersection).
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Polygonize.Polygonizer.#ctor">
- <summary>
- Create a polygonizer with the same {GeometryFactory}
- as the input <c>Geometry</c>s.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Polygonize.Polygonizer.Add(System.Collections.IList)">
- <summary>
- Add a collection of geometries to be polygonized.
- May be called multiple times.
- Any dimension of Geometry may be added;
- the constituent linework will be extracted and used.
- </summary>
- <param name="geomList">A list of <c>Geometry</c>s with linework to be polygonized.</param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Polygonize.Polygonizer.Add(DotSpatial.Topology.IGeometry)">
- <summary>
- Add a point to the linework to be polygonized.
- May be called multiple times.
- Any dimension of Geometry may be added;
- the constituent linework will be extracted and used
- </summary>
- <param name="g">A <c>Geometry</c> with linework to be polygonized.</param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Polygonize.Polygonizer.Polygonize">
- <summary>
- Perform the polygonization, if it has not already been carried out.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Polygonize.Polygonizer.FindValidRings(System.Collections.IEnumerable,System.Collections.IList,System.Collections.IList)">
- <summary>
-
- </summary>
- <param name="edgeRingList"></param>
- <param name="validEdgeRingList"></param>
- <param name="invalidRingList"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Polygonize.Polygonizer.FindShellsAndHoles(System.Collections.IEnumerable)">
- <summary>
-
- </summary>
- <param name="edgeRingList"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Polygonize.Polygonizer.AssignHolesToShells(System.Collections.IEnumerable,System.Collections.IList)">
- <summary>
-
- </summary>
- <param name="holeList"></param>
- <param name="shellList"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Polygonize.Polygonizer.AssignHoleToShell(DotSpatial.Topology.Operation.Polygonize.EdgeRing,System.Collections.IList)">
- <summary>
-
- </summary>
- <param name="holeEr"></param>
- <param name="shellList"></param>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Polygonize.Polygonizer.Polygons">
- <summary>
- Compute and returns the list of polygons formed by the polygonization.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Polygonize.Polygonizer.Dangles">
- <summary>
- Compute and returns the list of dangling lines found during polygonization.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Polygonize.Polygonizer.CutEdges">
- <summary>
- Compute and returns the list of cut edges found during polygonization.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Polygonize.Polygonizer.InvalidRingLines">
- <summary>
- Compute and returns the list of lines forming invalid rings found during polygonization.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Predicate.RectangleContains">
- <summary>
- Optimized implementation of spatial predicate "contains"
- for cases where the first <c>Geometry</c> is a rectangle.
- As a further optimization,
- this class can be used directly to test many geometries against a single rectangle.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Predicate.RectangleContains.#ctor(DotSpatial.Topology.Polygon)">
- <summary>
- Create a new contains computer for two geometries.
- </summary>
- <param name="rectangle">A rectangular geometry.</param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Predicate.RectangleContains.Contains(DotSpatial.Topology.Polygon,DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="rectangle"></param>
- <param name="b"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Predicate.RectangleContains.Contains(DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="geom"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Predicate.RectangleContains.IsContainedInBoundary(DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="geom"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Predicate.RectangleContains.IsPointContainedInBoundary(DotSpatial.Topology.Coordinate)">
- <summary>
- Given any valid implementation of ICoordinate, which
- will basically provide an X, Y or Z values, this will determine
- if the rectangle contains the point.
- </summary>
- <param name="pt"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Predicate.RectangleContains.IsLineStringContainedInBoundary(DotSpatial.Topology.IBasicGeometry)">
- <summary>
-
- </summary>
- <param name="line"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Predicate.RectangleContains.IsLineSegmentContainedInBoundary(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="p0"></param>
- <param name="p1"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Predicate.RectangleIntersects">
- <summary>
- Optimized implementation of spatial predicate "intersects"
- for cases where the first {@link Geometry} is a rectangle.
- As a further optimization,
- this class can be used directly to test many geometries against a single
- rectangle.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Operation.Predicate.RectangleIntersects.MAXIMUM_SCAN_SEGMENT_COUNT">
- <summary>
- Crossover size at which brute-force intersection scanning
- is slower than indexed intersection detection.
- Must be determined empirically. Should err on the
- safe side by making value smaller rather than larger.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Predicate.RectangleIntersects.#ctor(DotSpatial.Topology.IPolygon)">
- <summary>
- Create a new intersects computer for a rectangle.
- </summary>
- <param name="rectangle">A rectangular geometry.</param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Predicate.RectangleIntersects.Intersects(DotSpatial.Topology.Polygon,DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="rectangle"></param>
- <param name="b"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Predicate.RectangleIntersects.Intersects(DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="geom"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Predicate.EnvelopeIntersectsVisitor">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Predicate.EnvelopeIntersectsVisitor.#ctor(DotSpatial.Topology.IEnvelope)">
- <summary>
-
- </summary>
- <param name="rectEnv"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Predicate.EnvelopeIntersectsVisitor.Intersects">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Predicate.EnvelopeIntersectsVisitor.Visit(DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="element"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Predicate.EnvelopeIntersectsVisitor.IsDone">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Predicate.ContainsPointVisitor">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Predicate.ContainsPointVisitor.#ctor(DotSpatial.Topology.IPolygon)">
- <summary>
-
- </summary>
- <param name="rectangle"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Predicate.ContainsPointVisitor.ContainsPoint">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Predicate.ContainsPointVisitor.Visit(DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="geom"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Predicate.ContainsPointVisitor.IsDone">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Predicate.LineIntersectsVisitor">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Predicate.LineIntersectsVisitor.#ctor(DotSpatial.Topology.IPolygon)">
- <summary>
-
- </summary>
- <param name="rectangle"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Predicate.LineIntersectsVisitor.Intersects">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Predicate.LineIntersectsVisitor.Visit(DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="geom"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Predicate.LineIntersectsVisitor.ComputeSegmentIntersection(DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="geom"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Predicate.LineIntersectsVisitor.IsDone">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Predicate.SegmentIntersectionTester">
- <summary>
- Tests if any line segments in two sets of CoordinateSequences intersect.
- Optimized for small geometry size.
- Short-circuited to return as soon an intersection is found.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Predicate.SegmentIntersectionTester.HasIntersectionWithLineStrings(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate},System.Collections.IList)">
- <summary>
-
- </summary>
- <param name="seq"></param>
- <param name="lines"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Predicate.SegmentIntersectionTester.HasIntersection(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate},System.Collections.Generic.IList{DotSpatial.Topology.Coordinate})">
- <summary>
-
- </summary>
- <param name="seq0"></param>
- <param name="seq1"></param>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Relate.EdgeEndBuilder">
- <summary>
- An EdgeEndBuilder creates EdgeEnds for all the "split edges"
- created by the intersections determined for an Edge.
- Computes the <c>EdgeEnd</c>s which arise from a noded <c>Edge</c>.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Relate.EdgeEndBuilder.ComputeEdgeEnds(System.Collections.IEnumerator)">
- <summary>
-
- </summary>
- <param name="edges"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Relate.EdgeEndBuilder.ComputeEdgeEnds(DotSpatial.Topology.GeometriesGraph.Edge,System.Collections.IList)">
- <summary>
- Creates stub edges for all the intersections in this
- Edge (if any) and inserts them into the graph.
- </summary>
- <param name="edge"></param>
- <param name="l"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Relate.EdgeEndBuilder.CreateEdgeEndForPrev(DotSpatial.Topology.GeometriesGraph.Edge,System.Collections.IList,DotSpatial.Topology.GeometriesGraph.EdgeIntersection,DotSpatial.Topology.GeometriesGraph.EdgeIntersection)">
- <summary>
- Create a EdgeStub for the edge before the intersection eiCurr.
- The previous intersection is provided
- in case it is the endpoint for the stub edge.
- Otherwise, the previous point from the parent edge will be the endpoint.
- eiCurr will always be an EdgeIntersection, but eiPrev may be null.
- </summary>
- <param name="edge"></param>
- <param name="l"></param>
- <param name="eiCurr"></param>
- <param name="eiPrev"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Relate.EdgeEndBuilder.CreateEdgeEndForNext(DotSpatial.Topology.GeometriesGraph.Edge,System.Collections.IList,DotSpatial.Topology.GeometriesGraph.EdgeIntersection,DotSpatial.Topology.GeometriesGraph.EdgeIntersection)">
- <summary>
- Create a StubEdge for the edge after the intersection eiCurr.
- The next intersection is provided
- in case it is the endpoint for the stub edge.
- Otherwise, the next point from the parent edge will be the endpoint.
- eiCurr will always be an EdgeIntersection, but eiNext may be null.
- </summary>
- <param name="edge"></param>
- <param name="l"></param>
- <param name="eiCurr"></param>
- <param name="eiNext"></param>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Relate.EdgeEndBundle">
- <summary>
- A collection of EdgeStubs which obey the following invariant:
- They originate at the same node and have the same direction.
- Contains all <c>EdgeEnd</c>s which start at the same point and are parallel.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Relate.EdgeEndBundle.#ctor(DotSpatial.Topology.GeometriesGraph.EdgeEnd)">
- <summary>
-
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Relate.EdgeEndBundle.GetEnumerator">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Relate.EdgeEndBundle.Insert(DotSpatial.Topology.GeometriesGraph.EdgeEnd)">
- <summary>
-
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Relate.EdgeEndBundle.ComputeLabel">
- <summary>
- This computes the overall edge label for the set of
- edges in this EdgeStubBundle. It essentially merges
- the ON and side labels for each edge.
- These labels must be compatible
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Relate.EdgeEndBundle.ComputeLabelOn(System.Int32)">
- <summary>
- Compute the overall ON location for the list of EdgeStubs.
- (This is essentially equivalent to computing the self-overlay of a single Geometry)
- edgeStubs can be either on the boundary (eg Polygon edge)
- OR in the interior (e.g. segment of a LineString)
- of their parent Geometry.
- In addition, GeometryCollections use the mod-2 rule to determine
- whether a segment is on the boundary or not.
- Finally, in GeometryCollections it can still occur that an edge is both
- on the boundary and in the interior (e.g. a LineString segment lying on
- top of a Polygon edge.) In this case as usual the Boundary is given precendence.
- These observations result in the following rules for computing the ON location:
- if there are an odd number of Bdy edges, the attribute is Bdy
- if there are an even number >= 2 of Bdy edges, the attribute is Int
- if there are any Int edges, the attribute is Int
- otherwise, the attribute is Null.
- </summary>
- <param name="geomIndex"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Relate.EdgeEndBundle.ComputeLabelSides(System.Int32)">
- <summary>
- Compute the labelling for each side
- </summary>
- <param name="geomIndex"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Relate.EdgeEndBundle.ComputeLabelSide(System.Int32,DotSpatial.Topology.GeometriesGraph.PositionType)">
- <summary>
- To compute the summary label for a side, the algorithm is:
- FOR all edges
- IF any edge's location is Interior for the side, side location = Interior
- ELSE IF there is at least one Exterior attribute, side location = Exterior
- ELSE side location = Null
- Notice that it is possible for two sides to have apparently contradictory information
- i.e. one edge side may indicate that it is in the interior of a point, while
- another edge side may indicate the exterior of the same point. This is
- not an incompatibility - GeometryCollections may contain two Polygons that touch
- along an edge. This is the reason for Interior-primacy rule above - it
- results in the summary label having the Geometry interior on both sides.
- </summary>
- <param name="geomIndex"></param>
- <param name="side"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Relate.EdgeEndBundle.UpdateIm(DotSpatial.Topology.IntersectionMatrix)">
- <summary>
- Update the IM with the contribution for the computed label for the EdgeStubs.
- </summary>
- <param name="im"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Relate.EdgeEndBundle.Write(System.IO.StreamWriter)">
- <summary>
-
- </summary>
- <param name="outstream"></param>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Relate.EdgeEndBundle.EdgeEnds">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Relate.EdgeEndBundleStar">
- <summary>
- An ordered list of <c>EdgeEndBundle</c>s around a <c>RelateNode</c>.
- They are maintained in CCW order (starting with the positive x-axis) around the node
- for efficient lookup and topology building.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Relate.EdgeEndBundleStar.Insert(DotSpatial.Topology.GeometriesGraph.EdgeEnd)">
- <summary>
- Insert a EdgeEnd in order in the list.
- If there is an existing EdgeStubBundle which is parallel, the EdgeEnd is
- added to the bundle. Otherwise, a new EdgeEndBundle is created
- to contain the EdgeEnd.
- </summary>
- <param name="e"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Relate.EdgeEndBundleStar.UpdateIm(DotSpatial.Topology.IntersectionMatrix)">
- <summary>
- Update the IM with the contribution for the EdgeStubs around the node.
- </summary>
- <param name="im"></param>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Relate.RelateComputer">
- <summary>
- Computes the topological relationship between two Geometries.
- RelateComputer does not need to build a complete graph structure to compute
- the IntersectionMatrix. The relationship between the geometries can
- be computed by simply examining the labelling of edges incident on each node.
- RelateComputer does not currently support arbitrary GeometryCollections.
- This is because GeometryCollections can contain overlapping Polygons.
- In order to correct compute relate on overlapping Polygons, they
- would first need to be noded and merged (if not explicitly, at least
- implicitly).
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Relate.RelateComputer.#ctor(DotSpatial.Topology.GeometriesGraph.GeometryGraph[])">
- <summary>
-
- </summary>
- <param name="arg"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Relate.RelateComputer.ComputeIm">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Relate.RelateComputer.InsertEdgeEnds(System.Collections.IEnumerable)">
- <summary>
-
- </summary>
- <param name="ee"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Relate.RelateComputer.ComputeProperIntersectionIm(DotSpatial.Topology.GeometriesGraph.Index.SegmentIntersector,DotSpatial.Topology.IIntersectionMatrix)">
- <summary>
-
- </summary>
- <param name="intersector"></param>
- <param name="im"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Relate.RelateComputer.CopyNodesAndLabels(System.Int32)">
- <summary>
- Copy all nodes from an arg point into this graph.
- The node label in the arg point overrides any previously computed
- label for that argIndex.
- (E.g. a node may be an intersection node with
- a computed label of Boundary,
- but in the original arg Geometry it is actually
- in the interior due to the Boundary Determination Rule)
- </summary>
- <param name="argIndex"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Relate.RelateComputer.ComputeIntersectionNodes(System.Int32)">
- <summary>
- Insert nodes for all intersections on the edges of a Geometry.
- Label the created nodes the same as the edge label if they do not already have a label.
- This allows nodes created by either self-intersections or
- mutual intersections to be labelled.
- Endpoint nodes will already be labelled from when they were inserted.
- </summary>
- <param name="argIndex"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Relate.RelateComputer.ComputeDisjointIm(DotSpatial.Topology.IIntersectionMatrix)">
- <summary>
- If the Geometries are disjoint, we need to enter their dimension and
- boundary dimension in the Ext rows in the IM
- </summary>
- <param name="im"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Relate.RelateComputer.LabelNodeEdges">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Relate.RelateComputer.UpdateIm(DotSpatial.Topology.IntersectionMatrix)">
- <summary>
- Update the IM with the sum of the IMs for each component.
- </summary>
- <param name="im"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Relate.RelateComputer.LabelIsolatedEdges(System.Int32,System.Int32)">
- <summary>
- Processes isolated edges by computing their labelling and adding them
- to the isolated edges list.
- Isolated edges are guaranteed not to touch the boundary of the target (since if they
- did, they would have caused an intersection to be computed and hence would
- not be isolated).
- </summary>
- <param name="thisIndex"></param>
- <param name="targetIndex"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Relate.RelateComputer.LabelIsolatedEdge(DotSpatial.Topology.GeometriesGraph.GraphComponent,System.Int32,DotSpatial.Topology.IGeometry)">
- <summary>
- Label an isolated edge of a graph with its relationship to the target point.
- If the target has dim 2 or 1, the edge can either be in the interior or the exterior.
- If the target has dim 0, the edge must be in the exterior.
- </summary>
- <param name="e"></param>
- <param name="targetIndex"></param>
- <param name="target"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Relate.RelateComputer.LabelIsolatedNodes">
- <summary>
- Isolated nodes are nodes whose labels are incomplete
- (e.g. the location for one Geometry is null).
- This is the case because nodes in one graph which don't intersect
- nodes in the other are not completely labelled by the initial process
- of adding nodes to the nodeList.
- To complete the labelling we need to check for nodes that lie in the
- interior of edges, and in the interior of areas.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Relate.RelateComputer.LabelIsolatedNode(DotSpatial.Topology.GeometriesGraph.GraphComponent,System.Int32)">
- <summary>
- Label an isolated node with its relationship to the target point.
- </summary>
- <param name="n"></param>
- <param name="targetIndex"></param>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Relate.RelateNode">
- <summary>
- A RelateNode is a Node that maintains a list of EdgeStubs
- for the edges that are incident on it.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Relate.RelateNode.#ctor(DotSpatial.Topology.Coordinate,DotSpatial.Topology.GeometriesGraph.EdgeEndStar)">
- <summary>
-
- </summary>
- <param name="coord"></param>
- <param name="edges"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Relate.RelateNode.ComputeIm(DotSpatial.Topology.IntersectionMatrix)">
- <summary>
- Update the IM with the contribution for this component.
- A component only contributes if it has a labelling for both parent geometries.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Relate.RelateNode.UpdateImFromEdges(DotSpatial.Topology.IntersectionMatrix)">
- <summary>
- Update the IM with the contribution for the EdgeEnds incident on this node.
- </summary>
- <param name="im"></param>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Relate.RelateNodeFactory">
- <summary>
- Used by the <c>NodeMap</c> in a <c>RelateNodeGraph</c> to create <c>RelateNode</c>s.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Relate.RelateNodeFactory.CreateNode(DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="coord"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Relate.RelateNodeGraph">
- <summary>
- Implements the simple graph of Nodes and EdgeEnd which is all that is
- required to determine topological relationships between Geometries.
- Also supports building a topological graph of a single Geometry, to
- allow verification of valid topology.
- It is not necessary to create a fully linked
- PlanarGraph to determine relationships, since it is sufficient
- to know how the Geometries interact locally around the nodes.
- In fact, this is not even feasible, since it is not possible to compute
- exact intersection points, and hence the topology around those nodes
- cannot be computed robustly.
- The only Nodes that are created are for improper intersections;
- that is, nodes which occur at existing vertices of the Geometries.
- Proper intersections (e.g. ones which occur between the interior of line segments)
- have their topology determined implicitly, without creating a Node object
- to represent them.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Relate.RelateNodeGraph.GetNodeEnumerator">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Relate.RelateNodeGraph.Build(DotSpatial.Topology.GeometriesGraph.GeometryGraph)">
- <summary>
-
- </summary>
- <param name="geomGraph"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Relate.RelateNodeGraph.ComputeIntersectionNodes(DotSpatial.Topology.GeometriesGraph.GeometryGraph,System.Int32)">
- <summary>
- Insert nodes for all intersections on the edges of a Geometry.
- Label the created nodes the same as the edge label if they do not already have a label.
- This allows nodes created by either self-intersections or
- mutual intersections to be labelled.
- Endpoint nodes will already be labelled from when they were inserted.
- Precondition: edge intersections have been computed.
- </summary>
- <param name="geomGraph"></param>
- <param name="argIndex"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Relate.RelateNodeGraph.CopyNodesAndLabels(DotSpatial.Topology.GeometriesGraph.GeometryGraph,System.Int32)">
- <summary>
- Copy all nodes from an arg point into this graph.
- The node label in the arg point overrides any previously computed
- label for that argIndex.
- (E.g. a node may be an intersection node with
- a computed label of Boundary,
- but in the original arg Geometry it is actually
- in the interior due to the Boundary Determination Rule).
- </summary>
- <param name="geomGraph"></param>
- <param name="argIndex"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Relate.RelateNodeGraph.InsertEdgeEnds(System.Collections.IList)">
- <summary>
-
- </summary>
- <param name="ee"></param>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Relate.RelateOp">
- <summary>
- Implements the <c>Relate()</c> operation on <c>Geometry</c>s.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Relate.RelateOp.#ctor(DotSpatial.Topology.IGeometry,DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="g0"></param>
- <param name="g1"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Relate.RelateOp.Relate(DotSpatial.Topology.IGeometry,DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="a"></param>
- <param name="b"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Relate.RelateOp.IntersectionMatrix">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Valid.ConnectedInteriorTester">
- <summary>
- This class tests that the interior of an area <see cref="T:DotSpatial.Topology.Geometry"/>
- (<see cref="T:DotSpatial.Topology.Polygon"/> or <see cref="T:DotSpatial.Topology.MultiPolygon"/>)
- is connected. An area Geometry is invalid if the interior is disconnected.
- This can happen if:
- - a shell self-intersects,
- - one or more holes form a connected chain touching a shell at two different points,
- - one or more holes form a ring around a subset of the interior.
- If a disconnected situation is found the location of the problem is recorded.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.ConnectedInteriorTester.#ctor(DotSpatial.Topology.GeometriesGraph.GeometryGraph)">
- <summary>
-
- </summary>
- <param name="geomGraph"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.ConnectedInteriorTester.FindDifferentPoint(System.Collections.Generic.IEnumerable{DotSpatial.Topology.Coordinate},DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="coord"></param>
- <param name="pt"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.ConnectedInteriorTester.IsInteriorsConnected">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.ConnectedInteriorTester.SetInteriorEdgesInResult(DotSpatial.Topology.GeometriesGraph.PlanarGraph)">
- <summary>
-
- </summary>
- <param name="graph"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.ConnectedInteriorTester.BuildEdgeRings(System.Collections.IList)">
- <summary>
- Form <see cref="T:DotSpatial.Topology.GeometriesGraph.DirectedEdge"/>s in graph into Minimal EdgeRings.
- (Minimal Edgerings must be used, because only they are guaranteed to provide
- a correct isHole computation).
- </summary>
- <param name="dirEdges"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.ConnectedInteriorTester.VisitShellInteriors(DotSpatial.Topology.IGeometry,DotSpatial.Topology.GeometriesGraph.PlanarGraph)">
- <summary>
- Mark all the edges for the edgeRings corresponding to the shells of the input polygons.
- Only ONE ring gets marked for each shell - if there are others which remain unmarked
- this indicates a disconnected interior.
- </summary>
- <param name="g"></param>
- <param name="graph"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.ConnectedInteriorTester.VisitInteriorRing(DotSpatial.Topology.IBasicGeometry,DotSpatial.Topology.GeometriesGraph.PlanarGraph)">
- <summary>
-
- </summary>
- <param name="ring"></param>
- <param name="graph"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.ConnectedInteriorTester.VisitLinkedDirectedEdges(DotSpatial.Topology.GeometriesGraph.DirectedEdge)">
- <summary>
-
- </summary>
- <param name="start"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.ConnectedInteriorTester.HasUnvisitedShellEdge(System.Collections.IList)">
- <summary>
- Check if any shell ring has an unvisited edge.
- A shell ring is a ring which is not a hole and which has the interior
- of the parent area on the RHS.
- (Notice that there may be non-hole rings with the interior on the LHS,
- since the interior of holes will also be polygonized into CW rings
- by the <c>LinkAllDirectedEdges()</c> step).
- </summary>
- <param name="edgeRings"></param>
- <returns><c>true</c> if there is an unvisited edge in a non-hole ring.</returns>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Valid.ConnectedInteriorTester.Coordinate">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Valid.ConsistentAreaTester">
- <summary>
- Checks that a {GeometryGraph} representing an area
- (a <c>Polygon</c> or <c>MultiPolygon</c> )
- is consistent with the SFS semantics for area geometries.
- Checks include:
- Testing for rings which self-intersect (both properly and at nodes).
- Testing for duplicate rings.
- If an inconsistency if found the location of the problem is recorded.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.ConsistentAreaTester.#ctor(DotSpatial.Topology.GeometriesGraph.GeometryGraph)">
- <summary>
-
- </summary>
- <param name="geomGraph"></param>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Valid.ConsistentAreaTester.InvalidPoint">
- <summary>
- Returns the intersection point, or <c>null</c> if none was found.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Valid.ConsistentAreaTester.IsNodeConsistentArea">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Valid.ConsistentAreaTester.IsNodeEdgeAreaLabelsConsistent">
- <summary>
- Check all nodes to see if their labels are consistent.
- If any are not, return false.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Valid.ConsistentAreaTester.HasDuplicateRings">
- <summary>
- Checks for two duplicate rings in an area.
- Duplicate rings are rings that are topologically equal
- (that is, which have the same sequence of points up to point order).
- If the area is topologically consistent (determined by calling the
- <c>isNodeConsistentArea</c>,
- duplicate rings can be found by checking for EdgeBundles which contain more than one EdgeEnd.
- (This is because topologically consistent areas cannot have two rings sharing
- the same line segment, unless the rings are equal).
- The start point of one of the equal rings will be placed in invalidPoint.
- Returns <c>true</c> if this area Geometry is topologically consistent but has two duplicate rings.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Valid.IsValidOp">
- <summary>
- Implements the algorithsm required to compute the <see cref="P:DotSpatial.Topology.Geometry.IsValid"/>
- method for <see cref="T:DotSpatial.Topology.Geometry"/>s.
- See the documentation for the various geometry types for a specification of validity.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Operation.Valid.IsValidOp._isSelfTouchingRingFormingHoleValid">
- If the following condition is TRUE JTS will validate inverted shells and exverted holes (the Esri SDE model).
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.IsValidOp.#ctor(DotSpatial.Topology.Geometry)">
- <summary>
-
- </summary>
- <param name="parentGeometry"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.IsValidOp.IsValidCoordinate(DotSpatial.Topology.Coordinate)">
- <summary>
- Checks whether a coordinate is valid for processing.
- Coordinates are valid iff their x and y ordinates are in the
- range of the floating point representation.
- </summary>
- <param name="coord">The coordinate to validate.</param>
- <returns><c>true</c> if the coordinate is valid.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.IsValidOp.FindPointNotNode(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate},DotSpatial.Topology.ILinearRing,DotSpatial.Topology.GeometriesGraph.GeometryGraph)">
- <summary>
- Find a point from the list of testCoords
- that is NOT a node in the edge for the list of searchCoords.
- </summary>
- <param name="testCoords"></param>
- <param name="searchRing"></param>
- <param name="graph"></param>
- <returns>The point found, or <c>null</c> if none found.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.IsValidOp.CheckValid(DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="g"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.IsValidOp.CheckValidCoordinates(DotSpatial.Topology.IBasicGeometry)">
- <summary>
- Checks validity of a Point.
- </summary>
- <param name="g"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.IsValidOp.CheckValidLineString(DotSpatial.Topology.IGeometry)">
- <summary>
- Checks validity of a LineString.
- Almost anything goes for lineStrings!
- </summary>
- <param name="g"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.IsValidOp.CheckValidRing(DotSpatial.Topology.ILinearRing)">
- <summary>
- Checks validity of a LinearRing.
- </summary>
- <param name="g"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.IsValidOp.CheckValidPolygon(DotSpatial.Topology.IPolygon)">
- <summary>
- Checks the validity of a polygon and sets the validErr flag.
- </summary>
- <param name="g"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.IsValidOp.CheckValidMultipolygon(DotSpatial.Topology.IMultiPolygon)">
- <summary>
-
- </summary>
- <param name="g"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.IsValidOp.CheckValidCollection(DotSpatial.Topology.IGeometryCollection)">
- <summary>
-
- </summary>
- <param name="gc"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.IsValidOp.CheckInvalidCoordinates(System.Collections.Generic.IEnumerable{DotSpatial.Topology.Coordinate})">
- <summary>
-
- </summary>
- <param name="coords"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.IsValidOp.CheckInvalidCoordinates(DotSpatial.Topology.IPolygon)">
- <summary>
-
- </summary>
- <param name="poly"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.IsValidOp.CheckClosedRings(DotSpatial.Topology.IPolygon)">
- <summary>
-
- </summary>
- <param name="poly"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.IsValidOp.CheckClosedRing(DotSpatial.Topology.ILinearRing)">
- <summary>
-
- </summary>
- <param name="ring"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.IsValidOp.CheckTooFewPoints(DotSpatial.Topology.GeometriesGraph.GeometryGraph)">
- <summary>
-
- </summary>
- <param name="graph"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.IsValidOp.CheckConsistentArea(DotSpatial.Topology.GeometriesGraph.GeometryGraph)">
- <summary>
-
- </summary>
- <param name="graph"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.IsValidOp.CheckNoSelfIntersectingRings(DotSpatial.Topology.GeometriesGraph.GeometryGraph)">
- <summary>
- Check that there is no ring which self-intersects (except of course at its endpoints).
- This is required by OGC topology rules (but not by other models
- such as Esri SDE, which allow inverted shells and exverted holes).
- </summary>
- <param name="graph"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.IsValidOp.CheckNoSelfIntersectingRing(DotSpatial.Topology.GeometriesGraph.EdgeIntersectionList)">
- <summary>
- Check that a ring does not self-intersect, except at its endpoints.
- Algorithm is to count the number of times each node along edge occurs.
- If any occur more than once, that must be a self-intersection.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.IsValidOp.CheckHolesInShell(DotSpatial.Topology.IPolygon,DotSpatial.Topology.GeometriesGraph.GeometryGraph)">
- <summary>
- Tests that each hole is inside the polygon shell.
- This routine assumes that the holes have previously been tested
- to ensure that all vertices lie on the shell or inside it.
- A simple test of a single point in the hole can be used,
- provide the point is chosen such that it does not lie on the
- boundary of the shell.
- </summary>
- <param name="p">The polygon to be tested for hole inclusion.</param>
- <param name="graph">A GeometryGraph incorporating the polygon.</param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.IsValidOp.CheckHolesNotNested(DotSpatial.Topology.IPolygon,DotSpatial.Topology.GeometriesGraph.GeometryGraph)">
- <summary>
- Tests that no hole is nested inside another hole.
- This routine assumes that the holes are disjoint.
- To ensure this, holes have previously been tested
- to ensure that:
- They do not partially overlap
- (checked by <c>checkRelateConsistency</c>).
- They are not identical
- (checked by <c>checkRelateConsistency</c>).
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.IsValidOp.CheckShellsNotNested(DotSpatial.Topology.IGeometry,DotSpatial.Topology.GeometriesGraph.GeometryGraph)">
- <summary>
- Tests that no element polygon is wholly in the interior of another element polygon.
- Preconditions:
- Shells do not partially overlap.
- Shells do not touch along an edge.
- No duplicate rings exists.
- This routine relies on the fact that while polygon shells may touch at one or
- more vertices, they cannot touch at ALL vertices.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.IsValidOp.CheckShellNotNested(DotSpatial.Topology.LinearRing,DotSpatial.Topology.Polygon,DotSpatial.Topology.GeometriesGraph.GeometryGraph)">
- <summary>
- Check if a shell is incorrectly nested within a polygon. This is the case
- if the shell is inside the polygon shell, but not inside a polygon hole.
- (If the shell is inside a polygon hole, the nesting is valid.)
- The algorithm used relies on the fact that the rings must be properly contained.
- E.g. they cannot partially overlap (this has been previously checked by
- <c>CheckRelateConsistency</c>).
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.IsValidOp.CheckShellInsideHole(DotSpatial.Topology.LinearRing,DotSpatial.Topology.LinearRing,DotSpatial.Topology.GeometriesGraph.GeometryGraph)">
- <summary>
- This routine checks to see if a shell is properly contained in a hole.
- It assumes that the edges of the shell and hole do not
- properly intersect.
- </summary>
- <param name="shell"></param>
- <param name="hole"></param>
- <param name="graph"></param>
- <returns>
- <c>null</c> if the shell is properly contained, or
- a Coordinate which is not inside the hole if it is not.
- </returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.IsValidOp.CheckConnectedInteriors(DotSpatial.Topology.GeometriesGraph.GeometryGraph)">
- <summary>
-
- </summary>
- <param name="graph"></param>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Valid.IsValidOp.IsSelfTouchingRingFormingHoleValid">
- <summary>
- <para>
- Gets/Sets whether polygons using Self-Touching Rings to form
- holes are reported as valid.
- If this flag is set, the following Self-Touching conditions
- are treated as being valid:
- - The shell ring self-touches to create a hole touching the shell.
- - A hole ring self-touches to create two holes touching at a point.
- </para>
- <para>
- The default (following the OGC SFS standard)
- is that this condition is not valid (<c>false</c>).
- </para>
- <para>
- This does not affect whether Self-Touching Rings
- disconnecting the polygon interior are considered valid
- (these are considered to be invalid under the SFS, and many other
- spatial models as well).
- This includes "bow-tie" shells,
- which self-touch at a single point causing the interior to be disconnected,
- and "C-shaped" holes which self-touch at a single point causing an island to be formed.
- </para>
- </summary>
- <value>States whether geometry with this condition is valid.</value>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Valid.IsValidOp.IsValid">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Valid.IsValidOp.ValidationError">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Valid.QuadtreeNestedRingTester">
- <summary>
- Tests whether any of a set of <c>LinearRing</c>s are
- nested inside another ring in the set, using a <c>Quadtree</c>
- index to speed up the comparisons.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.QuadtreeNestedRingTester.#ctor(DotSpatial.Topology.GeometriesGraph.GeometryGraph)">
- <summary>
-
- </summary>
- <param name="graph"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.QuadtreeNestedRingTester.Add(DotSpatial.Topology.LinearRing)">
- <summary>
-
- </summary>
- <param name="ring"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.QuadtreeNestedRingTester.IsNonNested">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.QuadtreeNestedRingTester.BuildQuadtree">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Valid.QuadtreeNestedRingTester.NestedPoint">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Valid.RepeatedPointTester">
- <summary>
- Implements the appropriate checks for repeated points
- (consecutive identical coordinates) as defined in the
- NTS spec.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.RepeatedPointTester.HasRepeatedPoint(DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="g"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.RepeatedPointTester.HasRepeatedPoint(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate})">
- <summary>
-
- </summary>
- <param name="coord"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.RepeatedPointTester.HasRepeatedPoint(DotSpatial.Topology.IPolygon)">
- <summary>
-
- </summary>
- <param name="p"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.RepeatedPointTester.HasRepeatedPoint(DotSpatial.Topology.IGeometryCollection)">
- <summary>
-
- </summary>
- <param name="gc"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Valid.RepeatedPointTester.Coordinate">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Valid.ShellHoleIdentityException">
- <summary>
- A ShellHoleIdentityException Class
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.ShellHoleIdentityException.#ctor">
- <summary>
- Creates a new instance of ShellHoleIdentityException
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Valid.SimpleNestedRingTester">
- <summary>
- Tests whether any of a set of <c>LinearRing</c>s are
- nested inside another ring in the set, using a simple O(n^2)
- comparison.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.SimpleNestedRingTester.#ctor(DotSpatial.Topology.GeometriesGraph.GeometryGraph)">
- <summary>
-
- </summary>
- <param name="graph"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.SimpleNestedRingTester.Add(DotSpatial.Topology.LinearRing)">
- <summary>
-
- </summary>
- <param name="ring"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.SimpleNestedRingTester.IsNonNested">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Valid.SimpleNestedRingTester.NestedPoint">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Valid.SweeplineNestedRingTester">
- <summary>
- Tests whether any of a set of <c>LinearRing</c>s are
- nested inside another ring in the set, using a <c>SweepLineIndex</c>
- index to speed up the comparisons.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.SweeplineNestedRingTester.#ctor(DotSpatial.Topology.GeometriesGraph.GeometryGraph)">
- <summary>
-
- </summary>
- <param name="graph"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.SweeplineNestedRingTester.Add(DotSpatial.Topology.LinearRing)">
- <summary>
-
- </summary>
- <param name="ring"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.SweeplineNestedRingTester.IsNonNested">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.SweeplineNestedRingTester.BuildIndex">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.SweeplineNestedRingTester.IsInside(DotSpatial.Topology.ILinearRing,DotSpatial.Topology.ILinearRing)">
- <summary>
-
- </summary>
- <param name="innerRing"></param>
- <param name="searchRing"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Valid.SweeplineNestedRingTester.NestedPoint">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Valid.SweeplineNestedRingTester.OverlapAction">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.SweeplineNestedRingTester.OverlapAction.#ctor(DotSpatial.Topology.Operation.Valid.SweeplineNestedRingTester)">
- <summary>
-
- </summary>
- <param name="container"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.SweeplineNestedRingTester.OverlapAction.Overlap(DotSpatial.Topology.Index.Sweepline.SweepLineInterval,DotSpatial.Topology.Index.Sweepline.SweepLineInterval)">
- <summary>
-
- </summary>
- <param name="s0"></param>
- <param name="s1"></param>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Valid.SweeplineNestedRingTester.OverlapAction.IsNonNested">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Valid.TopologyValidationError">
- <summary>
- Contains information about the nature and location of a <c>Geometry</c>
- validation error.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Operation.Valid.TopologyValidationError.ErrMsg">
- <summary>
- These messages must synch up with the indexes above
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.TopologyValidationError.#ctor(DotSpatial.Topology.Operation.Valid.TopologyValidationErrorType,DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="errorType"></param>
- <param name="pt"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.TopologyValidationError.#ctor(DotSpatial.Topology.Operation.Valid.TopologyValidationErrorType)">
- <summary>
-
- </summary>
- <param name="errorType"></param>
- </member>
- <member name="M:DotSpatial.Topology.Operation.Valid.TopologyValidationError.ToString">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Valid.TopologyValidationError.Coordinate">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Valid.TopologyValidationError.ErrorType">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Operation.Valid.TopologyValidationError.Message">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Operation.Valid.TopologyValidationErrorType">
- <summary>
- Contains information about the nature and location of
- a <see cref="T:DotSpatial.Topology.Geometry"/> validation error.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Operation.Valid.TopologyValidationErrorType.Error">
- <summary>
- Not used.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Operation.Valid.TopologyValidationErrorType.RepeatedPoint">
- <summary>
- No longer used:
- repeated points are considered valid as per the SFS.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Operation.Valid.TopologyValidationErrorType.HoleOutsideShell">
- <summary>
- Indicates that a hole of a polygon lies partially
- or completely in the exterior of the shell.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Operation.Valid.TopologyValidationErrorType.NestedHoles">
- <summary>
- Indicates that a hole lies
- in the interior of another hole in the same polygon.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Operation.Valid.TopologyValidationErrorType.DisconnectedInteriors">
- <summary>
- Indicates that the interior of a polygon is disjoint
- (often caused by set of contiguous holes splitting
- the polygon into two parts).
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Operation.Valid.TopologyValidationErrorType.SelfIntersection">
- <summary>
- Indicates that two rings of a polygonal geometry intersect.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Operation.Valid.TopologyValidationErrorType.RingSelfIntersection">
- <summary>
- Indicates that a ring self-intersects.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Operation.Valid.TopologyValidationErrorType.NestedShells">
- <summary>
- Indicates that a polygon component of a
- <see cref="T:DotSpatial.Topology.MultiPolygon"/> lies inside another polygonal component.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Operation.Valid.TopologyValidationErrorType.DuplicateRings">
- <summary>
- Indicates that a polygonal geometry
- contains two rings which are identical.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Operation.Valid.TopologyValidationErrorType.TooFewPoints">
- <summary>
- Indicates that either:
- - A <see cref="T:DotSpatial.Topology.LineString"/> contains a single point.
- - A <see cref="T:DotSpatial.Topology.LinearRing"/> contains 2 or 3 points.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Operation.Valid.TopologyValidationErrorType.InvalidCoordinate">
- <summary>
- Indicates that the <c>X</c> or <c>Y</c> ordinate of
- a <see cref="T:DotSpatial.Topology.Coordinate"/> is not a valid
- numeric value (e.g. <see cref="F:System.Double.NaN"/>).
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Operation.Valid.TopologyValidationErrorType.RingNotClosed">
- <summary>
- Indicates that a ring is not correctly closed
- (the first and the last coordinate are different).
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Planargraph.Algorithm.ConnectedSubgraphFinder">
- <summary>
- Finds all connected <see cref="T:DotSpatial.Topology.Planargraph.Subgraph"/>s of a <see cref="T:DotSpatial.Topology.Planargraph.PlanarGraph"/>.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.Algorithm.ConnectedSubgraphFinder.#ctor(DotSpatial.Topology.Planargraph.PlanarGraph)">
- <summary>
- Initializes a new instance of the ConnectedSubgraphFinder class.
- </summary>
- <param name="graph">The <see cref="T:DotSpatial.Topology.Planargraph.PlanarGraph"/>.</param>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.Algorithm.ConnectedSubgraphFinder.GetConnectedSubgraphs">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.Algorithm.ConnectedSubgraphFinder.AddReachable(DotSpatial.Topology.Planargraph.Node,DotSpatial.Topology.Planargraph.Subgraph)">
- <summary>
- Adds all nodes and edges reachable from this node to the subgraph.
- Uses an explicit stack to avoid a large depth of recursion.
- </summary>
- <param name="startNode"></param>
- <param name="subgraph"></param>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.Algorithm.ConnectedSubgraphFinder.AddEdges(DotSpatial.Topology.Planargraph.Node,System.Collections.Stack,DotSpatial.Topology.Planargraph.Subgraph)">
- <summary>
- Adds the argument node and all its out edges to the subgraph.
- </summary>
- <param name="node"></param>
- <param name="nodeStack"></param>
- <param name="subgraph"></param>
- </member>
- <member name="T:DotSpatial.Topology.Planargraph.DirectedEdgeStar">
- <summary>
- A sorted collection of <c>DirectedEdge</c>s which leave a <c>Node</c>
- in a <c>PlanarGraph</c>.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Planargraph.DirectedEdgeStar._outEdges">
- <summary>
- The underlying list of outgoing DirectedEdges.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.DirectedEdgeStar.Add(DotSpatial.Topology.Planargraph.DirectedEdge)">
- <summary>
- Adds a new member to this DirectedEdgeStar.
- </summary>
- <param name="de"></param>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.DirectedEdgeStar.Remove(DotSpatial.Topology.Planargraph.DirectedEdge)">
- <summary>
- Drops a member of this DirectedEdgeStar.
- </summary>
- <param name="de"></param>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.DirectedEdgeStar.GetEnumerator">
- <summary>
- Returns an Iterator over the DirectedEdges, in ascending order by angle with the positive x-axis.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.DirectedEdgeStar.SortEdges">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.DirectedEdgeStar.GetIndex(DotSpatial.Topology.Planargraph.Edge)">
- <summary>
- Returns the zero-based index of the given Edge, after sorting in ascending order
- by angle with the positive x-axis.
- </summary>
- <param name="edge"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.DirectedEdgeStar.GetIndex(DotSpatial.Topology.Planargraph.DirectedEdge)">
- <summary>
- Returns the zero-based index of the given DirectedEdge, after sorting in ascending order
- by angle with the positive x-axis.
- </summary>
- <param name="dirEdge"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.DirectedEdgeStar.GetIndex(System.Int32)">
- <summary>
- Returns the remainder when i is divided by the number of edges in this
- DirectedEdgeStar.
- </summary>
- <param name="i"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.DirectedEdgeStar.GetNextEdge(DotSpatial.Topology.Planargraph.DirectedEdge)">
- <summary>
- Returns the DirectedEdge on the left-hand side of the given DirectedEdge (which
- must be a member of this DirectedEdgeStar).
- </summary>
- <param name="dirEdge"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.Planargraph.DirectedEdgeStar.OutEdges">
- <summary>
- The underlying list of outgoing Directed Edges
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Planargraph.DirectedEdgeStar.Degree">
- <summary>
- Returns the number of edges around the Node associated with this DirectedEdgeStar.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Planargraph.DirectedEdgeStar.Coordinate">
- <summary>
- Returns the coordinate for the node at wich this star is based.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Planargraph.DirectedEdgeStar.Edges">
- <summary>
- Returns the DirectedEdges, in ascending order by angle with the positive x-axis.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Planargraph.Node">
- <summary>
- A node in a <c>PlanarGraph</c> is a location where 0 or more <c>Edge</c>s
- meet. A node is connected to each of its incident Edges via an outgoing
- DirectedEdge. Some clients using a <c>PlanarGraph</c> may want to
- subclass <c>Node</c> to add their own application-specific
- data and methods.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Planargraph.Node.DeStar">
- <summary>
- The collection of DirectedEdges that leave this Node.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Planargraph.Node._location">
- <summary>
- The location of this Node.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.Node.#ctor(DotSpatial.Topology.Coordinate)">
- <summary>
- Constructs a Node with the given location.
- </summary>
- <param name="location"></param>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.Node.#ctor(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Planargraph.DirectedEdgeStar)">
- <summary>
- Constructs a Node with the given location and collection of outgoing DirectedEdges.
- </summary>
- <param name="location"></param>
- <param name="deStar"></param>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.Node.GetEdgesBetween(DotSpatial.Topology.Planargraph.Node,DotSpatial.Topology.Planargraph.Node)">
- <summary>
- Returns all Edges that connect the two nodes (which are assumed to be different).
- </summary>
- <param name="node0"></param>
- <param name="node1"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.Node.AddOutEdge(DotSpatial.Topology.Planargraph.DirectedEdge)">
- <summary>
- Adds an outgoing DirectedEdge to this Node.
- </summary>
- <param name="de"></param>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.Node.GetIndex(DotSpatial.Topology.Planargraph.Edge)">
- <summary>
- Returns the zero-based index of the given Edge, after sorting in ascending order
- by angle with the positive x-axis.
- </summary>
- <param name="edge"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.Node.Remove">
- <summary>
- Removes this node from its containing graph.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.Node.ToString">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.Planargraph.Node.Coordinate">
- <summary>
- Returns the location of this Node.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Planargraph.Node.OutEdges">
- <summary>
- Returns the collection of DirectedEdges that leave this Node.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Planargraph.Node.Degree">
- <summary>
- Returns the number of edges around this Node.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Planargraph.Node.IsRemoved">
- <summary>
- Tests whether this component has been removed from its containing graph.
- </summary>
- <value></value>
- </member>
- <member name="T:DotSpatial.Topology.Planargraph.NodeMap">
- <summary>
- A map of <c>Node</c>s, indexed by the coordinate of the node.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.NodeMap.Add(DotSpatial.Topology.Planargraph.Node)">
- <summary>
- Adds a node to the map, replacing any that is already at that location.
- </summary>
- <param name="n"></param>
- <returns>The added node.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.NodeMap.Remove(DotSpatial.Topology.Coordinate)">
- <summary>
- Removes the Node at the given location, and returns it (or null if no Node was there).
- </summary>
- <param name="pt"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.NodeMap.Find(DotSpatial.Topology.Coordinate)">
- <summary>
- Returns the Node at the given location, or null if no Node was there.
- </summary>
- <param name="coord"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.NodeMap.GetEnumerator">
- <summary>
- Returns an Iterator over the Nodes in this NodeMap, sorted in ascending order
- by angle with the positive x-axis.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Planargraph.NodeMap.Values">
- <summary>
- Returns the Nodes in this NodeMap, sorted in ascending order
- by angle with the positive x-axis.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Planargraph.Subgraph">
- <summary>
- A subgraph of a <see cref="T:DotSpatial.Topology.Planargraph.PlanarGraph"/>.
- A subgraph may contain any subset of <see cref="T:DotSpatial.Topology.Planargraph.Edge"/>s
- from the parent graph.
- It will also automatically contain all <see cref="T:DotSpatial.Topology.Planargraph.DirectedEdge"/>s
- and <see cref="T:DotSpatial.Topology.Planargraph.Node"/>s associated with those edges.
- No new objects are created when edges are added -
- all associated components must already exist in the parent graph.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Planargraph.Subgraph.DirEdges">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Planargraph.Subgraph.Edges">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Planargraph.Subgraph.NodeMap">
- <summary>
-
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Planargraph.Subgraph.ParentGraph">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.Subgraph.#ctor(DotSpatial.Topology.Planargraph.PlanarGraph)">
- <summary>
- Creates a new subgraph of the given <see cref="T:DotSpatial.Topology.Planargraph.PlanarGraph"/>.
- </summary>
- <param name="parentGraph"></param>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.Subgraph.GetParent">
- <summary>
- Gets the <see cref="T:DotSpatial.Topology.Planargraph.PlanarGraph"/> which this subgraph is part of.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.Subgraph.Add(DotSpatial.Topology.Planargraph.Edge)">
- <summary>
- Adds an <see cref="T:DotSpatial.Topology.Planargraph.Edge"/> to the subgraph.
- The associated <see cref="T:DotSpatial.Topology.Planargraph.DirectedEdge"/>s and <see cref="T:DotSpatial.Topology.Planargraph.Node"/>s are also added.
- </summary>
- <param name="e">The <see cref="T:DotSpatial.Topology.Planargraph.Edge"/> to add.</param>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.Subgraph.GetDirEdgeEnumerator">
- <summary>
- Returns an <see cref="T:System.Collections.IEnumerator"/> over the <see cref="T:DotSpatial.Topology.Planargraph.DirectedEdge"/>s in this graph,
- in the order in which they were added.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.Subgraph.GetEdgeEnumerator">
- <summary>
- Returns an <see cref="T:System.Collections.IEnumerator"/> over the <see cref="T:DotSpatial.Topology.Planargraph.Edge"/>s in this graph,
- in the order in which they were added.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.Subgraph.GetNodeEnumerator">
- <summary>
- Returns an <see cref="T:System.Collections.IEnumerator"/> over the <see cref="T:DotSpatial.Topology.Planargraph.Node"/>s in this graph.
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Planargraph.Subgraph.Contains(DotSpatial.Topology.Planargraph.Edge)">
- <summary>
- Tests whether an <see cref="T:DotSpatial.Topology.Planargraph.Edge"/> is contained in this subgraph.
- </summary>
- <param name="e">The <see cref="T:DotSpatial.Topology.Planargraph.Edge"/> to test.</param>
- <returns><c>true</c> if the <see cref="T:DotSpatial.Topology.Planargraph.Edge"/> is contained in this subgraph.</returns>
- </member>
- <member name="T:DotSpatial.Topology.Precision.CommonBits">
- <summary>
- Determines the maximum number of common most-significant
- bits in the mantissa of one or numbers.
- Can be used to compute the double-precision number which
- is represented by the common bits.
- If there are no common bits, the number computed is 0.0.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Precision.CommonBits.SignExpBits(System.Int64)">
- <summary>
- Computes the bit pattern for the sign and exponent of a
- double-precision number.
- </summary>
- <param name="num"></param>
- <returns>The bit pattern for the sign and exponent.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Precision.CommonBits.NumCommonMostSigMantissaBits(System.Int64,System.Int64)">
- <summary>
- This computes the number of common most-significant bits in the mantissas
- of two double-precision numbers.
- It does not count the hidden bit, which is always 1.
- It does not determine whether the numbers have the same exponent - if they do
- not, the value computed by this function is meaningless.
- </summary>
- <param name="num1"></param>
- /// <param name="num2"></param>
- <returns>The number of common most-significant mantissa bits.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Precision.CommonBits.ZeroLowerBits(System.Int64,System.Int32)">
- <summary>
- Zeroes the lower n bits of a bitstring.
- </summary>
- <param name="bits">The bitstring to alter.</param>
- <param name="nBits">the number of bits to zero.</param>
- <returns>The zeroed bitstring.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Precision.CommonBits.GetBit(System.Int64,System.Int32)">
- <summary>
- Extracts the i'th bit of a bitstring.
- </summary>
- <param name="bits">The bitstring to extract from.</param>
- <param name="i">The bit to extract.</param>
- <returns>The value of the extracted bit.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Precision.CommonBits.Add(System.Double)">
- <summary>
-
- </summary>
- <param name="num"></param>
- </member>
- <member name="M:DotSpatial.Topology.Precision.CommonBits.ToString(System.Int64)">
- <summary>
- A representation of the Double bits formatted for easy readability
- </summary>
- <param name="bits"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.Precision.CommonBits.Common">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Precision.CommonBitsOp">
- <summary>
- Provides versions of Geometry spatial functions which use
- common bit removal to reduce the likelihood of robustness problems.
- In the current implementation no rounding is performed on the
- reshifted result point, which means that it is possible
- that the returned Geometry is invalid.
- Client classes should check the validity of the returned result themselves.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Precision.CommonBitsOp.#ctor">
- <summary>
- Creates a new instance of class, which reshifts result <c>Geometry</c>s.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Precision.CommonBitsOp.#ctor(System.Boolean)">
- <summary>
- Creates a new instance of class, specifying whether
- the result <c>Geometry</c>s should be reshifted.
- </summary>
- <param name="returnToOriginalPrecision"></param>
- </member>
- <member name="M:DotSpatial.Topology.Precision.CommonBitsOp.Intersection(DotSpatial.Topology.IGeometry,DotSpatial.Topology.IGeometry)">
- <summary>
- Computes the set-theoretic intersection of two <c>Geometry</c>s, using enhanced precision.
- </summary>
- <param name="geom0">The first Geometry.</param>
- <param name="geom1">The second Geometry.</param>
- <returns>The Geometry representing the set-theoretic intersection of the input Geometries.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Precision.CommonBitsOp.Union(DotSpatial.Topology.IGeometry,DotSpatial.Topology.IGeometry)">
- <summary>
- Computes the set-theoretic union of two <c>Geometry</c>s, using enhanced precision.
- </summary>
- <param name="geom0">The first Geometry.</param>
- <param name="geom1">The second Geometry.</param>
- <returns>The Geometry representing the set-theoretic union of the input Geometries.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Precision.CommonBitsOp.Difference(DotSpatial.Topology.IGeometry,DotSpatial.Topology.IGeometry)">
- <summary>
- Computes the set-theoretic difference of two <c>Geometry</c>s, using enhanced precision.
- </summary>
- <param name="geom0">The first Geometry.</param>
- <param name="geom1">The second Geometry, to be subtracted from the first.</param>
- <returns>The Geometry representing the set-theoretic difference of the input Geometries.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Precision.CommonBitsOp.SymDifference(DotSpatial.Topology.IGeometry,DotSpatial.Topology.IGeometry)">
- <summary
- > Computes the set-theoretic symmetric difference of two geometries,
- using enhanced precision.
- </summary>
- <param name="geom0">The first Geometry.</param>
- <param name="geom1">The second Geometry.</param>
- <returns>The Geometry representing the set-theoretic symmetric difference of the input Geometries.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Precision.CommonBitsOp.Buffer(DotSpatial.Topology.IGeometry,System.Double)">
- <summary>
- Computes the buffer a point, using enhanced precision.
- </summary>
- <param name="geom0">The Geometry to buffer.</param>
- <param name="distance">The buffer distance.</param>
- <returns>The Geometry representing the buffer of the input Geometry.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Precision.CommonBitsOp.ComputeResultPrecision(DotSpatial.Topology.IGeometry)">
- <summary>
- If required, returning the result to the orginal precision if required.
- In this current implementation, no rounding is performed on the
- reshifted result point, which means that it is possible
- that the returned Geometry is invalid.
- </summary>
- <param name="result">The result Geometry to modify.</param>
- <returns>The result Geometry with the required precision.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Precision.CommonBitsOp.RemoveCommonBits(DotSpatial.Topology.IGeometry)">
- <summary>
- Computes a copy of the input <c>Geometry</c> with the calculated common bits
- removed from each coordinate.
- </summary>
- <param name="geom0">The Geometry to remove common bits from.</param>
- <returns>A copy of the input Geometry with common bits removed.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Precision.CommonBitsOp.RemoveCommonBits(DotSpatial.Topology.IGeometry,DotSpatial.Topology.IGeometry)">
- <summary>
- Computes a copy of each input <c>Geometry</c>s with the calculated common bits
- removed from each coordinate.
- </summary>
- <param name="geom0">An IGeometry to remove common bits from.</param>
- <param name="geom1">An second IGeometry to remove common bits from.</param>
- <returns>
- An array containing copies
- of the input Geometry's with common bits removed.
- </returns>
- </member>
- <member name="T:DotSpatial.Topology.Precision.CommonBitsRemover">
- <summary>
- Allow computing and removing common mantissa bits from one or more Geometries.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Precision.CommonBitsRemover.Add(DotSpatial.Topology.IGeometry)">
- <summary>
- Add a point to the set of geometries whose common bits are
- being computed. After this method has executed the
- common coordinate reflects the common bits of all added
- geometries.
- </summary>
- <param name="geom">A Geometry to test for common bits.</param>
- </member>
- <member name="M:DotSpatial.Topology.Precision.CommonBitsRemover.RemoveCommonBits(DotSpatial.Topology.Geometry)">
- <summary>
- Removes the common coordinate bits from a Geometry.
- The coordinates of the Geometry are changed.
- </summary>
- <param name="geom">The Geometry from which to remove the common coordinate bits.</param>
- <returns>The shifted Geometry.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Precision.CommonBitsRemover.AddCommonBits(DotSpatial.Topology.IGeometry)">
- <summary>
- Adds the common coordinate bits back into a Geometry.
- The coordinates of the Geometry are changed.
- </summary>
- <param name="geom">The Geometry to which to add the common coordinate bits.</param>
- </member>
- <member name="P:DotSpatial.Topology.Precision.CommonBitsRemover.CommonCoordinate">
- <summary>
- The common bits of the Coordinates in the supplied Geometries.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Precision.CommonBitsRemover.CommonCoordinateFilter">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Precision.CommonBitsRemover.CommonCoordinateFilter.Filter(DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="coord"></param>
- </member>
- <member name="P:DotSpatial.Topology.Precision.CommonBitsRemover.CommonCoordinateFilter.CommonCoordinate">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Precision.CommonBitsRemover.Translater">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Precision.CommonBitsRemover.Translater.#ctor(DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="trans"></param>
- </member>
- <member name="M:DotSpatial.Topology.Precision.CommonBitsRemover.Translater.Filter(DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="coord"></param>
- </member>
- <member name="T:DotSpatial.Topology.Precision.EnhancedPrecisionOp">
- <summary>
- Provides versions of Geometry spatial functions which use
- enhanced precision techniques to reduce the likelihood of robustness problems.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Precision.EnhancedPrecisionOp.#ctor">
- <summary>
- Only static methods!
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Precision.EnhancedPrecisionOp.Intersection(DotSpatial.Topology.IGeometry,DotSpatial.Topology.IGeometry)">
- <summary>
- Computes the set-theoretic intersection of two <c>Geometry</c>s, using enhanced precision.
- </summary>
- <param name="geom0">The first Geometry.</param>
- <param name="geom1">The second Geometry.</param>
- <returns>The Geometry representing the set-theoretic intersection of the input Geometries.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Precision.EnhancedPrecisionOp.Union(DotSpatial.Topology.IGeometry,DotSpatial.Topology.IGeometry)">
- <summary>
- Computes the set-theoretic union of two <c>Geometry</c>s, using enhanced precision.
- </summary>
- <param name="geom0">The first Geometry.</param>
- <param name="geom1">The second Geometry.</param>
- <returns>The Geometry representing the set-theoretic union of the input Geometries.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Precision.EnhancedPrecisionOp.Difference(DotSpatial.Topology.IGeometry,DotSpatial.Topology.IGeometry)">
- <summary>
- Computes the set-theoretic difference of two <c>Geometry</c>s, using enhanced precision.
- </summary>
- <param name="geom0">The first Geometry.</param>
- <param name="geom1">The second Geometry.</param>
- <returns>The Geometry representing the set-theoretic difference of the input Geometries.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Precision.EnhancedPrecisionOp.SymDifference(DotSpatial.Topology.IGeometry,DotSpatial.Topology.IGeometry)">
- <summary>
- Computes the set-theoretic symmetric difference of two <c>Geometry</c>s, using enhanced precision.
- </summary>
- <param name="geom0">The first Geometry.</param>
- <param name="geom1">The second Geometry.</param>
- <returns>The Geometry representing the set-theoretic symmetric difference of the input Geometries.</returns>
- </member>
- <member name="M:DotSpatial.Topology.Precision.EnhancedPrecisionOp.Buffer(DotSpatial.Topology.Geometry,System.Double)">
- <summary>
- Computes the buffer of a <c>Geometry</c>, using enhanced precision.
- This method should no longer be necessary, since the buffer algorithm
- now is highly robust.
- </summary>
- <param name="geom">The first Geometry.</param>
- <param name="distance">The buffer distance.</param>
- <returns>The Geometry representing the buffer of the input Geometry.</returns>
- </member>
- <member name="T:DotSpatial.Topology.Precision.SimpleGeometryPrecisionReducer">
- <summary>
- Reduces the precision of a <c>Geometry</c>
- according to the supplied {PrecisionModel}, without
- attempting to preserve valid topology.
- The topology of the resulting point may be invalid if
- topological collapse occurs due to coordinates being shifted.
- It is up to the client to check this and handle it if necessary.
- Collapses may not matter for some uses. An example
- is simplifying the input to the buffer algorithm.
- The buffer algorithm does not depend on the validity of the input point.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Precision.SimpleGeometryPrecisionReducer.#ctor(DotSpatial.Topology.PrecisionModel)">
- <summary>
-
- </summary>
- <param name="pm"></param>
- </member>
- <member name="M:DotSpatial.Topology.Precision.SimpleGeometryPrecisionReducer.Reduce(DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="geom"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.Precision.SimpleGeometryPrecisionReducer.RemoveCollapsedComponents">
- <summary>
- Sets whether the reduction will result in collapsed components
- being removed completely, or simply being collapsed to an (invalid)
- Geometry of the same type.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Precision.SimpleGeometryPrecisionReducer.ChangePrecisionModel">
- <summary>
- Gets/Sets whether the PrecisionModel of the new reduced Geometry
- will be changed to be the PrecisionModel supplied to
- specify the reduction.
- The default is to not change the precision model.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Precision.SimpleGeometryPrecisionReducer.PrecisionReducerCoordinateOperation">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Precision.SimpleGeometryPrecisionReducer.PrecisionReducerCoordinateOperation.#ctor(DotSpatial.Topology.Precision.SimpleGeometryPrecisionReducer)">
- <summary>
-
- </summary>
- <param name="container"></param>
- </member>
- <member name="M:DotSpatial.Topology.Precision.SimpleGeometryPrecisionReducer.PrecisionReducerCoordinateOperation.Edit(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate},DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="coordinates"></param>
- <param name="geom"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.ShouldNeverReachHereException">
- <summary>
- A ShouldNeverReachHereException Class
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.ShouldNeverReachHereException.#ctor">
- <summary>
- Creates a new instance of ShouldNeverReachHereException
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Simplify.DouglasPeuckerLineSimplifier">
- <summary>
- Simplifies a line (sequence of points) using
- the standard Douglas-Peucker algorithm.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.DouglasPeuckerLineSimplifier.#ctor(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate})">
- <summary>
-
- </summary>
- <param name="pts"></param>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.DouglasPeuckerLineSimplifier.Simplify(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate},System.Double)">
- <summary>
-
- </summary>
- <param name="pts"></param>
- <param name="distanceTolerance"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.DouglasPeuckerLineSimplifier.Simplify">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.DouglasPeuckerLineSimplifier.SimplifySection(System.Int32,System.Int32)">
- <summary>
-
- </summary>
- <param name="i"></param>
- <param name="j"></param>
- </member>
- <member name="T:DotSpatial.Topology.Simplify.DouglasPeuckerSimplifier">
- <summary>
- Simplifies a <c>Geometry</c> using the standard Douglas-Peucker algorithm.
- Ensures that any polygonal geometries returned are valid.
- Simple lines are not guaranteed to remain simple after simplification.
- Notice that in general D-P does not preserve topology -
- e.g. polygons can be split, collapse to lines or disappear
- holes can be created or disappear,
- and lines can cross.
- To simplify point while preserving topology use TopologySafeSimplifier.
- (However, using D-P is significantly faster).
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.DouglasPeuckerSimplifier.#ctor(DotSpatial.Topology.Geometry)">
- <summary>
-
- </summary>
- <param name="inputGeom"></param>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.DouglasPeuckerSimplifier.Simplify(DotSpatial.Topology.Geometry,System.Double)">
- <summary>
-
- </summary>
- <param name="geom"></param>
- <param name="distanceTolerance"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.DouglasPeuckerSimplifier.GetResultGeometry">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.Simplify.DouglasPeuckerSimplifier.DistanceTolerance">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Simplify.DouglasPeuckerSimplifier.DpTransformer">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.DouglasPeuckerSimplifier.DpTransformer.#ctor(DotSpatial.Topology.Simplify.DouglasPeuckerSimplifier)">
- <summary>
-
- </summary>
- <param name="container"></param>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.DouglasPeuckerSimplifier.DpTransformer.TransformCoordinates(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate},DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="coords"></param>
- <param name="parent"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.DouglasPeuckerSimplifier.DpTransformer.TransformPolygon(DotSpatial.Topology.IPolygon,DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="geom"></param>
- <param name="parent"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.DouglasPeuckerSimplifier.DpTransformer.TransformMultiPolygon(DotSpatial.Topology.IMultiPolygon)">
- <summary>
-
- </summary>
- <param name="geom"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.DouglasPeuckerSimplifier.DpTransformer.CreateValidArea(DotSpatial.Topology.IGeometry)">
- <summary>
- Creates a valid area point from one that possibly has
- bad topology (i.e. self-intersections).
- Since buffer can handle invalid topology, but always returns
- valid point, constructing a 0-width buffer "corrects" the
- topology.
- Notice this only works for area geometries, since buffer always returns
- areas. This also may return empty geometries, if the input
- has no actual area.
- </summary>
- <param name="roughAreaGeom">An area point possibly containing self-intersections.</param>
- <returns>A valid area point.</returns>
- </member>
- <member name="T:DotSpatial.Topology.Simplify.LineSegmentIndex">
- <summary>
- An index of LineSegments.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.LineSegmentIndex.Add(DotSpatial.Topology.Simplify.TaggedLineString)">
- <summary>
-
- </summary>
- <param name="line"></param>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.LineSegmentIndex.Add(DotSpatial.Topology.LineSegment)">
- <summary>
-
- </summary>
- <param name="seg"></param>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.LineSegmentIndex.Remove(DotSpatial.Topology.LineSegment)">
- <summary>
-
- </summary>
- <param name="seg"></param>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.LineSegmentIndex.Query(DotSpatial.Topology.LineSegment)">
- <summary>
-
- </summary>
- <param name="querySeg"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.Simplify.LineSegmentVisitor">
- <summary>
- ItemVisitor subclass to reduce volume of query results.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.LineSegmentVisitor.#ctor(DotSpatial.Topology.LineSegment)">
- <summary>
-
- </summary>
- <param name="querySeg"></param>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.LineSegmentVisitor.VisitItem(System.Object)">
- <summary>
-
- </summary>
- <param name="item"></param>
- </member>
- <member name="P:DotSpatial.Topology.Simplify.LineSegmentVisitor.Items">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Simplify.TaggedLineSegment">
- <summary>
- A LineSegment which is tagged with its location in a <c>Geometry</c>.
- Used to index the segments in a point and recover the segment locations
- from the index.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.TaggedLineSegment.#ctor(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate,DotSpatial.Topology.IGeometry,System.Int32)">
- <summary>
-
- </summary>
- <param name="p0"></param>
- <param name="p1"></param>
- <param name="parent"></param>
- <param name="index"></param>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.TaggedLineSegment.#ctor(DotSpatial.Topology.Coordinate,DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="p0"></param>
- <param name="p1"></param>
- </member>
- <member name="P:DotSpatial.Topology.Simplify.TaggedLineSegment.Parent">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Simplify.TaggedLineSegment.Index">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Simplify.TaggedLinesSimplifier">
- <summary>
- Simplifies a collection of TaggedLineStrings, preserving topology
- (in the sense that no new intersections are introduced).
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.TaggedLinesSimplifier.Simplify(System.Collections.IList)">
- <summary>
- Simplify a collection of <c>TaggedLineString</c>s.
- </summary>
- <param name="taggedLines">The collection of lines to simplify.</param>
- </member>
- <member name="P:DotSpatial.Topology.Simplify.TaggedLinesSimplifier.DistanceTolerance">
- <summary>
- Gets/Sets the distance tolerance for the simplification.
- Points closer than this tolerance to a simplified segment may
- be removed.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Simplify.TaggedLineString">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.TaggedLineString.#ctor(DotSpatial.Topology.LineString)">
- <summary>
-
- </summary>
- <param name="parentLine"></param>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.TaggedLineString.#ctor(DotSpatial.Topology.LineString,System.Int32)">
- <summary>
-
- </summary>
- <param name="parentLine"></param>
- <param name="minimumSize"></param>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.TaggedLineString.GetSegment(System.Int32)">
- <summary>
-
- </summary>
- <param name="i"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.TaggedLineString.Init">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.TaggedLineString.AddToResult(DotSpatial.Topology.LineSegment)">
- <summary>
-
- </summary>
- <param name="seg"></param>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.TaggedLineString.AsLineString">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.TaggedLineString.AsLinearRing">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.TaggedLineString.ExtractCoordinates(System.Collections.IList)">
- <summary>
-
- </summary>
- <param name="segs"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.Simplify.TaggedLineString.MinimumSize">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Simplify.TaggedLineString.Parent">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Simplify.TaggedLineString.ParentCoordinates">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Simplify.TaggedLineString.ResultCoordinates">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Simplify.TaggedLineString.ResultSize">
- <summary>
-
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Simplify.TaggedLineString.Segments">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Simplify.TaggedLineStringSimplifier">
- <summary>
- Simplifies a TaggedLineString, preserving topology
- (in the sense that no new intersections are introduced).
- Uses the recursive D-P algorithm.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.TaggedLineStringSimplifier.#ctor(DotSpatial.Topology.Simplify.LineSegmentIndex,DotSpatial.Topology.Simplify.LineSegmentIndex)">
- <summary>
-
- </summary>
- <param name="inputIndex"></param>
- <param name="outputIndex"></param>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.TaggedLineStringSimplifier.Simplify(DotSpatial.Topology.Simplify.TaggedLineString)">
- <summary>
-
- </summary>
- <param name="line"></param>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.TaggedLineStringSimplifier.SimplifySection(System.Int32,System.Int32,System.Int32)">
- <summary>
-
- </summary>
- <param name="i"></param>
- <param name="j"></param>
- <param name="depth"></param>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.TaggedLineStringSimplifier.FindFurthestPoint(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate},System.Int32,System.Int32,System.Double[])">
- <summary>
-
- </summary>
- <param name="pts"></param>
- <param name="i"></param>
- <param name="j"></param>
- <param name="maxDistance"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.TaggedLineStringSimplifier.Flatten(System.Int32,System.Int32)">
- <summary>
-
- </summary>
- <param name="start"></param>
- <param name="end"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.TaggedLineStringSimplifier.HasBadIntersection(DotSpatial.Topology.Simplify.TaggedLineString,System.Int32[],DotSpatial.Topology.LineSegment)">
- <summary>
-
- </summary>
- <param name="parentLine"></param>
- <param name="sectionIndex"></param>
- <param name="candidateSeg"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.TaggedLineStringSimplifier.HasBadOutputIntersection(DotSpatial.Topology.LineSegment)">
- <summary>
-
- </summary>
- <param name="candidateSeg"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.TaggedLineStringSimplifier.HasBadInputIntersection(DotSpatial.Topology.Simplify.TaggedLineString,System.Int32[],DotSpatial.Topology.LineSegment)">
- <summary>
-
- </summary>
- <param name="parentLine"></param>
- <param name="sectionIndex"></param>
- <param name="candidateSeg"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.TaggedLineStringSimplifier.IsInLineSection(DotSpatial.Topology.Simplify.TaggedLineString,System.Int32[],DotSpatial.Topology.Simplify.TaggedLineSegment)">
- <summary>
- Tests whether a segment is in a section of a TaggedLineString-
- </summary>
- <param name="line"></param>
- <param name="sectionIndex"></param>
- <param name="seg"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.TaggedLineStringSimplifier.HasInteriorIntersection(DotSpatial.Topology.ILineSegmentBase,DotSpatial.Topology.ILineSegmentBase)">
- <summary>
-
- </summary>
- <param name="seg0"></param>
- <param name="seg1"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.TaggedLineStringSimplifier.Remove(DotSpatial.Topology.Simplify.TaggedLineString,System.Int32,System.Int32)">
- <summary>
- Remove the segs in the section of the line.
- </summary>
- <param name="line"></param>
- <param name="start"></param>
- <param name="end"></param>
- </member>
- <member name="P:DotSpatial.Topology.Simplify.TaggedLineStringSimplifier.DistanceTolerance">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Simplify.TopologyPreservingSimplifier">
- <summary>
- Simplifies a point, ensuring that
- the result is a valid point having the
- same dimension and number of components as the input.
- The simplification uses a maximum distance difference algorithm
- similar to the one used in the Douglas-Peucker algorithm.
- In particular, if the input is an areal point
- ( <c>Polygon</c> or <c>MultiPolygon</c> )
- The result has the same number of shells and holes (rings) as the input,
- in the same order
- The result rings touch at no more than the number of touching point in the input
- (although they may touch at fewer points).
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.TopologyPreservingSimplifier.#ctor(DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="inputGeom"></param>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.TopologyPreservingSimplifier.Simplify(DotSpatial.Topology.IGeometry,System.Double)">
- <summary>
-
- </summary>
- <param name="geom"></param>
- <param name="distanceTolerance"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.TopologyPreservingSimplifier.GetResultGeometry">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.Simplify.TopologyPreservingSimplifier.DistanceTolerance">
- <summary>
-
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Simplify.TopologyPreservingSimplifier.LineStringMapBuilderFilter">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.TopologyPreservingSimplifier.LineStringMapBuilderFilter.#ctor(DotSpatial.Topology.Simplify.TopologyPreservingSimplifier)">
- <summary>
-
- </summary>
- <param name="container"></param>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.TopologyPreservingSimplifier.LineStringMapBuilderFilter.Filter(DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="geom"></param>
- </member>
- <member name="T:DotSpatial.Topology.Simplify.TopologyPreservingSimplifier.LineStringTransformer">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.TopologyPreservingSimplifier.LineStringTransformer.#ctor(DotSpatial.Topology.Simplify.TopologyPreservingSimplifier)">
- <summary>
-
- </summary>
- <param name="container"></param>
- </member>
- <member name="M:DotSpatial.Topology.Simplify.TopologyPreservingSimplifier.LineStringTransformer.TransformCoordinates(System.Collections.Generic.IList{DotSpatial.Topology.Coordinate},DotSpatial.Topology.IGeometry)">
- <summary>
-
- </summary>
- <param name="coords"></param>
- <param name="parent"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.Utilities.Assert">
- <summary>
- A utility for making programming assertions.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.Assert.#ctor">
- <summary>
- Only static methods!
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.Assert.IsTrue(System.Boolean)">
- <summary>
-
- </summary>
- <param name="assertion"></param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.Assert.IsTrue(System.Boolean,System.String)">
- <summary>
-
- </summary>
- <param name="assertion"></param>
- <param name="message"></param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.Assert.IsEquals(System.Object,System.Object)">
- <summary>
-
- </summary>
- <param name="expectedValue"></param>
- <param name="actualValue"></param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.Assert.IsEquals(System.Object,System.Object,System.String)">
- <summary>
-
- </summary>
- <param name="expectedValue"></param>
- <param name="actualValue"></param>
- <param name="message"></param>
- </member>
- <member name="T:DotSpatial.Topology.Utilities.AssertionFailedException">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.AssertionFailedException.#ctor">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.AssertionFailedException.#ctor(System.String)">
- <summary>
-
- </summary>
- <param name="message"></param>
- </member>
- <member name="T:DotSpatial.Topology.Utilities.CollectionUtil">
- <summary>
- Executes a transformation function on each element of a collection
- and returns the results in a new List.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.CollectionUtil.Transform(System.Collections.ICollection,DotSpatial.Topology.Utilities.CollectionUtil.GenericMethod{System.Object})">
- <summary>
- Executes a function on each item in a <see cref="T:System.Collections.ICollection"/>
- and returns the results in a new <see cref="T:System.Collections.IList"/>.
- </summary>
- <param name="coll"></param>
- <param name="func"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.CollectionUtil.Apply(System.Collections.ICollection,DotSpatial.Topology.Utilities.CollectionUtil.GenericMethod{System.Object})">
- <summary>
- Executes a function on each item in a <see cref="T:System.Collections.ICollection"/>
- but does not accumulate the result.
- </summary>
- <param name="coll"></param>
- <param name="func"></param>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.CollectionUtil.Select(System.Collections.ICollection,DotSpatial.Topology.Utilities.CollectionUtil.GenericMethod{System.Object})">
- <summary>
- Executes a function on each item in a <see cref="T:System.Collections.ICollection"/>
- and collects all the entries for which the result
- of the function is equal to <c>true</c>.
- </summary>
- <param name="coll"></param>
- <param name="func"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.Utilities.CollectionUtil.GenericMethod`1">
- <summary>
- The FunctionDelegate defines a structure taking a strong type in and passing a member of the same type back out.
- </summary>
- <typeparam name="T">The type for the method.</typeparam>
- <param name="obj">The object parameter for the method.</param>
- <returns>An object of type T.</returns>
- </member>
- <member name="T:DotSpatial.Topology.Utilities.Global">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.Global.GetNfi">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.Utilities.HexConverter">
- <summary>
-
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.HexConverter.#ctor">
- <summary>
- Only static methods!
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.HexConverter.ConvertAny2Any(System.String,System.Int32,System.Int32)">
- <summary>
- Convert the given numeric value (passed as string) of the base specified by <c>baseIn</c>
- to the value specified by <c>baseOut</c>.
- </summary>
- <param name="valueIn">Numeric value to be converted, as string.</param>
- <param name="baseIn">Base of input value.</param>
- <param name="baseOut">Base to use for conversion.</param>
- <returns>Converted value, as string.</returns>
- </member>
- <member name="T:DotSpatial.Topology.Utilities.UniqueCoordinateArrayFilter">
- <summary>
- A <c>CoordinateFilter</c> that builds a set of <c>Coordinate</c>s.
- The set of coordinates contains no duplicate points.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Utilities.UniqueCoordinateArrayFilter.Filter(DotSpatial.Topology.Coordinate)">
- <summary>
-
- </summary>
- <param name="coord"></param>
- </member>
- <member name="P:DotSpatial.Topology.Utilities.UniqueCoordinateArrayFilter.Coordinates">
- <summary>
- Returns the gathered <c>Coordinate</c>s.
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Voronoi.Fortune">
- <summary>
- Contains static methods and parameters that organize the major elements of
- applying the Fortune linesweep methods
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Voronoi.Fortune.VVUnkown">
- <summary>
- The default definition of a coordinate that uses double.NaN to clarify
- that no value has yet been assigned to this vector.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Voronoi.Fortune.VVInfinite">
- <summary>
- Represents an infinite vector location
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Voronoi.Fortune.DoCleanup">
- <summary>
- Boolean, true if the cleanup method should be called. This is unnecessary, for
- the mapwindow implementation and will in fact cause the implementation to break
- because infinities and other bad values start showing up.
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Voronoi.Fortune.ComputeVoronoiGraph(System.Double[],System.Double,System.Boolean)">
- <summary>
- Calculates the voronoi graph, but specifies a tolerance below which values should be considered equal.
- </summary>
- <param name="vertices">The original points to use during the calculation</param>
- <param name="tolerance">A double value that controls the test for equality</param>
- <param name="cleanup">This for Ben's code and should be passed as true if cleanup should be done.</param>
- <returns>A VoronoiGraph structure containing the output geometries</returns>
- </member>
- <member name="M:DotSpatial.Topology.Voronoi.Fortune.ComputeVoronoiGraph(System.Double[])">
- <summary>
- Calculates a list of edges and junction vertices by using the specified points.
- This defaults to not using any tolerance for determining if points are equal,
- and will not use the cleanup algorithm, which breaks the HandleBoundaries
- method in the Voronoi class.
- </summary>
- <param name="vertices">The original points to use during the calculation</param>
- <returns>A VoronoiGraph structure containing the output geometries</returns>
- </member>
- <member name="M:DotSpatial.Topology.Voronoi.Fortune.FilterVg(DotSpatial.Topology.Voronoi.VoronoiGraph,System.Double)">
- <summary>
- Applies an optional cleanup method needed by Benjamine Ditter for
- laser data calculations. This is not used by the MapWindow calculations
- </summary>
- <param name="vg">The output voronoi graph created in the Compute Voronoi Graph section</param>
- <param name="minLeftRightDist">A minimum left to right distance</param>
- <returns>The Voronoi Graph after it has been filtered.</returns>
- </member>
- <member name="T:DotSpatial.Topology.Voronoi.HashSet`1">
- <summary>
- The HashSet is a dictionary that provides the optimized
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Voronoi.HashSet`1.Add(`0)">
- <summary>
- Adds the specified object to the hash set collection
- </summary>
- <param name="item">The object to add</param>
- </member>
- <member name="M:DotSpatial.Topology.Voronoi.HashSet`1.GetEnumerator">
- <summary>
- Gets the enumerator of the items in the set
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Voronoi.HashSet`1.CopyTo(`0[],System.Int32)">
- <summary>
- Copies the members of this hash set to the specified array, starting at the specified index
- </summary>
- <param name="array"></param>
- <param name="index"></param>
- </member>
- <member name="M:DotSpatial.Topology.Voronoi.HashSet`1.Clear">
- <summary>
- Clears the entire set
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Voronoi.HashSet`1.Contains(`0)">
- <summary>
- Gets a boolean indicating if the specified item is in the set
- </summary>
- <param name="item"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Voronoi.HashSet`1.Remove(`0)">
- <summary>
- Removes the specified item
- </summary>
- <param name="item"></param>
- <returns></returns>
- </member>
- <member name="P:DotSpatial.Topology.Voronoi.HashSet`1.Count">
- <summary>
- Gets the integer count of members in this set
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Voronoi.HashSet`1.IsReadOnly">
- <summary>
- These sets can be modified
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Voronoi.MathTools">
- <summary>
- Contains several helpful tools that allow the voronoi polygon creation to work
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Voronoi.MathTools.Dist(System.Double,System.Double,System.Double,System.Double)">
- <summary>
- Calculates the euclidean distance
- </summary>
- <param name="x1"></param>
- <param name="y1"></param>
- <param name="x2"></param>
- <param name="y2"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Voronoi.MathTools.Ccw(System.Double,System.Double,System.Double,System.Double,System.Double,System.Double,System.Boolean)">
- <summary>
-
- </summary>
- <param name="p0X"></param>
- <param name="p0Y"></param>
- <param name="p1X"></param>
- <param name="p1Y"></param>
- <param name="p2X"></param>
- <param name="p2Y"></param>
- <param name="plusOneOnZeroDegrees"></param>
- <returns></returns>
- </member>
- <member name="T:DotSpatial.Topology.Voronoi.Vector2">
- <summary>
- A vector class, implementing all interesting features of vectors
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Voronoi.Vector2.Tolerance">
- <summary>
- This double controls the test for equality so that values that
- are smaller than this value will be considered equal.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Voronoi.Vector2.X">
- <summary>
- The x coordinate
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Voronoi.Vector2.Y">
- <summary>
- The y coordinate
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Voronoi.Vector2.#ctor(System.Double[],System.Int32)">
- <summary>
- Creates a vector by reading a long array of vertices and assigning the vector based on that
- </summary>
- <param name="xyvertices"></param>
- <param name="offset"></param>
- </member>
- <member name="M:DotSpatial.Topology.Voronoi.Vector2.#ctor(System.Double[])">
- <summary>
- Build a new vector
- </summary>
- <param name="x">The elements of the vector</param>
- </member>
- <member name="M:DotSpatial.Topology.Voronoi.Vector2.ToCoordinate">
- <summary>
- Transforms the vector into a coordinate with an x and y value
- </summary>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Voronoi.Vector2.ContainsNan">
- <summary>
- True if any of the double values is not a number
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Voronoi.Vector2.ToString">
- <summary>
- Convert the vector into a reconstructable string representation
- </summary>
- <returns>A string from which the vector can be rebuilt</returns>
- </member>
- <member name="M:DotSpatial.Topology.Voronoi.Vector2.Equals(System.Object)">
- <summary>
- Compares this vector with another one
- </summary>
- <param name="obj"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Voronoi.Vector2.Distance(DotSpatial.Topology.Voronoi.Vector2)">
- <summary>
- Calculates the euclidean distance from this cell to another
- </summary>
- <returns>Vector2 stuff</returns>
- </member>
- <member name="M:DotSpatial.Topology.Voronoi.Vector2.GetHashCode">
- <summary>
- Retrieves a hashcode that is dependent on the elements
- </summary>
- <returns>The hashcode</returns>
- </member>
- <member name="M:DotSpatial.Topology.Voronoi.Vector2.op_Multiply(DotSpatial.Topology.Voronoi.Vector2,DotSpatial.Topology.Voronoi.Vector2)">
- <summary>
- Get the scalar product of two vectors
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Voronoi.Vector2.op_Equality(DotSpatial.Topology.Voronoi.Vector2,DotSpatial.Topology.Voronoi.Vector2)">
- <summary>
- Overrides equality to use the tolerant equality
- </summary>
- <param name="a"></param>
- <param name="b"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Voronoi.Vector2.op_Inequality(DotSpatial.Topology.Voronoi.Vector2,DotSpatial.Topology.Voronoi.Vector2)">
- <summary>
- Overrides equality to use the tolerant equality test
- </summary>
- <param name="a"></param>
- <param name="b"></param>
- <returns></returns>
- </member>
- <member name="M:DotSpatial.Topology.Voronoi.Vector2.op_Addition(DotSpatial.Topology.Voronoi.Vector2,DotSpatial.Topology.Voronoi.Vector2)">
- <summary>
- Calculates the vector sum of these two vectors
- </summary>
- <param name="a">One vector to add</param>
- <param name="b">The second vector to add</param>
- <returns>The vector sum of the specified vectors</returns>
- </member>
- <member name="M:DotSpatial.Topology.Voronoi.Vector2.op_Subtraction(DotSpatial.Topology.Voronoi.Vector2,DotSpatial.Topology.Voronoi.Vector2)">
- <summary>
- Calculates the vector sum of these two vectors
- </summary>
- <param name="a">One vector to add</param>
- <param name="b">The second vector to add</param>
- <returns>The vector sum of the specified vectors</returns>
- </member>
- <member name="M:DotSpatial.Topology.Voronoi.Vector2.op_Multiply(DotSpatial.Topology.Voronoi.Vector2,System.Double)">
- <summary>
- Multiplies the vector by a scalar
- </summary>
- <param name="a">The vector to modify</param>
- <param name="scale">The double scale to multiply</param>
- <returns>A new Vector2</returns>
- </member>
- <member name="M:DotSpatial.Topology.Voronoi.Vector2.op_Multiply(System.Double,DotSpatial.Topology.Voronoi.Vector2)">
- <summary>
- Multiplies the vector by a scalar.
- </summary>
- <param name="scale">The double scale to multiply.</param>
- <param name="a">The vector to modify.</param>
- <returns>A new Vector2.</returns>
- </member>
- <member name="P:DotSpatial.Topology.Voronoi.Vector2.SquaredLength">
- <summary>
- Gets the dot product of this vector with itself
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Voronoi.VNode.ProcessDataEvent(DotSpatial.Topology.Voronoi.VDataEvent,DotSpatial.Topology.Voronoi.VNode,DotSpatial.Topology.Voronoi.VoronoiGraph,System.Double,DotSpatial.Topology.Voronoi.VDataNode[]@)">
- <summary>
- Will return the new root (unchanged except in start-up)
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Voronoi.VoronoiEdge">
- <summary>
- The Voronoi Edge represents a bisector between two of the original datapoints. The
- LeftData and RightData represent those original points. VVertexA and VVertexB represent
- the endpoints of the segment created using those original points.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Voronoi.VoronoiEdge.Done">
- <summary>
- An internal boolean for tracking some cleanup operations
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Voronoi.VoronoiEdge.LeftData">
- <summary>
- The other original point in the dataset
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Voronoi.VoronoiEdge.RightData">
- <summary>
- One of the original points in the dataset
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Voronoi.VoronoiEdge.VVertexA">
- <summary>
- One of the endpoints for the segment that defines this edge
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Voronoi.VoronoiEdge.VVertexB">
- <summary>
- THe other endpoint for the segment that defines this edge
- </summary>
- </member>
- <member name="M:DotSpatial.Topology.Voronoi.VoronoiEdge.AddVertex(DotSpatial.Topology.Voronoi.Vector2)">
- <summary>
- Adds VertexA and VertexB sequentially, so that if VertexA is defined,
- then VertexB will become the specified vertex.
- </summary>
- <param name="v"></param>
- <exception cref="T:System.Exception"></exception>
- </member>
- <member name="P:DotSpatial.Topology.Voronoi.VoronoiEdge.IsInfinite">
- <summary>
- Boolean, true if both the VertexA and VertexB are infinite vectors
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Voronoi.VoronoiEdge.IsPartlyInfinite">
- <summary>
- Indicates that one of the voronoi vertices for this edge is known, but no
- intersection is found to bound the other edge, and it should extend to the
- bounding box.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Voronoi.VoronoiEdge.FixedPoint">
- <summary>
- In the case where the line is infinite, this will return the
- center between the left and right data points.
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Voronoi.VoronoiEdge.DirectionVector">
- <summary>
- Calculates a vector direction that indicates the direction of this
- knwon
- </summary>
- </member>
- <member name="P:DotSpatial.Topology.Voronoi.VoronoiEdge.Length">
- <summary>
- Calculates the length of this edge
- </summary>
- </member>
- <member name="T:DotSpatial.Topology.Voronoi.VoronoiGraph">
- <summary>
- Voronoi Graph
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Voronoi.VoronoiGraph.Edges">
- <summary>
- The collection of VoronoiEdges. The Left and Right points are from the
- original set of points that are bisected by the edge. The A and B
- Vectors are the endpoints of the edge itself.
- </summary>
- </member>
- <member name="F:DotSpatial.Topology.Voronoi.VoronoiGraph.Vertices">
- <summary>
- The vertices that join the voronoi polygon edges (not the original points)
- </summary>
- </member>
- </members>
-</doc>
diff --git a/MES_Wind/bin/Debug/ZedGraph.xml b/MES_Wind/bin/Debug/ZedGraph.xml
deleted file mode 100644
index 5d21e570e28320601ff7b5138d14b059df091a7a..0000000000000000000000000000000000000000
--- a/MES_Wind/bin/Debug/ZedGraph.xml
+++ /dev/null
@@ -1,25465 +0,0 @@
-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>ZedGraph</name>
- </assembly>
- <members>
- <member name="T:ZedGraph.ZedGraphControl">
- <summary>
- The ZedGraphControl class provides a UserControl interface to the
- <see cref="N:ZedGraph"/> class library. This allows ZedGraph to be installed
- as a control in the Visual Studio toolbox. You can use the control by simply
- dragging it onto a form in the Visual Studio form editor. All graph
- attributes are accessible via the <see cref="P:ZedGraph.ZedGraphControl.GraphPane"/>
- property.
- </summary>
- <author> John Champion revised by Jerry Vos </author>
- <version> $Revision: 3.86 $ $Date: 2007-11-03 04:41:29 $ </version>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.GetImage">
- <summary>
- Gets the graph pane's current image.
- <seealso cref="T:System.Drawing.Bitmap"/>
- </summary>
- <exception cref="T:ZedGraph.ZedGraphException">
- When the control has been disposed before this call.
- </exception>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.ZedGraphControl_MouseDown(System.Object,System.Windows.Forms.MouseEventArgs)">
- <summary>
- Handle a MouseDown event in the <see cref="T:ZedGraph.ZedGraphControl"/>
- </summary>
- <param name="sender">A reference to the <see cref="T:ZedGraph.ZedGraphControl"/></param>
- <param name="e">A <see cref="T:System.Windows.Forms.MouseEventArgs"/> instance</param>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.SetCursor">
- <summary>
- Set the cursor according to the current mouse location.
- </summary>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.SetCursor(System.Drawing.Point)">
- <summary>
- Set the cursor according to the current mouse location.
- </summary>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.ZedGraphControl_KeyUp(System.Object,System.Windows.Forms.KeyEventArgs)">
- <summary>
- Handle a KeyUp event
- </summary>
- <param name="sender">The <see cref="T:ZedGraph.ZedGraphControl"/> in which the KeyUp occurred.</param>
- <param name="e">A <see cref="T:System.Windows.Forms.KeyEventArgs"/> instance.</param>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.ZedGraphControl_KeyDown(System.Object,System.Windows.Forms.KeyEventArgs)">
- <summary>
- Handle the Key Events so ZedGraph can Escape out of a panning or zooming operation.
- </summary>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.ZedGraphControl_MouseUp(System.Object,System.Windows.Forms.MouseEventArgs)">
- <summary>
- Handle a MouseUp event in the <see cref="T:ZedGraph.ZedGraphControl"/>
- </summary>
- <param name="sender">A reference to the <see cref="T:ZedGraph.ZedGraphControl"/></param>
- <param name="e">A <see cref="T:System.Windows.Forms.MouseEventArgs"/> instance</param>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.MakeValueLabel(ZedGraph.Axis,System.Double,System.Int32,System.Boolean)">
- <summary>
- Make a string label that corresponds to a user scale value.
- </summary>
- <param name="axis">The axis from which to obtain the scale value. This determines
- if it's a date value, linear, log, etc.</param>
- <param name="val">The value to be made into a label</param>
- <param name="iPt">The ordinal position of the value</param>
- <param name="isOverrideOrdinal">true to override the ordinal settings of the axis,
- and prefer the actual value instead.</param>
- <returns>The string label.</returns>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.ZedGraphControl_MouseMove(System.Object,System.Windows.Forms.MouseEventArgs)">
- <summary>
- protected method for handling MouseMove events to display tooltips over
- individual datapoints.
- </summary>
- <param name="sender">
- A reference to the control that has the MouseMove event.
- </param>
- <param name="e">
- A MouseEventArgs object.
- </param>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.ZedGraphControl_MouseWheel(System.Object,System.Windows.Forms.MouseEventArgs)">
- <summary>
- Handle a MouseWheel event in the <see cref="T:ZedGraph.ZedGraphControl"/>
- </summary>
- <param name="sender">A reference to the <see cref="T:ZedGraph.ZedGraphControl"/></param>
- <param name="e">A <see cref="T:System.Windows.Forms.MouseEventArgs"/> instance</param>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.ZoomPane(ZedGraph.GraphPane,System.Double,System.Drawing.PointF,System.Boolean,System.Boolean)">
- <summary>
- Zoom a specified pane in or out according to the specified zoom fraction.
- </summary>
- <remarks>
- The zoom will occur on the <see cref="T:ZedGraph.XAxis"/>, <see cref="T:ZedGraph.YAxis"/>, and
- <see cref="T:ZedGraph.Y2Axis"/> only if the corresponding flag, <see cref="P:ZedGraph.ZedGraphControl.IsEnableHZoom"/> or
- <see cref="P:ZedGraph.ZedGraphControl.IsEnableVZoom"/>, is true. Note that if there are multiple Y or Y2 axes, all of
- them will be zoomed.
- </remarks>
- <param name="pane">The <see cref="P:ZedGraph.ZedGraphControl.GraphPane"/> instance to be zoomed.</param>
- <param name="zoomFraction">The fraction by which to zoom, less than 1 to zoom in, greater than
- 1 to zoom out. For example, 0.9 will zoom in such that the scale is 90% of what it was
- originally.</param>
- <param name="centerPt">The screen position about which the zoom will be centered. This
- value is only used if <see paramref="isZoomOnCenter"/> is true.
- </param>
- <param name="isZoomOnCenter">true to cause the zoom to be centered on the point
- <see paramref="centerPt"/>, false to center on the <see cref="P:ZedGraph.Chart.Rect"/>.
- </param>
- <param name="isRefresh">true to force a refresh of the control, false to leave it unrefreshed</param>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.ZoomPane(ZedGraph.GraphPane,System.Double,System.Drawing.PointF,System.Boolean)">
- <summary>
- Zoom a specified pane in or out according to the specified zoom fraction.
- </summary>
- <remarks>
- The zoom will occur on the <see cref="T:ZedGraph.XAxis"/>, <see cref="T:ZedGraph.YAxis"/>, and
- <see cref="T:ZedGraph.Y2Axis"/> only if the corresponding flag, <see cref="P:ZedGraph.ZedGraphControl.IsEnableHZoom"/> or
- <see cref="P:ZedGraph.ZedGraphControl.IsEnableVZoom"/>, is true. Note that if there are multiple Y or Y2 axes, all of
- them will be zoomed.
- </remarks>
- <param name="pane">The <see cref="P:ZedGraph.ZedGraphControl.GraphPane"/> instance to be zoomed.</param>
- <param name="zoomFraction">The fraction by which to zoom, less than 1 to zoom in, greater than
- 1 to zoom out. For example, 0.9 will zoom in such that the scale is 90% of what it was
- originally.</param>
- <param name="centerPt">The screen position about which the zoom will be centered. This
- value is only used if <see paramref="isZoomOnCenter"/> is true.
- </param>
- <param name="isZoomOnCenter">true to cause the zoom to be centered on the point
- <see paramref="centerPt"/>, false to center on the <see cref="P:ZedGraph.Chart.Rect"/>.
- </param>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.ZoomScale(ZedGraph.Axis,System.Double,System.Double,System.Boolean)">
- <summary>
- Zoom the specified axis by the specified amount, with the center of the zoom at the
- (optionally) specified point.
- </summary>
- <remarks>
- This method is used for MouseWheel zoom operations</remarks>
- <param name="axis">The <see cref="T:ZedGraph.Axis"/> to be zoomed.</param>
- <param name="zoomFraction">The zoom fraction, less than 1.0 to zoom in, greater than 1.0 to
- zoom out. That is, a value of 0.9 will zoom in such that the scale length is 90% of what
- it previously was.</param>
- <param name="centerVal">The location for the center of the zoom. This is only used if
- <see paramref="IsZoomOnMouseCenter"/> is true.</param>
- <param name="isZoomOnCenter">true if the zoom is to be centered at the
- <see paramref="centerVal"/> screen position, false for the zoom to be centered within
- the <see cref="P:ZedGraph.Chart.Rect"/>.
- </param>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.PanScale(ZedGraph.Axis,System.Double,System.Double)">
- <summary>
- Handle a panning operation for the specified <see cref="T:ZedGraph.Axis"/>.
- </summary>
- <param name="axis">The <see cref="T:ZedGraph.Axis"/> to be panned</param>
- <param name="startVal">The value where the pan started. The scale range
- will be shifted by the difference between <see paramref="startVal"/> and
- <see paramref="endVal"/>.
- </param>
- <param name="endVal">The value where the pan ended. The scale range
- will be shifted by the difference between <see paramref="startVal"/> and
- <see paramref="endVal"/>.
- </param>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.HandleSelectionFinish(System.Object,System.Windows.Forms.MouseEventArgs)">
- <summary>
- Perform selection on curves within the drag pane, or under the mouse click.
- </summary>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="F:ZedGraph.ZedGraphControl._masterPane">
- <summary>
- This private field contains the instance for the MasterPane object of this control.
- You can access the MasterPane object through the public property
- <see cref="P:ZedGraph.ZedGraphControl.MasterPane"/>. This is nulled when this Control is
- disposed.
- </summary>
- </member>
- <member name="F:ZedGraph.ZedGraphControl._isShowPointValues">
- <summary>
- private field that determines whether or not tooltips will be displayed
- when the mouse hovers over data values. Use the public property
- <see cref="P:ZedGraph.ZedGraphControl.IsShowPointValues"/> to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.ZedGraphControl._isShowCursorValues">
- <summary>
- private field that determines whether or not tooltips will be displayed
- showing the scale values while the mouse is located within the ChartRect.
- Use the public property <see cref="P:ZedGraph.ZedGraphControl.IsShowCursorValues"/> to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.ZedGraphControl._pointValueFormat">
- <summary>
- private field that determines the format for displaying tooltip values.
- This format is passed to <see cref="M:ZedGraph.PointPairBase.ToString(System.String)"/>.
- Use the public property <see cref="P:ZedGraph.ZedGraphControl.PointValueFormat"/> to access this
- value.
- </summary>
- </member>
- <member name="F:ZedGraph.ZedGraphControl._isShowContextMenu">
- <summary>
- private field that determines whether or not the context menu will be available. Use the
- public property <see cref="P:ZedGraph.ZedGraphControl.IsShowContextMenu"/> to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.ZedGraphControl._isShowCopyMessage">
- <summary>
- private field that determines whether or not a message box will be shown in response to
- a context menu "Copy" command. Use the
- public property <see cref="P:ZedGraph.ZedGraphControl.IsShowCopyMessage"/> to access this value.
- </summary>
- <remarks>
- Note that, if this value is set to false, the user will receive no indicative feedback
- in response to a Copy action.
- </remarks>
- </member>
- <member name="F:ZedGraph.ZedGraphControl._isPrintScaleAll">
- <summary>
- private field that determines whether the settings of
- <see cref="P:ZedGraph.PaneBase.IsFontsScaled"/> and <see cref="P:ZedGraph.PaneBase.IsPenWidthScaled"/>
- will be overridden to true during printing operations.
- </summary>
- <remarks>
- Printing involves pixel maps that are typically of a dramatically different dimension
- than on-screen pixel maps. Therefore, it becomes more important to scale the fonts and
- lines to give a printed image that looks like what is shown on-screen. The default
- setting for <see cref="P:ZedGraph.PaneBase.IsFontsScaled"/> is true, but the default
- setting for <see cref="P:ZedGraph.PaneBase.IsPenWidthScaled"/> is false.
- </remarks>
- <value>
- A value of true will cause both <see cref="P:ZedGraph.PaneBase.IsFontsScaled"/> and
- <see cref="P:ZedGraph.PaneBase.IsPenWidthScaled"/> to be temporarily set to true during
- printing operations.
- </value>
- </member>
- <member name="F:ZedGraph.ZedGraphControl._isPrintKeepAspectRatio">
- <summary>
- private field that determines whether or not the visible aspect ratio of the
- <see cref="P:ZedGraph.ZedGraphControl.MasterPane"/> <see cref="P:ZedGraph.PaneBase.Rect"/> will be preserved
- when printing this <see cref="T:ZedGraph.ZedGraphControl"/>.
- </summary>
- </member>
- <member name="F:ZedGraph.ZedGraphControl._isPrintFillPage">
- <summary>
- private field that determines whether or not the <see cref="P:ZedGraph.ZedGraphControl.MasterPane"/>
- <see cref="P:ZedGraph.PaneBase.Rect"/> dimensions will be expanded to fill the
- available space when printing this <see cref="T:ZedGraph.ZedGraphControl"/>.
- </summary>
- <remarks>
- If <see cref="P:ZedGraph.ZedGraphControl.IsPrintKeepAspectRatio"/> is also true, then the <see cref="P:ZedGraph.ZedGraphControl.MasterPane"/>
- <see cref="P:ZedGraph.PaneBase.Rect"/> dimensions will be expanded to fit as large
- a space as possible while still honoring the visible aspect ratio.
- </remarks>
- </member>
- <member name="F:ZedGraph.ZedGraphControl._pointDateFormat">
- <summary>
- private field that determines the format for displaying tooltip date values.
- This format is passed to <see cref="M:ZedGraph.XDate.ToString(System.String)"/>.
- Use the public property <see cref="P:ZedGraph.ZedGraphControl.PointDateFormat"/> to access this
- value.
- </summary>
- </member>
- <member name="F:ZedGraph.ZedGraphControl._isEnableVZoom">
- <summary>
- private value that determines whether or not zooming is enabled for the control in the
- vertical direction. Use the public property <see cref="P:ZedGraph.ZedGraphControl.IsEnableVZoom"/> to access this
- value.
- </summary>
- </member>
- <member name="F:ZedGraph.ZedGraphControl._isEnableHZoom">
- <summary>
- private value that determines whether or not zooming is enabled for the control in the
- horizontal direction. Use the public property <see cref="P:ZedGraph.ZedGraphControl.IsEnableHZoom"/> to access this
- value.
- </summary>
- </member>
- <member name="F:ZedGraph.ZedGraphControl._isEnableWheelZoom">
- <summary>
- private value that determines whether or not zooming is enabled with the mousewheel.
- Note that this property is used in combination with the <see cref="P:ZedGraph.ZedGraphControl.IsEnableHZoom"/> and
- <see cref="P:ZedGraph.ZedGraphControl.IsEnableVZoom"/> properties to control zoom options.
- </summary>
- </member>
- <member name="F:ZedGraph.ZedGraphControl._isEnableVEdit">
- <summary>
- private value that determines whether or not point editing is enabled in the
- vertical direction. Use the public property <see cref="P:ZedGraph.ZedGraphControl.IsEnableVEdit"/> to access this
- value.
- </summary>
- </member>
- <member name="F:ZedGraph.ZedGraphControl._isEnableHEdit">
- <summary>
- private value that determines whether or not point editing is enabled in the
- horizontal direction. Use the public property <see cref="P:ZedGraph.ZedGraphControl.IsEnableHEdit"/> to access this
- value.
- </summary>
- </member>
- <member name="F:ZedGraph.ZedGraphControl._isEnableHPan">
- <summary>
- private value that determines whether or not panning is allowed for the control in the
- horizontal direction. Use the
- public property <see cref="P:ZedGraph.ZedGraphControl.IsEnableHPan"/> to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.ZedGraphControl._isEnableVPan">
- <summary>
- private value that determines whether or not panning is allowed for the control in the
- vertical direction. Use the
- public property <see cref="P:ZedGraph.ZedGraphControl.IsEnableVPan"/> to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.ZedGraphControl._isEnableSelection">
- <summary>
- Internal variable that indicates if the control can manage selections.
- </summary>
- </member>
- <member name="F:ZedGraph.ZedGraphControl._pdSave">
- <summary>
- private field that stores a <see cref="P:ZedGraph.ZedGraphControl.PrintDocument"/> instance, which maintains
- a persistent selection of printer options.
- </summary>
- <remarks>
- This is needed so that a "Print" action utilizes the settings from a prior
- "Page Setup" action.</remarks>
- </member>
- <member name="F:ZedGraph.ZedGraphControl._selection">
- <summary>
- This private field contains a list of selected CurveItems.
- </summary>
- </member>
- <member name="F:ZedGraph.ZedGraphControl._linkButtons">
- <summary>
- Gets or sets a value that determines which Mouse button will be used to click on
- linkable objects
- </summary>
- <seealso cref="P:ZedGraph.ZedGraphControl.LinkModifierKeys"/>
- </member>
- <member name="F:ZedGraph.ZedGraphControl._linkModifierKeys">
- <summary>
- Gets or sets a value that determines which modifier keys will be used to click
- on linkable objects
- </summary>
- <seealso cref="P:ZedGraph.ZedGraphControl.LinkButtons"/>
- </member>
- <member name="F:ZedGraph.ZedGraphControl._editButtons">
- <summary>
- Gets or sets a value that determines which Mouse button will be used to edit point
- data values
- </summary>
- <remarks>
- This setting only applies if <see cref="P:ZedGraph.ZedGraphControl.IsEnableHEdit"/> and/or
- <see cref="P:ZedGraph.ZedGraphControl.IsEnableVEdit"/> are true.
- </remarks>
- <seealso cref="P:ZedGraph.ZedGraphControl.EditModifierKeys"/>
- </member>
- <member name="F:ZedGraph.ZedGraphControl._editModifierKeys">
- <summary>
- Gets or sets a value that determines which modifier keys will be used to edit point
- data values
- </summary>
- <remarks>
- This setting only applies if <see cref="P:ZedGraph.ZedGraphControl.IsEnableHEdit"/> and/or
- <see cref="P:ZedGraph.ZedGraphControl.IsEnableVEdit"/> are true.
- </remarks>
- <seealso cref="P:ZedGraph.ZedGraphControl.EditButtons"/>
- </member>
- <member name="F:ZedGraph.ZedGraphControl._selectButtons">
- <summary>
- Gets or sets a value that determines which mouse button will be used to select
- <see cref="T:ZedGraph.CurveItem"/>'s.
- </summary>
- <remarks>
- This setting only applies if <see cref="P:ZedGraph.ZedGraphControl.IsEnableSelection"/> is true.
- </remarks>
- <seealso cref="P:ZedGraph.ZedGraphControl.SelectModifierKeys"/>
- </member>
- <member name="F:ZedGraph.ZedGraphControl._selectModifierKeys">
- <summary>
- Gets or sets a value that determines which modifier keys will be used to select
- <see cref="T:ZedGraph.CurveItem"/>'s.
- </summary>
- <remarks>
- This setting only applies if <see cref="P:ZedGraph.ZedGraphControl.IsEnableSelection"/> is true.
- </remarks>
- <seealso cref="P:ZedGraph.ZedGraphControl.SelectButtons"/>
- </member>
- <member name="F:ZedGraph.ZedGraphControl._zoomButtons">
- <summary>
- Gets or sets a value that determines which Mouse button will be used to perform
- zoom operations
- </summary>
- <remarks>
- This setting only applies if <see cref="P:ZedGraph.ZedGraphControl.IsEnableHZoom"/> and/or
- <see cref="P:ZedGraph.ZedGraphControl.IsEnableVZoom"/> are true.
- </remarks>
- <seealso cref="P:ZedGraph.ZedGraphControl.ZoomModifierKeys"/>
- <seealso cref="P:ZedGraph.ZedGraphControl.ZoomButtons2"/>
- <seealso cref="P:ZedGraph.ZedGraphControl.ZoomModifierKeys2"/>
- </member>
- <member name="F:ZedGraph.ZedGraphControl._zoomModifierKeys">
- <summary>
- Gets or sets a value that determines which modifier keys will be used to perform
- zoom operations
- </summary>
- <remarks>
- This setting only applies if <see cref="P:ZedGraph.ZedGraphControl.IsEnableHZoom"/> and/or
- <see cref="P:ZedGraph.ZedGraphControl.IsEnableVZoom"/> are true.
- </remarks>
- <seealso cref="P:ZedGraph.ZedGraphControl.ZoomButtons"/>
- <seealso cref="P:ZedGraph.ZedGraphControl.ZoomButtons2"/>
- <seealso cref="P:ZedGraph.ZedGraphControl.ZoomModifierKeys2"/>
- </member>
- <member name="F:ZedGraph.ZedGraphControl._zoomButtons2">
- <summary>
- Gets or sets a value that determines which Mouse button will be used as a
- secondary option to perform zoom operations
- </summary>
- <remarks>
- This setting only applies if <see cref="P:ZedGraph.ZedGraphControl.IsEnableHZoom"/> and/or
- <see cref="P:ZedGraph.ZedGraphControl.IsEnableVZoom"/> are true.
- </remarks>
- <seealso cref="P:ZedGraph.ZedGraphControl.ZoomModifierKeys2"/>
- <seealso cref="P:ZedGraph.ZedGraphControl.ZoomButtons"/>
- <seealso cref="P:ZedGraph.ZedGraphControl.ZoomModifierKeys"/>
- </member>
- <member name="F:ZedGraph.ZedGraphControl._zoomModifierKeys2">
- <summary>
- Gets or sets a value that determines which modifier keys will be used as a
- secondary option to perform zoom operations
- </summary>
- <remarks>
- This setting only applies if <see cref="P:ZedGraph.ZedGraphControl.IsEnableHZoom"/> and/or
- <see cref="P:ZedGraph.ZedGraphControl.IsEnableVZoom"/> are true.
- </remarks>
- <seealso cref="P:ZedGraph.ZedGraphControl.ZoomButtons"/>
- <seealso cref="P:ZedGraph.ZedGraphControl.ZoomButtons2"/>
- <seealso cref="P:ZedGraph.ZedGraphControl.ZoomModifierKeys2"/>
- </member>
- <member name="F:ZedGraph.ZedGraphControl._panButtons">
- <summary>
- Gets or sets a value that determines which Mouse button will be used to perform
- panning operations
- </summary>
- <remarks>
- This setting only applies if <see cref="P:ZedGraph.ZedGraphControl.IsEnableHPan"/> and/or
- <see cref="P:ZedGraph.ZedGraphControl.IsEnableVPan"/> are true. A Pan operation (dragging the graph with
- the mouse) should not be confused with a scroll operation (using a scroll bar to
- move the graph).
- </remarks>
- <seealso cref="P:ZedGraph.ZedGraphControl.PanModifierKeys"/>
- <seealso cref="P:ZedGraph.ZedGraphControl.PanButtons2"/>
- <seealso cref="P:ZedGraph.ZedGraphControl.PanModifierKeys2"/>
- </member>
- <member name="F:ZedGraph.ZedGraphControl._panModifierKeys">
- <summary>
- Gets or sets a value that determines which modifier keys will be used to perform
- panning operations
- </summary>
- <remarks>
- This setting only applies if <see cref="P:ZedGraph.ZedGraphControl.IsEnableHPan"/> and/or
- <see cref="P:ZedGraph.ZedGraphControl.IsEnableVPan"/> are true. A Pan operation (dragging the graph with
- the mouse) should not be confused with a scroll operation (using a scroll bar to
- move the graph).
- </remarks>
- <seealso cref="P:ZedGraph.ZedGraphControl.PanButtons"/>
- <seealso cref="P:ZedGraph.ZedGraphControl.PanButtons2"/>
- <seealso cref="P:ZedGraph.ZedGraphControl.PanModifierKeys2"/>
- </member>
- <member name="F:ZedGraph.ZedGraphControl._panButtons2">
- <summary>
- Gets or sets a value that determines which Mouse button will be used as a
- secondary option to perform panning operations
- </summary>
- <remarks>
- This setting only applies if <see cref="P:ZedGraph.ZedGraphControl.IsEnableHPan"/> and/or
- <see cref="P:ZedGraph.ZedGraphControl.IsEnableVPan"/> are true. A Pan operation (dragging the graph with
- the mouse) should not be confused with a scroll operation (using a scroll bar to
- move the graph).
- </remarks>
- <seealso cref="P:ZedGraph.ZedGraphControl.PanModifierKeys2"/>
- <seealso cref="P:ZedGraph.ZedGraphControl.PanButtons"/>
- <seealso cref="P:ZedGraph.ZedGraphControl.PanModifierKeys"/>
- </member>
- <member name="F:ZedGraph.ZedGraphControl._panModifierKeys2">
- <summary>
- Gets or sets a value that determines which modifier keys will be used as a
- secondary option to perform panning operations
- </summary>
- <remarks>
- This setting only applies if <see cref="P:ZedGraph.ZedGraphControl.IsEnableHPan"/> and/or
- <see cref="P:ZedGraph.ZedGraphControl.IsEnableVPan"/> are true. A Pan operation (dragging the graph with
- the mouse) should not be confused with a scroll operation (using a scroll bar to
- move the graph).
- </remarks>
- <seealso cref="P:ZedGraph.ZedGraphControl.PanButtons2"/>
- <seealso cref="P:ZedGraph.ZedGraphControl.PanButtons"/>
- <seealso cref="P:ZedGraph.ZedGraphControl.PanModifierKeys"/>
- </member>
- <member name="F:ZedGraph.ZedGraphControl._isZooming">
- <summary>
- Internal variable that indicates the control is currently being zoomed.
- </summary>
- </member>
- <member name="F:ZedGraph.ZedGraphControl._isPanning">
- <summary>
- Internal variable that indicates the control is currently being panned.
- </summary>
- </member>
- <member name="F:ZedGraph.ZedGraphControl._isEditing">
- <summary>
- Internal variable that indicates a point value is currently being edited.
- </summary>
- </member>
- <member name="F:ZedGraph.ZedGraphControl._isSelecting">
- <summary>
- Internal variable that indicates the control is currently using selection.
- </summary>
- </member>
- <member name="F:ZedGraph.ZedGraphControl._dragPane">
- <summary>
- Internal variable that stores the <see cref="P:ZedGraph.ZedGraphControl.GraphPane"/> reference for the Pane that is
- currently being zoomed or panned.
- </summary>
- </member>
- <member name="F:ZedGraph.ZedGraphControl._dragStartPt">
- <summary>
- Internal variable that stores a rectangle which is either the zoom rectangle, or the incremental
- pan amount since the last mousemove event.
- </summary>
- </member>
- <member name="F:ZedGraph.ZedGraphControl._zoomState">
- <summary>
- private field that stores the state of the scale ranges prior to starting a panning action.
- </summary>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.#ctor">
- <summary>
- Default Constructor
- </summary>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if the components should be
- disposed, false otherwise</param>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.OnPaint(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Called by the system to update the control on-screen
- </summary>
- <param name="e">
- A PaintEventArgs object containing the Graphics specifications
- for this Paint event.
- </param>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.ZedGraphControl_ReSize(System.Object,System.EventArgs)">
- <summary>
- Called when the control has been resized.
- </summary>
- <param name="sender">
- A reference to the control that has been resized.
- </param>
- <param name="e">
- An EventArgs object.
- </param>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.AxisChange">
- <summary>This performs an axis change command on the graphPane.
- </summary>
- <remarks>
- This is the same as
- <c>ZedGraphControl.GraphPane.AxisChange( ZedGraphControl.CreateGraphics() )</c>, however,
- this method also calls <see cref="M:ZedGraph.ZedGraphControl.SetScrollRangeFromData"/> if <see cref="P:ZedGraph.ZedGraphControl.IsAutoScrollRange"/>
- is true.
- </remarks>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.ZoomStateSave(ZedGraph.GraphPane,ZedGraph.ZoomState.StateType)">
- <summary>
- Save the current states of the GraphPanes to a separate collection. Save a single
- (<see paramref="primaryPane"/>) GraphPane if the panes are not synchronized
- (see <see cref="P:ZedGraph.ZedGraphControl.IsSynchronizeXAxes"/> and <see cref="P:ZedGraph.ZedGraphControl.IsSynchronizeYAxes"/>),
- or save a list of states for all GraphPanes if the panes are synchronized.
- </summary>
- <param name="primaryPane">The primary GraphPane on which zoom/pan/scroll operations
- are taking place</param>
- <param name="type">The <see cref="T:ZedGraph.ZoomState.StateType"/> that describes the
- current operation</param>
- <returns>The <see cref="T:ZedGraph.ZoomState"/> that corresponds to the
- <see paramref="primaryPane"/>.
- </returns>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.ZoomStateRestore(ZedGraph.GraphPane)">
- <summary>
- Restore the states of the GraphPanes to a previously saved condition (via
- <see cref="M:ZedGraph.ZedGraphControl.ZoomStateSave(ZedGraph.GraphPane,ZedGraph.ZoomState.StateType)"/>. This is essentially an "undo" for live
- pan and scroll actions. Restores a single
- (<see paramref="primaryPane"/>) GraphPane if the panes are not synchronized
- (see <see cref="P:ZedGraph.ZedGraphControl.IsSynchronizeXAxes"/> and <see cref="P:ZedGraph.ZedGraphControl.IsSynchronizeYAxes"/>),
- or save a list of states for all GraphPanes if the panes are synchronized.
- </summary>
- <param name="primaryPane">The primary GraphPane on which zoom/pan/scroll operations
- are taking place</param>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.ZoomStatePush(ZedGraph.GraphPane)">
- <summary>
- Place the previously saved states of the GraphPanes on the individual GraphPane
- <see cref="P:ZedGraph.GraphPane.ZoomStack"/> collections. This provides for an
- option to undo the state change at a later time. Save a single
- (<see paramref="primaryPane"/>) GraphPane if the panes are not synchronized
- (see <see cref="P:ZedGraph.ZedGraphControl.IsSynchronizeXAxes"/> and <see cref="P:ZedGraph.ZedGraphControl.IsSynchronizeYAxes"/>),
- or save a list of states for all GraphPanes if the panes are synchronized.
- </summary>
- <param name="primaryPane">The primary GraphPane on which zoom/pan/scroll operations
- are taking place</param>
- <returns>The <see cref="T:ZedGraph.ZoomState"/> that corresponds to the
- <see paramref="primaryPane"/>.
- </returns>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.ZoomStateClear">
- <summary>
- Clear the collection of saved states.
- </summary>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.ZoomStatePurge">
- <summary>
- Clear all states from the undo stack for each GraphPane.
- </summary>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.SetScrollRangeFromData">
- <summary>
- Sets the value of the scroll range properties (see <see cref="P:ZedGraph.ZedGraphControl.ScrollMinX"/>,
- <see cref="P:ZedGraph.ZedGraphControl.ScrollMaxX"/>, <see cref="P:ZedGraph.ZedGraphControl.YScrollRangeList"/>, and
- <see cref="P:ZedGraph.ZedGraphControl.Y2ScrollRangeList"/> based on the actual range of the data for
- each corresponding <see cref="T:ZedGraph.Axis"/>.
- </summary>
- <remarks>
- This method is called automatically by <see cref="M:ZedGraph.ZedGraphControl.AxisChange"/> if
- <see cref="P:ZedGraph.ZedGraphControl.IsAutoScrollRange"/>
- is true. Note that this will not be called if you call AxisChange directly from the
- <see cref="P:ZedGraph.ZedGraphControl.GraphPane"/>. For example, zedGraphControl1.AxisChange() works properly, but
- zedGraphControl1.GraphPane.AxisChange() does not.</remarks>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.MenuClick_PageSetup(System.Object,System.EventArgs)">
- <summary>
- Handler for the "Page Setup..." context menu item. Displays a
- <see cref="T:System.Windows.Forms.PageSetupDialog"/>.
- </summary>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.MenuClick_Print(System.Object,System.EventArgs)">
- <summary>
- Handler for the "Print..." context menu item. Displays a
- <see cref="T:System.Windows.Forms.PrintDialog"/>.
- </summary>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.Graph_PrintPage(System.Object,System.Drawing.Printing.PrintPageEventArgs)">
- <summary>
- Rendering method used by the print context menu items
- </summary>
- <param name="sender">The applicable <see cref="P:ZedGraph.ZedGraphControl.PrintDocument"/>.</param>
- <param name="e">A <see cref="T:System.Drawing.Printing.PrintPageEventArgs"/> instance providing
- page bounds, margins, and a Graphics instance for this printed output.
- </param>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.DoPageSetup">
- <summary>
- Display a <see cref="T:System.Windows.Forms.PageSetupDialog"/> to the user, allowing them to modify
- the print settings for this <see cref="T:ZedGraph.ZedGraphControl"/>.
- </summary>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.DoPrint">
- <summary>
- Display a <see cref="T:System.Windows.Forms.PrintDialog"/> to the user, allowing them to select a
- printer and print the <see cref="P:ZedGraph.ZedGraphControl.MasterPane"/> contained in this
- <see cref="T:ZedGraph.ZedGraphControl"/>.
- </summary>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.DoPrintPreview">
- <summary>
- Display a <see cref="T:System.Windows.Forms.PrintPreviewDialog"/>, allowing the user to preview and
- subsequently print the <see cref="P:ZedGraph.ZedGraphControl.MasterPane"/> contained in this
- <see cref="T:ZedGraph.ZedGraphControl"/>.
- </summary>
- </member>
- <member name="F:ZedGraph.ZedGraphControl.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.GetObjectState">
- <summary>
- Find the object currently under the mouse cursor, and return its state.
- </summary>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.contextMenuStrip1_Opening(System.Object,System.ComponentModel.CancelEventArgs)">
- <summary>
- protected method to handle the popup context menu in the <see cref="T:ZedGraph.ZedGraphControl"/>.
- </summary>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.MenuClick_Copy(System.Object,System.EventArgs)">
- <summary>
- Handler for the "Copy" context menu item. Copies the current image to a bitmap on the
- clipboard.
- </summary>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.Copy(System.Boolean)">
- <summary>
- Handler for the "Copy" context menu item. Copies the current image to a bitmap on the
- clipboard.
- </summary>
- <param name="isShowMessage">boolean value that determines whether or not a prompt will be
- displayed. true to show a message of "Image Copied to ClipBoard".</param>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.ClipboardCopyThread">
- <summary>
- A threaded version of the copy method to avoid crash with MTA
- </summary>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.ImageRender">
- <summary>
- Setup for creation of a new image, applying appropriate anti-alias properties and
- returning the resultant image file
- </summary>
- <returns></returns>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.CopyEmf(System.Boolean)">
- <summary>
- Special handler that copies the current image to an Emf file on the clipboard.
- </summary>
- <remarks>This version is similar to the regular <see cref="M:ZedGraph.ZedGraphControl.Copy(System.Boolean)"/> method, except that
- it will place an Emf image (vector) on the ClipBoard instead of the regular bitmap.</remarks>
- <param name="isShowMessage">boolean value that determines whether or not a prompt will be
- displayed. true to show a message of "Image Copied to ClipBoard".</param>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.ClipboardCopyThreadEmf">
- <summary>
- A threaded version of the copy method to avoid crash with MTA
- </summary>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.MenuClick_SaveAs(System.Object,System.EventArgs)">
- <summary>
- Handler for the "Save Image As" context menu item. Copies the current image to the selected
- file.
- </summary>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.SaveAs">
- <summary>
- Handler for the "Save Image As" context menu item. Copies the current image to the selected
- file in either the Emf (vector), or a variety of Bitmap formats.
- </summary>
- <remarks>
- Note that <see cref="M:ZedGraph.ZedGraphControl.SaveAsBitmap"/> and <see cref="M:ZedGraph.ZedGraphControl.SaveAsEmf"/> methods are provided
- which allow for Bitmap-only or Emf-only handling of the "Save As" context menu item.
- </remarks>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.SaveAs(System.String)">
- <summary>
- Copies the current image to the selected file in
- Emf (vector), or a variety of Bitmap formats.
- </summary>
- <param name="DefaultFileName">
- Accepts a default file name for the file dialog (if "" or null, default is not used)
- </param>
- <returns>
- The file name saved, or "" if cancelled.
- </returns>
- <remarks>
- Note that <see cref="M:ZedGraph.ZedGraphControl.SaveAsBitmap"/> and <see cref="M:ZedGraph.ZedGraphControl.SaveAsEmf"/> methods are provided
- which allow for Bitmap-only or Emf-only handling of the "Save As" context menu item.
- </remarks>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.SaveAsBitmap">
- <summary>
- Handler for the "Save Image As" context menu item. Copies the current image to the selected
- Bitmap file.
- </summary>
- <remarks>
- Note that this handler saves as a bitmap only. The default handler is
- <see cref="M:ZedGraph.ZedGraphControl.SaveAs"/>, which allows for Bitmap or EMF formats
- </remarks>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.SaveAsEmf">
- <summary>
- Handler for the "Save Image As" context menu item. Copies the current image to the selected
- Emf format file.
- </summary>
- <remarks>
- Note that this handler saves as an Emf format only. The default handler is
- <see cref="M:ZedGraph.ZedGraphControl.SaveAs"/>, which allows for Bitmap or EMF formats.
- </remarks>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.SaveEmfFile(System.String)">
- <summary>
- Save the current Graph to the specified filename in EMF (vector) format.
- See <see cref="M:ZedGraph.ZedGraphControl.SaveAsEmf"/> for public access.
- </summary>
- <remarks>
- Note that this handler saves as an Emf format only. The default handler is
- <see cref="M:ZedGraph.ZedGraphControl.SaveAs"/>, which allows for Bitmap or EMF formats.
- </remarks>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.MenuClick_ShowValues(System.Object,System.EventArgs)">
- <summary>
- Handler for the "Show Values" context menu item. Toggles the <see cref="P:ZedGraph.ZedGraphControl.IsShowPointValues"/>
- property, which activates the point value tooltips.
- </summary>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.MenuClick_RestoreScale(System.Object,System.EventArgs)">
- <summary>
- Handler for the "Set Scale to Default" context menu item. Sets the scale ranging to
- full auto mode for all axes.
- </summary>
- <remarks>
- This method differs from the <see cref="M:ZedGraph.ZedGraphControl.ZoomOutAll(ZedGraph.GraphPane)"/> method in that it sets the scales
- to full auto mode. The <see cref="M:ZedGraph.ZedGraphControl.ZoomOutAll(ZedGraph.GraphPane)"/> method sets the scales to their initial
- setting prior to any user actions (which may or may not be full auto mode).
- </remarks>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.RestoreScale(ZedGraph.GraphPane)">
- <summary>
- Handler for the "Set Scale to Default" context menu item. Sets the scale ranging to
- full auto mode for all axes.
- </summary>
- <remarks>
- This method differs from the <see cref="M:ZedGraph.ZedGraphControl.ZoomOutAll(ZedGraph.GraphPane)"/> method in that it sets the scales
- to full auto mode. The <see cref="M:ZedGraph.ZedGraphControl.ZoomOutAll(ZedGraph.GraphPane)"/> method sets the scales to their initial
- setting prior to any user actions (which may or may not be full auto mode).
- </remarks>
- <param name="primaryPane">The <see cref="P:ZedGraph.ZedGraphControl.GraphPane"/> object which is to have the
- scale restored</param>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.MenuClick_ZoomOut(System.Object,System.EventArgs)">
- <summary>
- Handler for the "UnZoom/UnPan" context menu item. Restores the scale ranges to the values
- before the last zoom or pan operation.
- </summary>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.ZoomOut(ZedGraph.GraphPane)">
- <summary>
- Handler for the "UnZoom/UnPan" context menu item. Restores the scale ranges to the values
- before the last zoom, pan, or scroll operation.
- </summary>
- <remarks>
- Triggers a <see cref="E:ZedGraph.ZedGraphControl.ZoomEvent"/> for any type of undo (including pan, scroll, zoom, and
- wheelzoom). This method will affect all the
- <see cref="P:ZedGraph.ZedGraphControl.GraphPane"/> objects in the <see cref="P:ZedGraph.ZedGraphControl.MasterPane"/> if
- <see cref="P:ZedGraph.ZedGraphControl.IsSynchronizeXAxes"/> or <see cref="P:ZedGraph.ZedGraphControl.IsSynchronizeYAxes"/> is true.
- </remarks>
- <param name="primaryPane">The primary <see cref="P:ZedGraph.ZedGraphControl.GraphPane"/> object which is to be
- zoomed out</param>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.MenuClick_ZoomOutAll(System.Object,System.EventArgs)">
- <summary>
- Handler for the "Undo All Zoom/Pan" context menu item. Restores the scale ranges to the values
- before all zoom and pan operations
- </summary>
- <remarks>
- This method differs from the <see cref="M:ZedGraph.ZedGraphControl.RestoreScale(ZedGraph.GraphPane)"/> method in that it sets the scales
- to their initial setting prior to any user actions. The <see cref="M:ZedGraph.ZedGraphControl.RestoreScale(ZedGraph.GraphPane)"/> method
- sets the scales to full auto mode (regardless of what the initial setting may have been).
- </remarks>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="M:ZedGraph.ZedGraphControl.ZoomOutAll(ZedGraph.GraphPane)">
- <summary>
- Handler for the "Undo All Zoom/Pan" context menu item. Restores the scale ranges to the values
- before all zoom and pan operations
- </summary>
- <remarks>
- This method differs from the <see cref="M:ZedGraph.ZedGraphControl.RestoreScale(ZedGraph.GraphPane)"/> method in that it sets the scales
- to their initial setting prior to any user actions. The <see cref="M:ZedGraph.ZedGraphControl.RestoreScale(ZedGraph.GraphPane)"/> method
- sets the scales to full auto mode (regardless of what the initial setting may have been).
- </remarks>
- <param name="primaryPane">The <see cref="P:ZedGraph.ZedGraphControl.GraphPane"/> object which is to be zoomed out</param>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.ZoomButtons">
- <summary>
- Gets or sets a value that determines which mouse button will be used as a primary option
- to trigger a zoom event.
- </summary>
- <remarks>
- This value is combined with <see cref="P:ZedGraph.ZedGraphControl.ZoomModifierKeys"/> to determine the actual zoom combination.
- A secondary zoom button/key combination option is available via <see cref="P:ZedGraph.ZedGraphControl.ZoomButtons2"/> and
- <see cref="P:ZedGraph.ZedGraphControl.ZoomModifierKeys2"/>. To not use this button/key combination, set the value
- of <see cref="P:ZedGraph.ZedGraphControl.ZoomButtons"/> to <see cref="F:System.Windows.Forms.MouseButtons.None"/>.
- </remarks>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.ZoomButtons2">
- <summary>
- Gets or sets a value that determines which mouse button will be used as the secondary option
- to trigger a zoom event.
- </summary>
- <remarks>
- This value is combined with <see cref="P:ZedGraph.ZedGraphControl.ZoomModifierKeys2"/> to determine the actual zoom combination.
- The primary zoom button/key combination option is available via <see cref="P:ZedGraph.ZedGraphControl.ZoomButtons"/> and
- <see cref="P:ZedGraph.ZedGraphControl.ZoomModifierKeys"/>. To not use this button/key combination, set the value
- of <see cref="P:ZedGraph.ZedGraphControl.ZoomButtons2"/> to <see cref="F:System.Windows.Forms.MouseButtons.None"/>.
- </remarks>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.ZoomModifierKeys">
- <summary>
- Gets or sets a value that determines which modifier keys will be used as a primary option
- to trigger a zoom event.
- </summary>
- <remarks>
- This value is combined with <see cref="P:ZedGraph.ZedGraphControl.ZoomButtons"/> to determine the actual zoom combination.
- A secondary zoom button/key combination option is available via <see cref="P:ZedGraph.ZedGraphControl.ZoomButtons2"/> and
- <see cref="P:ZedGraph.ZedGraphControl.ZoomModifierKeys2"/>. To not use this button/key combination, set the value
- of <see cref="P:ZedGraph.ZedGraphControl.ZoomButtons"/> to <see cref="F:System.Windows.Forms.MouseButtons.None"/>.
- </remarks>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.ZoomModifierKeys2">
- <summary>
- Gets or sets a value that determines which modifier keys will be used as a secondary option
- to trigger a zoom event.
- </summary>
- <remarks>
- This value is combined with <see cref="P:ZedGraph.ZedGraphControl.ZoomButtons2"/> to determine the actual zoom combination.
- A primary zoom button/key combination option is available via <see cref="P:ZedGraph.ZedGraphControl.ZoomButtons"/> and
- <see cref="P:ZedGraph.ZedGraphControl.ZoomModifierKeys"/>. To not use this button/key combination, set the value
- of <see cref="P:ZedGraph.ZedGraphControl.ZoomButtons2"/> to <see cref="F:System.Windows.Forms.MouseButtons.None"/>.
- </remarks>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.PanButtons">
- <summary>
- Gets or sets a value that determines which mouse button will be used as a primary option
- to trigger a pan event.
- </summary>
- <remarks>
- This value is combined with <see cref="P:ZedGraph.ZedGraphControl.PanModifierKeys"/> to determine the actual pan combination.
- A secondary pan button/key combination option is available via <see cref="P:ZedGraph.ZedGraphControl.PanButtons2"/> and
- <see cref="P:ZedGraph.ZedGraphControl.PanModifierKeys2"/>. To not use this button/key combination, set the value
- of <see cref="P:ZedGraph.ZedGraphControl.PanButtons"/> to <see cref="F:System.Windows.Forms.MouseButtons.None"/>.
- </remarks>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.PanButtons2">
- <summary>
- Gets or sets a value that determines which mouse button will be used as the secondary option
- to trigger a pan event.
- </summary>
- <remarks>
- This value is combined with <see cref="P:ZedGraph.ZedGraphControl.PanModifierKeys2"/> to determine the actual pan combination.
- The primary pan button/key combination option is available via <see cref="P:ZedGraph.ZedGraphControl.PanButtons"/> and
- <see cref="P:ZedGraph.ZedGraphControl.PanModifierKeys"/>. To not use this button/key combination, set the value
- of <see cref="P:ZedGraph.ZedGraphControl.PanButtons2"/> to <see cref="F:System.Windows.Forms.MouseButtons.None"/>.
- </remarks>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.PanModifierKeys">
- <summary>
- Gets or sets a value that determines which modifier keys will be used as a primary option
- to trigger a pan event.
- </summary>
- <remarks>
- This value is combined with <see cref="P:ZedGraph.ZedGraphControl.PanButtons"/> to determine the actual pan combination.
- A secondary pan button/key combination option is available via <see cref="P:ZedGraph.ZedGraphControl.PanButtons2"/> and
- <see cref="P:ZedGraph.ZedGraphControl.PanModifierKeys2"/>. To not use this button/key combination, set the value
- of <see cref="P:ZedGraph.ZedGraphControl.PanButtons"/> to <see cref="F:System.Windows.Forms.MouseButtons.None"/>.
- </remarks>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.PanModifierKeys2">
- <summary>
- Gets or sets a value that determines which modifier keys will be used as a secondary option
- to trigger a pan event.
- </summary>
- <remarks>
- This value is combined with <see cref="P:ZedGraph.ZedGraphControl.PanButtons2"/> to determine the actual pan combination.
- A primary pan button/key combination option is available via <see cref="P:ZedGraph.ZedGraphControl.PanButtons"/> and
- <see cref="P:ZedGraph.ZedGraphControl.PanModifierKeys"/>. To not use this button/key combination, set the value
- of <see cref="P:ZedGraph.ZedGraphControl.PanButtons2"/> to <see cref="F:System.Windows.Forms.MouseButtons.None"/>.
- </remarks>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.EditButtons">
- <summary>
- Gets or sets a value that determines which Mouse button will be used to edit point
- data values
- </summary>
- <remarks>
- This setting only applies if <see cref="P:ZedGraph.ZedGraphControl.IsEnableHEdit"/> and/or
- <see cref="P:ZedGraph.ZedGraphControl.IsEnableVEdit"/> are true.
- </remarks>
- <seealso cref="P:ZedGraph.ZedGraphControl.EditModifierKeys"/>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.EditModifierKeys">
- <summary>
- Gets or sets a value that determines which modifier keys will be used to edit point
- data values
- </summary>
- <remarks>
- This setting only applies if <see cref="P:ZedGraph.ZedGraphControl.IsEnableHEdit"/> and/or
- <see cref="P:ZedGraph.ZedGraphControl.IsEnableVEdit"/> are true.
- </remarks>
- <seealso cref="P:ZedGraph.ZedGraphControl.EditButtons"/>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.SelectButtons">
- <summary>
- Gets or sets a value that determines which Mouse button will be used to
- select <see cref="T:ZedGraph.CurveItem"/>'s.
- </summary>
- <remarks>
- This setting only applies if <see cref="P:ZedGraph.ZedGraphControl.IsEnableSelection"/> is true.
- </remarks>
- <seealso cref="P:ZedGraph.ZedGraphControl.SelectModifierKeys"/>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.SelectModifierKeys">
- <summary>
- Gets or sets a value that determines which Modifier keys will be used to
- select <see cref="T:ZedGraph.CurveItem"/>'s.
- </summary>
- <remarks>
- This setting only applies if <see cref="P:ZedGraph.ZedGraphControl.IsEnableSelection"/> is true.
- </remarks>
- <seealso cref="P:ZedGraph.ZedGraphControl.SelectButtons"/>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.SelectAppendModifierKeys">
- <summary>
- Gets or sets a value that determines which Modifier keys will be used to
- append a <see cref="T:ZedGraph.CurveItem"/> to the selection list.
- </summary>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.LinkButtons">
- <summary>
- Gets or sets a value that determines which Mouse button will be used to click
- on linkable objects
- </summary>
- <seealso cref="P:ZedGraph.ZedGraphControl.LinkModifierKeys"/>
- <seealso cref="E:ZedGraph.ZedGraphControl.LinkEvent"/>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.LinkModifierKeys">
- <summary>
- Gets or sets a value that determines which modifier keys will be used to click
- on linkable objects
- </summary>
- <seealso cref="P:ZedGraph.ZedGraphControl.LinkButtons"/>
- <seealso cref="E:ZedGraph.ZedGraphControl.LinkEvent"/>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.MasterPane">
- <summary>
- Gets or sets the <see cref="T:ZedGraph.MasterPane"/> property for the control
- </summary>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.GraphPane">
- <summary>
- Gets or sets the <see cref="T:ZedGraph.GraphPane"/> property for the control
- </summary>
- <remarks>
- <see cref="T:ZedGraph.ZedGraphControl"/> actually uses a <see cref="P:ZedGraph.ZedGraphControl.MasterPane"/> object
- to hold a list of <see cref="P:ZedGraph.ZedGraphControl.GraphPane"/> objects. This property really only
- accesses the first <see cref="P:ZedGraph.ZedGraphControl.GraphPane"/> in the list. If there is more
- than one <see cref="P:ZedGraph.ZedGraphControl.GraphPane"/>, use the <see cref="P:ZedGraph.ZedGraphControl.MasterPane"/>
- indexer property to access any of the <see cref="P:ZedGraph.ZedGraphControl.GraphPane"/> objects.</remarks>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.IsAntiAlias">
- <summary>
- Gets or sets a value that determines if all drawing operations for this control
- will be forced to operate in Anti-alias mode. Note that if this value is set to
- "true", it overrides the setting for sub-objects. Otherwise, the sub-object settings
- (such as <see cref="P:ZedGraph.FontSpec.IsAntiAlias"/>)
- will be honored.
- </summary>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.IsShowPointValues">
- <summary>
- Gets or sets a value that determines whether or not tooltips will be displayed
- when the mouse hovers over data values.
- </summary>
- <remarks>The displayed values are taken from <see cref="F:ZedGraph.PointPair.Tag"/>
- if it is a <see cref="T:System.String"/> type, or <see cref="M:ZedGraph.PointPairBase.ToString"/>
- otherwise (using the <see cref="P:ZedGraph.ZedGraphControl.PointValueFormat"/> as a format string).
- Additionally, the user can custom format the values using the
- <see cref="E:ZedGraph.ZedGraphControl.PointValueEvent"/> event. Note that <see cref="P:ZedGraph.ZedGraphControl.IsShowPointValues"/>
- may be overridden by <see cref="P:ZedGraph.ZedGraphControl.IsShowCursorValues"/>.
- </remarks>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.IsShowCursorValues">
- <summary>
- Gets or sets a value that determines whether or not tooltips will be displayed
- showing the current scale values when the mouse is within the
- <see cref="P:ZedGraph.Chart.Rect"/>.
- </summary>
- <remarks>The displayed values are taken from the current mouse position, and formatted
- according to <see cref="P:ZedGraph.ZedGraphControl.PointValueFormat"/> and/or <see cref="P:ZedGraph.ZedGraphControl.PointDateFormat"/>. If this
- value is set to true, it overrides the <see cref="P:ZedGraph.ZedGraphControl.IsShowPointValues"/> setting.
- </remarks>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.IsEnableHEdit">
- <summary>
- Gets or sets a value that determines whether or not editing of point data is allowed in
- the horizontal direction.
- </summary>
- <remarks>
- Editing is done by holding down the Alt key, and left-clicking on an individual point of
- a given <see cref="T:ZedGraph.CurveItem"/> to drag it to a new location. The Mouse and Key
- combination for this mode are modifiable using <see cref="P:ZedGraph.ZedGraphControl.EditButtons"/> and
- <see cref="P:ZedGraph.ZedGraphControl.EditModifierKeys"/>.
- </remarks>
- <seealso cref="P:ZedGraph.ZedGraphControl.EditButtons"/>
- <seealso cref="P:ZedGraph.ZedGraphControl.EditModifierKeys"/>
- <seealso cref="P:ZedGraph.ZedGraphControl.IsEnableVEdit"/>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.IsEnableVEdit">
- <summary>
- Gets or sets a value that determines whether or not editing of point data is allowed in
- the vertical direction.
- </summary>
- <remarks>
- Editing is done by holding down the Alt key, and left-clicking on an individual point of
- a given <see cref="T:ZedGraph.CurveItem"/> to drag it to a new location. The Mouse and Key
- combination for this mode are modifiable using <see cref="P:ZedGraph.ZedGraphControl.EditButtons"/> and
- <see cref="P:ZedGraph.ZedGraphControl.EditModifierKeys"/>.
- </remarks>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.IsEnableZoom">
- <summary>
- Gets or sets a value that determines whether or not zooming is allowed for the control.
- </summary>
- <remarks>
- Zooming is done by left-clicking inside the <see cref="P:ZedGraph.Chart.Rect"/> to drag
- out a rectangle, indicating the new scale ranges that will be part of the graph.
- </remarks>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.IsEnableHZoom">
- <summary>
- Gets or sets a value that determines whether or not zooming is allowed for the control in
- the horizontal direction.
- </summary>
- <remarks>
- Zooming is done by left-clicking inside the <see cref="P:ZedGraph.Chart.Rect"/> to drag
- out a rectangle, indicating the new scale ranges that will be part of the graph.
- </remarks>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.IsEnableVZoom">
- <summary>
- Gets or sets a value that determines whether or not zooming is allowed for the control in
- the vertical direction.
- </summary>
- <remarks>
- Zooming is done by left-clicking inside the <see cref="P:ZedGraph.Chart.Rect"/> to drag
- out a rectangle, indicating the new scale ranges that will be part of the graph.
- </remarks>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.IsEnableWheelZoom">
- <summary>
- Gets or sets a value that determines whether or not zooming is allowed via the mouse wheel.
- </summary>
- <remarks>
- Wheel zooming is done by rotating the mouse wheel.
- Note that this property is used in combination with the <see cref="P:ZedGraph.ZedGraphControl.IsEnableHZoom"/> and
- <see cref="P:ZedGraph.ZedGraphControl.IsEnableVZoom"/> properties to control zoom options.
- </remarks>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.IsEnableHPan">
- <summary>
- Gets or sets a value that determines whether or not panning is allowed for the control in
- the horizontal direction.
- </summary>
- <remarks>
- Panning is done by clicking the middle mouse button (or holding down the shift key
- while clicking the left mouse button) inside the <see cref="P:ZedGraph.Chart.Rect"/> and
- dragging the mouse around to shift the scale ranges as desired.
- </remarks>
- <seealso cref="P:ZedGraph.ZedGraphControl.IsEnableVPan"/>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.IsEnableVPan">
- <summary>
- Gets or sets a value that determines whether or not panning is allowed for the control in
- the vertical direction.
- </summary>
- <remarks>
- Panning is done by clicking the middle mouse button (or holding down the shift key
- while clicking the left mouse button) inside the <see cref="P:ZedGraph.Chart.Rect"/> and
- dragging the mouse around to shift the scale ranges as desired.
- </remarks>
- <seealso cref="P:ZedGraph.ZedGraphControl.IsEnableHPan"/>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.IsShowContextMenu">
- <summary>
- Gets or sets a value that determines whether or not the context menu will be available.
- </summary>
- <remarks>The context menu is a menu that appears when you right-click on the
- <see cref="T:ZedGraph.ZedGraphControl"/>. It provides options for Zoom, Pan, AutoScale, Clipboard
- Copy, and toggle <see cref="P:ZedGraph.ZedGraphControl.IsShowPointValues"/>.
- </remarks>
- <value>true to allow the context menu, false to disable it</value>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.IsShowCopyMessage">
- <summary>
- Gets or sets a value that determines whether or not a message box will be shown
- in response to a context menu "Copy" command.
- </summary>
- <remarks>
- Note that, if this property is set to false, the user will receive no
- indicative feedback in response to a Copy action.
- </remarks>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.SaveFileDialog">
- <summary>
- Gets or sets the <see cref="P:ZedGraph.ZedGraphControl.SaveFileDialog"/> instance that will be used
- by the "Save As..." context menu item.
- </summary>
- <remarks>
- This provides the opportunity to modify the dialog, such as setting the
- <see cref="P:System.Windows.Forms.FileDialog.InitialDirectory"/> property.
- </remarks>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.IsPrintKeepAspectRatio">
- <summary>
- Gets or sets a value that determines whether or not the visible aspect ratio of the
- <see cref="P:ZedGraph.ZedGraphControl.MasterPane"/> <see cref="P:ZedGraph.PaneBase.Rect"/> will be preserved
- when printing this <see cref="T:ZedGraph.ZedGraphControl"/>.
- </summary>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.IsPrintFillPage">
- <summary>
- Gets or sets a value that determines whether or not the <see cref="P:ZedGraph.ZedGraphControl.MasterPane"/>
- <see cref="P:ZedGraph.PaneBase.Rect"/> dimensions will be expanded to fill the
- available space when printing this <see cref="T:ZedGraph.ZedGraphControl"/>.
- </summary>
- <remarks>
- If <see cref="P:ZedGraph.ZedGraphControl.IsPrintKeepAspectRatio"/> is also true, then the <see cref="P:ZedGraph.ZedGraphControl.MasterPane"/>
- <see cref="P:ZedGraph.PaneBase.Rect"/> dimensions will be expanded to fit as large
- a space as possible while still honoring the visible aspect ratio.
- </remarks>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.IsPrintScaleAll">
- <summary>
- Gets or sets a value that determines whether the settings of
- <see cref="P:ZedGraph.PaneBase.IsFontsScaled"/> and <see cref="P:ZedGraph.PaneBase.IsPenWidthScaled"/>
- will be overridden to true during printing operations.
- </summary>
- <remarks>
- Printing involves pixel maps that are typically of a dramatically different dimension
- than on-screen pixel maps. Therefore, it becomes more important to scale the fonts and
- lines to give a printed image that looks like what is shown on-screen. The default
- setting for <see cref="P:ZedGraph.PaneBase.IsFontsScaled"/> is true, but the default
- setting for <see cref="P:ZedGraph.PaneBase.IsPenWidthScaled"/> is false.
- </remarks>
- <value>
- A value of true will cause both <see cref="P:ZedGraph.PaneBase.IsFontsScaled"/> and
- <see cref="P:ZedGraph.PaneBase.IsPenWidthScaled"/> to be temporarily set to true during
- printing operations.
- </value>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.IsAutoScrollRange">
- <summary>
- Gets or sets a value that controls whether or not the axis value range for the scroll
- bars will be set automatically.
- </summary>
- <remarks>
- If this value is set to true, then the range of the scroll bars will be set automatically
- to the actual range of the data as returned by <see cref="M:ZedGraph.CurveList.GetRange(System.Boolean,System.Boolean,ZedGraph.GraphPane)"/> at the
- time that <see cref="M:ZedGraph.ZedGraphControl.AxisChange"/> was last called. Note that a value of true
- can override any setting of <see cref="P:ZedGraph.ZedGraphControl.ScrollMinX"/>, <see cref="P:ZedGraph.ZedGraphControl.ScrollMaxX"/>,
- <see cref="P:ZedGraph.ZedGraphControl.ScrollMinY"/>, <see cref="P:ZedGraph.ZedGraphControl.ScrollMaxY"/>,
- <see cref="P:ZedGraph.ZedGraphControl.ScrollMinY2"/>, and <see cref="P:ZedGraph.ZedGraphControl.ScrollMaxY2"/>. Note also that you must
- call <see cref="M:ZedGraph.ZedGraphControl.AxisChange"/> from the <see cref="T:ZedGraph.ZedGraphControl"/> for this to
- work properly (e.g., don't call it directly from the <see cref="P:ZedGraph.ZedGraphControl.GraphPane"/>.
- Alternatively, you can call <see cref="M:ZedGraph.ZedGraphControl.SetScrollRangeFromData"/> at anytime to set
- the scroll bar range.<br/>
- <b>In most cases, you will probably want to disable
- <see cref="P:ZedGraph.GraphPane.IsBoundedRanges"/> before activating this option.</b>
- </remarks>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.ScrollGrace">
- <summary>
- Set a "grace" value that leaves a buffer area around the data when
- <see cref="P:ZedGraph.ZedGraphControl.IsAutoScrollRange"/> is true.
- </summary>
- <remarks>
- This value represents a fraction of the total range around each axis. For example, if the
- axis ranges from 0 to 100, then a 0.05 value for ScrollGrace would set the scroll range
- to -5 to 105.
- </remarks>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.IsShowHScrollBar">
- <summary>
- Gets or sets a value that determines if the horizontal scroll bar will be visible.
- </summary>
- <remarks>This scroll bar allows the display to be scrolled in the horizontal direction.
- Another option is display panning, in which the user can move the display around by
- clicking directly on it and dragging (see <see cref="P:ZedGraph.ZedGraphControl.IsEnableHPan"/> and <see cref="P:ZedGraph.ZedGraphControl.IsEnableVPan"/>).
- You can control the available range of scrolling with the <see cref="P:ZedGraph.ZedGraphControl.ScrollMinX"/> and
- <see cref="P:ZedGraph.ZedGraphControl.ScrollMaxX"/> properties. Note that the scroll range can be set automatically by
- <see cref="P:ZedGraph.ZedGraphControl.IsAutoScrollRange"/>.<br/>
- <b>In most cases, you will probably want to disable
- <see cref="P:ZedGraph.GraphPane.IsBoundedRanges"/> before activating this option.</b>
- </remarks>
- <value>A boolean value. true to display a horizontal scrollbar, false otherwise.</value>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.IsShowVScrollBar">
- <summary>
- Gets or sets a value that determines if the vertical scroll bar will be visible.
- </summary>
- <remarks>This scroll bar allows the display to be scrolled in the vertical direction.
- Another option is display panning, in which the user can move the display around by
- clicking directly on it and dragging (see <see cref="P:ZedGraph.ZedGraphControl.IsEnableHPan"/> and <see cref="P:ZedGraph.ZedGraphControl.IsEnableVPan"/>).
- You can control the available range of scrolling with the <see cref="P:ZedGraph.ZedGraphControl.ScrollMinY"/> and
- <see cref="P:ZedGraph.ZedGraphControl.ScrollMaxY"/> properties.
- Note that the vertical scroll bar only affects the <see cref="T:ZedGraph.YAxis"/>; it has no impact on
- the <see cref="T:ZedGraph.Y2Axis"/>. The panning options affect both the <see cref="T:ZedGraph.YAxis"/> and
- <see cref="T:ZedGraph.Y2Axis"/>. Note also that the scroll range can be set automatically by
- <see cref="P:ZedGraph.ZedGraphControl.IsAutoScrollRange"/>.<br/>
- <b>In most cases, you will probably want to disable
- <see cref="P:ZedGraph.GraphPane.IsBoundedRanges"/> before activating this option.</b>
- </remarks>
- <value>A boolean value. true to display a vertical scrollbar, false otherwise.</value>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.IsSynchronizeXAxes">
- <summary>
- Gets or sets a value that determines if the <see cref="T:ZedGraph.XAxis"/> <see cref="T:ZedGraph.Scale"/>
- ranges for all <see cref="P:ZedGraph.ZedGraphControl.GraphPane"/> objects in the <see cref="P:ZedGraph.ZedGraphControl.MasterPane"/> will
- be forced to match.
- </summary>
- <remarks>
- If set to true (default is false), then all of the <see cref="P:ZedGraph.ZedGraphControl.GraphPane"/> objects
- in the <see cref="P:ZedGraph.ZedGraphControl.MasterPane"/> associated with this <see cref="T:ZedGraph.ZedGraphControl"/>
- will be forced to have matching scale ranges for the x axis. That is, zoom, pan,
- and scroll operations will result in zoom/pan/scroll for all graphpanes simultaneously.
- </remarks>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.IsSynchronizeYAxes">
- <summary>
- Gets or sets a value that determines if the <see cref="T:ZedGraph.YAxis"/> <see cref="T:ZedGraph.Scale"/>
- ranges for all <see cref="P:ZedGraph.ZedGraphControl.GraphPane"/> objects in the <see cref="P:ZedGraph.ZedGraphControl.MasterPane"/> will
- be forced to match.
- </summary>
- <remarks>
- If set to true (default is false), then all of the <see cref="P:ZedGraph.ZedGraphControl.GraphPane"/> objects
- in the <see cref="P:ZedGraph.ZedGraphControl.MasterPane"/> associated with this <see cref="T:ZedGraph.ZedGraphControl"/>
- will be forced to have matching scale ranges for the y axis. That is, zoom, pan,
- and scroll operations will result in zoom/pan/scroll for all graphpanes simultaneously.
- </remarks>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.IsScrollY2">
- <summary>
- Gets or sets a value that determines if the vertical scroll bar will affect the Y2 axis.
- </summary>
- <remarks>
- The vertical scroll bar is automatically associated with the Y axis. With this value, you
- can choose to include or exclude the Y2 axis with the scrolling. Note that the Y2 axis
- scrolling is handled as a secondary. The vertical scroll bar position always reflects
- the status of the Y axis. This can cause the Y2 axis to "jump" when first scrolled if
- the <see cref="P:ZedGraph.ZedGraphControl.ScrollMinY2"/> and <see cref="P:ZedGraph.ZedGraphControl.ScrollMaxY2"/> values are not set to the
- same proportions as <see cref="P:ZedGraph.ZedGraphControl.ScrollMinY"/> and <see cref="P:ZedGraph.ZedGraphControl.ScrollMaxY"/> with respect
- to the actual <see cref="P:ZedGraph.Scale.Min"/> and <see cref="P:ZedGraph.Scale.Max"/>. Also note that
- this property is actually just an alias to the <see cref="P:ZedGraph.ScrollRange.IsScrollable"/>
- property of the first element of <see cref="P:ZedGraph.ZedGraphControl.YScrollRangeList"/>.
- </remarks>
- <seealso cref="P:ZedGraph.ZedGraphControl.IsShowVScrollBar"/>
- <seealso cref="P:ZedGraph.ZedGraphControl.ScrollMinY2"/>
- <seealso cref="P:ZedGraph.ZedGraphControl.ScrollMaxY2"/>
- <seealso cref="P:ZedGraph.ZedGraphControl.YScrollRangeList"/>
- <seealso cref="P:ZedGraph.ZedGraphControl.Y2ScrollRangeList"/>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.YScrollRangeList">
- <summary>
- Access the <see cref="T:ZedGraph.ScrollRangeList"/> for the Y axes.
- </summary>
- <remarks>
- This list maintains the user scale ranges for the scroll bars for each axis
- in the <see cref="P:ZedGraph.GraphPane.YAxisList"/>. Each ordinal location in
- <see cref="P:ZedGraph.ZedGraphControl.YScrollRangeList"/> corresponds to an equivalent ordinal location
- in <see cref="P:ZedGraph.GraphPane.YAxisList"/>.
- </remarks>
- <seealso cref="P:ZedGraph.ZedGraphControl.ScrollMinY"/>
- <seealso cref="P:ZedGraph.ZedGraphControl.ScrollMaxY"/>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.Y2ScrollRangeList">
- <summary>
- Access the <see cref="T:ZedGraph.ScrollRangeList"/> for the Y2 axes.
- </summary>
- <remarks>
- This list maintains the user scale ranges for the scroll bars for each axis
- in the <see cref="P:ZedGraph.GraphPane.Y2AxisList"/>. Each ordinal location in
- <see cref="P:ZedGraph.ZedGraphControl.Y2ScrollRangeList"/> corresponds to an equivalent ordinal location
- in <see cref="P:ZedGraph.GraphPane.Y2AxisList"/>.
- </remarks>
- <seealso cref="P:ZedGraph.ZedGraphControl.ScrollMinY2"/>
- <seealso cref="P:ZedGraph.ZedGraphControl.ScrollMaxY2"/>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.ScrollMinX">
- <summary>
- The minimum value for the X axis scroll range.
- </summary>
- <remarks>
- Effectively, the minimum endpoint of the scroll range will cause the
- <see cref="P:ZedGraph.Scale.Min"/> value to be set to <see cref="P:ZedGraph.ZedGraphControl.ScrollMinX"/>. Note that this
- value applies only to the scroll bar settings. Axis panning (see <see cref="P:ZedGraph.ZedGraphControl.IsEnableHPan"/>)
- is not affected by this value. Note that this value can be overridden by
- <see cref="P:ZedGraph.ZedGraphControl.IsAutoScrollRange"/> and <see cref="M:ZedGraph.ZedGraphControl.SetScrollRangeFromData"/>.
- </remarks>
- <value>A double value indicating the minimum axis value</value>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.ScrollMaxX">
- <summary>
- The maximum value for the X axis scroll range.
- </summary>
- <remarks>
- Effectively, the maximum endpoint of the scroll range will cause the
- <see cref="P:ZedGraph.Scale.Max"/> value to be set to <see cref="P:ZedGraph.ZedGraphControl.ScrollMaxX"/>. Note that this
- value applies only to the scroll bar settings. Axis panning (see <see cref="P:ZedGraph.ZedGraphControl.IsEnableHPan"/>)
- is not affected by this value. Note that this value can be overridden by
- <see cref="P:ZedGraph.ZedGraphControl.IsAutoScrollRange"/> and <see cref="M:ZedGraph.ZedGraphControl.SetScrollRangeFromData"/>.
- </remarks>
- <value>A double value indicating the maximum axis value</value>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.ScrollMinY">
- <summary>
- The minimum value for the Y axis scroll range.
- </summary>
- <remarks>
- Effectively, the minimum endpoint of the scroll range will cause the
- <see cref="P:ZedGraph.Scale.Min"/> value to be set to <see cref="P:ZedGraph.ZedGraphControl.ScrollMinY"/>. Note that this
- value applies only to the scroll bar settings. Axis panning (see <see cref="P:ZedGraph.ZedGraphControl.IsEnableVPan"/>)
- is not affected by this value. Note that this value can be overridden by
- <see cref="P:ZedGraph.ZedGraphControl.IsAutoScrollRange"/> and <see cref="M:ZedGraph.ZedGraphControl.SetScrollRangeFromData"/>. Also note that
- this property is actually just an alias to the <see cref="P:ZedGraph.ScrollRange.Min"/>
- property of the first element of <see cref="P:ZedGraph.ZedGraphControl.YScrollRangeList"/>.
- </remarks>
- <value>A double value indicating the minimum axis value</value>
- <seealso cref="P:ZedGraph.ZedGraphControl.YScrollRangeList"/>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.ScrollMaxY">
- <summary>
- The maximum value for the Y axis scroll range.
- </summary>
- <remarks>
- Effectively, the maximum endpoint of the scroll range will cause the
- <see cref="P:ZedGraph.Scale.Max"/> value to be set to <see cref="P:ZedGraph.ZedGraphControl.ScrollMaxY"/>. Note that this
- value applies only to the scroll bar settings. Axis panning (see <see cref="P:ZedGraph.ZedGraphControl.IsEnableVPan"/>)
- is not affected by this value. Note that this value can be overridden by
- <see cref="P:ZedGraph.ZedGraphControl.IsAutoScrollRange"/> and <see cref="M:ZedGraph.ZedGraphControl.SetScrollRangeFromData"/>. Also note that
- this property is actually just an alias to the <see cref="P:ZedGraph.ScrollRange.Max"/>
- property of the first element of <see cref="P:ZedGraph.ZedGraphControl.YScrollRangeList"/>.
- </remarks>
- <value>A double value indicating the maximum axis value</value>
- <seealso cref="P:ZedGraph.ZedGraphControl.YScrollRangeList"/>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.ScrollMinY2">
- <summary>
- The minimum value for the Y2 axis scroll range.
- </summary>
- <remarks>
- Effectively, the minimum endpoint of the scroll range will cause the
- <see cref="P:ZedGraph.Scale.Min"/> value to be set to <see cref="P:ZedGraph.ZedGraphControl.ScrollMinY2"/>. Note that this
- value applies only to the scroll bar settings. Axis panning (see <see cref="P:ZedGraph.ZedGraphControl.IsEnableVPan"/>)
- is not affected by this value. Note that this value can be overridden by
- <see cref="P:ZedGraph.ZedGraphControl.IsAutoScrollRange"/> and <see cref="M:ZedGraph.ZedGraphControl.SetScrollRangeFromData"/>. Also note that
- this property is actually just an alias to the <see cref="P:ZedGraph.ScrollRange.Min"/>
- property of the first element of <see cref="P:ZedGraph.ZedGraphControl.Y2ScrollRangeList"/>.
- </remarks>
- <value>A double value indicating the minimum axis value</value>
- <seealso cref="P:ZedGraph.ZedGraphControl.Y2ScrollRangeList"/>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.ScrollMaxY2">
- <summary>
- The maximum value for the Y2 axis scroll range.
- </summary>
- <remarks>
- Effectively, the maximum endpoint of the scroll range will cause the
- <see cref="P:ZedGraph.Scale.Max"/> value to be set to <see cref="P:ZedGraph.ZedGraphControl.ScrollMaxY2"/>. Note that this
- value applies only to the scroll bar settings. Axis panning (see <see cref="P:ZedGraph.ZedGraphControl.IsEnableVPan"/>)
- is not affected by this value. Note that this value can be overridden by
- <see cref="P:ZedGraph.ZedGraphControl.IsAutoScrollRange"/> and <see cref="M:ZedGraph.ZedGraphControl.SetScrollRangeFromData"/>. Also note that
- this property is actually just an alias to the <see cref="P:ZedGraph.ScrollRange.Max"/>
- property of the first element of <see cref="P:ZedGraph.ZedGraphControl.Y2ScrollRangeList"/>.
- </remarks>
- <value>A double value indicating the maximum axis value</value>
- <seealso cref="P:ZedGraph.ZedGraphControl.Y2ScrollRangeList"/>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.IsScrolling">
- <summary>
- Returns true if the user is currently scrolling via the scrollbar, or
- false if no scrolling is taking place.
- </summary>
- <remarks>
- This method just tests ScrollBar.Capture to see if the
- mouse has been captured by the scroll bar. If so, scrolling is active.
- </remarks>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.PointValueFormat">
- <summary>
- Gets or sets the format for displaying tooltip values.
- This format is passed to <see cref="M:ZedGraph.PointPairBase.ToString(System.String)"/>.
- </summary>
- <remarks>
- Use the <see cref="T:System.Globalization.NumberFormatInfo"/> type
- to determine the format strings.
- </remarks>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.PointDateFormat">
- <summary>
- Gets or sets the format for displaying tooltip values.
- This format is passed to <see cref="M:ZedGraph.XDate.ToString(System.String)"/>.
- </summary>
- <remarks>
- Use the <see cref="T:System.Globalization.DateTimeFormatInfo"/> type
- to determine the format strings.
- </remarks>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.ZoomStepFraction">
- <summary>
- Gets or sets the step size fraction for zooming with the mouse wheel.
- A value of 0.1 will result in a 10% zoom step for each mouse wheel movement.
- </summary>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.IsZoomOnMouseCenter">
- <summary>
- Gets or sets a boolean value that determines if zooming with the wheel mouse
- is centered on the mouse location, or centered on the existing graph.
- </summary>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.BeenDisposed">
- <summary>
- This checks if the control has been disposed. This is synonymous with
- the graph pane having been nulled or disposed. Therefore this is the
- same as <c>ZedGraphControl.GraphPane == null</c>.
- </summary>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.Selection">
- <summary>
- Readonly property that gets the list of selected CurveItems
- </summary>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.IsEnableSelection">
- <summary>
- Gets or sets a value that determines whether or not selection is allowed for the control.
- </summary>
- </member>
- <member name="E:ZedGraph.ZedGraphControl.ContextMenuBuilder">
- <summary>
- Subscribe to this event to be able to modify the ZedGraph context menu.
- </summary>
- <remarks>
- The context menu is built on the fly after a right mouse click. You can add menu items
- to this menu by simply modifying the <see paramref="menu"/> parameter.
- </remarks>
- </member>
- <member name="E:ZedGraph.ZedGraphControl.ZoomEvent">
- <summary>
- Subscribe to this event to be notified when the <see cref="P:ZedGraph.ZedGraphControl.GraphPane"/> is zoomed or panned by the user,
- either via a mouse drag operation or by the context menu commands.
- </summary>
- </member>
- <member name="E:ZedGraph.ZedGraphControl.ScrollDoneEvent">
- <summary>
- Subscribe to this event to be notified when the <see cref="P:ZedGraph.ZedGraphControl.GraphPane"/> is scrolled by the user
- using the scrollbars.
- </summary>
- </member>
- <member name="E:ZedGraph.ZedGraphControl.ScrollProgressEvent">
- <summary>
- Subscribe to this event to be notified when the <see cref="P:ZedGraph.ZedGraphControl.GraphPane"/> is scrolled by the user
- using the scrollbars.
- </summary>
- </member>
- <member name="E:ZedGraph.ZedGraphControl.ScrollEvent">
- <summary>
- Subscribe to this event to be notified when the <see cref="P:ZedGraph.ZedGraphControl.GraphPane"/> is scrolled by the user
- using the scrollbars.
- </summary>
- </member>
- <member name="E:ZedGraph.ZedGraphControl.PointEditEvent">
- <summary>
- Subscribe to this event to receive notifcation and/or respond after a data
- point has been edited via <see cref="P:ZedGraph.ZedGraphControl.IsEnableHEdit"/> and <see cref="P:ZedGraph.ZedGraphControl.IsEnableVEdit"/>.
- </summary>
- <example>
- <para>To subscribe to this event, use the following in your Form_Load method:</para>
- <code>zedGraphControl1.PointEditEvent +=
- new ZedGraphControl.PointEditHandler( MyPointEditHandler );</code>
- <para>Add this method to your Form1.cs:</para>
- <code>
- private string MyPointEditHandler( object sender, GraphPane pane, CurveItem curve, int iPt )
- {
- PointPair pt = curve[iPt];
- return "This value is " + pt.Y.ToString("f2") + " gallons";
- }</code>
- </example>
- </member>
- <member name="E:ZedGraph.ZedGraphControl.PointValueEvent">
- <summary>
- Subscribe to this event to provide custom formatting for the tooltips
- </summary>
- <example>
- <para>To subscribe to this event, use the following in your FormLoad method:</para>
- <code>zedGraphControl1.PointValueEvent +=
- new ZedGraphControl.PointValueHandler( MyPointValueHandler );</code>
- <para>Add this method to your Form1.cs:</para>
- <code>
- private string MyPointValueHandler( object sender, GraphPane pane, CurveItem curve, int iPt )
- {
- #region
- PointPair pt = curve[iPt];
- return "This value is " + pt.Y.ToString("f2") + " gallons";
- #endregion
- }</code>
- </example>
- </member>
- <member name="E:ZedGraph.ZedGraphControl.CursorValueEvent">
- <summary>
- Subscribe to this event to provide custom formatting for the cursor value tooltips
- </summary>
- <example>
- <para>To subscribe to this event, use the following in your FormLoad method:</para>
- <code>zedGraphControl1.CursorValueEvent +=
- new ZedGraphControl.CursorValueHandler( MyCursorValueHandler );</code>
- <para>Add this method to your Form1.cs:</para>
- <code>
- private string MyCursorValueHandler( object sender, GraphPane pane, Point mousePt )
- {
- #region
- double x, y;
- pane.ReverseTransform( mousePt, out x, out y );
- return "( " + x.ToString( "f2" ) + ", " + y.ToString( "f2" ) + " )";
- #endregion
- }</code>
- </example>
- </member>
- <member name="E:ZedGraph.ZedGraphControl.MouseDownEvent">
- <summary>
- Subscribe to this event to provide notification of MouseDown clicks on graph
- objects
- </summary>
- <remarks>
- This event provides for a notification when the mouse is clicked on an object
- within any <see cref="P:ZedGraph.ZedGraphControl.GraphPane"/> of the <see cref="P:ZedGraph.ZedGraphControl.MasterPane"/> associated
- with this <see cref="T:ZedGraph.ZedGraphControl"/>. This event will use the
- <see cref="M:ZedGraph.MasterPane.FindNearestPaneObject(System.Drawing.PointF,System.Drawing.Graphics,ZedGraph.GraphPane@,System.Object@,System.Int32@)"/> method to determine which object
- was clicked. The boolean value that you return from this handler determines whether
- or not the <see cref="T:ZedGraph.ZedGraphControl"/> will do any further handling of the
- MouseDown event (see <see cref="T:ZedGraph.ZedGraphControl.ZedMouseEventHandler"/>). Return true if you have
- handled the MouseDown event entirely, and you do not
- want the <see cref="T:ZedGraph.ZedGraphControl"/> to do any further action (e.g., starting
- a zoom operation). Return false if ZedGraph should go ahead and process the
- MouseDown event.
- </remarks>
- </member>
- <member name="E:ZedGraph.ZedGraphControl.MouseDown">
- <summary>
- Hide the standard control MouseDown event so that the ZedGraphControl.MouseDownEvent
- can be used. This is so that the user must return true/false in order to indicate
- whether or not we should respond to the event.
- </summary>
- </member>
- <member name="E:ZedGraph.ZedGraphControl.MouseUp">
- <summary>
- Hide the standard control MouseUp event so that the ZedGraphControl.MouseUpEvent
- can be used. This is so that the user must return true/false in order to indicate
- whether or not we should respond to the event.
- </summary>
- </member>
- <member name="E:ZedGraph.ZedGraphControl.MouseMove">
- <summary>
- Hide the standard control MouseMove event so that the ZedGraphControl.MouseMoveEvent
- can be used. This is so that the user must return true/false in order to indicate
- whether or not we should respond to the event.
- </summary>
- </member>
- <member name="E:ZedGraph.ZedGraphControl.MouseUpEvent">
- <summary>
- Subscribe to this event to provide notification of MouseUp clicks on graph
- objects
- </summary>
- <remarks>
- This event provides for a notification when the mouse is clicked on an object
- within any <see cref="P:ZedGraph.ZedGraphControl.GraphPane"/> of the <see cref="P:ZedGraph.ZedGraphControl.MasterPane"/> associated
- with this <see cref="T:ZedGraph.ZedGraphControl"/>. This event will use the
- <see cref="M:ZedGraph.MasterPane.FindNearestPaneObject(System.Drawing.PointF,System.Drawing.Graphics,ZedGraph.GraphPane@,System.Object@,System.Int32@)"/> method to determine which object
- was clicked. The boolean value that you return from this handler determines whether
- or not the <see cref="T:ZedGraph.ZedGraphControl"/> will do any further handling of the
- MouseUp event (see <see cref="T:ZedGraph.ZedGraphControl.ZedMouseEventHandler"/>). Return true if you have
- handled the MouseUp event entirely, and you do not
- want the <see cref="T:ZedGraph.ZedGraphControl"/> to do any further action (e.g., starting
- a zoom operation). Return false if ZedGraph should go ahead and process the
- MouseUp event.
- </remarks>
- </member>
- <member name="E:ZedGraph.ZedGraphControl.MouseMoveEvent">
- <summary>
- Subscribe to this event to provide notification of MouseMove events over graph
- objects
- </summary>
- <remarks>
- This event provides for a notification when the mouse is moving over on the control.
- The boolean value that you return from this handler determines whether
- or not the <see cref="T:ZedGraph.ZedGraphControl"/> will do any further handling of the
- MouseMove event (see <see cref="T:ZedGraph.ZedGraphControl.ZedMouseEventHandler"/>). Return true if you
- have handled the MouseMove event entirely, and you do not
- want the <see cref="T:ZedGraph.ZedGraphControl"/> to do any further action.
- Return false if ZedGraph should go ahead and process the MouseMove event.
- </remarks>
- </member>
- <member name="E:ZedGraph.ZedGraphControl.DoubleClickEvent">
- <summary>
- Subscribe to this event to provide notification of Double Clicks on graph
- objects
- </summary>
- <remarks>
- This event provides for a notification when the mouse is double-clicked on an object
- within any <see cref="P:ZedGraph.ZedGraphControl.GraphPane"/> of the <see cref="P:ZedGraph.ZedGraphControl.MasterPane"/> associated
- with this <see cref="T:ZedGraph.ZedGraphControl"/>. This event will use the
- <see cref="M:ZedGraph.MasterPane.FindNearestPaneObject(System.Drawing.PointF,System.Drawing.Graphics,ZedGraph.GraphPane@,System.Object@,System.Int32@)"/> method to determine which object
- was clicked. The boolean value that you return from this handler determines whether
- or not the <see cref="T:ZedGraph.ZedGraphControl"/> will do any further handling of the
- DoubleClick event (see <see cref="T:ZedGraph.ZedGraphControl.ZedMouseEventHandler"/>). Return true if you have
- handled the DoubleClick event entirely, and you do not
- want the <see cref="T:ZedGraph.ZedGraphControl"/> to do any further action.
- Return false if ZedGraph should go ahead and process the
- DoubleClick event.
- </remarks>
- </member>
- <member name="E:ZedGraph.ZedGraphControl.LinkEvent">
- <summary>
- Subscribe to this event to be able to respond to mouse clicks within linked
- objects.
- </summary>
- <remarks>
- Linked objects are typically either <see cref="T:ZedGraph.GraphObj"/> type objects or
- <see cref="T:ZedGraph.CurveItem"/> type objects. These object types can include
- hyperlink information allowing for "drill-down" type operation.
- </remarks>
- <seealso cref="T:ZedGraph.ZedGraphControl.LinkEventHandler"/>
- <seealso cref="T:ZedGraph.Link"/>
- <seealso cref="P:ZedGraph.CurveItem.Link">CurveItem.Link</seealso>
- <seealso cref="P:ZedGraph.GraphObj.Link">GraphObj.Link</seealso>
- </member>
- <member name="P:ZedGraph.ZedGraphControl.PrintDocument">
- <summary>
- Gets or sets the <see cref="T:System.Drawing.Printing.PrintDocument"/> instance
- that is used for all of the context menu printing functions.
- </summary>
- </member>
- <member name="T:ZedGraph.ZedGraphControl.ContextMenuBuilderEventHandler">
- <summary>
- A delegate that allows subscribing methods to append or modify the context menu.
- </summary>
- <param name="sender">The source <see cref="T:ZedGraph.ZedGraphControl"/> object</param>
- <param name="menuStrip">A reference to the <see cref="T:System.Windows.Forms.ContextMenuStrip"/> object
- that contains the context menu.
- </param>
- <param name="mousePt">The point at which the mouse was clicked</param>
- <param name="objState">The current context menu state</param>
- <seealso cref="E:ZedGraph.ZedGraphControl.ContextMenuBuilder"/>
- </member>
- <member name="T:ZedGraph.ZedGraphControl.ZoomEventHandler">
- <summary>
- A delegate that allows notification of zoom and pan events.
- </summary>
- <param name="sender">The source <see cref="T:ZedGraph.ZedGraphControl"/> object</param>
- <param name="oldState">A <see cref="T:ZedGraph.ZoomState"/> object that corresponds to the state of the
- <see cref="P:ZedGraph.ZedGraphControl.GraphPane"/> before the zoom or pan event.</param>
- <param name="newState">A <see cref="T:ZedGraph.ZoomState"/> object that corresponds to the state of the
- <see cref="P:ZedGraph.ZedGraphControl.GraphPane"/> after the zoom or pan event</param>
- <seealso cref="E:ZedGraph.ZedGraphControl.ZoomEvent"/>
- </member>
- <member name="T:ZedGraph.ZedGraphControl.ScrollDoneHandler">
- <summary>
- A delegate that allows notification of scroll events.
- </summary>
- <param name="sender">The source <see cref="T:ZedGraph.ZedGraphControl"/> object</param>
- <param name="scrollBar">The source <see cref="T:System.Windows.Forms.ScrollBar"/> object</param>
- <param name="oldState">A <see cref="T:ZedGraph.ZoomState"/> object that corresponds to the state of the
- <see cref="P:ZedGraph.ZedGraphControl.GraphPane"/> before the scroll event.</param>
- <param name="newState">A <see cref="T:ZedGraph.ZoomState"/> object that corresponds to the state of the
- <see cref="P:ZedGraph.ZedGraphControl.GraphPane"/> after the scroll event</param>
- <seealso cref="E:ZedGraph.ZedGraphControl.ZoomEvent"/>
- </member>
- <member name="T:ZedGraph.ZedGraphControl.ScrollProgressHandler">
- <summary>
- A delegate that allows notification of scroll events.
- </summary>
- <param name="sender">The source <see cref="T:ZedGraph.ZedGraphControl"/> object</param>
- <param name="scrollBar">The source <see cref="T:System.Windows.Forms.ScrollBar"/> object</param>
- <param name="oldState">A <see cref="T:ZedGraph.ZoomState"/> object that corresponds to the state of the
- <see cref="P:ZedGraph.ZedGraphControl.GraphPane"/> before the scroll event.</param>
- <param name="newState">A <see cref="T:ZedGraph.ZoomState"/> object that corresponds to the state of the
- <see cref="P:ZedGraph.ZedGraphControl.GraphPane"/> after the scroll event</param>
- <seealso cref="E:ZedGraph.ZedGraphControl.ZoomEvent"/>
- </member>
- <member name="T:ZedGraph.ZedGraphControl.PointEditHandler">
- <summary>
- A delegate that receives notification after a point-edit operation is completed.
- </summary>
- <param name="sender">The source <see cref="T:ZedGraph.ZedGraphControl"/> object</param>
- <param name="pane">The <see cref="P:ZedGraph.ZedGraphControl.GraphPane"/> object that contains the
- point that has been edited</param>
- <param name="curve">The <see cref="T:ZedGraph.CurveItem"/> object that contains the point
- that has been edited</param>
- <param name="iPt">The integer index of the edited <see cref="T:ZedGraph.PointPair"/> within the
- <see cref="T:ZedGraph.IPointList"/> of the selected <see cref="T:ZedGraph.CurveItem"/>
- </param>
- <seealso cref="E:ZedGraph.ZedGraphControl.PointValueEvent"/>
- </member>
- <member name="T:ZedGraph.ZedGraphControl.PointValueHandler">
- <summary>
- A delegate that allows custom formatting of the point value tooltips
- </summary>
- <param name="sender">The source <see cref="T:ZedGraph.ZedGraphControl"/> object</param>
- <param name="pane">The <see cref="P:ZedGraph.ZedGraphControl.GraphPane"/> object that contains the point value of interest</param>
- <param name="curve">The <see cref="T:ZedGraph.CurveItem"/> object that contains the point value of interest</param>
- <param name="iPt">The integer index of the selected <see cref="T:ZedGraph.PointPair"/> within the
- <see cref="T:ZedGraph.IPointList"/> of the selected <see cref="T:ZedGraph.CurveItem"/></param>
- <seealso cref="E:ZedGraph.ZedGraphControl.PointValueEvent"/>
- </member>
- <member name="T:ZedGraph.ZedGraphControl.CursorValueHandler">
- <summary>
- A delegate that allows custom formatting of the cursor value tooltips
- </summary>
- <param name="sender">The source <see cref="T:ZedGraph.ZedGraphControl"/> object</param>
- <param name="pane">The <see cref="P:ZedGraph.ZedGraphControl.GraphPane"/> object that contains the cursor of interest</param>
- <param name="mousePt">The <see cref="T:System.Drawing.Point"/> object that represents the cursor value location</param>
- <seealso cref="E:ZedGraph.ZedGraphControl.CursorValueEvent"/>
- </member>
- <member name="T:ZedGraph.ZedGraphControl.ZedMouseEventHandler">
- <summary>
- A delegate that allows notification of mouse events on Graph objects.
- </summary>
- <param name="sender">The source <see cref="T:ZedGraph.ZedGraphControl"/> object</param>
- <param name="e">A <see cref="T:System.Windows.Forms.MouseEventArgs"/> corresponding to this event</param>
- <seealso cref="E:ZedGraph.ZedGraphControl.MouseDownEvent"/>
- <returns>
- Return true if you have handled the mouse event entirely, and you do not
- want the <see cref="T:ZedGraph.ZedGraphControl"/> to do any further action (e.g., starting
- a zoom operation). Return false if ZedGraph should go ahead and process the
- mouse event.
- </returns>
- </member>
- <member name="T:ZedGraph.ZedGraphControl.LinkEventHandler">
- <summary>
- A delegate that allows notification of clicks on ZedGraph objects that have
- active links enabled
- </summary>
- <param name="sender">The source <see cref="T:ZedGraph.ZedGraphControl"/> object</param>
- <param name="pane">The source <see cref="P:ZedGraph.ZedGraphControl.GraphPane"/> in which the click
- occurred.
- </param>
- <param name="source">The source object which was clicked. This is typically
- a type of <see cref="T:ZedGraph.CurveItem"/> if a curve point was clicked, or
- a type of <see cref="T:ZedGraph.GraphObj"/> if a graph object was clicked.
- </param>
- <param name="link">The <see cref="T:ZedGraph.Link"/> object, belonging to
- <paramref name="source"/>, that contains the link information
- </param>
- <param name="index">An index value, typically used if a <see cref="T:ZedGraph.CurveItem"/>
- was clicked, indicating the ordinal value of the actual point that was clicked.
- </param>
- <returns>
- Return true if you have handled the LinkEvent entirely, and you do not
- want the <see cref="T:ZedGraph.ZedGraphControl"/> to do any further action.
- Return false if ZedGraph should go ahead and process the LinkEvent.
- </returns>
- </member>
- <member name="T:ZedGraph.ZedGraphControl.ContextMenuObjectState">
- <summary>
- Public enumeration that specifies the type of
- object present at the Context Menu's mouse location
- </summary>
- </member>
- <member name="F:ZedGraph.ZedGraphControl.ContextMenuObjectState.InactiveSelection">
- <summary>
- The object is an Inactive Curve Item at the Context Menu's mouse position
- </summary>
- </member>
- <member name="F:ZedGraph.ZedGraphControl.ContextMenuObjectState.ActiveSelection">
- <summary>
- The object is an active Curve Item at the Context Menu's mouse position
- </summary>
- </member>
- <member name="F:ZedGraph.ZedGraphControl.ContextMenuObjectState.Background">
- <summary>
- There is no selectable object present at the Context Menu's mouse position
- </summary>
- </member>
- <member name="T:ZedGraph.YAxisList">
- <summary>
- A collection class containing a list of <see cref="T:ZedGraph.YAxis"/> objects.
- </summary>
-
- <author>John Champion</author>
- <version> $Revision: 3.3 $ $Date: 2006-06-24 20:26:43 $ </version>
- </member>
- <member name="M:ZedGraph.YAxisList.#ctor">
- <summary>
- Default constructor for the collection class.
- </summary>
- </member>
- <member name="M:ZedGraph.YAxisList.#ctor(ZedGraph.YAxisList)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.YAxisList"/> object from which to copy</param>
- </member>
- <member name="M:ZedGraph.YAxisList.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.YAxisList.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.YAxisList.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.YAxisList.IndexOf(System.String)">
- <summary>
- Return the zero-based position index of the
- <see cref="T:ZedGraph.Axis"/> with the specified <see cref="P:ZedGraph.Axis.Title"/>.
- </summary>
- <remarks>The comparison of titles is not case sensitive, but it must include
- all characters including punctuation, spaces, etc.</remarks>
- <param name="title">The <see cref="T:System.String"/> label that is in the
- <see cref="P:ZedGraph.Axis.Title"/> attribute of the item to be found.
- </param>
- <returns>The zero-based index of the specified <see cref="T:ZedGraph.Axis"/>,
- or -1 if the <see cref="P:ZedGraph.Axis.Title"/> was not found in the list</returns>
- <seealso cref="M:ZedGraph.YAxisList.IndexOfTag(System.String)"/>
- </member>
- <member name="M:ZedGraph.YAxisList.IndexOfTag(System.String)">
- <summary>
- Return the zero-based position index of the
- <see cref="T:ZedGraph.Axis"/> with the specified <see cref="F:ZedGraph.Axis.Tag"/>.
- </summary>
- <remarks>In order for this method to work, the <see cref="F:ZedGraph.Axis.Tag"/>
- property must be of type <see cref="T:System.String"/>.
- </remarks>
- <param name="tagStr">The <see cref="T:System.String"/> tag that is in the
- <see cref="F:ZedGraph.Axis.Tag"/> attribute of the item to be found.
- </param>
- <returns>The zero-based index of the specified <see cref="T:ZedGraph.Axis"/>,
- or -1 if the <see cref="F:ZedGraph.Axis.Tag"/> string is not in the list</returns>
- </member>
- <member name="M:ZedGraph.YAxisList.Add(System.String)">
- <summary>
- Create a new <see cref="T:ZedGraph.YAxis"/> and add it to this list.
- </summary>
- <param name="title">The title string for the new axis</param>
- <returns>An integer representing the ordinal position of the new <see cref="T:ZedGraph.YAxis"/> in
- this <see cref="T:ZedGraph.YAxisList"/>. This is the value that you would set the
- <see cref="P:ZedGraph.CurveItem.YAxisIndex"/> property of a given <see cref="T:ZedGraph.CurveItem"/> to
- assign it to this new <see cref="T:ZedGraph.YAxis"/>.</returns>
- </member>
- <member name="P:ZedGraph.YAxisList.Item(System.Int32)">
- <summary>
- Indexer to access the specified <see cref="T:ZedGraph.Axis"/> object by
- its ordinal position in the list.
- </summary>
- <param name="index">The ordinal position (zero-based) of the
- <see cref="T:ZedGraph.YAxis"/> object to be accessed.</param>
- <value>An <see cref="T:ZedGraph.Axis"/> object reference.</value>
- </member>
- <member name="P:ZedGraph.YAxisList.Item(System.String)">
- <summary>
- Indexer to access the specified <see cref="T:ZedGraph.Axis"/> object by
- its <see cref="P:ZedGraph.Axis.Title"/> string.
- </summary>
- <param name="title">The string title of the
- <see cref="T:ZedGraph.YAxis"/> object to be accessed.</param>
- <value>A <see cref="T:ZedGraph.Axis"/> object reference.</value>
- </member>
- <member name="T:ZedGraph.StockPt">
- <summary>
- The basic <see cref="T:ZedGraph.PointPair"/> class holds three data values (X, Y, Z). This
- class extends the basic PointPair to contain five data values (X, Y, Z, Open, Close).
- </summary>
- <remarks>
- The values are remapped to <see cref="P:ZedGraph.StockPt.Date"/>, <see cref="P:ZedGraph.StockPt.High"/>,
- <see cref="P:ZedGraph.StockPt.Low"/>, <see cref="F:ZedGraph.StockPt.Open"/>, and <see cref="F:ZedGraph.StockPt.Close"/>.
- </remarks>
-
- <author> John Champion </author>
- <version> $Revision: 3.4 $ $Date: 2007-02-07 07:46:46 $ </version>
- </member>
- <member name="T:ZedGraph.PointPair">
- <summary>
- A simple point represented by an (X,Y,Z) group of double values.
- </summary>
-
- <author> Jerry Vos modified by John Champion </author>
- <version> $Revision: 3.26 $ $Date: 2007-11-28 02:38:22 $ </version>
- </member>
- <member name="T:ZedGraph.PointPairBase">
- <summary>
- This is a base class that provides base-level functionality for a data point consisting
- of an (X,Y) pair of double values.
- </summary>
- <remarks>
- This class is typically a base class for actual <see cref="T:ZedGraph.PointPair"/> type implementations.
- </remarks>
-
- <author> Jerry Vos modified by John Champion </author>
- <version> $Revision: 1.4 $ $Date: 2007-04-16 00:03:02 $ </version>
- </member>
- <member name="F:ZedGraph.PointPairBase.Missing">
- <summary>
- Missing values are represented internally using <see cref="F:System.Double.MaxValue"/>.
- </summary>
- </member>
- <member name="F:ZedGraph.PointPairBase.DefaultFormat">
- <summary>
- The default format to be used for displaying point values via the
- <see cref="M:ZedGraph.PointPairBase.ToString"/> method.
- </summary>
- </member>
- <member name="F:ZedGraph.PointPairBase.schema">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="F:ZedGraph.PointPairBase.X">
- <summary>
- This PointPair's X coordinate
- </summary>
- </member>
- <member name="F:ZedGraph.PointPairBase.Y">
- <summary>
- This PointPair's Y coordinate
- </summary>
- </member>
- <member name="M:ZedGraph.PointPairBase.#ctor">
- <summary>
- Default Constructor
- </summary>
- </member>
- <member name="M:ZedGraph.PointPairBase.#ctor(System.Double,System.Double)">
- <summary>
- Creates a point pair with the specified X and Y.
- </summary>
- <param name="x">This pair's x coordinate.</param>
- <param name="y">This pair's y coordinate.</param>
- </member>
- <member name="M:ZedGraph.PointPairBase.#ctor(System.Drawing.PointF)">
- <summary>
- Creates a point pair from the specified <see cref="T:System.Drawing.PointF"/> struct.
- </summary>
- <param name="pt">The <see cref="T:System.Drawing.PointF"/> struct from which to get the
- new <see cref="T:ZedGraph.PointPair"/> values.</param>
- </member>
- <member name="M:ZedGraph.PointPairBase.#ctor(ZedGraph.PointPairBase)">
- <summary>
- The PointPairBase copy constructor.
- </summary>
- <param name="rhs">The basis for the copy.</param>
- </member>
- <member name="M:ZedGraph.PointPairBase.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.PointPairBase.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.PointPairBase.IsValueInvalid(System.Double)">
- <summary>
- static method to determine if the specified point value is invalid.
- </summary>
- <remarks>The value is considered invalid if it is <see cref="F:ZedGraph.PointPairBase.Missing"/>,
- <see cref="F:System.Double.PositiveInfinity"/>, <see cref="F:System.Double.NegativeInfinity"/>
- or <see cref="F:System.Double.NaN"/>.</remarks>
- <param name="value">The value to be checked for validity.</param>
- <returns>true if the value is invalid, false otherwise</returns>
- </member>
- <member name="M:ZedGraph.PointPairBase.op_Implicit(ZedGraph.PointPairBase)~System.Drawing.PointF">
- <summary>
- Implicit conversion from PointPair to PointF. Note that this conversion
- can result in data loss, since the data are being cast from a type
- double (64 bit) to a float (32 bit).
- </summary>
- <param name="pair">The PointPair struct on which to operate</param>
- <returns>A PointF struct equivalent to the PointPair</returns>
- </member>
- <member name="M:ZedGraph.PointPairBase.Equals(System.Object)">
- <summary>
- Compare two <see cref="T:ZedGraph.PointPairBase"/> objects for equality. To be equal, X and Y
- must be exactly the same between the two objects.
- </summary>
- <param name="obj">The <see cref="T:ZedGraph.PointPairBase"/> object to be compared with.</param>
- <returns>true if the <see cref="T:ZedGraph.PointPairBase"/> objects are equal, false otherwise</returns>
- </member>
- <member name="M:ZedGraph.PointPairBase.GetHashCode">
- <summary>
- Return the HashCode from the base class.
- </summary>
- <returns></returns>
- </member>
- <member name="M:ZedGraph.PointPairBase.ToString">
- <summary>
- Format this PointPair value using the default format. Example: "( 12.345, -16.876 )".
- The two double values are formatted with the "g" format type.
- </summary>
- <returns>A string representation of the PointPair</returns>
- </member>
- <member name="M:ZedGraph.PointPairBase.ToString(System.String)">
- <summary>
- Format this PointPair value using a general format string.
- Example: a format string of "e2" would give "( 1.23e+001, -1.69e+001 )".
- </summary>
- <param name="format">A format string that will be used to format each of
- the two double type values (see <see cref="M:System.Double.ToString"/>).</param>
- <returns>A string representation of the PointPair</returns>
- </member>
- <member name="M:ZedGraph.PointPairBase.ToString(System.String,System.String)">
- <summary>
- Format this PointPair value using different general format strings for the X and Y values.
- Example: a format string of "e2" would give "( 1.23e+001, -1.69e+001 )".
- The Z value is not displayed (see <see cref="M:ZedGraph.PointPair.ToString(System.String,System.String,System.String)"/>).
- </summary>
- <param name="formatX">A format string that will be used to format the X
- double type value (see <see cref="M:System.Double.ToString"/>).</param>
- <param name="formatY">A format string that will be used to format the Y
- double type value (see <see cref="M:System.Double.ToString"/>).</param>
- <returns>A string representation of the PointPair</returns>
- </member>
- <member name="P:ZedGraph.PointPairBase.IsMissing">
- <summary>
- Readonly value that determines if either the X or the Y
- coordinate in this PointPair is a missing value.
- </summary>
- <returns>true if either value is missing</returns>
- </member>
- <member name="P:ZedGraph.PointPairBase.IsInvalid">
- <summary>
- Readonly value that determines if either the X or the Y
- coordinate in this PointPair is an invalid (not plotable) value.
- It is considered invalid if it is missing (equal to System.Double.Max),
- Infinity, or NaN.
- </summary>
- <returns>true if either value is invalid</returns>
- </member>
- <member name="F:ZedGraph.PointPair.schema2">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="F:ZedGraph.PointPair.Z">
- <summary>
- This PointPair's Z coordinate. Also used for the lower value (dependent axis)
- for <see cref="T:ZedGraph.HiLowBarItem"/> and <see cref="T:ZedGraph.ErrorBarItem"/> charts.
- </summary>
- </member>
- <member name="F:ZedGraph.PointPair.Tag">
- <summary>
- A tag object for use by the user. This can be used to store additional
- information associated with the <see cref="T:ZedGraph.PointPair"/>. ZedGraph never
- modifies this value, but if it is a <see cref="T:System.String"/> type, it
- may be displayed in a <see cref="T:System.Windows.Forms.ToolTip"/>
- within the <see cref="T:ZedGraph.ZedGraphControl"/> object.
- </summary>
- <remarks>
- Note that, if you are going to Serialize ZedGraph data, then any type
- that you store in <see cref="F:ZedGraph.PointPair.Tag"/> must be a serializable type (or
- it will cause an exception).
- </remarks>
- </member>
- <member name="M:ZedGraph.PointPair.#ctor">
- <summary>
- Default Constructor
- </summary>
- </member>
- <member name="M:ZedGraph.PointPair.#ctor(System.Double,System.Double)">
- <summary>
- Creates a point pair with the specified X and Y.
- </summary>
- <param name="x">This pair's x coordinate.</param>
- <param name="y">This pair's y coordinate.</param>
- </member>
- <member name="M:ZedGraph.PointPair.#ctor(System.Double,System.Double,System.String)">
- <summary>
- Creates a point pair with the specified X, Y, and
- label (<see cref="F:ZedGraph.PointPair.Tag"/>).
- </summary>
- <param name="x">This pair's x coordinate.</param>
- <param name="y">This pair's y coordinate.</param>
- <param name="label">This pair's string label (<see cref="F:ZedGraph.PointPair.Tag"/>)</param>
- </member>
- <member name="M:ZedGraph.PointPair.#ctor(System.Double,System.Double,System.Double)">
- <summary>
- Creates a point pair with the specified X, Y, and base value.
- </summary>
- <param name="x">This pair's x coordinate.</param>
- <param name="y">This pair's y coordinate.</param>
- <param name="z">This pair's z or lower dependent coordinate.</param>
- </member>
- <member name="M:ZedGraph.PointPair.#ctor(System.Double,System.Double,System.Double,System.String)">
- <summary>
- Creates a point pair with the specified X, Y, base value, and
- string label (<see cref="F:ZedGraph.PointPair.Tag"/>).
- </summary>
- <param name="x">This pair's x coordinate.</param>
- <param name="y">This pair's y coordinate.</param>
- <param name="z">This pair's z or lower dependent coordinate.</param>
- <param name="label">This pair's string label (<see cref="F:ZedGraph.PointPair.Tag"/>)</param>
- </member>
- <member name="M:ZedGraph.PointPair.#ctor(System.Double,System.Double,System.Double,System.Object)">
- <summary>
- Creates a point pair with the specified X, Y, base value, and
- (<see cref="F:ZedGraph.PointPair.Tag"/>).
- </summary>
- <param name="x">This pair's x coordinate.</param>
- <param name="y">This pair's y coordinate.</param>
- <param name="z">This pair's z or lower dependent coordinate.</param>
- <param name="tag">This pair's <see cref="F:ZedGraph.PointPair.Tag"/> property</param>
- </member>
- <member name="M:ZedGraph.PointPair.#ctor(System.Drawing.PointF)">
- <summary>
- Creates a point pair from the specified <see cref="T:System.Drawing.PointF"/> struct.
- </summary>
- <param name="pt">The <see cref="T:System.Drawing.PointF"/> struct from which to get the
- new <see cref="T:ZedGraph.PointPair"/> values.</param>
- </member>
- <member name="M:ZedGraph.PointPair.#ctor(ZedGraph.PointPair)">
- <summary>
- The PointPair copy constructor.
- </summary>
- <param name="rhs">The basis for the copy.</param>
- </member>
- <member name="M:ZedGraph.PointPair.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.PointPair.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.PointPair.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.PointPair.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.PointPair.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.PointPair.Equals(System.Object)">
- <summary>
- Compare two <see cref="T:ZedGraph.PointPair"/> objects for equality. To be equal, X, Y, and Z
- must be exactly the same between the two objects.
- </summary>
- <param name="obj">The <see cref="T:ZedGraph.PointPair"/> object to be compared with.</param>
- <returns>true if the <see cref="T:ZedGraph.PointPair"/> objects are equal, false otherwise</returns>
- </member>
- <member name="M:ZedGraph.PointPair.GetHashCode">
- <summary>
- Return the HashCode from the base class.
- </summary>
- <returns></returns>
- </member>
- <member name="M:ZedGraph.PointPair.ToString(System.Boolean)">
- <summary>
- Format this PointPair value using the default format. Example: "( 12.345, -16.876 )".
- The two double values are formatted with the "g" format type.
- </summary>
- <param name="isShowZ">true to show the third "Z" or low dependent value coordinate</param>
- <returns>A string representation of the PointPair</returns>
- </member>
- <member name="M:ZedGraph.PointPair.ToString(System.String,System.Boolean)">
- <summary>
- Format this PointPair value using a general format string.
- Example: a format string of "e2" would give "( 1.23e+001, -1.69e+001 )".
- If <see paramref="isShowZ"/>
- is true, then the third "Z" coordinate is also shown.
- </summary>
- <param name="format">A format string that will be used to format each of
- the two double type values (see <see cref="M:System.Double.ToString"/>).</param>
- <returns>A string representation of the PointPair</returns>
- <param name="isShowZ">true to show the third "Z" or low dependent value coordinate</param>
- </member>
- <member name="M:ZedGraph.PointPair.ToString(System.String,System.String,System.String)">
- <summary>
- Format this PointPair value using different general format strings for the X, Y, and Z values.
- Example: a format string of "e2" would give "( 1.23e+001, -1.69e+001 )".
- </summary>
- <param name="formatX">A format string that will be used to format the X
- double type value (see <see cref="M:System.Double.ToString"/>).</param>
- <param name="formatY">A format string that will be used to format the Y
- double type value (see <see cref="M:System.Double.ToString"/>).</param>
- <param name="formatZ">A format string that will be used to format the Z
- double type value (see <see cref="M:System.Double.ToString"/>).</param>
- <returns>A string representation of the PointPair</returns>
- </member>
- <member name="P:ZedGraph.PointPair.IsInvalid3D">
- <summary>
- Readonly value that determines if either the X, Y, or Z
- coordinate in this PointPair is an invalid (not plotable) value.
- It is considered invalid if it is missing (equal to System.Double.Max),
- Infinity, or NaN.
- </summary>
- <returns>true if any value is invalid</returns>
- </member>
- <member name="P:ZedGraph.PointPair.LowValue">
- <summary>
- The "low" value for this point (lower dependent-axis value).
- This is really just an alias for <see cref="F:ZedGraph.PointPair.Z"/>.
- </summary>
- <value>The lower dependent value for this <see cref="T:ZedGraph.PointPair"/>.</value>
- </member>
- <member name="P:ZedGraph.PointPair.ColorValue">
- <summary>
- The ColorValue property is just an alias for the <see cref="F:ZedGraph.PointPair.Z"/>
- property.
- </summary>
- <remarks>
- For other types, such as the <see cref="T:ZedGraph.StockPt"/>, the <see cref="T:ZedGraph.StockPt"/>
- can be mapped to a unique value. This is used with the
- <see cref="F:ZedGraph.FillType.GradientByColorValue"/> option.
- </remarks>
- </member>
- <member name="T:ZedGraph.PointPair.PointPairComparerY">
- <summary>
- Compares points based on their y values. Is setup to be used in an
- ascending order sort.
- <seealso cref="M:System.Collections.ArrayList.Sort"/>
- </summary>
- </member>
- <member name="M:ZedGraph.PointPair.PointPairComparerY.Compare(ZedGraph.PointPair,ZedGraph.PointPair)">
- <summary>
- Compares two <see cref="T:ZedGraph.PointPair"/>s.
- </summary>
- <param name="l">Point to the left.</param>
- <param name="r">Point to the right.</param>
- <returns>-1, 0, or 1 depending on l.Y's relation to r.Y</returns>
- </member>
- <member name="T:ZedGraph.PointPair.PointPairComparer">
- <summary>
- Compares points based on their x values. Is setup to be used in an
- ascending order sort.
- <seealso cref="M:System.Collections.ArrayList.Sort"/>
- </summary>
- </member>
- <member name="M:ZedGraph.PointPair.PointPairComparer.#ctor(ZedGraph.SortType)">
- <summary>
- Constructor for PointPairComparer.
- </summary>
- <param name="type">The axis type on which to sort.</param>
- </member>
- <member name="M:ZedGraph.PointPair.PointPairComparer.Compare(ZedGraph.PointPair,ZedGraph.PointPair)">
- <summary>
- Compares two <see cref="T:ZedGraph.PointPair"/>s.
- </summary>
- <param name="l">Point to the left.</param>
- <param name="r">Point to the right.</param>
- <returns>-1, 0, or 1 depending on l.X's relation to r.X</returns>
- </member>
- <member name="F:ZedGraph.StockPt.schema3">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="F:ZedGraph.StockPt.Open">
- <summary>
- This opening value
- </summary>
- </member>
- <member name="F:ZedGraph.StockPt.Close">
- <summary>
- This closing value
- </summary>
- </member>
- <member name="F:ZedGraph.StockPt.Vol">
- <summary>
- This daily trading volume
- </summary>
- </member>
- <member name="F:ZedGraph.StockPt._colorValue">
- <summary>
- This is a user value that can be anything. It is used to provide special
- property-based coloration to the graph elements.
- </summary>
- </member>
- <member name="M:ZedGraph.StockPt.#ctor">
- <summary>
- Default Constructor
- </summary>
- </member>
- <member name="M:ZedGraph.StockPt.#ctor(System.Double,System.Double,System.Double,System.Double,System.Double,System.Double)">
- <summary>
- Construct a new StockPt from the specified data values
- </summary>
- <param name="date">The trading date (<see cref="T:ZedGraph.XDate"/>)</param>
- <param name="open">The opening stock price</param>
- <param name="close">The closing stock price</param>
- <param name="high">The daily high stock price</param>
- <param name="low">The daily low stock price</param>
- <param name="vol">The daily trading volume</param>
- </member>
- <member name="M:ZedGraph.StockPt.#ctor(System.Double,System.Double,System.Double,System.Double,System.Double,System.Double,System.String)">
- <summary>
- Construct a new StockPt from the specified data values including a Tag property
- </summary>
- <param name="date">The trading date (<see cref="T:ZedGraph.XDate"/>)</param>
- <param name="open">The opening stock price</param>
- <param name="close">The closing stock price</param>
- <param name="high">The daily high stock price</param>
- <param name="low">The daily low stock price</param>
- <param name="vol">The daily trading volume</param>
- <param name="tag">The user-defined <see cref="F:ZedGraph.PointPair.Tag"/> property.</param>
- </member>
- <member name="M:ZedGraph.StockPt.#ctor(ZedGraph.StockPt)">
- <summary>
- The StockPt copy constructor.
- </summary>
- <param name="rhs">The basis for the copy.</param>
- </member>
- <member name="M:ZedGraph.StockPt.#ctor(ZedGraph.PointPair)">
- <summary>
- The StockPt copy constructor.
- </summary>
- <param name="rhs">The basis for the copy.</param>
- </member>
- <member name="M:ZedGraph.StockPt.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.StockPt.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.StockPt.ToString(System.Boolean)">
- <summary>
- Format this StockPt value using the default format. Example: "( 12.345, -16.876 )".
- The two double values are formatted with the "g" format type.
- </summary>
- <param name="isShowAll">true to show all the value coordinates</param>
- <returns>A string representation of the <see cref="T:ZedGraph.StockPt"/>.</returns>
- </member>
- <member name="M:ZedGraph.StockPt.ToString(System.String,System.Boolean)">
- <summary>
- Format this PointPair value using a general format string.
- Example: a format string of "e2" would give "( 1.23e+001, -1.69e+001 )".
- If <see paramref="isShowAll"/>
- is true, then the third all coordinates are shown.
- </summary>
- <param name="format">A format string that will be used to format each of
- the two double type values (see <see cref="M:System.Double.ToString"/>).</param>
- <returns>A string representation of the PointPair</returns>
- <param name="isShowAll">true to show all the value coordinates</param>
- </member>
- <member name="P:ZedGraph.StockPt.Date">
- <summary>
- Map the Date property to the X value
- </summary>
- </member>
- <member name="P:ZedGraph.StockPt.High">
- <summary>
- Map the high property to the Y value
- </summary>
- </member>
- <member name="P:ZedGraph.StockPt.Low">
- <summary>
- Map the low property to the Z value
- </summary>
- </member>
- <member name="P:ZedGraph.StockPt.ColorValue">
- <summary>
- The ColorValue property. This is used with the
- <see cref="F:ZedGraph.FillType.GradientByColorValue"/> option.
- </summary>
- </member>
- <member name="P:ZedGraph.StockPt.IsInvalid5D">
- <summary>
- Readonly value that determines if either the Date, Close, Open, High, or Low
- coordinate in this StockPt is an invalid (not plotable) value.
- It is considered invalid if it is missing (equal to System.Double.Max),
- Infinity, or NaN.
- </summary>
- <returns>true if any value is invalid</returns>
- </member>
- <member name="T:ZedGraph.GraphObj">
- <summary>
- An abstract base class that represents a text object on the graph. A list of
- <see cref="T:ZedGraph.GraphObj"/> objects is maintained by the
- <see cref="T:ZedGraph.GraphObjList"/> collection class.
- </summary>
-
- <author> John Champion </author>
- <version> $Revision: 3.1 $ $Date: 2006-06-24 20:26:44 $ </version>
- </member>
- <member name="F:ZedGraph.GraphObj.schema">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- <remarks>
- schema changed to 2 when isClippedToChartRect was added.
- </remarks>
- </member>
- <member name="F:ZedGraph.GraphObj._location">
- <summary>
- Protected field that stores the location of this <see cref="T:ZedGraph.GraphObj"/>.
- Use the public property <see cref="P:ZedGraph.GraphObj.Location"/> to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.GraphObj._isVisible">
- <summary>
- Protected field that determines whether or not this <see cref="T:ZedGraph.GraphObj"/>
- is visible in the graph. Use the public property <see cref="P:ZedGraph.GraphObj.IsVisible"/> to
- access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.GraphObj._isClippedToChartRect">
- <summary>
- Protected field that determines whether or not the rendering of this <see cref="T:ZedGraph.GraphObj"/>
- will be clipped to the ChartRect. Use the public property <see cref="P:ZedGraph.GraphObj.IsClippedToChartRect"/> to
- access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.GraphObj.Tag">
- <summary>
- A tag object for use by the user. This can be used to store additional
- information associated with the <see cref="T:ZedGraph.GraphObj"/>. ZedGraph does
- not use this value for any purpose.
- </summary>
- <remarks>
- Note that, if you are going to Serialize ZedGraph data, then any type
- that you store in <see cref="F:ZedGraph.GraphObj.Tag"/> must be a serializable type (or
- it will cause an exception).
- </remarks>
- </member>
- <member name="F:ZedGraph.GraphObj._zOrder">
- <summary>
- Internal field that determines the z-order "depth" of this
- item relative to other graphic objects. Use the public property
- <see cref="P:ZedGraph.GraphObj.ZOrder"/> to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.GraphObj._link">
- <summary>
- Internal field that stores the hyperlink information for this object.
- </summary>
- </member>
- <member name="M:ZedGraph.GraphObj.#ctor">
- <overloads>
- Constructors for the <see cref="T:ZedGraph.GraphObj"/> class.
- </overloads>
- <summary>
- Default constructor that sets all <see cref="T:ZedGraph.GraphObj"/> properties to default
- values as defined in the <see cref="T:ZedGraph.GraphObj.Default"/> class.
- </summary>
- </member>
- <member name="M:ZedGraph.GraphObj.#ctor(System.Double,System.Double)">
- <summary>
- Constructor that sets all <see cref="T:ZedGraph.GraphObj"/> properties to default
- values as defined in the <see cref="T:ZedGraph.GraphObj.Default"/> class.
- </summary>
- <param name="x">The x position of the text. The units
- of this position are specified by the
- <see cref="P:ZedGraph.Location.CoordinateFrame"/> property. The text will be
- aligned to this position based on the <see cref="T:ZedGraph.AlignH"/>
- property.</param>
- <param name="y">The y position of the text. The units
- of this position are specified by the
- <see cref="P:ZedGraph.Location.CoordinateFrame"/> property. The text will be
- aligned to this position based on the
- <see cref="T:ZedGraph.AlignV"/> property.</param>
- </member>
- <member name="M:ZedGraph.GraphObj.#ctor(System.Double,System.Double,System.Double,System.Double)">
- <summary>
- Constructor that creates a <see cref="T:ZedGraph.GraphObj"/> with the specified
- coordinates and all other properties to defaults as specified
- in the <see cref="T:ZedGraph.GraphObj.Default"/> class..
- </summary>
- <remarks>
- The four coordinates define the starting point and ending point for
- <see cref="T:ZedGraph.ArrowObj"/>'s, or the topleft and bottomright points for
- <see cref="T:ZedGraph.ImageObj"/>'s. For <see cref="T:ZedGraph.GraphObj"/>'s that only require
- one point, the <see paramref="x2"/> and <see paramref="y2"/> values
- will be ignored. The units of the coordinates are specified by the
- <see cref="P:ZedGraph.Location.CoordinateFrame"/> property.
- </remarks>
- <param name="x">The x position of the item.</param>
- <param name="y">The y position of the item.</param>
- <param name="x2">The x2 position of the item.</param>
- <param name="y2">The x2 position of the item.</param>
- </member>
- <member name="M:ZedGraph.GraphObj.#ctor(System.Double,System.Double,ZedGraph.CoordType)">
- <summary>
- Constructor that creates a <see cref="T:ZedGraph.GraphObj"/> with the specified
- position and <see cref="T:ZedGraph.CoordType"/>. Other properties are set to default
- values as defined in the <see cref="T:ZedGraph.GraphObj.Default"/> class.
- </summary>
- <remarks>
- The two coordinates define the location point for the object.
- The units of the coordinates are specified by the
- <see cref="P:ZedGraph.Location.CoordinateFrame"/> property.
- </remarks>
- <param name="x">The x position of the item. The item will be
- aligned to this position based on the <see cref="T:ZedGraph.AlignH"/>
- property.</param>
- <param name="y">The y position of the item. The item will be
- aligned to this position based on the
- <see cref="T:ZedGraph.AlignV"/> property.</param>
- <param name="coordType">The <see cref="T:ZedGraph.CoordType"/> enum value that
- indicates what type of coordinate system the x and y parameters are
- referenced to.</param>
- </member>
- <member name="M:ZedGraph.GraphObj.#ctor(System.Double,System.Double,ZedGraph.CoordType,ZedGraph.AlignH,ZedGraph.AlignV)">
- <summary>
- Constructor that creates a <see cref="T:ZedGraph.GraphObj"/> with the specified
- position, <see cref="T:ZedGraph.CoordType"/>, <see cref="T:ZedGraph.AlignH"/>, and <see cref="T:ZedGraph.AlignV"/>.
- Other properties are set to default values as defined in the <see cref="T:ZedGraph.GraphObj.Default"/> class.
- </summary>
- <remarks>
- The two coordinates define the location point for the object.
- The units of the coordinates are specified by the
- <see cref="P:ZedGraph.Location.CoordinateFrame"/> property.
- </remarks>
- <param name="x">The x position of the item. The item will be
- aligned to this position based on the <see cref="T:ZedGraph.AlignH"/>
- property.</param>
- <param name="y">The y position of the text. The units
- of this position are specified by the
- <see cref="P:ZedGraph.Location.CoordinateFrame"/> property. The text will be
- aligned to this position based on the
- <see cref="T:ZedGraph.AlignV"/> property.</param>
- <param name="coordType">The <see cref="T:ZedGraph.CoordType"/> enum value that
- indicates what type of coordinate system the x and y parameters are
- referenced to.</param>
- <param name="alignH">The <see cref="T:ZedGraph.AlignH"/> enum that specifies
- the horizontal alignment of the object with respect to the (x,y) location</param>
- <param name="alignV">The <see cref="T:ZedGraph.AlignV"/> enum that specifies
- the vertical alignment of the object with respect to the (x,y) location</param>
- </member>
- <member name="M:ZedGraph.GraphObj.#ctor(System.Double,System.Double,System.Double,System.Double,ZedGraph.CoordType,ZedGraph.AlignH,ZedGraph.AlignV)">
- <summary>
- Constructor that creates a <see cref="T:ZedGraph.GraphObj"/> with the specified
- position, <see cref="T:ZedGraph.CoordType"/>, <see cref="T:ZedGraph.AlignH"/>, and <see cref="T:ZedGraph.AlignV"/>.
- Other properties are set to default values as defined in the <see cref="T:ZedGraph.GraphObj.Default"/> class.
- </summary>
- <remarks>
- The four coordinates define the starting point and ending point for
- <see cref="T:ZedGraph.ArrowObj"/>'s, or the topleft and bottomright points for
- <see cref="T:ZedGraph.ImageObj"/>'s. For <see cref="T:ZedGraph.GraphObj"/>'s that only require
- one point, the <see paramref="x2"/> and <see paramref="y2"/> values
- will be ignored. The units of the coordinates are specified by the
- <see cref="P:ZedGraph.Location.CoordinateFrame"/> property.
- </remarks>
- <param name="x">The x position of the item.</param>
- <param name="y">The y position of the item.</param>
- <param name="x2">The x2 position of the item.</param>
- <param name="y2">The x2 position of the item.</param>
- <param name="coordType">The <see cref="T:ZedGraph.CoordType"/> enum value that
- indicates what type of coordinate system the x and y parameters are
- referenced to.</param>
- <param name="alignH">The <see cref="T:ZedGraph.AlignH"/> enum that specifies
- the horizontal alignment of the object with respect to the (x,y) location</param>
- <param name="alignV">The <see cref="T:ZedGraph.AlignV"/> enum that specifies
- the vertical alignment of the object with respect to the (x,y) location</param>
- </member>
- <member name="M:ZedGraph.GraphObj.#ctor(ZedGraph.GraphObj)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.GraphObj"/> object from which to copy</param>
- </member>
- <member name="M:ZedGraph.GraphObj.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of Clone.
- </summary>
- <remarks>
- Note that this method must be called with an explicit cast to ICloneable, and
- that it is inherently virtual. For example:
- <code>
- ParentClass foo = new ChildClass();
- ChildClass bar = (ChildClass) ((ICloneable)foo).Clone();
- </code>
- Assume that ChildClass is inherited from ParentClass. Even though foo is declared with
- ParentClass, it is actually an instance of ChildClass. Calling the ICloneable implementation
- of Clone() on foo actually calls ChildClass.Clone() as if it were a virtual function.
- </remarks>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.GraphObj.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.GraphObj.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.GraphObj.Draw(System.Drawing.Graphics,ZedGraph.PaneBase,System.Single)">
- <summary>
- Render this <see cref="T:ZedGraph.GraphObj"/> object to the specified <see cref="T:System.Drawing.Graphics"/> device.
- </summary>
- <remarks>
- This method is normally only called by the Draw method
- of the parent <see cref="T:ZedGraph.GraphObjList"/> collection object.
- </remarks>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.PaneBase"/> object that is the parent or
- owner of this object.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.PaneBase"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.GraphObj.PointInBox(System.Drawing.PointF,ZedGraph.PaneBase,System.Drawing.Graphics,System.Single)">
- <summary>
- Determine if the specified screen point lies inside the bounding box of this
- <see cref="T:ZedGraph.GraphObj"/>.
- </summary>
- <param name="pt">The screen point, in pixels</param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.PaneBase"/> object that is the parent or
- owner of this object.
- </param>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.PaneBase"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <returns>true if the point lies in the bounding box, false otherwise</returns>
- </member>
- <member name="M:ZedGraph.GraphObj.GetCoords(ZedGraph.PaneBase,System.Drawing.Graphics,System.Single,System.String@,System.String@)">
- <summary>
- Determines the shape type and Coords values for this GraphObj
- </summary>
- </member>
- <member name="P:ZedGraph.GraphObj.Location">
- <summary>
- The <see cref="T:ZedGraph.Location"/> struct that describes the location
- for this <see cref="T:ZedGraph.GraphObj"/>.
- </summary>
- </member>
- <member name="P:ZedGraph.GraphObj.ZOrder">
- <summary>
- Gets or sets a value that determines the z-order "depth" of this
- item relative to other graphic objects.
- </summary>
- <remarks>Note that this controls the z-order with respect to
- other elements such as <see cref="T:ZedGraph.CurveItem"/>'s, <see cref="T:ZedGraph.Axis"/>
- objects, etc. The order of <see cref="T:ZedGraph.GraphObj"/> objects having
- the same <see cref="T:ZedGraph.ZOrder"/> value is controlled by their order in
- the <see cref="T:ZedGraph.GraphObjList"/>. The first <see cref="T:ZedGraph.GraphObj"/>
- in the list is drawn in front of other <see cref="T:ZedGraph.GraphObj"/>
- objects having the same <see cref="T:ZedGraph.ZOrder"/> value.</remarks>
- </member>
- <member name="P:ZedGraph.GraphObj.IsVisible">
- <summary>
- Gets or sets a value that determines if this <see cref="T:ZedGraph.GraphObj"/> will be
- visible in the graph. true displays the item, false hides it.
- </summary>
- </member>
- <member name="P:ZedGraph.GraphObj.IsClippedToChartRect">
- <summary>
- Gets or sets a value that determines whether or not the rendering of this <see cref="T:ZedGraph.GraphObj"/>
- will be clipped to the <see cref="P:ZedGraph.Chart.Rect"/>.
- </summary>
- <value>true to clip the <see cref="T:ZedGraph.GraphObj"/> to the <see cref="P:ZedGraph.Chart.Rect"/> bounds,
- false to leave it unclipped.</value>
- </member>
- <member name="P:ZedGraph.GraphObj.Link">
- <summary>
- Gets or sets the hyperlink information for this <see cref="T:ZedGraph.GraphObj"/>.
- </summary>
- </member>
- <member name="P:ZedGraph.GraphObj.IsInFrontOfData">
- <summary>
- true if the <see cref="P:ZedGraph.GraphObj.ZOrder"/> of this object is set to put it in front
- of the <see cref="T:ZedGraph.CurveItem"/> data points.
- </summary>
- </member>
- <member name="T:ZedGraph.GraphObj.Default">
- <summary>
- A simple struct that defines the
- default property values for the <see cref="T:ZedGraph.GraphObj"/> class.
- </summary>
- </member>
- <member name="F:ZedGraph.GraphObj.Default.AlignV">
- <summary>
- Default value for the vertical <see cref="T:ZedGraph.GraphObj"/>
- text alignment (<see cref="P:ZedGraph.GraphObj.Location"/> property).
- This is specified
- using the <see cref="F:ZedGraph.GraphObj.Default.AlignV"/> enum type.
- </summary>
- </member>
- <member name="F:ZedGraph.GraphObj.Default.AlignH">
- <summary>
- Default value for the horizontal <see cref="T:ZedGraph.GraphObj"/>
- text alignment (<see cref="P:ZedGraph.GraphObj.Location"/> property).
- This is specified
- using the <see cref="F:ZedGraph.GraphObj.Default.AlignH"/> enum type.
- </summary>
- </member>
- <member name="F:ZedGraph.GraphObj.Default.CoordFrame">
- <summary>
- The default coordinate system to be used for defining the
- <see cref="T:ZedGraph.GraphObj"/> location coordinates
- (<see cref="P:ZedGraph.GraphObj.Location"/> property).
- </summary>
- <value> The coordinate system is defined with the <see cref="T:ZedGraph.CoordType"/>
- enum</value>
- </member>
- <member name="F:ZedGraph.GraphObj.Default.IsClippedToChartRect">
- <summary>
- The default value for <see cref="P:ZedGraph.GraphObj.IsClippedToChartRect"/>.
- </summary>
- </member>
- <member name="T:ZedGraph.ZoomState">
- <summary>
- A class that captures all the scale range settings for a <see cref="T:ZedGraph.GraphPane"/>.
- </summary>
- <remarks>
- This class is used to store scale ranges in order to allow zooming out to
- prior scale range states. <see cref="T:ZedGraph.ZoomState"/> objects are maintained in the
- <see cref="T:ZedGraph.ZoomStateStack"/> collection. The <see cref="T:ZedGraph.ZoomState"/> object holds
- a <see cref="T:ZedGraph.ScaleState"/> object for each of the three axes; the <see cref="T:ZedGraph.XAxis"/>,
- the <see cref="T:ZedGraph.YAxis"/>, and the <see cref="T:ZedGraph.Y2Axis"/>.
- </remarks>
- <author> John Champion </author>
- <version> $Revision: 3.15 $ $Date: 2007-04-16 00:03:07 $ </version>
- </member>
- <member name="F:ZedGraph.ZoomState._xAxis">
- <summary>
- <see cref="T:ZedGraph.ScaleState"/> objects to store the state data from the axes.
- </summary>
- </member>
- <member name="F:ZedGraph.ZoomState._x2Axis">
- <summary>
- <see cref="T:ZedGraph.ScaleState"/> objects to store the state data from the axes.
- </summary>
- </member>
- <member name="F:ZedGraph.ZoomState._type">
- <summary>
- An enum value indicating the type of adjustment being made to the
- scale range state.
- </summary>
- </member>
- <member name="M:ZedGraph.ZoomState.#ctor(ZedGraph.GraphPane,ZedGraph.ZoomState.StateType)">
- <summary>
- Construct a <see cref="T:ZedGraph.ZoomState"/> object from the scale ranges settings contained
- in the specified <see cref="T:ZedGraph.GraphPane"/>.
- </summary>
- <param name="pane">The <see cref="T:ZedGraph.GraphPane"/> from which to obtain the scale
- range values.
- </param>
- <param name="type">A <see cref="T:ZedGraph.ZoomState.StateType"/> enumeration that indicates whether
- this saved state is from a pan or zoom.</param>
- </member>
- <member name="M:ZedGraph.ZoomState.#ctor(ZedGraph.ZoomState)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.ZoomState"/> object from which to copy</param>
- </member>
- <member name="M:ZedGraph.ZoomState.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.ZoomState.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.ZoomState.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.ZoomState.ApplyState(ZedGraph.GraphPane)">
- <summary>
- Copy the properties from this <see cref="T:ZedGraph.ZoomState"/> out to the specified <see cref="T:ZedGraph.GraphPane"/>.
- </summary>
- <param name="pane">The <see cref="T:ZedGraph.GraphPane"/> to which the scale range properties should be
- copied.</param>
- </member>
- <member name="M:ZedGraph.ZoomState.IsChanged(ZedGraph.GraphPane)">
- <summary>
- Determine if the state contained in this <see cref="T:ZedGraph.ZoomState"/> object is different from
- the state of the specified <see cref="T:ZedGraph.GraphPane"/>.
- </summary>
- <param name="pane">The <see cref="T:ZedGraph.GraphPane"/> object with which to compare states.</param>
- <returns>true if the states are different, false otherwise</returns>
- </member>
- <member name="P:ZedGraph.ZoomState.Type">
- <summary>
- Gets a <see cref="T:ZedGraph.ZoomState.StateType"/> value indicating the type of action (zoom or pan)
- saved by this <see cref="T:ZedGraph.ZoomState"/>.
- </summary>
- </member>
- <member name="P:ZedGraph.ZoomState.TypeString">
- <summary>
- Gets a string representing the type of adjustment that was made when this scale
- state was saved.
- </summary>
- <value>A string representation for the state change type; typically
- "Pan", "Zoom", or "Scroll".</value>
- </member>
- <member name="T:ZedGraph.ZoomState.StateType">
- <summary>
- An enumeration that describes whether a given state is the result of a Pan or Zoom
- operation.
- </summary>
- </member>
- <member name="F:ZedGraph.ZoomState.StateType.Zoom">
- <summary>
- Indicates the <see cref="T:ZedGraph.ZoomState"/> object is from a Zoom operation
- </summary>
- </member>
- <member name="F:ZedGraph.ZoomState.StateType.WheelZoom">
- <summary>
- Indicates the <see cref="T:ZedGraph.ZoomState"/> object is from a Wheel Zoom operation
- </summary>
- </member>
- <member name="F:ZedGraph.ZoomState.StateType.Pan">
- <summary>
- Indicates the <see cref="T:ZedGraph.ZoomState"/> object is from a Pan operation
- </summary>
- </member>
- <member name="F:ZedGraph.ZoomState.StateType.Scroll">
- <summary>
- Indicates the <see cref="T:ZedGraph.ZoomState"/> object is from a Scroll operation
- </summary>
- </member>
- <member name="T:ZedGraph.ValueHandler">
- <summary>
- A class designed to simplify the process of getting the actual value for
- the various stacked and regular curve types
- </summary>
-
- <author> John Champion</author>
- <version> $Revision: 3.21 $ $Date: 2008-12-02 12:55:34 $ </version>
- </member>
- <member name="M:ZedGraph.ValueHandler.#ctor(ZedGraph.GraphPane,System.Boolean)">
- <summary>
- Basic constructor that saves a reference to the parent
- <see cref="T:ZedGraph.GraphPane"/> object.
- </summary>
- <param name="pane">The parent <see cref="T:ZedGraph.GraphPane"/> object.</param>
- <param name="initialize">A <see cref="T:System.Boolean"/> flag to indicate whether or
- not the drawing variables should be initialized. Initialization is not
- required if this is part of a ZedGraph internal draw operation (i.e., its in
- the middle of a call to <see cref="M:ZedGraph.GraphPane.Draw(System.Drawing.Graphics)"/>). Otherwise, you should
- initialize to make sure the drawing variables are configured. true to do
- an initialization, false otherwise.</param>
- </member>
- <member name="M:ZedGraph.ValueHandler.GetValues(ZedGraph.CurveItem,System.Int32,System.Double@,System.Double@,System.Double@)">
- <summary>
- Get the user scale values associate with a particular point of a
- particular curve.</summary>
- <remarks>The main purpose of this method is to handle
- stacked bars, in which case the stacked values are returned rather
- than the individual data values.
- </remarks>
- <param name="curve">A <see cref="T:ZedGraph.CurveItem"/> object of interest.</param>
- <param name="iPt">The zero-based point index for the point of interest.</param>
- <param name="baseVal">A <see cref="T:System.Double"/> value representing the value
- for the independent axis.</param>
- <param name="lowVal">A <see cref="T:System.Double"/> value representing the lower
- value for the dependent axis.</param>
- <param name="hiVal">A <see cref="T:System.Double"/> value representing the upper
- value for the dependent axis.</param>
- <returns>true if the data point is value, false for
- <see cref="F:ZedGraph.PointPairBase.Missing"/>, invalid, etc. data.</returns>
- </member>
- <member name="M:ZedGraph.ValueHandler.GetValues(ZedGraph.GraphPane,ZedGraph.CurveItem,System.Int32,System.Double@,System.Double@,System.Double@)">
- <summary>
- Get the user scale values associate with a particular point of a
- particular curve.</summary>
- <remarks>The main purpose of this method is to handle
- stacked bars and lines, in which case the stacked values are returned rather
- than the individual data values. However, this method works generically for any
- curve type.
- </remarks>
- <param name="pane">The parent <see cref="T:ZedGraph.GraphPane"/> object.</param>
- <param name="curve">A <see cref="T:ZedGraph.CurveItem"/> object of interest.</param>
- <param name="iPt">The zero-based point index for the point of interest.</param>
- <param name="baseVal">A <see cref="T:System.Double"/> value representing the value
- for the independent axis.</param>
- <param name="lowVal">A <see cref="T:System.Double"/> value representing the lower
- value for the dependent axis.</param>
- <param name="hiVal">A <see cref="T:System.Double"/> value representing the upper
- value for the dependent axis.</param>
- <returns>true if the data point is value, false for
- <see cref="F:ZedGraph.PointPairBase.Missing"/>, invalid, etc. data.</returns>
- </member>
- <member name="M:ZedGraph.ValueHandler.BarCenterValue(ZedGraph.CurveItem,System.Single,System.Int32,System.Double,System.Int32)">
- <summary>
- Calculate the user scale position of the center of the specified bar, using the
- <see cref="T:ZedGraph.Axis"/> as specified by <see cref="P:ZedGraph.BarSettings.Base"/>. This method is
- used primarily by the
- <see cref="M:ZedGraph.GraphPane.FindNearestPoint(System.Drawing.PointF,ZedGraph.CurveItem@,System.Int32@)"/> method in order to
- determine the bar "location," which is defined as the center of the top of the individual bar.
- </summary>
- <param name="curve">The <see cref="T:ZedGraph.CurveItem"/> representing the
- bar of interest.</param>
- <param name="barWidth">The width of each individual bar. This can be calculated using
- the <see cref="M:ZedGraph.CurveItem.GetBarWidth(ZedGraph.GraphPane)"/> method.</param>
- <param name="iCluster">The cluster number for the bar of interest. This is the ordinal
- position of the current point. That is, if a particular <see cref="T:ZedGraph.CurveItem"/> has
- 10 points, then a value of 3 would indicate the 4th point in the data array.</param>
- <param name="val">The actual independent axis value for the bar of interest.</param>
- <param name="iOrdinal">The ordinal position of the <see cref="T:ZedGraph.CurveItem"/> of interest.
- That is, the first bar series is 0, the second is 1, etc. Note that this applies only
- to the bars. If a graph includes both bars and lines, then count only the bars.</param>
- <returns>A user scale value position of the center of the bar of interest.</returns>
- </member>
- <member name="T:ZedGraph.Selection">
- <summary>
- </summary>
- <remarks>
- </remarks>
-
- <author> John Champion and JCarpenter </author>
- <version> $Revision: 3.5 $ $Date: 2007-03-11 02:08:16 $ </version>
- </member>
- <member name="T:ZedGraph.CurveList">
- <summary>
- A collection class containing a list of <see cref="T:ZedGraph.CurveItem"/> objects
- that define the set of curves to be displayed on the graph.
- </summary>
-
- <author> John Champion
- modified by Jerry Vos</author>
- <version> $Revision: 3.43 $ $Date: 2007-11-03 04:41:28 $ </version>
- </member>
- <member name="M:ZedGraph.CurveList.HasData">
- <summary>
- Determine if there is any data in any of the <see cref="T:ZedGraph.CurveItem"/>
- objects for this graph. This method does not verify valid data, it
- only checks to see if <see cref="P:ZedGraph.CurveItem.NPts"/> > 0.
- </summary>
- <returns>true if there is any data, false otherwise</returns>
- </member>
- <member name="M:ZedGraph.CurveList.#ctor">
- <summary>
- Default constructor for the collection class
- </summary>
- </member>
- <member name="M:ZedGraph.CurveList.#ctor(ZedGraph.CurveList)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The XAxis object from which to copy</param>
- </member>
- <member name="M:ZedGraph.CurveList.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.CurveList.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.CurveList.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.CurveList.IndexOf(System.String)">
- <summary>
- Return the zero-based position index of the
- <see cref="T:ZedGraph.CurveItem"/> with the specified <see cref="P:ZedGraph.CurveItem.Label"/>.
- </summary>
- <param name="label">The <see cref="T:System.String"/> label that is in the
- <see cref="P:ZedGraph.CurveItem.Label"/> attribute of the item to be found.
- </param>
- <returns>The zero-based index of the specified <see cref="T:ZedGraph.CurveItem"/>,
- or -1 if the <see cref="T:ZedGraph.CurveItem"/> is not in the list</returns>
- <seealso cref="M:ZedGraph.CurveList.IndexOfTag(System.String)"/>
- </member>
- <member name="M:ZedGraph.CurveList.IndexOfTag(System.String)">
- <summary>
- Return the zero-based position index of the
- <see cref="T:ZedGraph.CurveItem"/> with the specified <see cref="F:ZedGraph.CurveItem.Tag"/>.
- </summary>
- <remarks>In order for this method to work, the <see cref="F:ZedGraph.CurveItem.Tag"/>
- property must be of type <see cref="T:System.String"/>.</remarks>
- <param name="tag">The <see cref="T:System.String"/> tag that is in the
- <see cref="F:ZedGraph.CurveItem.Tag"/> attribute of the item to be found.
- </param>
- <returns>The zero-based index of the specified <see cref="T:ZedGraph.CurveItem"/>,
- or -1 if the <see cref="T:ZedGraph.CurveItem"/> is not in the list</returns>
- </member>
- <member name="M:ZedGraph.CurveList.Sort(ZedGraph.SortType,System.Int32)">
- <summary>
- Sorts the list according to the point values at the specified index and
- for the specified axis.
- </summary>
- </member>
- <member name="M:ZedGraph.CurveList.Move(System.Int32,System.Int32)">
- <summary>
- Move the position of the object at the specified index
- to the new relative position in the list.</summary>
- <remarks>For Graphic type objects, this method controls the
- Z-Order of the items. Objects at the beginning of the list
- appear in front of objects at the end of the list.</remarks>
- <param name="index">The zero-based index of the object
- to be moved.</param>
- <param name="relativePos">The relative number of positions to move
- the object. A value of -1 will move the
- object one position earlier in the list, a value
- of 1 will move it one position later. To move an item to the
- beginning of the list, use a large negative value (such as -999).
- To move it to the end of the list, use a large positive value.
- </param>
- <returns>The new position for the object, or -1 if the object
- was not found.</returns>
- </member>
- <member name="M:ZedGraph.CurveList.GetRange(System.Boolean,System.Boolean,ZedGraph.GraphPane)">
- <summary>
- Go through each <see cref="T:ZedGraph.CurveItem"/> object in the collection,
- calling the <see cref="M:ZedGraph.CurveItem.GetRange(System.Double@,System.Double@,System.Double@,System.Double@,System.Boolean,System.Boolean,ZedGraph.GraphPane)"/> member to
- determine the minimum and maximum values in the
- <see cref="P:ZedGraph.CurveItem.Points"/> list of data value pairs. If the curves include
- a stack bar, handle within the current GetRange method. In the event that no
- data are available, a default range of min=0.0 and max=1.0 are returned.
- If the Y axis has a valid data range and the Y2 axis not, then the Y2
- range will be a duplicate of the Y range. Vice-versa for the Y2 axis
- having valid data when the Y axis does not.
- If any <see cref="T:ZedGraph.CurveItem"/> in the list has a missing
- <see cref="T:ZedGraph.PointPairList"/>, a new empty one will be generated.
- </summary>
- <param name="bIgnoreInitial">ignoreInitial is a boolean value that
- affects the data range that is considered for the automatic scale
- ranging (see <see cref="P:ZedGraph.GraphPane.IsIgnoreInitial"/>). If true, then initial
- data points where the Y value is zero are not included when
- automatically determining the scale <see cref="P:ZedGraph.Scale.Min"/>,
- <see cref="P:ZedGraph.Scale.Max"/>, and <see cref="P:ZedGraph.Scale.MajorStep"/> size. All data after
- the first non-zero Y value are included.
- </param>
- <param name="isBoundedRanges">
- Determines if the auto-scaled axis ranges will subset the
- data points based on any manually set scale range values.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <seealso cref="P:ZedGraph.GraphPane.IsBoundedRanges"/>
- </member>
- <member name="M:ZedGraph.CurveList.GetStackRange(ZedGraph.GraphPane,ZedGraph.CurveItem,System.Double@,System.Double@,System.Double@,System.Double@)">
- <summary>
- Calculate the range for stacked bars and lines.
- </summary>
- <remarks>This method is required for the stacked
- types because (for bars), the negative values are a separate stack than the positive
- values. If you just sum up the bars, you will get the sum of the positive plus negative,
- which is less than the maximum positive value and greater than the maximum negative value.
- </remarks>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="curve">The <see cref="T:ZedGraph.CurveItem"/> for which to calculate the range</param>
- <param name="tXMinVal">The minimum X value so far</param>
- <param name="tYMinVal">The minimum Y value so far</param>
- <param name="tXMaxVal">The maximum X value so far</param>
- <param name="tYMaxVal">The maximum Y value so far</param>
- <seealso cref="P:ZedGraph.GraphPane.IsBoundedRanges"/>
- </member>
- <member name="M:ZedGraph.CurveList.Draw(System.Drawing.Graphics,ZedGraph.GraphPane,System.Single)">
- <summary>
- Render all the <see cref="T:ZedGraph.CurveItem"/> objects in the list to the
- specified <see cref="T:System.Drawing.Graphics"/>
- device by calling the <see cref="M:ZedGraph.CurveItem.Draw(System.Drawing.Graphics,ZedGraph.GraphPane,System.Int32,System.Single)"/> member function of
- each <see cref="T:ZedGraph.CurveItem"/> object.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.CurveList.GetBarItemPos(ZedGraph.GraphPane,ZedGraph.BarItem)">
- <summary>
- Find the ordinal position of the specified <see cref="T:ZedGraph.BarItem"/> within
- the <see cref="T:ZedGraph.CurveList"/>. This position only counts <see cef="BarItem"/>
- types, ignoring all other types.
- </summary>
- <param name="pane">The <see cref="T:ZedGraph.GraphPane"/> of interest</param>
- <param name="barItem">The <see cref="T:ZedGraph.BarItem"/> for which to search.</param>
- <returns>The ordinal position of the specified bar, or -1 if the bar
- was not found.</returns>
- </member>
- <member name="P:ZedGraph.CurveList.MaxPts">
- <summary>
- Read only value for the maximum number of points in any of the curves
- in the list.
- </summary>
- </member>
- <member name="P:ZedGraph.CurveList.NumBars">
- <summary>
- Read only property that returns the number of curves in the list that are of
- type <see cref="T:ZedGraph.BarItem"/>. This does not include <see cref="T:ZedGraph.HiLowBarItem"/> or
- <see cref="T:ZedGraph.ErrorBarItem"/> types.
- </summary>
- </member>
- <member name="P:ZedGraph.CurveList.NumClusterableBars">
- <summary>
- Read only property that returns the number of curves in the list that are
- potentially "clusterable", which includes <see cref="T:ZedGraph.BarItem"/> and
- <see cref="T:ZedGraph.HiLowBarItem"/> types. This does not include <see cref="T:ZedGraph.ErrorBarItem"/>,
- <see cref="T:ZedGraph.OHLCBarItem"/>, <see cref="T:ZedGraph.JapaneseCandleStickItem"/>, etc. types.
- </summary>
- <remarks>Note that this property is only the number of bars that COULD BE clustered. The
- actual cluster settings are not considered.</remarks>
- </member>
- <member name="P:ZedGraph.CurveList.NumPies">
- <summary>
- Read only property that returns the number of pie slices in the list (class type is
- <see cref="T:ZedGraph.PieItem"/> ).
- </summary>
- </member>
- <member name="P:ZedGraph.CurveList.IsPieOnly">
- <summary>
- Read only property that determines if all items in the <see cref="T:ZedGraph.CurveList"/> are
- Pies.
- </summary>
- </member>
- <member name="P:ZedGraph.CurveList.Backward">
- <summary>
- Iterate backwards through the <see cref="T:ZedGraph.CurveList"/> items.
- </summary>
- </member>
- <member name="P:ZedGraph.CurveList.Forward">
- <summary>
- Iterate forward through the <see cref="T:ZedGraph.CurveList"/> items.
- </summary>
- </member>
- <member name="P:ZedGraph.CurveList.Item(System.String)">
- <summary>
- Indexer to access the specified <see cref="T:ZedGraph.CurveItem"/> object by
- its <see cref="P:ZedGraph.CurveItem.Label"/> string.
- </summary>
- <param name="label">The string label of the
- <see cref="T:ZedGraph.CurveItem"/> object to be accessed.</param>
- <value>A <see cref="T:ZedGraph.CurveItem"/> object reference.</value>
- </member>
- <member name="F:ZedGraph.Selection.Border">
- <summary>
- The <see cref="F:ZedGraph.Selection.Border"/> type to be used for drawing "selected"
- <see cref="T:ZedGraph.PieItem"/>, <see cref="T:ZedGraph.BarItem"/>, <see cref="T:ZedGraph.HiLowBarItem"/>,
- <see cref="T:ZedGraph.OHLCBarItem"/>, and <see cref="T:ZedGraph.JapaneseCandleStickItem"/> item types.
- </summary>
- </member>
- <member name="F:ZedGraph.Selection.Fill">
- <summary>
- The <see cref="F:ZedGraph.Selection.Fill"/> type to be used for drawing "selected"
- <see cref="T:ZedGraph.PieItem"/>, <see cref="T:ZedGraph.BarItem"/>, <see cref="T:ZedGraph.HiLowBarItem"/>,
- and <see cref="T:ZedGraph.JapaneseCandleStickItem"/> item types.
- </summary>
- </member>
- <member name="F:ZedGraph.Selection.Line">
- <summary>
- The <see cref="F:ZedGraph.Selection.Line"/> type to be used for drawing "selected"
- <see cref="T:ZedGraph.LineItem"/> and <see cref="T:ZedGraph.StickItem"/> types
- </summary>
- </member>
- <member name="F:ZedGraph.Selection.Symbol">
- <summary>
- The <see cref="F:ZedGraph.Selection.Symbol"/> type to be used for drawing "selected"
- <see cref="T:ZedGraph.LineItem"/> and <see cref="T:ZedGraph.ErrorBarItem"/> types.
- </summary>
- </member>
- <member name="M:ZedGraph.Selection.Select(ZedGraph.MasterPane,ZedGraph.CurveItem)">
- <summary>
- Place a <see cref="T:ZedGraph.CurveItem"/> in the selection list, removing all other
- items.
- </summary>
- <param name="master">The <see cref="T:ZedGraph.MasterPane"/> that is the "owner"
- of the <see cref="T:ZedGraph.CurveItem"/>'s.</param>
- <param name="ci">The <see cref="T:ZedGraph.CurveItem"/> to be added to the list.</param>
- </member>
- <member name="M:ZedGraph.Selection.Select(ZedGraph.MasterPane,ZedGraph.CurveList)">
- <summary>
- Place a list of <see cref="T:ZedGraph.CurveItem"/>'s in the selection list, removing all other
- items.
- </summary>
- <param name="master">The <see cref="T:ZedGraph.MasterPane"/> that is the "owner"
- of the <see cref="T:ZedGraph.CurveItem"/>'s.</param>
- <param name="ciList">The list of <see cref="T:ZedGraph.CurveItem"/> to be added to the list.</param>
- </member>
- <member name="M:ZedGraph.Selection.AddToSelection(ZedGraph.MasterPane,ZedGraph.CurveItem)">
- <summary>
- Add a <see cref="T:ZedGraph.CurveItem"/> to the selection list.
- </summary>
- <param name="master">The <see cref="T:ZedGraph.MasterPane"/> that is the "owner"
- of the <see cref="T:ZedGraph.CurveItem"/>'s.</param>
- <param name="ci">The <see cref="T:ZedGraph.CurveItem"/> to be added to the list.</param>
- </member>
- <member name="M:ZedGraph.Selection.AddToSelection(ZedGraph.MasterPane,ZedGraph.CurveList)">
- <summary>
- Add a list of <see cref="T:ZedGraph.CurveItem"/>'s to the selection list.
- </summary>
- <param name="master">The <see cref="T:ZedGraph.MasterPane"/> that is the "owner"
- of the <see cref="T:ZedGraph.CurveItem"/>'s.</param>
- <param name="ciList">The list of <see cref="T:ZedGraph.CurveItem"/>'s to be added to the list.</param>
- </member>
- <member name="M:ZedGraph.Selection.RemoveFromSelection(ZedGraph.MasterPane,ZedGraph.CurveItem)">
- <summary>
- Remove the specified <see cref="T:ZedGraph.CurveItem"/> from the selection list.
- </summary>
- <param name="master">The <see cref="T:ZedGraph.MasterPane"/> that is the "owner"
- of the <see cref="T:ZedGraph.CurveItem"/>'s.</param>
- <param name="ci">The <see cref="T:ZedGraph.CurveItem"/> to be removed from the list.</param>
- </member>
- <member name="M:ZedGraph.Selection.ClearSelection(ZedGraph.MasterPane)">
- <summary>
- Clear the selection list and trigger a <see cref="E:ZedGraph.Selection.SelectionChangedEvent"/>.
- </summary>
- <param name="master">The <see cref="T:ZedGraph.MasterPane"/> that "owns" the selection list.</param>
- </member>
- <member name="M:ZedGraph.Selection.ClearSelection(ZedGraph.MasterPane,System.Boolean)">
- <summary>
- Clear the selection list and optionally trigger a <see cref="E:ZedGraph.Selection.SelectionChangedEvent"/>.
- </summary>
- <param name="master">The <see cref="T:ZedGraph.MasterPane"/> that "owns" the selection list.</param>
- <param name="sendEvent">true to trigger a <see cref="E:ZedGraph.Selection.SelectionChangedEvent"/>,
- false otherwise.</param>
- </member>
- <member name="M:ZedGraph.Selection.UpdateSelection(ZedGraph.MasterPane)">
- <summary>
- Mark the <see cref="T:ZedGraph.CurveItem"/>'s that are included in the selection list
- by setting the <see cref="P:ZedGraph.CurveItem.IsSelected"/> property to true.
- </summary>
- <param name="master">The <see cref="T:ZedGraph.MasterPane"/> that "owns" the selection list.</param>
- </member>
- <member name="E:ZedGraph.Selection.SelectionChangedEvent">
- <summary>
- Subscribe to this event to receive notice
- that the list of selected CurveItems has changed
- </summary>
- </member>
- <member name="T:ZedGraph.RadarPointList">
- <summary>
- A class containing a set of data values to be plotted as a RadarPlot.
- This class will effectively convert the data into <see cref="T:ZedGraph.PointPair"/> objects
- by converting the polar coordinates to rectangular coordinates
- </summary>
- <seealso cref="T:ZedGraph.BasicArrayPointList"/>
- <seealso cref="T:ZedGraph.IPointList"/>
- <seealso cref="T:ZedGraph.IPointListEdit"/>
-
- <author>Jerry Vos and John Champion</author>
- <version> $Revision: 3.5 $ $Date: 2007-04-16 00:03:02 $ </version>
- </member>
- <member name="T:ZedGraph.IPointList">
- <summary>
- An interface to a collection class containing data
- that define the set of points to be displayed on the curve.
- </summary>
- <remarks>
- This interface is designed to allow customized data abstraction. The default data
- collection class is <see cref="T:ZedGraph.PointPairList"/>, however, you can define your own
- data collection class using the <see cref="T:ZedGraph.IPointList"/> interface.
- </remarks>
- <seealso cref="T:ZedGraph.PointPairList"/>
- <seealso cref="T:ZedGraph.BasicArrayPointList"/>
-
- <author> John Champion</author>
- <version> $Revision: 1.6 $ $Date: 2007-11-11 07:29:43 $ </version>
- </member>
- <member name="P:ZedGraph.IPointList.Item(System.Int32)">
- <summary>
- Indexer to access a data point by its ordinal position in the collection.
- </summary>
- <remarks>
- This is the standard interface that ZedGraph uses to access the data. Although
- you must pass a <see cref="T:ZedGraph.PointPair"/> here, your internal data storage format
- can be anything.
- </remarks>
- <param name="index">The ordinal position (zero-based) of the
- data point to be accessed.</param>
- <value>A <see cref="T:ZedGraph.PointPair"/> object instance.</value>
- </member>
- <member name="P:ZedGraph.IPointList.Count">
- <summary>
- Gets the number of points available in the list.
- </summary>
- </member>
- <member name="T:ZedGraph.IPointListEdit">
- <summary>
- An interface to a collection class containing data
- that define the set of points to be displayed on the curve.
- </summary>
- <remarks>
- This interface is designed to allow customized data abstraction. The default data
- collection class is <see cref="T:ZedGraph.PointPairList"/>, however, you can define your own
- data collection class using the <see cref="T:ZedGraph.IPointList"/> interface. This
- <see cref="T:ZedGraph.IPointListEdit"/> interface adds the ability to remove and add points
- to the list, and so is used by the <see cref="T:ZedGraph.CurveItem"/> class for the
- <see cref="M:ZedGraph.CurveItem.AddPoint(System.Double,System.Double)"/>, <see cref="M:ZedGraph.CurveItem.RemovePoint(System.Int32)"/>, and
- <see cref="M:ZedGraph.CurveItem.Clear"/> methods.
- </remarks>
- <seealso cref="T:ZedGraph.PointPairList"/>
- <seealso cref="T:ZedGraph.BasicArrayPointList"/>
- <seealso cref="T:ZedGraph.IPointList"/>
- <seealso cref="T:ZedGraph.FilteredPointList"/>
-
- <author> John Champion</author>
- <version> $Revision: 3.6 $ $Date: 2006-10-19 04:40:14 $ </version>
- </member>
- <member name="M:ZedGraph.IPointListEdit.Add(ZedGraph.PointPair)">
- <summary>
- Appends a point to the end of the list. The data are passed in as a <see cref="T:ZedGraph.PointPair"/>
- object.
- </summary>
- <param name="point">The <see cref="T:ZedGraph.PointPair"/> object containing the data to be added.</param>
- </member>
- <member name="M:ZedGraph.IPointListEdit.Add(System.Double,System.Double)">
- <summary>
- Appends a point to the end of the list. The data are passed in as two <see cref="T:System.Double"/>
- types.
- </summary>
- <param name="x">The <see cref="T:System.Double"/> value containing the X data to be added.</param>
- <param name="y">The <see cref="T:System.Double"/> value containing the Y data to be added.</param>
- <returns>The ordinal position (zero-based), at which the new point was added.</returns>
- </member>
- <member name="M:ZedGraph.IPointListEdit.RemoveAt(System.Int32)">
- <summary>
- Removes a single data point from the list at the specified ordinal location
- (zero based).
- </summary>
- </member>
- <member name="M:ZedGraph.IPointListEdit.Clear">
- <summary>
- Clears all data points from the list. After calling this method,
- <see cref="P:ZedGraph.IPointList.Count"/> will be zero.
- </summary>
- </member>
- <member name="P:ZedGraph.IPointListEdit.Item(System.Int32)">
- <summary>
- Indexer to access a data point by its ordinal position in the collection.
- </summary>
- <remarks>
- This is the standard interface that ZedGraph uses to access the data. Although
- you must pass a <see cref="T:ZedGraph.PointPair"/> here, your internal data storage format
- can be anything.
- </remarks>
- <param name="index">The ordinal position (zero-based) of the
- data point to be accessed.</param>
- <value>A <see cref="T:ZedGraph.PointPair"/> object instance.</value>
- </member>
- <member name="F:ZedGraph.RadarPointList._clockwise">
- <summary>
- Default to clockwise rotation as this is the standard for radar charts
- </summary>
- </member>
- <member name="F:ZedGraph.RadarPointList._rotation">
- <summary>
- Default to 90 degree rotation so main axis is in the 12 o'clock position,
- which is the standard for radar charts.
- </summary>
- </member>
- <member name="M:ZedGraph.RadarPointList.GetAt(System.Int32)">
- <summary>
- Get the raw data
- </summary>
- <param name="index"></param>
- <returns></returns>
- </member>
- <member name="M:ZedGraph.RadarPointList.#ctor">
- <summary>
- Default Constructor
- </summary>
- </member>
- <member name="M:ZedGraph.RadarPointList.#ctor(ZedGraph.RadarPointList)">
- <summary>
- Copy Constructor
- </summary>
- </member>
- <member name="M:ZedGraph.RadarPointList.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.RadarPointList.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.RadarPointList.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.RadarPointList.Add(System.Double,System.Double)">
- <summary>
- Add a single point to the <see cref="T:ZedGraph.RadarPointList"/> from two values of type double.
- </summary>
- <param name="r">The radial coordinate value</param>
- <param name="z">The 'Z' coordinate value, which is not normally used for plotting,
- but can be used for <see cref="F:ZedGraph.FillType.GradientByZ"/> type fills</param>
- <returns>The zero-based ordinal index where the point was added in the list.</returns>
- </member>
- <member name="P:ZedGraph.RadarPointList.Item(System.Int32)">
- <summary>
- Indexer to access the specified <see cref="T:ZedGraph.PointPair"/> object by
- its ordinal position in the list. This method does the calculations
- to convert the data from polar to rectangular coordinates.
- </summary>
- <param name="index">The ordinal position (zero-based) of the
- <see cref="T:ZedGraph.PointPair"/> object to be accessed.</param>
- <value>A <see cref="T:ZedGraph.PointPair"/> object reference.</value>
- </member>
- <member name="P:ZedGraph.RadarPointList.Clockwise">
- <summary>
- Indicates if points should be added in clockwise or counter-clockwise order
- </summary>
- </member>
- <member name="P:ZedGraph.RadarPointList.Rotation">
- <summary>
- Sets the angular rotation (starting angle) for the initial axis
- </summary>
- </member>
- <member name="P:ZedGraph.RadarPointList.Count">
- <summary>
- gets the number of points available in the list
- </summary>
- </member>
- <member name="T:ZedGraph.LineBase">
- <summary>
- A class that handles the basic attributes of a line segment.
- </summary>
- <remarks>
- This is the base class for <see cref="T:ZedGraph.Line"/> and <see cref="T:ZedGraph.Border"/> classes.
- </remarks>
- <author> John Champion </author>
- <version> $Revision: 3.2 $ $Date: 2007-03-17 18:43:44 $ </version>
- </member>
- <member name="F:ZedGraph.LineBase.schema0">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="F:ZedGraph.LineBase._width">
- <summary>
- Private field that stores the pen width for this line.
- Use the public property <see cref="P:ZedGraph.LineBase.Width"/> to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.LineBase._style">
- <summary>
- Private field that stores the <see cref="T:System.Drawing.Drawing2D.DashStyle"/> for this
- line. Use the public
- property <see cref="P:ZedGraph.LineBase.Style"/> to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.LineBase._dashOn">
- <summary>
- private field that stores the "Dash On" length for drawing the line. Use the
- public property <see cref="P:ZedGraph.LineBase.DashOn"/> to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.LineBase._dashOff">
- <summary>
- private field that stores the "Dash Off" length for drawing the line. Use the
- public property <see cref="P:ZedGraph.LineBase.DashOff"/> to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.LineBase._isVisible">
- <summary>
- Private field that stores the visibility of this line. Use the public
- property <see cref="P:ZedGraph.LineBase.IsVisible"/> to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.LineBase._isAntiAlias">
- <summary>
- private field that determines if the line is drawn using
- Anti-Aliasing capabilities from the <see cref="T:System.Drawing.Graphics"/> class.
- Use the public property <see cref="P:ZedGraph.LineBase.IsAntiAlias"/> to access
- this value.
- </summary>
- </member>
- <member name="F:ZedGraph.LineBase._color">
- <summary>
- Private field that stores the color of this line. Use the public
- property <see cref="P:ZedGraph.LineBase.Color"/> to access this value. If this value is
- false, the line will not be shown (but the <see cref="T:ZedGraph.Symbol"/> may
- still be shown).
- </summary>
- </member>
- <member name="F:ZedGraph.LineBase._gradientFill">
- <summary>
- Internal field that stores a custom <see cref="T:ZedGraph.Fill"/> class. This
- fill is used strictly for <see cref="F:ZedGraph.FillType.GradientByX"/>,
- <see cref="F:ZedGraph.FillType.GradientByY"/>, <see cref="F:ZedGraph.FillType.GradientByZ"/>,
- and <see cref="F:ZedGraph.FillType.GradientByColorValue"/> calculations to determine
- the color of the line.
- </summary>
- </member>
- <member name="M:ZedGraph.LineBase.#ctor">
- <summary>
- Default constructor that sets all <see cref="T:ZedGraph.LineBase"/> properties to default
- values as defined in the <see cref="T:ZedGraph.LineBase.Default"/> class.
- </summary>
- </member>
- <member name="M:ZedGraph.LineBase.#ctor(System.Drawing.Color)">
- <summary>
- Constructor that sets the color property to the specified value, and sets
- the remaining <see cref="T:ZedGraph.LineBase"/> properties to default
- values as defined in the <see cref="T:ZedGraph.LineBase.Default"/> class.
- </summary>
- <param name="color">The color to assign to this new Line object</param>
- </member>
- <member name="M:ZedGraph.LineBase.#ctor(ZedGraph.LineBase)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The LineBase object from which to copy</param>
- </member>
- <member name="M:ZedGraph.LineBase.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of Clone.
- </summary>
- <remarks>
- Note that this method must be called with an explicit cast to ICloneable, and
- that it is inherently virtual. For example:
- <code>
- ParentClass foo = new ChildClass();
- ChildClass bar = (ChildClass) ((ICloneable)foo).Clone();
- </code>
- Assume that ChildClass is inherited from ParentClass. Even though foo is declared with
- ParentClass, it is actually an instance of ChildClass. Calling the ICloneable implementation
- of Clone() on foo actually calls ChildClass.Clone() as if it were a virtual function.
- </remarks>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.LineBase.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the
- serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains
- the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.LineBase.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize
- the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the
- serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the
- serialized data</param>
- </member>
- <member name="M:ZedGraph.LineBase.GetPen(ZedGraph.PaneBase,System.Single)">
- <summary>
- Create a <see cref="T:System.Drawing.Pen"/> object based on the properties of this
- <see cref="T:ZedGraph.LineBase"/>.
- </summary>
- <param name="pane">The owner <see cref="T:ZedGraph.GraphPane"/> of this
- <see cref="T:ZedGraph.LineBase"/>.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <returns>A <see cref="T:System.Drawing.Pen"/> object with the properties of this <see cref="T:ZedGraph.LineBase"/>
- </returns>
- </member>
- <member name="M:ZedGraph.LineBase.GetPen(ZedGraph.PaneBase,System.Single,ZedGraph.PointPair)">
- <summary>
- Create a <see cref="T:System.Drawing.Pen"/> object based on the properties of this
- <see cref="T:ZedGraph.LineBase"/>.
- </summary>
- <param name="pane">The owner <see cref="T:ZedGraph.GraphPane"/> of this
- <see cref="T:ZedGraph.LineBase"/>.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <param name="dataValue">The data value to be used for a value-based
- color gradient. This is only applicable if <see cref="P:ZedGraph.Fill.Type">GradientFill.Type</see>
- is one of <see cref="F:ZedGraph.FillType.GradientByX"/>,
- <see cref="F:ZedGraph.FillType.GradientByY"/>, <see cref="F:ZedGraph.FillType.GradientByZ"/>,
- or <see cref="F:ZedGraph.FillType.GradientByColorValue"/>.
- </param>
- <returns>A <see cref="T:System.Drawing.Pen"/> object with the properties of this <see cref="T:ZedGraph.LineBase"/>
- </returns>
- </member>
- <member name="P:ZedGraph.LineBase.Color">
- <summary>
- The color of the <see cref="T:ZedGraph.Line"/>. Note that this color value can be
- overridden if the <see cref="P:ZedGraph.Fill.Type">GradientFill.Type</see> is one of the
- <see cref="F:ZedGraph.FillType.GradientByX"/>,
- <see cref="F:ZedGraph.FillType.GradientByY"/>, <see cref="F:ZedGraph.FillType.GradientByZ"/>,
- and <see cref="F:ZedGraph.FillType.GradientByColorValue"/> types.
- </summary>
- <seealso cref="P:ZedGraph.LineBase.GradientFill"/>
- </member>
- <member name="P:ZedGraph.LineBase.Style">
- <summary>
- The style of the <see cref="T:ZedGraph.Line"/>, defined as a <see cref="T:System.Drawing.Drawing2D.DashStyle"/> enum.
- This allows the line to be solid, dashed, or dotted.
- </summary>
- <seealso cref="F:ZedGraph.LineBase.Default.Style"/>
- <seealso cref="P:ZedGraph.LineBase.DashOn"/>
- <seealso cref="P:ZedGraph.LineBase.DashOff"/>
- </member>
- <member name="P:ZedGraph.LineBase.DashOn">
- <summary>
- The "Dash On" mode for drawing the line.
- </summary>
- <remarks>
- This is the distance, in points (1/72 inch), of the dash segments that make up
- the dashed grid lines. This setting is only valid if
- <see cref="P:ZedGraph.LineBase.Style"/> is set to <see cref="F:System.Drawing.Drawing2D.DashStyle.Custom"/>.
- </remarks>
- <value>The dash on length is defined in points (1/72 inch)</value>
- <seealso cref="P:ZedGraph.LineBase.DashOff"/>
- <seealso cref="P:ZedGraph.LineBase.IsVisible"/>
- <seealso cref="F:ZedGraph.LineBase.Default.DashOn"/>.
- </member>
- <member name="P:ZedGraph.LineBase.DashOff">
- <summary>
- The "Dash Off" mode for drawing the line.
- </summary>
- <remarks>
- This is the distance, in points (1/72 inch), of the spaces between the dash
- segments that make up the dashed grid lines. This setting is only valid if
- <see cref="P:ZedGraph.LineBase.Style"/> is set to <see cref="F:System.Drawing.Drawing2D.DashStyle.Custom"/>.
- </remarks>
- <value>The dash off length is defined in points (1/72 inch)</value>
- <seealso cref="P:ZedGraph.LineBase.DashOn"/>
- <seealso cref="P:ZedGraph.LineBase.IsVisible"/>
- <seealso cref="F:ZedGraph.LineBase.Default.DashOff"/>.
- </member>
- <member name="P:ZedGraph.LineBase.Width">
- <summary>
- The pen width used to draw the <see cref="T:ZedGraph.Line"/>, in points (1/72 inch)
- </summary>
- <seealso cref="F:ZedGraph.LineBase.Default.Width"/>
- </member>
- <member name="P:ZedGraph.LineBase.IsVisible">
- <summary>
- Gets or sets a property that shows or hides the <see cref="T:ZedGraph.Line"/>.
- </summary>
- <value>true to show the line, false to hide it</value>
- <seealso cref="F:ZedGraph.LineBase.Default.IsVisible"/>
- </member>
- <member name="P:ZedGraph.LineBase.IsAntiAlias">
- <summary>
- Gets or sets a value that determines if the lines are drawn using
- Anti-Aliasing capabilities from the <see cref="T:System.Drawing.Graphics"/> class.
- </summary>
- <remarks>
- If this value is set to true, then the <see cref="P:System.Drawing.Graphics.SmoothingMode"/>
- property will be set to <see cref="F:System.Drawing.Drawing2D.SmoothingMode.HighQuality"/> only while
- this <see cref="T:ZedGraph.Line"/> is drawn. A value of false will leave the value of
- <see cref="P:System.Drawing.Graphics.SmoothingMode"/> unchanged.
- </remarks>
- </member>
- <member name="P:ZedGraph.LineBase.GradientFill">
- <summary>
- Gets or sets a custom <see cref="T:ZedGraph.Fill"/> class.
- </summary>
- <remarks>This fill is used strictly for <see cref="F:ZedGraph.FillType.GradientByX"/>,
- <see cref="F:ZedGraph.FillType.GradientByY"/>, <see cref="F:ZedGraph.FillType.GradientByZ"/>,
- and <see cref="F:ZedGraph.FillType.GradientByColorValue"/> calculations to determine
- the color of the line. It overrides the <see cref="P:ZedGraph.LineBase.Color"/> property if
- one of the above <see cref="T:ZedGraph.FillType"/> values are selected.
- </remarks>
- <seealso cref="P:ZedGraph.LineBase.Color"/>
- </member>
- <member name="T:ZedGraph.LineBase.Default">
- <summary>
- A simple struct that defines the
- default property values for the <see cref="T:ZedGraph.LineBase"/> class.
- </summary>
- </member>
- <member name="F:ZedGraph.LineBase.Default.IsVisible">
- <summary>
- The default mode for displaying line segments (<see cref="P:ZedGraph.LineBase.IsVisible"/>
- property). True to show the line segments, false to hide them.
- </summary>
- </member>
- <member name="F:ZedGraph.LineBase.Default.Width">
- <summary>
- The default width for line segments (<see cref="P:ZedGraph.LineBase.Width"/> property).
- Units are points (1/72 inch).
- </summary>
- </member>
- <member name="F:ZedGraph.LineBase.Default.IsAntiAlias">
- <summary>
- The default value for the <see cref="P:ZedGraph.LineBase.IsAntiAlias"/>
- property.
- </summary>
- </member>
- <member name="F:ZedGraph.LineBase.Default.Style">
- <summary>
- The default drawing style for line segments (<see cref="P:ZedGraph.LineBase.Style"/> property).
- This is defined with the <see cref="T:System.Drawing.Drawing2D.DashStyle"/> enumeration.
- </summary>
- </member>
- <member name="F:ZedGraph.LineBase.Default.DashOn">
- <summary>
- The default "dash on" size for drawing the line
- (<see cref="P:ZedGraph.LineBase.DashOn"/> property). Units are in points (1/72 inch).
- </summary>
- </member>
- <member name="F:ZedGraph.LineBase.Default.DashOff">
- <summary>
- The default "dash off" size for drawing the the line
- (<see cref="P:ZedGraph.LineBase.DashOff"/> property). Units are in points (1/72 inch).
- </summary>
- </member>
- <member name="F:ZedGraph.LineBase.Default.Color">
- <summary>
- The default color for the line.
- This is the default value for the <see cref="P:ZedGraph.LineBase.Color"/> property.
- </summary>
- </member>
- <member name="T:ZedGraph.GraphObjList">
- <summary>
- A collection class containing a list of <see cref="T:ZedGraph.TextObj"/> objects
- to be displayed on the graph.
- </summary>
-
- <author> John Champion </author>
- <version> $Revision: 3.1 $ $Date: 2006-06-24 20:26:44 $ </version>
- </member>
- <member name="M:ZedGraph.GraphObjList.#ctor">
- <summary>
- Default constructor for the <see cref="T:ZedGraph.GraphObjList"/> collection class
- </summary>
- </member>
- <member name="M:ZedGraph.GraphObjList.#ctor(ZedGraph.GraphObjList)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.GraphObjList"/> object from which to copy</param>
- </member>
- <member name="M:ZedGraph.GraphObjList.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.GraphObjList.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.GraphObjList.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.GraphObjList.IndexOfTag(System.String)">
- <summary>
- Return the zero-based position index of the
- <see cref="T:ZedGraph.GraphObj"/> with the specified <see cref="F:ZedGraph.GraphObj.Tag"/>.
- </summary>
- <remarks>In order for this method to work, the <see cref="F:ZedGraph.GraphObj.Tag"/>
- property must be of type <see cref="T:System.String"/>.</remarks>
- <param name="tag">The <see cref="T:System.String"/> tag that is in the
- <see cref="F:ZedGraph.GraphObj.Tag"/> attribute of the item to be found.
- </param>
- <returns>The zero-based index of the specified <see cref="T:ZedGraph.GraphObj"/>,
- or -1 if the <see cref="T:ZedGraph.GraphObj"/> is not in the list</returns>
- </member>
- <member name="M:ZedGraph.GraphObjList.Move(System.Int32,System.Int32)">
- <summary>
- Move the position of the object at the specified index
- to the new relative position in the list.</summary>
- <remarks>For Graphic type objects, this method controls the
- Z-Order of the items. Objects at the beginning of the list
- appear in front of objects at the end of the list.</remarks>
- <param name="index">The zero-based index of the object
- to be moved.</param>
- <param name="relativePos">The relative number of positions to move
- the object. A value of -1 will move the
- object one position earlier in the list, a value
- of 1 will move it one position later. To move an item to the
- beginning of the list, use a large negative value (such as -999).
- To move it to the end of the list, use a large positive value.
- </param>
- <returns>The new position for the object, or -1 if the object
- was not found.</returns>
- </member>
- <member name="M:ZedGraph.GraphObjList.Draw(System.Drawing.Graphics,ZedGraph.PaneBase,System.Single,ZedGraph.ZOrder)">
- <summary>
- Render text to the specified <see cref="T:System.Drawing.Graphics"/> device
- by calling the Draw method of each <see cref="T:ZedGraph.GraphObj"/> object in
- the collection.
- </summary>
- <remarks>This method is normally only called by the Draw method
- of the parent <see cref="T:ZedGraph.GraphPane"/> object.
- </remarks>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.PaneBase"/> object that is the parent or
- owner of this object.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <param name="zOrder">A <see cref="T:ZedGraph.ZOrder"/> enumeration that controls
- the placement of this <see cref="T:ZedGraph.GraphObj"/> relative to other
- graphic objects. The order of <see cref="T:ZedGraph.GraphObj"/>'s with the
- same <see cref="T:ZedGraph.ZOrder"/> value is control by their order in
- this <see cref="T:ZedGraph.GraphObjList"/>.</param>
- </member>
- <member name="M:ZedGraph.GraphObjList.FindPoint(System.Drawing.PointF,ZedGraph.PaneBase,System.Drawing.Graphics,System.Single,System.Int32@)">
- <summary>
- Determine if a mouse point is within any <see cref="T:ZedGraph.GraphObj"/>, and if so,
- return the index number of the the <see cref="T:ZedGraph.GraphObj"/>.
- </summary>
- <param name="mousePt">The screen point, in pixel coordinates.</param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.PaneBase"/> object that is the parent or
- owner of this object.
- </param>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <param name="index">The index number of the <see cref="T:ZedGraph.TextObj"/>
- that is under the mouse point. The <see cref="T:ZedGraph.TextObj"/> object is
- accessible via the <see cref="T:ZedGraph.GraphObjList"/> indexer property.
- </param>
- <returns>true if the mouse point is within a <see cref="T:ZedGraph.GraphObj"/> bounding
- box, false otherwise.</returns>
- <seealso cref="M:ZedGraph.GraphPane.FindNearestObject(System.Drawing.PointF,System.Drawing.Graphics,System.Object@,System.Int32@)"/>
- </member>
- <member name="P:ZedGraph.GraphObjList.Item(System.String)">
- <summary>
- Indexer to access the specified <see cref="T:ZedGraph.GraphObj"/> object by its <see cref="F:ZedGraph.GraphObj.Tag"/>.
- Note that the <see cref="F:ZedGraph.GraphObj.Tag"/> must be a <see cref="T:System.String"/> type for this method
- to work.
- </summary>
- <param name="tag">The <see cref="T:System.String"/> type tag to search for.</param>
- <value>A <see cref="T:ZedGraph.GraphObj"/> object reference.</value>
- <seealso cref="M:ZedGraph.GraphObjList.IndexOfTag(System.String)"/>
- </member>
- <member name="T:ZedGraph.GapLabel">
- <summary>
- Class that handles the data associated with a text title and its associated font
- properties. Inherits from <see cref="T:ZedGraph.Label"/>, and adds the <see cref="P:ZedGraph.GapLabel.Gap"/>
- property for use by the <see cref="T:ZedGraph.Axis"/> and <see cref="T:ZedGraph.PaneBase"/> objects.
- </summary>
-
- <author> John Champion </author>
- <version> $Revision: 3.1 $ $Date: 2006-06-24 20:26:44 $ </version>
- </member>
- <member name="T:ZedGraph.Label">
- <summary>
- Class that handles the data associated with text title and its associated font
- properties
- </summary>
-
- <author> John Champion </author>
- <version> $Revision: 3.2 $ $Date: 2007-03-11 02:08:16 $ </version>
- </member>
- <member name="F:ZedGraph.Label.schema">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="F:ZedGraph.Label._text">
- <summary>
- private field that stores the <see cref="T:System.String"/> text for this label
- </summary>
- </member>
- <member name="F:ZedGraph.Label._fontSpec">
- <summary>
- private field that stores the <see cref="P:ZedGraph.Label.FontSpec"/> font properties for this label
- </summary>
- </member>
- <member name="F:ZedGraph.Label._isVisible">
- <summary>
- private field that determines if this label will be displayed.
- </summary>
- </member>
- <member name="M:ZedGraph.Label.#ctor(System.String,System.String,System.Single,System.Drawing.Color,System.Boolean,System.Boolean,System.Boolean)">
- <summary>
- Constructor to build an <see cref="T:ZedGraph.AxisLabel"/> from the text and the
- associated font properties.
- </summary>
- <param name="text">The <see cref="T:System.String"/> representing the text to be
- displayed</param>
- <param name="fontFamily">The <see cref="T:System.String"/> font family name</param>
- <param name="fontSize">The size of the font in points and scaled according
- to the <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> logic.</param>
- <param name="color">The <see cref="T:System.Drawing.Color"/> instance representing the color
- of the font</param>
- <param name="isBold">true for a bold font face</param>
- <param name="isItalic">true for an italic font face</param>
- <param name="isUnderline">true for an underline font face</param>
- </member>
- <member name="M:ZedGraph.Label.#ctor(System.String,ZedGraph.FontSpec)">
- <summary>
- Constructor that builds a <see cref="T:ZedGraph.Label"/> from a text <see cref="T:System.String"/>
- and a <see cref="P:ZedGraph.Label.FontSpec"/> instance.
- </summary>
- <param name="text"></param>
- <param name="fontSpec"></param>
- </member>
- <member name="M:ZedGraph.Label.#ctor(ZedGraph.Label)">
- <summary>
- Copy constructor
- </summary>
- <param name="rhs">the <see cref="T:ZedGraph.Label"/> instance to be copied.</param>
- </member>
- <member name="M:ZedGraph.Label.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.Label.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.Label.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.Label.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.Label.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="P:ZedGraph.Label.Text">
- <summary>
- The <see cref="T:System.String"/> text to be displayed
- </summary>
- </member>
- <member name="P:ZedGraph.Label.FontSpec">
- <summary>
- A <see cref="T:ZedGraph.FontSpec"/> instance representing the font properties
- for the displayed text.
- </summary>
- </member>
- <member name="P:ZedGraph.Label.IsVisible">
- <summary>
- Gets or sets a boolean value that determines whether or not this label will be displayed.
- </summary>
- </member>
- <member name="F:ZedGraph.GapLabel.schema2">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="M:ZedGraph.GapLabel.#ctor(System.String,System.String,System.Single,System.Drawing.Color,System.Boolean,System.Boolean,System.Boolean)">
- <summary>
- Constructor to build a <see cref="T:ZedGraph.GapLabel"/> from the text and the
- associated font properties.
- </summary>
- <param name="text">The <see cref="T:System.String"/> representing the text to be
- displayed</param>
- <param name="fontFamily">The <see cref="T:System.String"/> font family name</param>
- <param name="fontSize">The size of the font in points and scaled according
- to the <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> logic.</param>
- <param name="color">The <see cref="T:System.Drawing.Color"/> instance representing the color
- of the font</param>
- <param name="isBold">true for a bold font face</param>
- <param name="isItalic">true for an italic font face</param>
- <param name="isUnderline">true for an underline font face</param>
- </member>
- <member name="M:ZedGraph.GapLabel.#ctor(ZedGraph.GapLabel)">
- <summary>
- Copy constructor
- </summary>
- <param name="rhs">the <see cref="T:ZedGraph.AxisLabel"/> instance to be copied.</param>
- </member>
- <member name="M:ZedGraph.GapLabel.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.GapLabel.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.GapLabel.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.GapLabel.GetScaledGap(System.Single)">
- <summary>
- Calculate the size of the <see cref="P:ZedGraph.GapLabel.Gap"/> based on the <see cref="P:ZedGraph.Label.FontSpec"/>
- height, in pixel units and scaled according to <see paramref="scalefactor"/>.
- </summary>
- <param name="scaleFactor">The scaling factor to be applied</param>
- </member>
- <member name="M:ZedGraph.GapLabel.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.GapLabel.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="P:ZedGraph.GapLabel.Gap">
- <summary>
- Gets or sets the gap factor between this label and the opposing <see cref="T:ZedGraph.Axis"/>
- or <see cref="T:ZedGraph.Chart"/>.
- </summary>
- <remarks>
- This value is expressed as a fraction of the character height for the <see cref="T:ZedGraph.GapLabel"/>.
- </remarks>
- </member>
- <member name="T:ZedGraph.GapLabel.Default">
- <summary>
- A simple struct that defines the
- default property values for the <see cref="T:ZedGraph.GapLabel"/> class.
- </summary>
- </member>
- <member name="F:ZedGraph.GapLabel.Default.Gap">
- <summary>
- The default <see cref="P:ZedGraph.GapLabel.Gap"/> setting.
- </summary>
- </member>
- <member name="T:ZedGraph.Chart">
- <summary>
- Class that handles the properties of the charting area (where the curves are
- actually drawn), which is bounded by the <see cref="T:ZedGraph.XAxis"/>, <see cref="T:ZedGraph.YAxis"/>,
- and <see cref="T:ZedGraph.Y2Axis"/>.
- </summary>
-
- <author> John Champion </author>
- <version> $Revision: 3.1 $ $Date: 2006-06-24 20:26:44 $ </version>
- </member>
- <member name="F:ZedGraph.Chart.schema">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="F:ZedGraph.Chart._rect">
- <summary>
- The rectangle that contains the area bounded by the axes, in pixel units
- </summary>
- </member>
- <member name="F:ZedGraph.Chart._fill">
- <summary>
- Private field that stores the <see cref="T:ZedGraph.Fill"/> data for this
- <see cref="T:ZedGraph.Chart"/>. Use the public property <see cref="P:ZedGraph.Chart.Fill"/> to
- access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.Chart._border">
- <summary>
- Private field that stores the <see cref="T:ZedGraph.Border"/> data for this
- <see cref="T:ZedGraph.Chart"/>. Use the public property <see cref="P:ZedGraph.Chart.Border"/> to
- access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.Chart._isRectAuto">
- <summary>Private field that determines if the <see cref="P:ZedGraph.Chart.Rect"/> will be
- sized automatically. Use the public property <see cref="P:ZedGraph.Chart.IsRectAuto"/> to access
- this value. </summary>
- </member>
- <member name="M:ZedGraph.Chart.#ctor">
- <summary>
- Default constructor.
- </summary>
- </member>
- <member name="M:ZedGraph.Chart.#ctor(ZedGraph.Chart)">
- <summary>
- Copy constructor
- </summary>
- <param name="rhs">The source <see cref="T:ZedGraph.Chart"/> to be copied.</param>
- </member>
- <member name="M:ZedGraph.Chart.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.Chart.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.Chart.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.Chart.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.Chart.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="P:ZedGraph.Chart.Rect">
- <summary>
- Gets or sets the rectangle that contains the area bounded by the axes
- (<see cref="T:ZedGraph.XAxis"/>, <see cref="T:ZedGraph.YAxis"/>, and <see cref="T:ZedGraph.Y2Axis"/>).
- If you set this value manually, then the <see cref="P:ZedGraph.Chart.IsRectAuto"/>
- value will automatically be set to false.
- </summary>
- <value>The rectangle units are in screen pixels</value>
- </member>
- <member name="P:ZedGraph.Chart.Fill">
- <summary>
- Gets or sets the <see cref="T:ZedGraph.Fill"/> data for this
- <see cref="T:ZedGraph.Chart"/>.
- </summary>
- </member>
- <member name="P:ZedGraph.Chart.Border">
- <summary>
- Gets or sets the <see cref="T:ZedGraph.Border"/> class for drawing the border
- border around the <see cref="T:ZedGraph.Chart"/>
- </summary>
- <seealso cref="F:ZedGraph.Chart.Default.BorderColor"/>
- <seealso cref="F:ZedGraph.Chart.Default.BorderPenWidth"/>
- </member>
- <member name="P:ZedGraph.Chart.IsRectAuto">
- <summary>
- Gets or sets a boolean value that determines whether or not the
- <see cref="P:ZedGraph.Chart.Rect"/> will be calculated automatically (almost always true).
- </summary>
- <remarks>
- If you have a need to set the ChartRect manually, such as you have multiple graphs
- on a page and you want to line up the edges perfectly, you can set this value
- to false. If you set this value to false, you must also manually set
- the <see cref="P:ZedGraph.Chart.Rect"/> property.
- You can easily determine the ChartRect that ZedGraph would have
- calculated by calling the <see cref="M:ZedGraph.GraphPane.CalcChartRect(System.Drawing.Graphics)"/> method, which returns
- a chart rect sized for the current data range, scale sizes, etc.
- </remarks>
- <value>true to have ZedGraph calculate the ChartRect, false to do it yourself</value>
- </member>
- <member name="T:ZedGraph.Chart.Default">
- <summary>
- A simple struct that defines the
- default property values for the <see cref="T:ZedGraph.Chart"/> class.
- </summary>
- </member>
- <member name="F:ZedGraph.Chart.Default.BorderColor">
- <summary>
- The default color for the <see cref="T:ZedGraph.Chart"/> border.
- (<see cref="P:ZedGraph.Chart.Border"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.Chart.Default.FillColor">
- <summary>
- The default color for the <see cref="T:ZedGraph.Chart"/> background.
- (<see cref="P:ZedGraph.Chart.Fill"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.Chart.Default.FillBrush">
- <summary>
- The default brush for the <see cref="P:ZedGraph.GraphPane.Chart"/> background.
- (<see cref="P:ZedGraph.Fill.Brush"/> property of <see cref="P:ZedGraph.Chart.Fill"/>).
- </summary>
- </member>
- <member name="F:ZedGraph.Chart.Default.FillType">
- <summary>
- The default <see cref="F:ZedGraph.Chart.Default.FillType"/> for the <see cref="P:ZedGraph.GraphPane.Chart"/> background.
- (<see cref="P:ZedGraph.Fill.Type"/> property of <see cref="P:ZedGraph.Chart.Fill"/>).
- </summary>
- </member>
- <member name="F:ZedGraph.Chart.Default.BorderPenWidth">
- <summary>
- The default pen width for drawing the
- <see cref="P:ZedGraph.GraphPane.Chart"/> border
- (<see cref="P:ZedGraph.Chart.Border"/> property).
- Units are in points (1/72 inch).
- </summary>
- </member>
- <member name="F:ZedGraph.Chart.Default.IsBorderVisible">
- <summary>
- The default display mode for the <see cref="T:ZedGraph.Chart"/> border
- (<see cref="P:ZedGraph.Chart.Border"/> property). true
- to show the border border, false to omit the border
- </summary>
- </member>
- <member name="T:ZedGraph.OHLCBarItem">
- <summary>
- Encapsulates a CandleStick curve type that displays a vertical (or horizontal)
- line displaying the range of data values at each sample point, plus an starting
- mark and an ending mark signifying the opening and closing value for the sample.
- </summary>
- <remarks>For this type to work properly, your <see cref="T:ZedGraph.IPointList"/> must contain
- <see cref="T:ZedGraph.StockPt"/> objects, rather than ordinary <see cref="T:ZedGraph.PointPair"/> types.
- This is because the <see cref="T:ZedGraph.OHLCBarItem"/> type actually displays 5 data values
- but the <see cref="T:ZedGraph.PointPair"/> only stores 3 data values. The <see cref="T:ZedGraph.StockPt"/>
- stores <see cref="P:ZedGraph.StockPt.Date"/>, <see cref="F:ZedGraph.StockPt.Close"/>,
- <see cref="F:ZedGraph.StockPt.Open"/>, <see cref="P:ZedGraph.StockPt.High"/>, and
- <see cref="P:ZedGraph.StockPt.Low"/> members.
- For a vertical CandleStick chart, the opening value is drawn as a horizontal line
- segment to the left of the vertical range bar, and the closing value is a horizontal
- line segment to the right. The total length of these two line segments is controlled
- by the <see cref="P:ZedGraph.OHLCBar.Size"/> property, which is specified in
- points (1/72nd inch), and scaled according to <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/>.
- The candlesticks are drawn horizontally or vertically depending on the
- value of <see cref="P:ZedGraph.BarSettings.Base"/>, which is a
- <see cref="T:ZedGraph.BarBase"/> enum type.</remarks>
- <author> John Champion </author>
- <version> $Revision: 3.4 $ $Date: 2007-12-31 00:23:05 $ </version>
- </member>
- <member name="T:ZedGraph.CurveItem">
- <summary>
- This class contains the data and methods for an individual curve within
- a graph pane. It carries the settings for the curve including the
- key and item names, colors, symbols and sizes, linetypes, etc.
- </summary>
-
- <author> John Champion
- modified by Jerry Vos </author>
- <version> $Revision: 3.43 $ $Date: 2007-11-03 04:41:28 $ </version>
- </member>
- <member name="F:ZedGraph.CurveItem.schema">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="F:ZedGraph.CurveItem._label">
- <summary>
- protected field that stores a <see cref="P:ZedGraph.CurveItem.Label"/> instance for this
- <see cref="T:ZedGraph.CurveItem"/>, which is used for the <see cref="T:ZedGraph.Legend"/>
- label. Use the public
- property <see cref="P:ZedGraph.CurveItem.Label"/> to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.CurveItem._isX2Axis">
- <summary>
- protected field that stores the boolean value that determines whether this
- <see cref="T:ZedGraph.CurveItem"/> is on the bottom X axis or the top X axis (X2).
- Use the public property <see cref="P:ZedGraph.CurveItem.IsX2Axis"/> to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.CurveItem._isY2Axis">
- <summary>
- protected field that stores the boolean value that determines whether this
- <see cref="T:ZedGraph.CurveItem"/> is on the left Y axis or the right Y axis (Y2).
- Use the public property <see cref="P:ZedGraph.CurveItem.IsY2Axis"/> to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.CurveItem._yAxisIndex">
- <summary>
- protected field that stores the index number of the Y Axis to which this
- <see cref="T:ZedGraph.CurveItem"/> belongs. Use the public property <see cref="P:ZedGraph.CurveItem.YAxisIndex"/>
- to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.CurveItem._isVisible">
- <summary>
- protected field that stores the boolean value that determines whether this
- <see cref="T:ZedGraph.CurveItem"/> is visible on the graph.
- Use the public property <see cref="P:ZedGraph.CurveItem.IsVisible"/> to access this value.
- Note that this value turns the curve display on or off, but it does not
- affect the display of the legend entry. To hide the legend entry, you
- have to set <see cref="P:ZedGraph.Label.IsVisible"/> to false.
- </summary>
- </member>
- <member name="F:ZedGraph.CurveItem._isSelected">
- <summary>
- Protected field that stores the boolean value that determines whether this
- <see cref="T:ZedGraph.CurveItem"/> is selected on the graph.
- Use the public property <see cref="P:ZedGraph.CurveItem.IsSelected"/> to access this value.
- Note that this value changes the curve display color, but it does not
- affect the display of the legend entry. To hide the legend entry, you
- have to set <see cref="P:ZedGraph.Label.IsVisible"/> to false.
- </summary>
- </member>
- <member name="F:ZedGraph.CurveItem._isSelectable">
- <summary>
- Protected field that stores the boolean value that determines whether this
- <see cref="T:ZedGraph.CurveItem"/> can be selected in the graph.
- </summary>
- </member>
- <member name="F:ZedGraph.CurveItem._isOverrideOrdinal">
- <summary>
- protected field that stores a boolean value which allows you to override the normal
- ordinal axis behavior. Use the public property <see cref="P:ZedGraph.CurveItem.IsOverrideOrdinal"/> to
- access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.CurveItem._points">
- <summary>
- The <see cref="T:ZedGraph.IPointList"/> of value sets that
- represent this <see cref="T:ZedGraph.CurveItem"/>.
- The size of this list determines the number of points that are
- plotted. Note that values defined as
- System.Double.MaxValue are considered "missing" values
- (see <see cref="F:ZedGraph.PointPairBase.Missing"/>),
- and are not plotted. The curve will have a break at these points
- to indicate the values are missing.
- </summary>
- </member>
- <member name="F:ZedGraph.CurveItem.Tag">
- <summary>
- A tag object for use by the user. This can be used to store additional
- information associated with the <see cref="T:ZedGraph.CurveItem"/>. ZedGraph does
- not use this value for any purpose.
- </summary>
- <remarks>
- Note that, if you are going to Serialize ZedGraph data, then any type
- that you store in <see cref="F:ZedGraph.CurveItem.Tag"/> must be a serializable type (or
- it will cause an exception).
- </remarks>
- </member>
- <member name="F:ZedGraph.CurveItem._link">
- <summary>
- Protected field that stores the hyperlink information for this object.
- </summary>
- </member>
- <member name="M:ZedGraph.CurveItem.#ctor(System.String,System.Double[],System.Double[])">
- <summary>
- <see cref="T:ZedGraph.CurveItem"/> constructor the pre-specifies the curve label, the
- x and y data values as a <see cref="T:ZedGraph.IPointList"/>, the curve
- type (Bar or Line/Symbol), the <see cref="P:ZedGraph.CurveItem.Color"/>, and the
- <see cref="T:ZedGraph.SymbolType"/>. Other properties of the curve are
- defaulted to the values in the <see cref="T:ZedGraph.GraphPane.Default"/> class.
- </summary>
- <param name="label">A string label (legend entry) for this curve</param>
- <param name="x">An array of double precision values that define
- the independent (X axis) values for this curve</param>
- <param name="y">An array of double precision values that define
- the dependent (Y axis) values for this curve</param>
- </member>
- <member name="M:ZedGraph.CurveItem.#ctor(System.String,ZedGraph.IPointList)">
- <summary>
- <see cref="T:ZedGraph.CurveItem"/> constructor the pre-specifies the curve label, the
- x and y data values as a <see cref="T:ZedGraph.IPointList"/>, the curve
- type (Bar or Line/Symbol), the <see cref="P:ZedGraph.CurveItem.Color"/>, and the
- <see cref="T:ZedGraph.SymbolType"/>. Other properties of the curve are
- defaulted to the values in the <see cref="T:ZedGraph.GraphPane.Default"/> class.
- </summary>
- <param name="label">A string label (legend entry) for this curve</param>
- <param name="points">A <see cref="T:ZedGraph.IPointList"/> of double precision value pairs that define
- the X and Y values for this curve</param>
- </member>
- <member name="M:ZedGraph.CurveItem.Init(System.String)">
- <summary>
- Internal initialization routine thats sets some initial values to defaults.
- </summary>
- <param name="label">A string label (legend entry) for this curve</param>
- </member>
- <member name="M:ZedGraph.CurveItem.#ctor(System.String)">
- <summary>
- <see cref="T:ZedGraph.CurveItem"/> constructor that specifies the label of the CurveItem.
- This is the same as <c>CurveItem(label, null, null)</c>.
- <seealso cref="M:ZedGraph.CurveItem.#ctor(System.String,System.Double[],System.Double[])"/>
- </summary>
- <param name="label">A string label (legend entry) for this curve</param>
- </member>
- <member name="M:ZedGraph.CurveItem.#ctor">
- <summary>
-
- </summary>
- </member>
- <member name="M:ZedGraph.CurveItem.#ctor(ZedGraph.CurveItem)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The CurveItem object from which to copy</param>
- </member>
- <member name="M:ZedGraph.CurveItem.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of Clone.
- </summary>
- <remarks>
- Note that this method must be called with an explicit cast to ICloneable, and
- that it is inherently virtual. For example:
- <code>
- ParentClass foo = new ChildClass();
- ChildClass bar = (ChildClass) ((ICloneable)foo).Clone();
- </code>
- Assume that ChildClass is inherited from ParentClass. Even though foo is declared with
- ParentClass, it is actually an instance of ChildClass. Calling the ICloneable implementation
- of Clone() on foo actually calls ChildClass.Clone() as if it were a virtual function.
- </remarks>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.CurveItem.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.CurveItem.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.CurveItem.IsZIncluded(ZedGraph.GraphPane)">
- <summary>
- Gets a flag indicating if the Z data range should be included in the axis scaling calculations.
- </summary>
- <param name="pane">The parent <see cref="T:ZedGraph.GraphPane"/> of this <see cref="T:ZedGraph.CurveItem"/>.
- </param>
- <value>true if the Z data are included, false otherwise</value>
- </member>
- <member name="M:ZedGraph.CurveItem.IsXIndependent(ZedGraph.GraphPane)">
- <summary>
- Gets a flag indicating if the X axis is the independent axis for this <see cref="T:ZedGraph.CurveItem"/>
- </summary>
- <param name="pane">The parent <see cref="T:ZedGraph.GraphPane"/> of this <see cref="T:ZedGraph.CurveItem"/>.
- </param>
- <value>true if the X axis is independent, false otherwise</value>
- </member>
- <member name="M:ZedGraph.CurveItem.Draw(System.Drawing.Graphics,ZedGraph.GraphPane,System.Int32,System.Single)">
- <summary>
- Do all rendering associated with this <see cref="T:ZedGraph.CurveItem"/> to the specified
- <see cref="T:System.Drawing.Graphics"/> device. This method is normally only
- called by the Draw method of the parent <see cref="T:ZedGraph.CurveList"/>
- collection object.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="pos">The ordinal position of the current <see cref="T:ZedGraph.Bar"/>
- curve.</param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.CurveItem.DrawLegendKey(System.Drawing.Graphics,ZedGraph.GraphPane,System.Drawing.RectangleF,System.Single)">
- <summary>
- Draw a legend key entry for this <see cref="T:ZedGraph.CurveItem"/> at the specified location.
- This abstract base method passes through to <see cref="M:ZedGraph.BarItem.DrawLegendKey(System.Drawing.Graphics,ZedGraph.GraphPane,System.Drawing.RectangleF,System.Single)"/> or
- <see cref="M:ZedGraph.LineItem.DrawLegendKey(System.Drawing.Graphics,ZedGraph.GraphPane,System.Drawing.RectangleF,System.Single)"/> to do the rendering.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="rect">The <see cref="T:System.Drawing.RectangleF"/> struct that specifies the
- location for the legend key</param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.CurveItem.AddPoint(System.Double,System.Double)">
- <summary>
- Add a single x,y coordinate point to the end of the points collection for this curve.
- </summary>
- <param name="x">The X coordinate value</param>
- <param name="y">The Y coordinate value</param>
- </member>
- <member name="M:ZedGraph.CurveItem.AddPoint(ZedGraph.PointPair)">
- <summary>
- Add a <see cref="T:ZedGraph.PointPair"/> object to the end of the points collection for this curve.
- </summary>
- <remarks>
- This method will only work if the <see cref="T:ZedGraph.IPointList"/> instance reference
- at <see cref="P:ZedGraph.CurveItem.Points"/> supports the <see cref="T:ZedGraph.IPointListEdit"/> interface.
- Otherwise, it does nothing.
- </remarks>
- <param name="point">A reference to the <see cref="T:ZedGraph.PointPair"/> object to
- be added</param>
- </member>
- <member name="M:ZedGraph.CurveItem.Clear">
- <summary>
- Clears the points from this <see cref="T:ZedGraph.CurveItem"/>. This is the same
- as <c>CurveItem.Points.Clear()</c>.
- </summary>
- <remarks>
- This method will only work if the <see cref="T:ZedGraph.IPointList"/> instance reference
- at <see cref="P:ZedGraph.CurveItem.Points"/> supports the <see cref="T:ZedGraph.IPointListEdit"/> interface.
- Otherwise, it does nothing.
- </remarks>
- </member>
- <member name="M:ZedGraph.CurveItem.RemovePoint(System.Int32)">
- <summary>
- Removes a single point from this <see cref="T:ZedGraph.CurveItem"/>.
- </summary>
- <remarks>
- This method will only work if the <see cref="T:ZedGraph.IPointList"/> instance reference
- at <see cref="P:ZedGraph.CurveItem.Points"/> supports the <see cref="T:ZedGraph.IPointListEdit"/> interface.
- Otherwise, it does nothing.
- </remarks>
- <param name="index">The ordinal position of the point to be removed.</param>
- </member>
- <member name="M:ZedGraph.CurveItem.GetXAxis(ZedGraph.GraphPane)">
- <summary>
- Get the X Axis instance (either <see cref="T:ZedGraph.XAxis"/> or <see cref="T:ZedGraph.X2Axis"/>) to
- which this <see cref="T:ZedGraph.CurveItem"/> belongs.
- </summary>
- <param name="pane">The <see cref="T:ZedGraph.GraphPane"/> object to which this curve belongs.</param>
- <returns>Either a <see cref="T:ZedGraph.XAxis"/> or <see cref="T:ZedGraph.X2Axis"/> to which this
- <see cref="T:ZedGraph.CurveItem"/> belongs.
- </returns>
- </member>
- <member name="M:ZedGraph.CurveItem.GetYAxis(ZedGraph.GraphPane)">
- <summary>
- Get the Y Axis instance (either <see cref="T:ZedGraph.YAxis"/> or <see cref="T:ZedGraph.Y2Axis"/>) to
- which this <see cref="T:ZedGraph.CurveItem"/> belongs.
- </summary>
- <remarks>
- This method safely retrieves a Y Axis instance from either the <see cref="P:ZedGraph.GraphPane.YAxisList"/>
- or the <see cref="P:ZedGraph.GraphPane.Y2AxisList"/> using the values of <see cref="P:ZedGraph.CurveItem.YAxisIndex"/> and
- <see cref="P:ZedGraph.CurveItem.IsY2Axis"/>. If the value of <see cref="P:ZedGraph.CurveItem.YAxisIndex"/> is out of bounds, the
- default <see cref="T:ZedGraph.YAxis"/> or <see cref="T:ZedGraph.Y2Axis"/> is used.
- </remarks>
- <param name="pane">The <see cref="T:ZedGraph.GraphPane"/> object to which this curve belongs.</param>
- <returns>Either a <see cref="T:ZedGraph.YAxis"/> or <see cref="T:ZedGraph.Y2Axis"/> to which this
- <see cref="T:ZedGraph.CurveItem"/> belongs.
- </returns>
- </member>
- <member name="M:ZedGraph.CurveItem.GetYAxisIndex(ZedGraph.GraphPane)">
- <summary>
- Get the index of the Y Axis in the <see cref="T:ZedGraph.YAxis"/> or <see cref="T:ZedGraph.Y2Axis"/> list to
- which this <see cref="T:ZedGraph.CurveItem"/> belongs.
- </summary>
- <remarks>
- This method safely retrieves a Y Axis index into either the <see cref="P:ZedGraph.GraphPane.YAxisList"/>
- or the <see cref="P:ZedGraph.GraphPane.Y2AxisList"/> using the values of <see cref="P:ZedGraph.CurveItem.YAxisIndex"/> and
- <see cref="P:ZedGraph.CurveItem.IsY2Axis"/>. If the value of <see cref="P:ZedGraph.CurveItem.YAxisIndex"/> is out of bounds, the
- default <see cref="T:ZedGraph.YAxis"/> or <see cref="T:ZedGraph.Y2Axis"/> is used, which is index zero.
- </remarks>
- <param name="pane">The <see cref="T:ZedGraph.GraphPane"/> object to which this curve belongs.</param>
- <returns>An integer value indicating which index position in the list applies to this
- <see cref="T:ZedGraph.CurveItem"/>
- </returns>
- </member>
- <member name="M:ZedGraph.CurveItem.MakeUnique">
- <summary>
- Loads some pseudo unique colors/symbols into this CurveItem. This
- is the same as <c>MakeUnique(ColorSymbolRotator.StaticInstance)</c>.
- <seealso cref="P:ZedGraph.ColorSymbolRotator.StaticInstance"/>
- <seealso cref="T:ZedGraph.ColorSymbolRotator"/>
- <seealso cref="M:ZedGraph.CurveItem.MakeUnique(ZedGraph.ColorSymbolRotator)"/>
- </summary>
- </member>
- <member name="M:ZedGraph.CurveItem.MakeUnique(ZedGraph.ColorSymbolRotator)">
- <summary>
- Loads some pseudo unique colors/symbols into this CurveItem. This
- is mainly useful for differentiating a set of new CurveItems without
- having to pick your own colors/symbols.
- <seealso cref="M:ZedGraph.CurveItem.MakeUnique(ZedGraph.ColorSymbolRotator)"/>
- </summary>
- <param name="rotator">
- The <see cref="T:ZedGraph.ColorSymbolRotator"/> that is used to pick the color
- and symbol for this method call.
- </param>
- </member>
- <member name="M:ZedGraph.CurveItem.GetRange(System.Double@,System.Double@,System.Double@,System.Double@,System.Boolean,System.Boolean,ZedGraph.GraphPane)">
- <summary>
- Go through the list of <see cref="T:ZedGraph.PointPair"/> data values for this <see cref="T:ZedGraph.CurveItem"/>
- and determine the minimum and maximum values in the data.
- </summary>
- <param name="xMin">The minimum X value in the range of data</param>
- <param name="xMax">The maximum X value in the range of data</param>
- <param name="yMin">The minimum Y value in the range of data</param>
- <param name="yMax">The maximum Y value in the range of data</param>
- <param name="ignoreInitial">ignoreInitial is a boolean value that
- affects the data range that is considered for the automatic scale
- ranging (see <see cref="P:ZedGraph.GraphPane.IsIgnoreInitial"/>). If true, then initial
- data points where the Y value is zero are not included when
- automatically determining the scale <see cref="P:ZedGraph.Scale.Min"/>,
- <see cref="P:ZedGraph.Scale.Max"/>, and <see cref="P:ZedGraph.Scale.MajorStep"/> size. All data after
- the first non-zero Y value are included.
- </param>
- <param name="isBoundedRanges">
- Determines if the auto-scaled axis ranges will subset the
- data points based on any manually set scale range values.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <seealso cref="P:ZedGraph.GraphPane.IsBoundedRanges"/>
- </member>
- <member name="M:ZedGraph.CurveItem.BaseAxis(ZedGraph.GraphPane)">
- <summary>Returns a reference to the <see cref="T:ZedGraph.Axis"/> object that is the "base"
- (independent axis) from which the values are drawn. </summary>
- <remarks>
- This property is determined by the value of <see cref="P:ZedGraph.BarSettings.Base"/> for
- <see cref="T:ZedGraph.BarItem"/>, <see cref="T:ZedGraph.ErrorBarItem"/>, and <see cref="T:ZedGraph.HiLowBarItem"/>
- types. It is always the X axis for regular <see cref="T:ZedGraph.LineItem"/> types.
- Note that the <see cref="P:ZedGraph.BarSettings.Base"/> setting can override the
- <see cref="P:ZedGraph.CurveItem.IsY2Axis"/> and <see cref="P:ZedGraph.CurveItem.YAxisIndex"/> settings for bar types
- (this is because all the bars that are clustered together must share the
- same base axis).
- </remarks>
- <seealso cref="T:ZedGraph.BarBase"/>
- <seealso cref="M:ZedGraph.CurveItem.ValueAxis(ZedGraph.GraphPane)"/>
- </member>
- <member name="M:ZedGraph.CurveItem.ValueAxis(ZedGraph.GraphPane)">
- <summary>Returns a reference to the <see cref="T:ZedGraph.Axis"/> object that is the "value"
- (dependent axis) from which the points are drawn. </summary>
- <remarks>
- This property is determined by the value of <see cref="P:ZedGraph.BarSettings.Base"/> for
- <see cref="T:ZedGraph.BarItem"/>, <see cref="T:ZedGraph.ErrorBarItem"/>, and <see cref="T:ZedGraph.HiLowBarItem"/>
- types. It is always the Y axis for regular <see cref="T:ZedGraph.LineItem"/> types.
- </remarks>
- <seealso cref="T:ZedGraph.BarBase"/>
- <seealso cref="M:ZedGraph.CurveItem.BaseAxis(ZedGraph.GraphPane)"/>
- </member>
- <member name="M:ZedGraph.CurveItem.GetBarWidth(ZedGraph.GraphPane)">
- <summary>
- Calculate the width of each bar, depending on the actual bar type
- </summary>
- <returns>The width for an individual bar, in pixel units</returns>
- </member>
- <member name="M:ZedGraph.CurveItem.GetCoords(ZedGraph.GraphPane,System.Int32,System.String@)">
- <summary>
- Determine the coords for the rectangle associated with a specified point for
- this <see cref="T:ZedGraph.CurveItem"/>
- </summary>
- <param name="pane">The <see cref="T:ZedGraph.GraphPane"/> to which this curve belongs</param>
- <param name="i">The index of the point of interest</param>
- <param name="coords">A list of coordinates that represents the "rect" for
- this point (used in an html AREA tag)</param>
- <returns>true if it's a valid point, false otherwise</returns>
- </member>
- <member name="P:ZedGraph.CurveItem.Label">
- <summary>
- A <see cref="P:ZedGraph.CurveItem.Label"/> instance that represents the <see cref="T:ZedGraph.Legend"/>
- entry for the this <see cref="T:ZedGraph.CurveItem"/> object
- </summary>
- </member>
- <member name="P:ZedGraph.CurveItem.Color">
- <summary>
- The <see cref="T:ZedGraph.Line"/>/<see cref="T:ZedGraph.Symbol"/>/<see cref="T:ZedGraph.Bar"/>
- color (FillColor for the Bar). This is a common access to
- <see cref="P:ZedGraph.LineBase.Color">Line.Color</see>,
- <see cref="P:ZedGraph.LineBase.Color">Border.Color</see>, and
- <see cref="P:ZedGraph.Fill.Color">Fill.Color</see> properties for this curve.
- </summary>
- </member>
- <member name="P:ZedGraph.CurveItem.IsVisible">
- <summary>
- Determines whether this <see cref="T:ZedGraph.CurveItem"/> is visible on the graph.
- Note that this value turns the curve display on or off, but it does not
- affect the display of the legend entry. To hide the legend entry, you
- have to set <see cref="P:ZedGraph.Label.IsVisible"/> to false.
- </summary>
- </member>
- <member name="P:ZedGraph.CurveItem.IsSelected">
- <summary>
- Determines whether this <see cref="T:ZedGraph.CurveItem"/> is selected on the graph.
- Note that this value changes the curve displayed color, but it does not
- affect the display of the legend entry. To hide the legend entry, you
- have to set <see cref="P:ZedGraph.Label.IsVisible"/> to false.
- </summary>
- </member>
- <member name="P:ZedGraph.CurveItem.IsSelectable">
- <summary>
- Determines whether this <see cref="T:ZedGraph.CurveItem"/> can be selected in the graph.
- </summary>
- </member>
- <member name="P:ZedGraph.CurveItem.IsOverrideOrdinal">
- <summary>
- Gets or sets a value which allows you to override the normal
- ordinal axis behavior.
- </summary>
- <remarks>
- Normally for an ordinal axis type, the actual data values corresponding to the ordinal
- axis will be ignored (essentially they are replaced by ordinal values, e.g., 1, 2, 3, etc).
- If IsOverrideOrdinal is true, then the user data values will be used (even if they don't
- make sense). Fractional values are allowed, such that a value of 1.5 is between the first and
- second ordinal position, etc.
- </remarks>
- <seealso cref="F:ZedGraph.AxisType.Ordinal"/>
- <seealso cref="F:ZedGraph.AxisType.Text"/>
- </member>
- <member name="P:ZedGraph.CurveItem.IsX2Axis">
- <summary>
- Gets or sets a value that determines which X axis this <see cref="T:ZedGraph.CurveItem"/>
- is assigned to.
- </summary>
- <remarks>
- The
- <see cref="T:ZedGraph.XAxis"/> is on the bottom side of the graph and the
- <see cref="T:ZedGraph.X2Axis"/> is on the top side. Assignment to an axis
- determines the scale that is used to draw the curve on the graph.
- </remarks>
- <value>true to assign the curve to the <see cref="T:ZedGraph.X2Axis"/>,
- false to assign the curve to the <see cref="T:ZedGraph.XAxis"/></value>
- </member>
- <member name="P:ZedGraph.CurveItem.IsY2Axis">
- <summary>
- Gets or sets a value that determines which Y axis this <see cref="T:ZedGraph.CurveItem"/>
- is assigned to.
- </summary>
- <remarks>
- The
- <see cref="T:ZedGraph.YAxis"/> is on the left side of the graph and the
- <see cref="T:ZedGraph.Y2Axis"/> is on the right side. Assignment to an axis
- determines the scale that is used to draw the curve on the graph. Note that
- this value is used in combination with the <see cref="P:ZedGraph.CurveItem.YAxisIndex"/> to determine
- which of the Y Axes (if there are multiples) this curve belongs to.
- </remarks>
- <value>true to assign the curve to the <see cref="T:ZedGraph.Y2Axis"/>,
- false to assign the curve to the <see cref="T:ZedGraph.YAxis"/></value>
- </member>
- <member name="P:ZedGraph.CurveItem.YAxisIndex">
- <summary>
- Gets or sets the index number of the Y Axis to which this
- <see cref="T:ZedGraph.CurveItem"/> belongs.
- </summary>
- <remarks>
- This value is essentially an index number into the <see cref="P:ZedGraph.GraphPane.YAxisList"/>
- or <see cref="P:ZedGraph.GraphPane.Y2AxisList"/>, depending on the setting of
- <see cref="P:ZedGraph.CurveItem.IsY2Axis"/>.
- </remarks>
- </member>
- <member name="P:ZedGraph.CurveItem.IsBar">
- <summary>
- Determines whether this <see cref="T:ZedGraph.CurveItem"/>
- is a <see cref="T:ZedGraph.BarItem"/>.
- </summary>
- <value>true for a bar chart, or false for a line or pie graph</value>
- </member>
- <member name="P:ZedGraph.CurveItem.IsPie">
- <summary>
- Determines whether this <see cref="T:ZedGraph.CurveItem"/>
- is a <see cref="T:ZedGraph.PieItem"/>.
- </summary>
- <value>true for a pie chart, or false for a line or bar graph</value>
- </member>
- <member name="P:ZedGraph.CurveItem.IsLine">
- <summary>
- Determines whether this <see cref="T:ZedGraph.CurveItem"/>
- is a <see cref="T:ZedGraph.LineItem"/>.
- </summary>
- <value>true for a line chart, or false for a bar type</value>
- </member>
- <member name="P:ZedGraph.CurveItem.NPts">
- <summary>
- Readonly property that gives the number of points that define this
- <see cref="T:ZedGraph.CurveItem"/> object, which is the number of points in the
- <see cref="P:ZedGraph.CurveItem.Points"/> data collection.
- </summary>
- </member>
- <member name="P:ZedGraph.CurveItem.Points">
- <summary>
- The <see cref="T:ZedGraph.IPointList"/> of X,Y point sets that represent this
- <see cref="T:ZedGraph.CurveItem"/>.
- </summary>
- </member>
- <member name="P:ZedGraph.CurveItem.Item(System.Int32)">
- <summary>
- An accessor for the <see cref="T:ZedGraph.PointPair"/> datum for this <see cref="T:ZedGraph.CurveItem"/>.
- Index is the ordinal reference (zero based) of the point.
- </summary>
- </member>
- <member name="P:ZedGraph.CurveItem.Link">
- <summary>
- Gets or sets the hyperlink information for this <see cref="T:ZedGraph.CurveItem"/>.
- </summary>
- </member>
- <member name="T:ZedGraph.CurveItem.Comparer">
- <summary>
- Compares <see cref="T:ZedGraph.CurveItem"/>'s based on the point value at the specified
- index and for the specified axis.
- <seealso cref="M:System.Collections.ArrayList.Sort"/>
- </summary>
- </member>
- <member name="M:ZedGraph.CurveItem.Comparer.#ctor(ZedGraph.SortType,System.Int32)">
- <summary>
- Constructor for Comparer.
- </summary>
- <param name="type">The axis type on which to sort.</param>
- <param name="index">The index number of the point on which to sort</param>
- </member>
- <member name="M:ZedGraph.CurveItem.Comparer.Compare(ZedGraph.CurveItem,ZedGraph.CurveItem)">
- <summary>
- Compares two <see cref="T:ZedGraph.CurveItem"/>s using the previously specified index value
- and axis. Sorts in descending order.
- </summary>
- <param name="l">Curve to the left.</param>
- <param name="r">Curve to the right.</param>
- <returns>-1, 0, or 1 depending on l.X's relation to r.X</returns>
- </member>
- <member name="F:ZedGraph.OHLCBarItem.schema2">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="F:ZedGraph.OHLCBarItem._bar">
- <summary>
- Private field that stores a reference to the <see cref="T:ZedGraph.OHLCBar"/>
- class defined for this <see cref="T:ZedGraph.OHLCBarItem"/>. Use the public
- property <see cref="T:ZedGraph.OHLCBar"/> to access this value.
- </summary>
-
- </member>
- <member name="M:ZedGraph.OHLCBarItem.IsXIndependent(ZedGraph.GraphPane)">
- <summary>
- Gets a flag indicating if the X axis is the independent axis for this <see cref="T:ZedGraph.CurveItem"/>
- </summary>
- <param name="pane">The parent <see cref="T:ZedGraph.GraphPane"/> of this <see cref="T:ZedGraph.CurveItem"/>.
- </param>
- <value>true if the X axis is independent, false otherwise</value>
- </member>
- <member name="M:ZedGraph.OHLCBarItem.IsZIncluded(ZedGraph.GraphPane)">
- <summary>
- Gets a flag indicating if the Z data range should be included in the axis scaling calculations.
- </summary>
- <remarks>
- IsZIncluded is true for <see cref="T:ZedGraph.OHLCBarItem"/> objects, since the Y and Z
- values are defined as the High and Low values for the day.</remarks>
- <param name="pane">The parent <see cref="T:ZedGraph.GraphPane"/> of this <see cref="T:ZedGraph.CurveItem"/>.
- </param>
- <value>true if the Z data are included, false otherwise</value>
- </member>
- <member name="M:ZedGraph.OHLCBarItem.#ctor(System.String)">
- <summary>
- Create a new <see cref="T:ZedGraph.OHLCBarItem"/>, specifying only the legend label.
- </summary>
- <param name="label">The label that will appear in the legend.</param>
- </member>
- <member name="M:ZedGraph.OHLCBarItem.#ctor(System.String,ZedGraph.IPointList,System.Drawing.Color)">
- <summary>
- Create a new <see cref="T:ZedGraph.OHLCBarItem"/> using the specified properties.
- </summary>
- <param name="label">The _label that will appear in the legend.</param>
- <param name="points">An <see cref="T:ZedGraph.IPointList"/> of double precision values that define
- the Date, Close, Open, High, and Low values for the curve. Note that this
- <see cref="T:ZedGraph.IPointList"/> should contain <see cref="T:ZedGraph.StockPt"/> items rather
- than <see cref="T:ZedGraph.PointPair"/> items.
- </param>
- <param name="color">
- The <see cref="T:System.Drawing.Color"/> to use for drawing the candlesticks.</param>
- </member>
- <member name="M:ZedGraph.OHLCBarItem.#ctor(ZedGraph.OHLCBarItem)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.OHLCBarItem"/> object from which to copy</param>
- </member>
- <member name="M:ZedGraph.OHLCBarItem.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.OHLCBarItem.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.OHLCBarItem.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.OHLCBarItem.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.OHLCBarItem.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.OHLCBarItem.Draw(System.Drawing.Graphics,ZedGraph.GraphPane,System.Int32,System.Single)">
- <summary>
- Do all rendering associated with this <see cref="T:ZedGraph.OHLCBarItem"/> to the specified
- <see cref="T:System.Drawing.Graphics"/> device. This method is normally only
- called by the Draw method of the parent <see cref="T:ZedGraph.CurveList"/>
- collection object.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="pos">The ordinal position of the current <see cref="T:ZedGraph.OHLCBarItem"/>
- curve.</param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.OHLCBarItem.DrawLegendKey(System.Drawing.Graphics,ZedGraph.GraphPane,System.Drawing.RectangleF,System.Single)">
- <summary>
- Draw a legend key entry for this <see cref="T:ZedGraph.OHLCBarItem"/> at the specified location
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="rect">The <see cref="T:System.Drawing.RectangleF"/> struct that specifies the
- location for the legend key</param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.OHLCBarItem.GetCoords(ZedGraph.GraphPane,System.Int32,System.String@)">
- <summary>
- Determine the coords for the rectangle associated with a specified point for
- this <see cref="T:ZedGraph.CurveItem"/>
- </summary>
- <param name="pane">The <see cref="T:ZedGraph.GraphPane"/> to which this curve belongs</param>
- <param name="i">The index of the point of interest</param>
- <param name="coords">A list of coordinates that represents the "rect" for
- this point (used in an html AREA tag)</param>
- <returns>true if it's a valid point, false otherwise</returns>
- </member>
- <member name="P:ZedGraph.OHLCBarItem.Bar">
- <summary>
- Gets a reference to the <see cref="T:ZedGraph.OHLCBar"/> class defined
- for this <see cref="T:ZedGraph.OHLCBarItem"/>.
- </summary>
- </member>
- <member name="T:ZedGraph.ScaleState">
- <summary>
- A class that captures an <see cref="T:ZedGraph.Axis"/> scale range.
- </summary>
- <remarks>This structure is used by the <see cref="T:ZedGraph.ZoomState"/> class to store
- <see cref="T:ZedGraph.Axis"/> scale range settings in a collection for later retrieval.
- The class stores the <see cref="P:ZedGraph.Scale.Min"/>, <see cref="P:ZedGraph.Scale.Max"/>,
- <see cref="P:ZedGraph.Scale.MinorStep"/>, and <see cref="P:ZedGraph.Scale.MajorStep"/> properties, along with
- the corresponding auto-scale settings: <see cref="P:ZedGraph.Scale.MinAuto"/>,
- <see cref="P:ZedGraph.Scale.MaxAuto"/>, <see cref="P:ZedGraph.Scale.MinorStepAuto"/>,
- and <see cref="P:ZedGraph.Scale.MajorStepAuto"/>.</remarks>
- <author> John Champion </author>
- <version> $Revision: 3.2 $ $Date: 2007-02-19 08:05:24 $ </version>
- </member>
- <member name="F:ZedGraph.ScaleState._min">
- <summary>
- The axis range data for <see cref="P:ZedGraph.Scale.Min"/>, <see cref="P:ZedGraph.Scale.Max"/>,
- <see cref="P:ZedGraph.Scale.MinorStep"/>, and <see cref="P:ZedGraph.Scale.MajorStep"/>
- </summary>
- </member>
- <member name="F:ZedGraph.ScaleState._minorStep">
- <summary>
- The axis range data for <see cref="P:ZedGraph.Scale.Min"/>, <see cref="P:ZedGraph.Scale.Max"/>,
- <see cref="P:ZedGraph.Scale.MinorStep"/>, and <see cref="P:ZedGraph.Scale.MajorStep"/>
- </summary>
- </member>
- <member name="F:ZedGraph.ScaleState._majorStep">
- <summary>
- The axis range data for <see cref="P:ZedGraph.Scale.Min"/>, <see cref="P:ZedGraph.Scale.Max"/>,
- <see cref="P:ZedGraph.Scale.MinorStep"/>, and <see cref="P:ZedGraph.Scale.MajorStep"/>
- </summary>
- </member>
- <member name="F:ZedGraph.ScaleState._max">
- <summary>
- The axis range data for <see cref="P:ZedGraph.Scale.Min"/>, <see cref="P:ZedGraph.Scale.Max"/>,
- <see cref="P:ZedGraph.Scale.MinorStep"/>, and <see cref="P:ZedGraph.Scale.MajorStep"/>
- </summary>
- </member>
- <member name="F:ZedGraph.ScaleState._minAuto">
- <summary>
- The status of <see cref="P:ZedGraph.Scale.MinAuto"/>,
- <see cref="P:ZedGraph.Scale.MaxAuto"/>, <see cref="P:ZedGraph.Scale.MinorStepAuto"/>,
- and <see cref="P:ZedGraph.Scale.MajorStepAuto"/>
- </summary>
- </member>
- <member name="F:ZedGraph.ScaleState._minorStepAuto">
- <summary>
- The status of <see cref="P:ZedGraph.Scale.MinAuto"/>,
- <see cref="P:ZedGraph.Scale.MaxAuto"/>, <see cref="P:ZedGraph.Scale.MinorStepAuto"/>,
- and <see cref="P:ZedGraph.Scale.MajorStepAuto"/>
- </summary>
- </member>
- <member name="F:ZedGraph.ScaleState._majorStepAuto">
- <summary>
- The status of <see cref="P:ZedGraph.Scale.MinAuto"/>,
- <see cref="P:ZedGraph.Scale.MaxAuto"/>, <see cref="P:ZedGraph.Scale.MinorStepAuto"/>,
- and <see cref="P:ZedGraph.Scale.MajorStepAuto"/>
- </summary>
- </member>
- <member name="F:ZedGraph.ScaleState._maxAuto">
- <summary>
- The status of <see cref="P:ZedGraph.Scale.MinAuto"/>,
- <see cref="P:ZedGraph.Scale.MaxAuto"/>, <see cref="P:ZedGraph.Scale.MinorStepAuto"/>,
- and <see cref="P:ZedGraph.Scale.MajorStepAuto"/>
- </summary>
- </member>
- <member name="F:ZedGraph.ScaleState._formatAuto">
- <summary>
- The status of <see cref="P:ZedGraph.Scale.MinAuto"/>,
- <see cref="P:ZedGraph.Scale.MaxAuto"/>, <see cref="P:ZedGraph.Scale.MinorStepAuto"/>,
- and <see cref="P:ZedGraph.Scale.MajorStepAuto"/>
- </summary>
- </member>
- <member name="F:ZedGraph.ScaleState._magAuto">
- <summary>
- The status of <see cref="P:ZedGraph.Scale.MinAuto"/>,
- <see cref="P:ZedGraph.Scale.MaxAuto"/>, <see cref="P:ZedGraph.Scale.MinorStepAuto"/>,
- and <see cref="P:ZedGraph.Scale.MajorStepAuto"/>
- </summary>
- </member>
- <member name="F:ZedGraph.ScaleState._minorUnit">
- <summary>
- The status of <see cref="P:ZedGraph.Scale.MajorUnit"/> and <see cref="P:ZedGraph.Scale.MinorUnit"/>
- </summary>
- </member>
- <member name="F:ZedGraph.ScaleState._majorUnit">
- <summary>
- The status of <see cref="P:ZedGraph.Scale.MajorUnit"/> and <see cref="P:ZedGraph.Scale.MinorUnit"/>
- </summary>
- </member>
- <member name="M:ZedGraph.ScaleState.#ctor(ZedGraph.Axis)">
- <summary>
- Construct a <see cref="T:ZedGraph.ScaleState"/> from the specified <see cref="T:ZedGraph.Axis"/>
- </summary>
- <param name="axis">The <see cref="T:ZedGraph.Axis"/> from which to collect the scale
- range settings.</param>
- </member>
- <member name="M:ZedGraph.ScaleState.#ctor(ZedGraph.ScaleState)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.ScaleState"/> object from which to copy</param>
- </member>
- <member name="M:ZedGraph.ScaleState.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.ScaleState.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.ScaleState.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.ScaleState.ApplyScale(ZedGraph.Axis)">
- <summary>
- Copy the properties from this <see cref="T:ZedGraph.ScaleState"/> out to the specified <see cref="T:ZedGraph.Axis"/>.
- </summary>
- <param name="axis">The <see cref="T:ZedGraph.Axis"/> reference to which the properties should be
- copied</param>
- </member>
- <member name="M:ZedGraph.ScaleState.IsChanged(ZedGraph.Axis)">
- <summary>
- Determine if the state contained in this <see cref="T:ZedGraph.ScaleState"/> object is different from
- the state of the specified <see cref="T:ZedGraph.Axis"/>.
- </summary>
- <param name="axis">The <see cref="T:ZedGraph.Axis"/> object with which to compare states.</param>
- <returns>true if the states are different, false otherwise</returns>
- </member>
- <member name="T:ZedGraph.Scale">
- <summary>
- The Scale class is an abstract base class that encompasses the properties
- and methods associated with a scale of data.
- </summary>
- <remarks>This class is inherited by the
- <see cref="T:ZedGraph.LinearScale"/>, <see cref="T:ZedGraph.LogScale"/>, <see cref="T:ZedGraph.OrdinalScale"/>,
- <see cref="T:ZedGraph.TextScale"/>, <see cref="T:ZedGraph.DateScale"/>, <see cref="T:ZedGraph.ExponentScale"/>,
- <see cref="T:ZedGraph.DateAsOrdinalScale"/>, and <see cref="T:ZedGraph.LinearAsOrdinalScale"/>
- classes to define specific characteristics for those types.
- </remarks>
-
- <author> John Champion </author>
- <version> $Revision: 1.33 $ $Date: 2007-09-19 06:41:56 $ </version>
- </member>
- <member name="F:ZedGraph.Scale.schema">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="F:ZedGraph.Scale._min">
- <summary> Private fields for the <see cref="T:ZedGraph.Axis"/> scale definitions.
- Use the public properties <see cref="P:ZedGraph.Scale.Min"/>, <see cref="P:ZedGraph.Scale.Max"/>,
- <see cref="P:ZedGraph.Scale.MajorStep"/>, <see cref="P:ZedGraph.Scale.MinorStep"/>, and <see cref="P:ZedGraph.Scale.Exponent"/>
- for access to these values.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale._max">
- <summary> Private fields for the <see cref="T:ZedGraph.Axis"/> scale definitions.
- Use the public properties <see cref="P:ZedGraph.Scale.Min"/>, <see cref="P:ZedGraph.Scale.Max"/>,
- <see cref="P:ZedGraph.Scale.MajorStep"/>, <see cref="P:ZedGraph.Scale.MinorStep"/>, and <see cref="P:ZedGraph.Scale.Exponent"/>
- for access to these values.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale._majorStep">
- <summary> Private fields for the <see cref="T:ZedGraph.Axis"/> scale definitions.
- Use the public properties <see cref="P:ZedGraph.Scale.Min"/>, <see cref="P:ZedGraph.Scale.Max"/>,
- <see cref="P:ZedGraph.Scale.MajorStep"/>, <see cref="P:ZedGraph.Scale.MinorStep"/>, and <see cref="P:ZedGraph.Scale.Exponent"/>
- for access to these values.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale._minorStep">
- <summary> Private fields for the <see cref="T:ZedGraph.Axis"/> scale definitions.
- Use the public properties <see cref="P:ZedGraph.Scale.Min"/>, <see cref="P:ZedGraph.Scale.Max"/>,
- <see cref="P:ZedGraph.Scale.MajorStep"/>, <see cref="P:ZedGraph.Scale.MinorStep"/>, and <see cref="P:ZedGraph.Scale.Exponent"/>
- for access to these values.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale._exponent">
- <summary> Private fields for the <see cref="T:ZedGraph.Axis"/> scale definitions.
- Use the public properties <see cref="P:ZedGraph.Scale.Min"/>, <see cref="P:ZedGraph.Scale.Max"/>,
- <see cref="P:ZedGraph.Scale.MajorStep"/>, <see cref="P:ZedGraph.Scale.MinorStep"/>, and <see cref="P:ZedGraph.Scale.Exponent"/>
- for access to these values.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale._baseTic">
- <summary> Private fields for the <see cref="T:ZedGraph.Axis"/> scale definitions.
- Use the public properties <see cref="P:ZedGraph.Scale.Min"/>, <see cref="P:ZedGraph.Scale.Max"/>,
- <see cref="P:ZedGraph.Scale.MajorStep"/>, <see cref="P:ZedGraph.Scale.MinorStep"/>, and <see cref="P:ZedGraph.Scale.Exponent"/>
- for access to these values.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale._minAuto">
- <summary> Private fields for the <see cref="T:ZedGraph.Axis"/> automatic scaling modes.
- Use the public properties <see cref="P:ZedGraph.Scale.MinAuto"/>, <see cref="P:ZedGraph.Scale.MaxAuto"/>,
- <see cref="P:ZedGraph.Scale.MajorStepAuto"/>, <see cref="P:ZedGraph.Scale.MinorStepAuto"/>,
- <see cref="P:ZedGraph.Scale.MagAuto"/> and <see cref="P:ZedGraph.Scale.FormatAuto"/>
- for access to these values.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale._maxAuto">
- <summary> Private fields for the <see cref="T:ZedGraph.Axis"/> automatic scaling modes.
- Use the public properties <see cref="P:ZedGraph.Scale.MinAuto"/>, <see cref="P:ZedGraph.Scale.MaxAuto"/>,
- <see cref="P:ZedGraph.Scale.MajorStepAuto"/>, <see cref="P:ZedGraph.Scale.MinorStepAuto"/>,
- <see cref="P:ZedGraph.Scale.MagAuto"/> and <see cref="P:ZedGraph.Scale.FormatAuto"/>
- for access to these values.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale._majorStepAuto">
- <summary> Private fields for the <see cref="T:ZedGraph.Axis"/> automatic scaling modes.
- Use the public properties <see cref="P:ZedGraph.Scale.MinAuto"/>, <see cref="P:ZedGraph.Scale.MaxAuto"/>,
- <see cref="P:ZedGraph.Scale.MajorStepAuto"/>, <see cref="P:ZedGraph.Scale.MinorStepAuto"/>,
- <see cref="P:ZedGraph.Scale.MagAuto"/> and <see cref="P:ZedGraph.Scale.FormatAuto"/>
- for access to these values.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale._minorStepAuto">
- <summary> Private fields for the <see cref="T:ZedGraph.Axis"/> automatic scaling modes.
- Use the public properties <see cref="P:ZedGraph.Scale.MinAuto"/>, <see cref="P:ZedGraph.Scale.MaxAuto"/>,
- <see cref="P:ZedGraph.Scale.MajorStepAuto"/>, <see cref="P:ZedGraph.Scale.MinorStepAuto"/>,
- <see cref="P:ZedGraph.Scale.MagAuto"/> and <see cref="P:ZedGraph.Scale.FormatAuto"/>
- for access to these values.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale._magAuto">
- <summary> Private fields for the <see cref="T:ZedGraph.Axis"/> automatic scaling modes.
- Use the public properties <see cref="P:ZedGraph.Scale.MinAuto"/>, <see cref="P:ZedGraph.Scale.MaxAuto"/>,
- <see cref="P:ZedGraph.Scale.MajorStepAuto"/>, <see cref="P:ZedGraph.Scale.MinorStepAuto"/>,
- <see cref="P:ZedGraph.Scale.MagAuto"/> and <see cref="P:ZedGraph.Scale.FormatAuto"/>
- for access to these values.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale._formatAuto">
- <summary> Private fields for the <see cref="T:ZedGraph.Axis"/> automatic scaling modes.
- Use the public properties <see cref="P:ZedGraph.Scale.MinAuto"/>, <see cref="P:ZedGraph.Scale.MaxAuto"/>,
- <see cref="P:ZedGraph.Scale.MajorStepAuto"/>, <see cref="P:ZedGraph.Scale.MinorStepAuto"/>,
- <see cref="P:ZedGraph.Scale.MagAuto"/> and <see cref="P:ZedGraph.Scale.FormatAuto"/>
- for access to these values.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale._minGrace">
- <summary> Private fields for the <see cref="T:ZedGraph.Axis"/> "grace" settings.
- These values determine how much extra space is left before the first data value
- and after the last data value.
- Use the public properties <see cref="P:ZedGraph.Scale.MinGrace"/> and <see cref="P:ZedGraph.Scale.MaxGrace"/>
- for access to these values.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale._maxGrace">
- <summary> Private fields for the <see cref="T:ZedGraph.Axis"/> "grace" settings.
- These values determine how much extra space is left before the first data value
- and after the last data value.
- Use the public properties <see cref="P:ZedGraph.Scale.MinGrace"/> and <see cref="P:ZedGraph.Scale.MaxGrace"/>
- for access to these values.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale._mag">
- <summary> Private field for the <see cref="T:ZedGraph.Axis"/> scale value display.
- Use the public property <see cref="P:ZedGraph.Scale.Mag"/> for access to this value.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale._isReverse">
- <summary> Private fields for the <see cref="T:ZedGraph.Scale"/> attributes.
- Use the public properties <see cref="P:ZedGraph.Scale.IsReverse"/> and <see cref="P:ZedGraph.Scale.IsUseTenPower"/>
- for access to these values.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale._isPreventLabelOverlap">
- <summary> Private fields for the <see cref="T:ZedGraph.Scale"/> attributes.
- Use the public properties <see cref="P:ZedGraph.Scale.IsReverse"/> and <see cref="P:ZedGraph.Scale.IsUseTenPower"/>
- for access to these values.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale._isUseTenPower">
- <summary> Private fields for the <see cref="T:ZedGraph.Scale"/> attributes.
- Use the public properties <see cref="P:ZedGraph.Scale.IsReverse"/> and <see cref="P:ZedGraph.Scale.IsUseTenPower"/>
- for access to these values.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale._isLabelsInside">
- <summary> Private fields for the <see cref="T:ZedGraph.Scale"/> attributes.
- Use the public properties <see cref="P:ZedGraph.Scale.IsReverse"/> and <see cref="P:ZedGraph.Scale.IsUseTenPower"/>
- for access to these values.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale._isSkipFirstLabel">
- <summary> Private fields for the <see cref="T:ZedGraph.Scale"/> attributes.
- Use the public properties <see cref="P:ZedGraph.Scale.IsReverse"/> and <see cref="P:ZedGraph.Scale.IsUseTenPower"/>
- for access to these values.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale._isSkipLastLabel">
- <summary> Private fields for the <see cref="T:ZedGraph.Scale"/> attributes.
- Use the public properties <see cref="P:ZedGraph.Scale.IsReverse"/> and <see cref="P:ZedGraph.Scale.IsUseTenPower"/>
- for access to these values.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale._isSkipCrossLabel">
- <summary> Private fields for the <see cref="T:ZedGraph.Scale"/> attributes.
- Use the public properties <see cref="P:ZedGraph.Scale.IsReverse"/> and <see cref="P:ZedGraph.Scale.IsUseTenPower"/>
- for access to these values.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale._isVisible">
- <summary> Private fields for the <see cref="T:ZedGraph.Scale"/> attributes.
- Use the public properties <see cref="P:ZedGraph.Scale.IsReverse"/> and <see cref="P:ZedGraph.Scale.IsUseTenPower"/>
- for access to these values.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale._textLabels">
- <summary> Private <see cref="T:System.Collections.ArrayList"/> field for the <see cref="T:ZedGraph.Axis"/> array of text labels.
- This property is only used if <see cref="P:ZedGraph.Scale.Type"/> is set to
- <see cref="F:ZedGraph.AxisType.Text"/> </summary>
- </member>
- <member name="F:ZedGraph.Scale._format">
- <summary> Private field for the format of the <see cref="T:ZedGraph.Axis"/> tic labels.
- Use the public property <see cref="P:ZedGraph.Scale.Format"/> for access to this value. </summary>
- <seealso cref="P:ZedGraph.Scale.FormatAuto"/>
- </member>
- <member name="F:ZedGraph.Scale._majorUnit">
- <summary>
- Private fields for Unit types to be used for the major and minor tics.
- See <see cref="P:ZedGraph.Scale.MajorUnit"/> and <see cref="P:ZedGraph.Scale.MinorUnit"/> for the corresponding
- public properties.
- These types only apply for date-time scales (<see cref="P:ZedGraph.Scale.IsDate"/>).
- </summary>
- <value>The value of these types is of enumeration type <see cref="T:ZedGraph.DateUnit"/>
- </value>
- </member>
- <member name="F:ZedGraph.Scale._minorUnit">
- <summary>
- Private fields for Unit types to be used for the major and minor tics.
- See <see cref="P:ZedGraph.Scale.MajorUnit"/> and <see cref="P:ZedGraph.Scale.MinorUnit"/> for the corresponding
- public properties.
- These types only apply for date-time scales (<see cref="P:ZedGraph.Scale.IsDate"/>).
- </summary>
- <value>The value of these types is of enumeration type <see cref="T:ZedGraph.DateUnit"/>
- </value>
- </member>
- <member name="F:ZedGraph.Scale._align">
- <summary> Private field for the alignment of the <see cref="T:ZedGraph.Axis"/> tic labels.
- This fields controls whether the inside, center, or outside edges of the text labels are aligned.
- Use the public property <see cref="P:ZedGraph.Scale.Align"/>
- for access to this value. </summary>
- <seealso cref="P:ZedGraph.Scale.FormatAuto"/>
- </member>
- <member name="F:ZedGraph.Scale._alignH">
- <summary> Private field for the alignment of the <see cref="T:ZedGraph.Axis"/> tic labels.
- This fields controls whether the left, center, or right edges of the text labels are aligned.
- Use the public property <see cref="P:ZedGraph.Scale.AlignH"/>
- for access to this value. </summary>
- <seealso cref="P:ZedGraph.Scale.FormatAuto"/>
- </member>
- <member name="F:ZedGraph.Scale._fontSpec">
- <summary> Private fields for the <see cref="T:ZedGraph.Axis"/> font specificatios.
- Use the public properties <see cref="P:ZedGraph.Scale.FontSpec"/> and
- <see cref="P:ZedGraph.Scale.FontSpec"/> for access to these values. </summary>
- </member>
- <member name="F:ZedGraph.Scale._labelGap">
- <summary>
- Internal field that stores the amount of space between the scale labels and the
- major tics. Use the public property <see cref="P:ZedGraph.Scale.LabelGap"/> to access this
- value.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale._rangeMin">
- <summary>
- Data range temporary values, used by GetRange().
- </summary>
- </member>
- <member name="F:ZedGraph.Scale._rangeMax">
- <summary>
- Data range temporary values, used by GetRange().
- </summary>
- </member>
- <member name="F:ZedGraph.Scale._lBound">
- <summary>
- Data range temporary values, used by GetRange().
- </summary>
- </member>
- <member name="F:ZedGraph.Scale._uBound">
- <summary>
- Data range temporary values, used by GetRange().
- </summary>
- </member>
- <member name="F:ZedGraph.Scale._minPix">
- <summary>
- Pixel positions at the minimum and maximum value for this scale.
- These are temporary values used/valid only during the Draw process.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale._maxPix">
- <summary>
- Pixel positions at the minimum and maximum value for this scale.
- These are temporary values used/valid only during the Draw process.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale._minLinTemp">
- <summary>
- Scale values for calculating transforms. These are temporary values
- used ONLY during the Draw process.
- </summary>
- <remarks>
- These values are just <see cref="P:ZedGraph.Scale.Min"/> and <see cref="P:ZedGraph.Scale.Max"/>
- for normal linear scales, but for log or exponent scales they will be a
- linear representation. For <see cref="T:ZedGraph.LogScale"/>, it is the
- <see cref="M:System.Math.Log(System.Double)"/> of the value, and for <see cref="T:ZedGraph.ExponentScale"/>,
- it is the <see cref="M:System.Math.Exp(System.Double)"/>
- of the value.
- </remarks>
- </member>
- <member name="F:ZedGraph.Scale._maxLinTemp">
- <summary>
- Scale values for calculating transforms. These are temporary values
- used ONLY during the Draw process.
- </summary>
- <remarks>
- These values are just <see cref="P:ZedGraph.Scale.Min"/> and <see cref="P:ZedGraph.Scale.Max"/>
- for normal linear scales, but for log or exponent scales they will be a
- linear representation. For <see cref="T:ZedGraph.LogScale"/>, it is the
- <see cref="M:System.Math.Log(System.Double)"/> of the value, and for <see cref="T:ZedGraph.ExponentScale"/>,
- it is the <see cref="M:System.Math.Exp(System.Double)"/>
- of the value.
- </remarks>
- </member>
- <member name="F:ZedGraph.Scale._ownerAxis">
- <summary>
- private field that stores the owner Axis that contains this Scale instance.
- </summary>
- </member>
- <member name="M:ZedGraph.Scale.#ctor(ZedGraph.Axis)">
- <summary>
- Basic constructor -- requires that the <see cref="T:ZedGraph.Scale"/> object be intialized with
- a pre-existing owner <see cref="T:ZedGraph.Axis"/>.
- </summary>
- <param name="ownerAxis">The <see cref="T:ZedGraph.Axis"/> object that is the owner of this
- <see cref="T:ZedGraph.Scale"/> instance.</param>
- </member>
- <member name="M:ZedGraph.Scale.#ctor(ZedGraph.Scale,ZedGraph.Axis)">
- <summary>
- Copy Constructor. Create a new <see cref="T:ZedGraph.Scale"/> object based on the specified
- existing one.
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.Scale"/> object to be copied.</param>
- <param name="owner">The <see cref="T:ZedGraph.Axis"/> object that will own the
- new instance of <see cref="T:ZedGraph.Scale"/></param>
- </member>
- <member name="M:ZedGraph.Scale.Clone(ZedGraph.Axis)">
- <summary>
- Create a new clone of the current item, with a new owner assignment
- </summary>
- <param name="owner">The new <see cref="T:ZedGraph.Axis"/> instance that will be
- the owner of the new Scale</param>
- <returns>A new <see cref="T:ZedGraph.Scale"/> clone.</returns>
- </member>
- <member name="M:ZedGraph.Scale.MakeNewScale(ZedGraph.Scale,ZedGraph.AxisType)">
- <summary>
- A construction method that creates a new <see cref="T:ZedGraph.Scale"/> object using the
- properties of an existing <see cref="T:ZedGraph.Scale"/> object, but specifying a new
- <see cref="T:ZedGraph.AxisType"/>.
- </summary>
- <remarks>
- This constructor is used to change the type of an existing <see cref="T:ZedGraph.Axis"/>.
- By specifying the old <see cref="T:ZedGraph.Scale"/> object, you are giving a set of properties
- (which encompasses all fields associated with the scale, since the derived types
- have no fields) to be used in creating a new <see cref="T:ZedGraph.Scale"/> object, only this
- time having the newly specified object type.</remarks>
- <param name="oldScale">The existing <see cref="T:ZedGraph.Scale"/> object from which to
- copy the field data.</param>
- <param name="type">An <see cref="T:ZedGraph.AxisType"/> representing the type of derived type
- of new <see cref="T:ZedGraph.Scale"/> object to create.</param>
- <returns>The new <see cref="T:ZedGraph.Scale"/> object.</returns>
- </member>
- <member name="M:ZedGraph.Scale.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.Scale.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to
- serialize the target object
- </summary>
- <remarks>
- You MUST set the _ownerAxis property after deserializing a BarSettings object.
- </remarks>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.Scale.SetupScaleData(ZedGraph.GraphPane,ZedGraph.Axis)">
- <summary>
- Setup some temporary transform values in preparation for rendering the
- <see cref="T:ZedGraph.Axis"/>.
- </summary>
- <remarks>
- This method is typically called by the parent <see cref="T:ZedGraph.GraphPane"/>
- object as part of the <see cref="M:ZedGraph.GraphPane.Draw(System.Drawing.Graphics)"/> method. It is also
- called by <see cref="M:ZedGraph.GraphPane.GeneralTransform(System.Double,System.Double,ZedGraph.CoordType)"/> and
- <see cref="M:ZedGraph.GraphPane.ReverseTransform(System.Drawing.PointF,System.Double@,System.Double@)"/>
- methods to setup for coordinate transformations.
- </remarks>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="axis">
- The parent <see cref="T:ZedGraph.Axis"/> for this <see cref="T:ZedGraph.Scale"/>
- </param>
- </member>
- <member name="M:ZedGraph.Scale.Linearize(System.Double)">
- <summary>
- Convert a value to its linear equivalent for this type of scale.
- </summary>
- <remarks>
- The default behavior is to just return the value unchanged. However,
- for <see cref="F:ZedGraph.AxisType.Log"/> and <see cref="F:ZedGraph.AxisType.Exponent"/>,
- it returns the log or power equivalent.
- </remarks>
- <param name="val">The value to be converted</param>
- </member>
- <member name="M:ZedGraph.Scale.DeLinearize(System.Double)">
- <summary>
- Convert a value from its linear equivalent to its actual scale value
- for this type of scale.
- </summary>
- <remarks>
- The default behavior is to just return the value unchanged. However,
- for <see cref="F:ZedGraph.AxisType.Log"/> and <see cref="F:ZedGraph.AxisType.Exponent"/>,
- it returns the anti-log or inverse-power equivalent.
- </remarks>
- <param name="val">The value to be converted</param>
- </member>
- <member name="M:ZedGraph.Scale.MakeLabel(ZedGraph.GraphPane,System.Int32,System.Double)">
- <summary>
- Make a value label for the axis at the specified ordinal position.
- </summary>
- <remarks>
- This method properly accounts for <see cref="P:ZedGraph.Scale.IsLog"/>, <see cref="P:ZedGraph.Scale.IsText"/>,
- and other axis format settings.
- </remarks>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="index">
- The zero-based, ordinal index of the label to be generated. For example, a value of 2 would
- cause the third value label on the axis to be generated.
- </param>
- <param name="dVal">
- The numeric value associated with the label. This value is ignored for log (<see cref="P:ZedGraph.Scale.IsLog"/>)
- and text (<see cref="P:ZedGraph.Scale.IsText"/>) type axes.
- </param>
- <returns>The resulting value label as a <see cref="T:System.String"/></returns>
- </member>
- <member name="M:ZedGraph.Scale.GetScaleMaxSpace(System.Drawing.Graphics,ZedGraph.GraphPane,System.Single,System.Boolean)">
- <summary>
- Get the maximum width of the scale value text that is required to label this
- <see cref="T:ZedGraph.Axis"/>.
- The results of this method are used to determine how much space is required for
- the axis labels.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <param name="applyAngle">
- true to get the bounding box of the text using the <see cref="P:ZedGraph.FontSpec.Angle"/>,
- false to just get the bounding box without rotation
- </param>
- <returns>the maximum width of the text in pixel units</returns>
- </member>
- <member name="M:ZedGraph.Scale.CalcMajorTicValue(System.Double,System.Double)">
- <summary>
- Determine the value for any major tic.
- </summary>
- <remarks>
- This method properly accounts for <see cref="P:ZedGraph.Scale.IsLog"/>, <see cref="P:ZedGraph.Scale.IsText"/>,
- and other axis format settings.
- </remarks>
- <param name="baseVal">
- The value of the first major tic (floating point double)
- </param>
- <param name="tic">
- The major tic number (0 = first major tic). For log scales, this is the actual power of 10.
- </param>
- <returns>
- The specified major tic value (floating point double).
- </returns>
- </member>
- <member name="M:ZedGraph.Scale.CalcMinorTicValue(System.Double,System.Int32)">
- <summary>
- Determine the value for any minor tic.
- </summary>
- <remarks>
- This method properly accounts for <see cref="P:ZedGraph.Scale.IsLog"/>, <see cref="P:ZedGraph.Scale.IsText"/>,
- and other axis format settings.
- </remarks>
- <param name="baseVal">
- The value of the first major tic (floating point double). This tic value is the base
- reference for all tics (including minor ones).
- </param>
- <param name="iTic">
- The major tic number (0 = first major tic). For log scales, this is the actual power of 10.
- </param>
- <returns>
- The specified minor tic value (floating point double).
- </returns>
- </member>
- <member name="M:ZedGraph.Scale.CalcMinorStart(System.Double)">
- <summary>
- Internal routine to determine the ordinals of the first minor tic mark
- </summary>
- <param name="baseVal">
- The value of the first major tic for the axis.
- </param>
- <returns>
- The ordinal position of the first minor tic, relative to the first major tic.
- This value can be negative (e.g., -3 means the first minor tic is 3 minor step
- increments before the first major tic.
- </returns>
- </member>
- <member name="M:ZedGraph.Scale.CalcBaseTic">
- <summary>
- Determine the value for the first major tic.
- </summary>
- <remarks>
- This is done by finding the first possible value that is an integral multiple of
- the step size, taking into account the date/time units if appropriate.
- This method properly accounts for <see cref="P:ZedGraph.Scale.IsLog"/>, <see cref="P:ZedGraph.Scale.IsText"/>,
- and other axis format settings.
- </remarks>
- <returns>
- First major tic value (floating point double).
- </returns>
- </member>
- <member name="M:ZedGraph.Scale.DrawLabels(System.Drawing.Graphics,ZedGraph.GraphPane,System.Double,System.Int32,System.Single,System.Single,System.Single)">
- <summary>
- Draw the value labels, tic marks, and grid lines as
- required for this <see cref="T:ZedGraph.Axis"/>.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="baseVal">
- The first major tic value for the axis
- </param>
- <param name="nTics">
- The total number of major tics for the axis
- </param>
- <param name="topPix">
- The pixel location of the far side of the ChartRect from this axis.
- This value is the ChartRect.Height for the XAxis, or the ChartRect.Width
- for the YAxis and Y2Axis.
- </param>
- <param name="shift">The number of pixels to shift this axis, based on the
- value of <see cref="P:ZedGraph.Axis.Cross"/>. A positive value is into the ChartRect relative to
- the default axis position.</param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.Scale.Draw(System.Drawing.Graphics,ZedGraph.GraphPane,System.Single,System.Single)">
- <summary>
- Draw the scale, including the tic marks, value labels, and grid lines as
- required for this <see cref="T:ZedGraph.Axis"/>.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <param name="shiftPos">
- The number of pixels to shift to account for non-primary axis position (e.g.,
- the second, third, fourth, etc. <see cref="T:ZedGraph.YAxis"/> or <see cref="T:ZedGraph.Y2Axis"/>.
- </param>
- </member>
- <member name="M:ZedGraph.Scale.GetClusterWidth(ZedGraph.GraphPane)">
- <summary>
- Determine the width, in pixel units, of each bar cluster including
- the cluster gaps and bar gaps.
- </summary>
- <remarks>
- This method uses the <see cref="P:ZedGraph.BarSettings.ClusterScaleWidth"/> for
- non-ordinal axes, or a cluster width of 1.0 for ordinal axes.
- </remarks>
- <param name="pane">A reference to the <see cref="T:ZedGraph.GraphPane"/> object
- associated with this <see cref="T:ZedGraph.Axis"/></param>
- <returns>The width of each bar cluster, in pixel units</returns>
- </member>
- <member name="M:ZedGraph.Scale.GetClusterWidth(System.Double)">
- <summary>
- Calculates the cluster width, in pixels, by transforming the specified
- clusterScaleWidth.
- </summary>
- <param name="clusterScaleWidth">The width in user scale units of each
- bar cluster</param>
- <returns>The equivalent pixel size of the bar cluster</returns>
- </member>
- <member name="M:ZedGraph.Scale.PickScale(ZedGraph.GraphPane,System.Drawing.Graphics,System.Single)">
- <summary>
- Select a reasonable scale given a range of data values.
- </summary>
- <remarks>
- The scale range is chosen
- based on increments of 1, 2, or 5 (because they are even divisors of 10). This
- routine honors the <see cref="P:ZedGraph.Scale.MinAuto"/>, <see cref="P:ZedGraph.Scale.MaxAuto"/>,
- and <see cref="P:ZedGraph.Scale.MajorStepAuto"/> autorange settings as well as the <see cref="P:ZedGraph.Scale.IsLog"/>
- setting. In the event that any of the autorange settings are false, the
- corresponding <see cref="P:ZedGraph.Scale.Min"/>, <see cref="P:ZedGraph.Scale.Max"/>, or <see cref="P:ZedGraph.Scale.MajorStep"/>
- setting is explicitly honored, and the remaining autorange settings (if any) will
- be calculated to accomodate the non-autoranged values. The basic defaults for
- scale selection are defined using <see cref="F:ZedGraph.Scale.Default.ZeroLever"/>,
- <see cref="F:ZedGraph.Scale.Default.TargetXSteps"/>, and <see cref="F:ZedGraph.Scale.Default.TargetYSteps"/>
- from the <see cref="T:ZedGraph.Scale.Default"/> default class.
- <para>On Exit:</para>
- <para><see cref="P:ZedGraph.Scale.Min"/> is set to scale minimum (if <see cref="P:ZedGraph.Scale.MinAuto"/> = true)</para>
- <para><see cref="P:ZedGraph.Scale.Max"/> is set to scale maximum (if <see cref="P:ZedGraph.Scale.MaxAuto"/> = true)</para>
- <para><see cref="P:ZedGraph.Scale.MajorStep"/> is set to scale step size (if <see cref="P:ZedGraph.Scale.MajorStepAuto"/> = true)</para>
- <para><see cref="P:ZedGraph.Scale.MinorStep"/> is set to scale minor step size (if <see cref="P:ZedGraph.Scale.MinorStepAuto"/> = true)</para>
- <para><see cref="P:ZedGraph.Scale.Mag"/> is set to a magnitude multiplier according to the data</para>
- <para><see cref="P:ZedGraph.Scale.Format"/> is set to the display format for the values (this controls the
- number of decimal places, whether there are thousands separators, currency types, etc.)</para>
- </remarks>
- <param name="pane">A reference to the <see cref="T:ZedGraph.GraphPane"/> object
- associated with this <see cref="T:ZedGraph.Axis"/></param>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.Scale.CalcMaxLabels(System.Drawing.Graphics,ZedGraph.GraphPane,System.Single)">
- <summary>
- Calculate the maximum number of labels that will fit on this axis.
- </summary>
- <remarks>
- This method works for
- both X and Y direction axes, and it works for angled text (assuming that a bounding box
- is an appropriate measure). Technically, labels at 45 degree angles could fit better than
- the return value of this method since the bounding boxes can overlap without the labels actually
- overlapping.
- </remarks>
- <param name="pane">A reference to the <see cref="T:ZedGraph.GraphPane"/> object
- associated with this <see cref="T:ZedGraph.Axis"/></param>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.Scale.CalcStepSize(System.Double,System.Double)">
- <summary>
- Calculate a step size based on a data range.
- </summary>
- <remarks>
- This utility method
- will try to honor the <see cref="F:ZedGraph.Scale.Default.TargetXSteps"/> and
- <see cref="F:ZedGraph.Scale.Default.TargetYSteps"/> number of
- steps while using a rational increment (1, 2, or 5 -- which are
- even divisors of 10). This method is used by <see cref="M:ZedGraph.Scale.PickScale(ZedGraph.GraphPane,System.Drawing.Graphics,System.Single)"/>.
- </remarks>
- <param name="range">The range of data in user scale units. This can
- be a full range of the data for the major step size, or just the
- value of the major step size to calculate the minor step size</param>
- <param name="targetSteps">The desired "typical" number of steps
- to divide the range into</param>
- <returns>The calculated step size for the specified data range.</returns>
- </member>
- <member name="M:ZedGraph.Scale.CalcBoundedStepSize(System.Double,System.Double)">
- <summary>
- Calculate a step size based on a data range, limited to a maximum number of steps.
- </summary>
- <remarks>
- This utility method
- will calculate a step size, of no more than maxSteps,
- using a rational increment (1, 2, or 5 -- which are
- even divisors of 10). This method is used by <see cref="M:ZedGraph.Scale.PickScale(ZedGraph.GraphPane,System.Drawing.Graphics,System.Single)"/>.
- </remarks>
- <param name="range">The range of data in user scale units. This can
- be a full range of the data for the major step size, or just the
- value of the major step size to calculate the minor step size</param>
- <param name="maxSteps">The maximum allowable number of steps
- to divide the range into</param>
- <returns>The calculated step size for the specified data range.</returns>
- </member>
- <member name="M:ZedGraph.Scale.CalcNumTics">
- <summary>
- Internal routine to determine the ordinals of the first and last major axis label.
- </summary>
- <returns>
- This is the total number of major tics for this axis.
- </returns>
- </member>
- <member name="M:ZedGraph.Scale.MyMod(System.Double,System.Double)">
- <summary>
- Calculate the modulus (remainder) in a safe manner so that divide
- by zero errors are avoided
- </summary>
- <param name="x">The divisor</param>
- <param name="y">The dividend</param>
- <returns>the value of the modulus, or zero for the divide-by-zero
- case</returns>
- </member>
- <member name="M:ZedGraph.Scale.SetRange(ZedGraph.GraphPane,ZedGraph.Axis)">
- <summary>
- Define suitable default ranges for an axis in the event that
- no data were available
- </summary>
- <param name="pane">The <see cref="T:ZedGraph.GraphPane"/> of interest</param>
- <param name="axis">The <see cref="T:ZedGraph.Axis"/> for which to set the range</param>
- </member>
- <member name="M:ZedGraph.Scale.Transform(System.Double)">
- <summary>
- Transform the coordinate value from user coordinates (scale value)
- to graphics device coordinates (pixels).
- </summary>
- <remarks>This method takes into
- account the scale range (<see cref="P:ZedGraph.Scale.Min"/> and <see cref="P:ZedGraph.Scale.Max"/>),
- logarithmic state (<see cref="P:ZedGraph.Scale.IsLog"/>), scale reverse state
- (<see cref="P:ZedGraph.Scale.IsReverse"/>) and axis type (<see cref="T:ZedGraph.XAxis"/>,
- <see cref="T:ZedGraph.YAxis"/>, or <see cref="T:ZedGraph.Y2Axis"/>).
- Note that the <see cref="P:ZedGraph.Chart.Rect"/> must be valid, and
- <see cref="M:ZedGraph.Scale.SetupScaleData(ZedGraph.GraphPane,ZedGraph.Axis)"/> must be called for the
- current configuration before using this method (this is called everytime
- the graph is drawn (i.e., <see cref="M:ZedGraph.GraphPane.Draw(System.Drawing.Graphics)"/> is called).
- </remarks>
- <param name="x">The coordinate value, in user scale units, to
- be transformed</param>
- <returns>the coordinate value transformed to screen coordinates
- for use in calling the <see cref="T:System.Drawing.Graphics"/> draw routines</returns>
- </member>
- <member name="M:ZedGraph.Scale.Transform(System.Boolean,System.Int32,System.Double)">
- <summary>
- Transform the coordinate value from user coordinates (scale value)
- to graphics device coordinates (pixels).
- </summary>
- <remarks>
- This method takes into
- account the scale range (<see cref="P:ZedGraph.Scale.Min"/> and <see cref="P:ZedGraph.Scale.Max"/>),
- logarithmic state (<see cref="P:ZedGraph.Scale.IsLog"/>), scale reverse state
- (<see cref="P:ZedGraph.Scale.IsReverse"/>) and axis type (<see cref="T:ZedGraph.XAxis"/>,
- <see cref="T:ZedGraph.YAxis"/>, or <see cref="T:ZedGraph.Y2Axis"/>).
- Note that the <see cref="P:ZedGraph.Chart.Rect"/> must be valid, and
- <see cref="M:ZedGraph.Scale.SetupScaleData(ZedGraph.GraphPane,ZedGraph.Axis)"/> must be called for the
- current configuration before using this method (this is called everytime
- the graph is drawn (i.e., <see cref="M:ZedGraph.GraphPane.Draw(System.Drawing.Graphics)"/> is called).
- </remarks>
- <param name="isOverrideOrdinal">true to force the axis to honor the data
- value, rather than replacing it with the ordinal value</param>
- <param name="i">The ordinal value of this point, just in case
- this is an <see cref="F:ZedGraph.AxisType.Ordinal"/> axis</param>
- <param name="x">The coordinate value, in user scale units, to
- be transformed</param>
- <returns>the coordinate value transformed to screen coordinates
- for use in calling the <see cref="T:System.Drawing.Graphics"/> draw routines</returns>
- </member>
- <member name="M:ZedGraph.Scale.ReverseTransform(System.Single)">
- <summary>
- Reverse transform the user coordinates (scale value)
- given a graphics device coordinate (pixels).
- </summary>
- <remarks>
- This method takes into
- account the scale range (<see cref="P:ZedGraph.Scale.Min"/> and <see cref="P:ZedGraph.Scale.Max"/>),
- logarithmic state (<see cref="P:ZedGraph.Scale.IsLog"/>), scale reverse state
- (<see cref="P:ZedGraph.Scale.IsReverse"/>) and axis type (<see cref="T:ZedGraph.XAxis"/>,
- <see cref="T:ZedGraph.YAxis"/>, or <see cref="T:ZedGraph.Y2Axis"/>).
- Note that the <see cref="P:ZedGraph.Chart.Rect"/> must be valid, and
- <see cref="M:ZedGraph.Scale.SetupScaleData(ZedGraph.GraphPane,ZedGraph.Axis)"/> must be called for the
- current configuration before using this method (this is called everytime
- the graph is drawn (i.e., <see cref="M:ZedGraph.GraphPane.Draw(System.Drawing.Graphics)"/> is called).
- </remarks>
- <param name="pixVal">The screen pixel value, in graphics device coordinates to
- be transformed</param>
- <returns>The user scale value that corresponds to the screen pixel location</returns>
- </member>
- <member name="M:ZedGraph.Scale.LocalTransform(System.Double)">
- <summary>
- Transform the coordinate value from user coordinates (scale value)
- to graphics device coordinates (pixels).
- </summary>
- <remarks>Assumes that the origin
- has been set to the "left" of this axis, facing from the label side.
- Note that the left side corresponds to the scale minimum for the X and
- Y2 axes, but it is the scale maximum for the Y axis.
- This method takes into
- account the scale range (<see cref="P:ZedGraph.Scale.Min"/> and <see cref="P:ZedGraph.Scale.Max"/>),
- logarithmic state (<see cref="P:ZedGraph.Scale.IsLog"/>), scale reverse state
- (<see cref="P:ZedGraph.Scale.IsReverse"/>) and axis type (<see cref="T:ZedGraph.XAxis"/>,
- <see cref="T:ZedGraph.YAxis"/>, or <see cref="T:ZedGraph.Y2Axis"/>). Note that
- the <see cref="P:ZedGraph.Chart.Rect"/> must be valid, and
- <see cref="M:ZedGraph.Scale.SetupScaleData(ZedGraph.GraphPane,ZedGraph.Axis)"/> must be called for the
- current configuration before using this method.
- </remarks>
- <param name="x">The coordinate value, in linearized user scale units, to
- be transformed</param>
- <returns>the coordinate value transformed to screen coordinates
- for use in calling the <see cref="M:ZedGraph.Scale.Draw(System.Drawing.Graphics,ZedGraph.GraphPane,System.Single,System.Single)"/> method</returns>
- </member>
- <member name="M:ZedGraph.Scale.SafeLog(System.Double)">
- <summary>
- Calculate a base 10 logarithm in a safe manner to avoid math exceptions
- </summary>
- <param name="x">The value for which the logarithm is to be calculated</param>
- <returns>The value of the logarithm, or 0 if the <paramref name="x"/>
- argument was negative or zero</returns>
- </member>
- <member name="M:ZedGraph.Scale.SafeExp(System.Double,System.Double)">
- <summary>
- Calculate an exponential in a safe manner to avoid math exceptions
- </summary>
- <param name="x">The value for which the exponential is to be calculated</param>
- <param name="exponent">The exponent value to use for calculating the exponential.</param>
- </member>
- <member name="P:ZedGraph.Scale._minLinearized">
- <summary>
- Gets or sets the linearized version of the <see cref="P:ZedGraph.Scale.Min"/> scale range.
- </summary>
- <remarks>
- This value is valid at any time, whereas <see cref="F:ZedGraph.Scale._minLinTemp"/> is an optimization
- pre-set that is only valid during draw operations.
- </remarks>
- </member>
- <member name="P:ZedGraph.Scale._maxLinearized">
- <summary>
- Gets or sets the linearized version of the <see cref="P:ZedGraph.Scale.Max"/> scale range.
- </summary>
- <remarks>
- This value is valid at any time, whereas <see cref="F:ZedGraph.Scale._maxLinTemp"/> is an optimization
- pre-set that is only valid during draw operations.
- </remarks>
- </member>
- <member name="P:ZedGraph.Scale.Type">
- <summary>
- Get an <see cref="T:ZedGraph.AxisType"/> enumeration that indicates the type of this scale.
- </summary>
- </member>
- <member name="P:ZedGraph.Scale.IsLog">
- <summary>
- True if this scale is <see cref="F:ZedGraph.AxisType.Log"/>, false otherwise.
- </summary>
- </member>
- <member name="P:ZedGraph.Scale.IsExponent">
- <summary>
- True if this scale is <see cref="F:ZedGraph.AxisType.Exponent"/>, false otherwise.
- </summary>
- </member>
- <member name="P:ZedGraph.Scale.IsDate">
- <summary>
- True if this scale is <see cref="F:ZedGraph.AxisType.Date"/>, false otherwise.
- </summary>
- </member>
- <member name="P:ZedGraph.Scale.IsText">
- <summary>
- True if this scale is <see cref="F:ZedGraph.AxisType.Text"/>, false otherwise.
- </summary>
- </member>
- <member name="P:ZedGraph.Scale.IsOrdinal">
- <summary>
- True if this scale is <see cref="F:ZedGraph.AxisType.Ordinal"/>, false otherwise.
- </summary>
- <remarks>
- Note that this is only true for an actual <see cref="T:ZedGraph.OrdinalScale"/> class.
- This property will be false for other ordinal types such as
- <see cref="F:ZedGraph.AxisType.Text"/>, <see cref="F:ZedGraph.AxisType.LinearAsOrdinal"/>,
- or <see cref="F:ZedGraph.AxisType.DateAsOrdinal"/>. Use the <see cref="P:ZedGraph.Scale.IsAnyOrdinal"/>
- as a "catchall" for all ordinal type axes.
- </remarks>
- </member>
- <member name="P:ZedGraph.Scale.IsAnyOrdinal">
- <summary>
- Gets a value that indicates if this <see cref="T:ZedGraph.Scale"/> is of any of the
- ordinal types in the <see cref="T:ZedGraph.AxisType"/> enumeration.
- </summary>
- <seealso cref="P:ZedGraph.Scale.Type"/>
- </member>
- <member name="P:ZedGraph.Scale.Min">
- <summary>
- Gets or sets the minimum scale value for this <see cref="T:ZedGraph.Scale"/>.
- </summary>
- <remarks>This value can be set
- automatically based on the state of <see cref="P:ZedGraph.Scale.MinAuto"/>. If
- this value is set manually, then <see cref="P:ZedGraph.Scale.MinAuto"/> will
- also be set to false.
- </remarks>
- <value> The value is defined in user scale units for <see cref="F:ZedGraph.AxisType.Log"/>
- and <see cref="F:ZedGraph.AxisType.Linear"/> axes. For <see cref="F:ZedGraph.AxisType.Text"/>
- and <see cref="F:ZedGraph.AxisType.Ordinal"/> axes,
- this value is an ordinal starting with 1.0. For <see cref="F:ZedGraph.AxisType.Date"/>
- axes, this value is in XL Date format (see <see cref="T:ZedGraph.XDate"/>, which is the
- number of days since the reference date of January 1, 1900.</value>
- <seealso cref="P:ZedGraph.Scale.Max"/>
- <seealso cref="P:ZedGraph.Scale.MajorStep"/>
- <seealso cref="P:ZedGraph.Scale.MinorStep"/>
- <seealso cref="P:ZedGraph.Scale.MinAuto"/>
- </member>
- <member name="P:ZedGraph.Scale.Max">
- <summary>
- Gets or sets the maximum scale value for this <see cref="T:ZedGraph.Scale"/>.
- </summary>
- <remarks>
- This value can be set
- automatically based on the state of <see cref="P:ZedGraph.Scale.MaxAuto"/>. If
- this value is set manually, then <see cref="P:ZedGraph.Scale.MaxAuto"/> will
- also be set to false.
- </remarks>
- <value> The value is defined in user scale units for <see cref="F:ZedGraph.AxisType.Log"/>
- and <see cref="F:ZedGraph.AxisType.Linear"/> axes. For <see cref="F:ZedGraph.AxisType.Text"/>
- and <see cref="F:ZedGraph.AxisType.Ordinal"/> axes,
- this value is an ordinal starting with 1.0. For <see cref="F:ZedGraph.AxisType.Date"/>
- axes, this value is in XL Date format (see <see cref="T:ZedGraph.XDate"/>, which is the
- number of days since the reference date of January 1, 1900.</value>
- <seealso cref="P:ZedGraph.Scale.Min"/>
- <seealso cref="P:ZedGraph.Scale.MajorStep"/>
- <seealso cref="P:ZedGraph.Scale.MinorStep"/>
- <seealso cref="P:ZedGraph.Scale.MaxAuto"/>
- </member>
- <member name="P:ZedGraph.Scale.MajorStep">
- <summary>
- Gets or sets the scale step size for this <see cref="T:ZedGraph.Scale"/> (the increment between
- labeled axis values).
- </summary>
- <remarks>
- This value can be set
- automatically based on the state of <see cref="P:ZedGraph.Scale.MajorStepAuto"/>. If
- this value is set manually, then <see cref="P:ZedGraph.Scale.MajorStepAuto"/> will
- also be set to false. This value is ignored for <see cref="F:ZedGraph.AxisType.Log"/>
- axes. For <see cref="F:ZedGraph.AxisType.Date"/> axes, this
- value is defined in units of <see cref="P:ZedGraph.Scale.MajorUnit"/>.
- </remarks>
- <value> The value is defined in user scale units </value>
- <seealso cref="P:ZedGraph.Scale.Min"/>
- <seealso cref="P:ZedGraph.Scale.Max"/>
- <seealso cref="P:ZedGraph.Scale.MinorStep"/>
- <seealso cref="P:ZedGraph.Scale.MajorStepAuto"/>
- <seealso cref="F:ZedGraph.Scale.Default.TargetXSteps"/>
- <seealso cref="F:ZedGraph.Scale.Default.TargetYSteps"/>
- <seealso cref="F:ZedGraph.Scale.Default.ZeroLever"/>
- <seealso cref="F:ZedGraph.Scale.Default.MaxTextLabels"/>
- </member>
- <member name="P:ZedGraph.Scale.MinorStep">
- <summary>
- Gets or sets the scale minor step size for this <see cref="T:ZedGraph.Scale"/> (the spacing between
- minor tics).
- </summary>
- <remarks>This value can be set
- automatically based on the state of <see cref="P:ZedGraph.Scale.MinorStepAuto"/>. If
- this value is set manually, then <see cref="P:ZedGraph.Scale.MinorStepAuto"/> will
- also be set to false. This value is ignored for <see cref="F:ZedGraph.AxisType.Log"/> and
- <see cref="F:ZedGraph.AxisType.Text"/> axes. For <see cref="F:ZedGraph.AxisType.Date"/> axes, this
- value is defined in units of <see cref="P:ZedGraph.Scale.MinorUnit"/>.
- </remarks>
- <value> The value is defined in user scale units </value>
- <seealso cref="P:ZedGraph.Scale.Min"/>
- <seealso cref="P:ZedGraph.Scale.Max"/>
- <seealso cref="P:ZedGraph.Scale.MajorStep"/>
- <seealso cref="P:ZedGraph.Scale.MinorStepAuto"/>
- </member>
- <member name="P:ZedGraph.Scale.Exponent">
- <summary>
- Gets or sets the scale exponent value. This only applies to <see cref="F:ZedGraph.AxisType.Exponent"/>.
- </summary>
- <seealso cref="P:ZedGraph.Scale.Min"/>
- <seealso cref="P:ZedGraph.Scale.Max"/>
- <seealso cref="P:ZedGraph.Scale.MinorStep"/>
- <seealso cref="P:ZedGraph.Scale.MajorStepAuto"/>
- <seealso cref="F:ZedGraph.Scale.Default.TargetXSteps"/>
- <seealso cref="F:ZedGraph.Scale.Default.TargetYSteps"/>
- <seealso cref="F:ZedGraph.Scale.Default.ZeroLever"/>
- <seealso cref="F:ZedGraph.Scale.Default.MaxTextLabels"/>
- </member>
- <member name="P:ZedGraph.Scale.BaseTic">
- <summary>
- Gets or sets the scale value at which the first major tic label will appear.
- </summary>
- <remarks>This property allows the scale labels to start at an irregular value.
- For example, on a scale range with <see cref="P:ZedGraph.Scale.Min"/> = 0, <see cref="P:ZedGraph.Scale.Max"/> = 1000,
- and <see cref="P:ZedGraph.Scale.MajorStep"/> = 200, a <see cref="P:ZedGraph.Scale.BaseTic"/> value of 50 would cause
- the scale labels to appear at values 50, 250, 450, 650, and 850. Note that the
- default value for this property is <see cref="F:ZedGraph.PointPairBase.Missing"/>, which means the
- value is not used. Setting this property to any value other than
- <see cref="F:ZedGraph.PointPairBase.Missing"/> will activate the effect. The value specified must
- coincide with the first major tic. That is, if <see cref="P:ZedGraph.Scale.BaseTic"/> were set to
- 650 in the example above, then the major tics would only occur at 650 and 850. This
- setting may affect the minor tics, since the minor tics are always referenced to the
- <see cref="P:ZedGraph.Scale.BaseTic"/>. That is, in the example above, if the <see cref="P:ZedGraph.Scale.MinorStep"/>
- were set to 30 (making it a non-multiple of the major step), then the minor tics would
- occur at 20, 50 (so it lines up with the BaseTic), 80, 110, 140, etc.
- </remarks>
- <value> The value is defined in user scale units </value>
- <seealso cref="P:ZedGraph.Scale.Min"/>
- <seealso cref="P:ZedGraph.Scale.Max"/>
- <seealso cref="P:ZedGraph.Scale.MajorStep"/>
- <seealso cref="P:ZedGraph.Scale.MinorStep"/>
- <seealso cref="P:ZedGraph.Axis.Cross"/>
- </member>
- <member name="P:ZedGraph.Scale.MajorUnit">
- <summary>
- Gets or sets the type of units used for the major step size (<see cref="P:ZedGraph.Scale.MajorStep"/>).
- </summary>
- <remarks>
- This unit type only applies to Date-Time axes (<see cref="F:ZedGraph.AxisType.Date"/> = true).
- The axis is set to date type with the <see cref="P:ZedGraph.Scale.Type"/> property.
- The unit types are defined as <see cref="T:ZedGraph.DateUnit"/>.
- </remarks>
- <value> The value is a <see cref="T:ZedGraph.DateUnit"/> enum type </value>
- <seealso cref="P:ZedGraph.Scale.Min"/>
- <seealso cref="P:ZedGraph.Scale.Max"/>
- <seealso cref="P:ZedGraph.Scale.MajorStep"/>
- <seealso cref="P:ZedGraph.Scale.MinorStep"/>
- <seealso cref="P:ZedGraph.Scale.MajorStepAuto"/>
- </member>
- <member name="P:ZedGraph.Scale.MinorUnit">
- <summary>
- Gets or sets the type of units used for the minor step size (<see cref="P:ZedGraph.Scale.MinorStep"/>).
- </summary>
- <remarks>
- This unit type only applies to Date-Time axes (<see cref="F:ZedGraph.AxisType.Date"/> = true).
- The axis is set to date type with the <see cref="P:ZedGraph.Scale.Type"/> property.
- The unit types are defined as <see cref="T:ZedGraph.DateUnit"/>.
- </remarks>
- <value> The value is a <see cref="T:ZedGraph.DateUnit"/> enum type </value>
- <seealso cref="P:ZedGraph.Scale.Min"/>
- <seealso cref="P:ZedGraph.Scale.Max"/>
- <seealso cref="P:ZedGraph.Scale.MajorStep"/>
- <seealso cref="P:ZedGraph.Scale.MinorStep"/>
- <seealso cref="P:ZedGraph.Scale.MinorStepAuto"/>
- </member>
- <member name="P:ZedGraph.Scale.MajorUnitMultiplier">
- <summary>
- Gets the major unit multiplier for this scale type, if any.
- </summary>
- <remarks>The major unit multiplier will correct the units of
- <see cref="P:ZedGraph.Scale.MajorStep"/> to match the units of <see cref="P:ZedGraph.Scale.Min"/>
- and <see cref="P:ZedGraph.Scale.Max"/>. This reflects the setting of
- <see cref="P:ZedGraph.Scale.MajorUnit"/>.
- </remarks>
- </member>
- <member name="P:ZedGraph.Scale.MinorUnitMultiplier">
- <summary>
- Gets the minor unit multiplier for this scale type, if any.
- </summary>
- <remarks>The minor unit multiplier will correct the units of
- <see cref="P:ZedGraph.Scale.MinorStep"/> to match the units of <see cref="P:ZedGraph.Scale.Min"/>
- and <see cref="P:ZedGraph.Scale.Max"/>. This reflects the setting of
- <see cref="P:ZedGraph.Scale.MinorUnit"/>.
- </remarks>
- </member>
- <member name="P:ZedGraph.Scale.MinAuto">
- <summary>
- Gets or sets a value that determines whether or not the minimum scale value <see cref="P:ZedGraph.Scale.Min"/>
- is set automatically.
- </summary>
- <remarks>
- This value will be set to false if
- <see cref="P:ZedGraph.Scale.Min"/> is manually changed.
- </remarks>
- <value>true for automatic mode, false for manual mode</value>
- <seealso cref="P:ZedGraph.Scale.Min"/>
- </member>
- <member name="P:ZedGraph.Scale.MaxAuto">
- <summary>
- Gets or sets a value that determines whether or not the maximum scale value <see cref="P:ZedGraph.Scale.Max"/>
- is set automatically.
- </summary>
- <remarks>
- This value will be set to false if
- <see cref="P:ZedGraph.Scale.Max"/> is manually changed.
- </remarks>
- <value>true for automatic mode, false for manual mode</value>
- <seealso cref="P:ZedGraph.Scale.Max"/>
- </member>
- <member name="P:ZedGraph.Scale.MajorStepAuto">
- <summary>
- Gets or sets a value that determines whether or not the scale step size <see cref="P:ZedGraph.Scale.MajorStep"/>
- is set automatically.
- </summary>
- <remarks>
- This value will be set to false if
- <see cref="P:ZedGraph.Scale.MajorStep"/> is manually changed.
- </remarks>
- <value>true for automatic mode, false for manual mode</value>
- <seealso cref="P:ZedGraph.Scale.MajorStep"/>
- </member>
- <member name="P:ZedGraph.Scale.MinorStepAuto">
- <summary>
- Gets or sets a value that determines whether or not the minor scale step size <see cref="P:ZedGraph.Scale.MinorStep"/>
- is set automatically.
- </summary>
- <remarks>
- This value will be set to false if
- <see cref="P:ZedGraph.Scale.MinorStep"/> is manually changed.
- </remarks>
- <value>true for automatic mode, false for manual mode</value>
- <seealso cref="P:ZedGraph.Scale.MinorStep"/>
- </member>
- <member name="P:ZedGraph.Scale.FormatAuto">
- <summary>
- Determines whether or not the scale label format <see cref="P:ZedGraph.Scale.Format"/>
- is determined automatically based on the range of data values.
- </summary>
- <remarks>
- This value will be set to false if
- <see cref="P:ZedGraph.Scale.Format"/> is manually changed.
- </remarks>
- <value>true if <see cref="P:ZedGraph.Scale.Format"/> will be set automatically, false
- if it is to be set manually by the user</value>
- <seealso cref="P:ZedGraph.Scale.Mag"/>
- <seealso cref="P:ZedGraph.Scale.Format"/>
- <seealso cref="P:ZedGraph.Scale.FontSpec"/>
- </member>
- <member name="P:ZedGraph.Scale.Format">
- <summary>
- The format of the <see cref="T:ZedGraph.Axis"/> tic labels.
- </summary>
- <remarks>
- This property may be a date format or a numeric format, depending on the setting of
- <see cref="P:ZedGraph.Scale.Type">Scale.Type</see>.
- This property may be set automatically by ZedGraph, depending on the state of
- <see cref="P:ZedGraph.Scale.FormatAuto"/>.
- </remarks>
- <value>The format string conforms to the
- <see cref="T:System.Globalization.DateTimeFormatInfo"/> for date formats, and
- <see cref="T:System.Globalization.NumberFormatInfo"/> for numeric formats.
- </value>
- <seealso cref="P:ZedGraph.Scale.Mag"/>
- <seealso cref="P:ZedGraph.Scale.FormatAuto"/>
- <seealso cref="P:ZedGraph.Scale.FontSpec"/>
- </member>
- <member name="P:ZedGraph.Scale.Mag">
- <summary>
- The magnitude multiplier for scale values.
- </summary>
- <remarks>
- This is used to limit
- the size of the displayed value labels. For example, if the value
- is really 2000000, then the graph will display 2000 with a 10^3
- magnitude multiplier. This value can be determined automatically
- depending on the state of <see cref="P:ZedGraph.Scale.MagAuto"/>.
- If this value is set manually by the user,
- then <see cref="P:ZedGraph.Scale.MagAuto"/> will also be set to false.
- </remarks>
- <value>The magnitude multiplier (power of 10) for the scale
- value labels</value>
- <seealso cref="P:ZedGraph.AxisLabel.IsOmitMag"/>
- <seealso cref="P:ZedGraph.Axis.Title"/>
- <seealso cref="P:ZedGraph.Scale.Format"/>
- <seealso cref="P:ZedGraph.Scale.FontSpec"/>
- </member>
- <member name="P:ZedGraph.Scale.MagAuto">
- <summary>
- Determines whether the <see cref="P:ZedGraph.Scale.Mag"/> value will be set
- automatically based on the data, or manually by the user.
- </summary>
- <remarks>
- If the user manually sets the <see cref="P:ZedGraph.Scale.Mag"/> value, then this
- flag will be set to false.
- </remarks>
- <value>true to have <see cref="P:ZedGraph.Scale.Mag"/> set automatically,
- false otherwise</value>
- <seealso cref="P:ZedGraph.AxisLabel.IsOmitMag"/>
- <seealso cref="P:ZedGraph.Axis.Title"/>
- <seealso cref="P:ZedGraph.Scale.Mag"/>
- </member>
- <member name="P:ZedGraph.Scale.MinGrace">
- <summary> Gets or sets the "grace" value applied to the minimum data range.
- </summary>
- <remarks>
- This value is
- expressed as a fraction of the total data range. For example, assume the data
- range is from 4.0 to 16.0, leaving a range of 12.0. If MinGrace is set to
- 0.1, then 10% of the range, or 1.2 will be subtracted from the minimum data value.
- The scale will then be ranged to cover at least 2.8 to 16.0.
- </remarks>
- <seealso cref="P:ZedGraph.Scale.Min"/>
- <seealso cref="F:ZedGraph.Scale.Default.MinGrace"/>
- <seealso cref="P:ZedGraph.Scale.MaxGrace"/>
- </member>
- <member name="P:ZedGraph.Scale.MaxGrace">
- <summary> Gets or sets the "grace" value applied to the maximum data range.
- </summary>
- <remarks>
- This values determines how much extra space is left after the last data value.
- This value is
- expressed as a fraction of the total data range. For example, assume the data
- range is from 4.0 to 16.0, leaving a range of 12.0. If MaxGrace is set to
- 0.1, then 10% of the range, or 1.2 will be added to the maximum data value.
- The scale will then be ranged to cover at least 4.0 to 17.2.
- </remarks>
- <seealso cref="P:ZedGraph.Scale.Max"/>
- <seealso cref="F:ZedGraph.Scale.Default.MaxGrace"/>
- <seealso cref="P:ZedGraph.Scale.MinGrace"/>
- </member>
- <member name="P:ZedGraph.Scale.Align">
- <summary> Controls the alignment of the <see cref="T:ZedGraph.Axis"/> tic labels.
- </summary>
- <remarks>
- This property controls whether the inside, center, or outside edges of the
- text labels are aligned.
- </remarks>
- </member>
- <member name="P:ZedGraph.Scale.AlignH">
- <summary> Controls the alignment of the <see cref="T:ZedGraph.Axis"/> tic labels.
- </summary>
- <remarks>
- This property controls whether the left, center, or right edges of the
- text labels are aligned.
- </remarks>
- </member>
- <member name="P:ZedGraph.Scale.FontSpec">
- <summary>
- Gets a reference to the <see cref="T:ZedGraph.FontSpec"/> class used to render
- the scale values
- </summary>
- <seealso cref="F:ZedGraph.Scale.Default.FontFamily"/>
- <seealso cref="F:ZedGraph.Scale.Default.FontSize"/>
- <seealso cref="F:ZedGraph.Scale.Default.FontColor"/>
- <seealso cref="F:ZedGraph.Scale.Default.FontBold"/>
- <seealso cref="F:ZedGraph.Scale.Default.FontUnderline"/>
- <seealso cref="F:ZedGraph.Scale.Default.FontItalic"/>
- </member>
- <member name="P:ZedGraph.Scale.LabelGap">
- <summary>
- The gap between the scale labels and the tics.
- </summary>
- </member>
- <member name="P:ZedGraph.Scale.IsLabelsInside">
- <summary>
- Gets or sets a value that causes the axis scale labels and title to appear on the
- opposite side of the axis.
- </summary>
- <remarks>
- For example, setting this flag to true for the <see cref="T:ZedGraph.YAxis"/> will shift the
- axis labels and title to the right side of the <see cref="T:ZedGraph.YAxis"/> instead of the
- normal left-side location. Set this property to true for the <see cref="T:ZedGraph.XAxis"/>,
- and set the <see cref="P:ZedGraph.Axis.Cross"/> property for the <see cref="T:ZedGraph.XAxis"/> to an arbitrarily
- large value (assuming <see cref="P:ZedGraph.Scale.IsReverse"/> is false for the <see cref="T:ZedGraph.YAxis"/>) in
- order to have the <see cref="T:ZedGraph.XAxis"/> appear at the top of the <see cref="P:ZedGraph.Chart.Rect"/>.
- </remarks>
- <seealso cref="P:ZedGraph.Scale.IsReverse"/>
- <seealso cref="P:ZedGraph.Axis.Cross"/>
- </member>
- <member name="P:ZedGraph.Scale.IsSkipFirstLabel">
- <summary>
- Gets or sets a value that causes the first scale label for this <see cref="T:ZedGraph.Axis"/> to be
- hidden.
- </summary>
- <remarks>
- Often, for axis that have an active <see cref="P:ZedGraph.Axis.Cross"/> setting (e.g., <see cref="P:ZedGraph.Axis.CrossAuto"/>
- is false), the first and/or last scale label are overlapped by opposing axes. Use this
- property to hide the first scale label to avoid the overlap. Note that setting this value
- to true will hide any scale label that appears within <see cref="F:ZedGraph.Scale.Default.EdgeTolerance"/> of the
- beginning of the <see cref="T:ZedGraph.Axis"/>.
- </remarks>
- </member>
- <member name="P:ZedGraph.Scale.IsSkipLastLabel">
- <summary>
- Gets or sets a value that causes the last scale label for this <see cref="T:ZedGraph.Axis"/> to be
- hidden.
- </summary>
- <remarks>
- Often, for axis that have an active <see cref="P:ZedGraph.Axis.Cross"/> setting (e.g., <see cref="P:ZedGraph.Axis.CrossAuto"/>
- is false), the first and/or last scale label are overlapped by opposing axes. Use this
- property to hide the last scale label to avoid the overlap. Note that setting this value
- to true will hide any scale label that appears within <see cref="F:ZedGraph.Scale.Default.EdgeTolerance"/> of the
- end of the <see cref="T:ZedGraph.Axis"/>.
- </remarks>
- </member>
- <member name="P:ZedGraph.Scale.IsSkipCrossLabel">
- <summary>
- Gets or sets a value that causes the scale label that is located at the <see cref="P:ZedGraph.Axis.Cross"/>
- value for this <see cref="T:ZedGraph.Axis"/> to be hidden.
- </summary>
- <remarks>
- For axes that have an active <see cref="P:ZedGraph.Axis.Cross"/> setting (e.g., <see cref="P:ZedGraph.Axis.CrossAuto"/>
- is false), the scale label at the <see cref="P:ZedGraph.Axis.Cross"/> value is overlapped by opposing axes.
- Use this property to hide the scale label to avoid the overlap.
- </remarks>
- </member>
- <member name="P:ZedGraph.Scale.IsReverse">
- <summary>
- Determines if the scale values are reversed for this <see cref="T:ZedGraph.Axis"/>
- </summary>
- <value>true for the X values to decrease to the right or the Y values to
- decrease upwards, false otherwise</value>
- <seealso cref="F:ZedGraph.Scale.Default.IsReverse"/>.
- </member>
- <member name="P:ZedGraph.Scale.IsUseTenPower">
- <summary>
- Determines if powers-of-ten notation will be used for the numeric value labels.
- </summary>
- <remarks>
- The powers-of-ten notation is just the text "10" followed by a superscripted value
- indicating the magnitude. This mode is only valid for log scales (see
- <see cref="P:ZedGraph.Scale.IsLog"/> and <see cref="P:ZedGraph.Scale.Type"/>).
- </remarks>
- <value> boolean value; true to show the title as a power of ten, false to
- show a regular numeric value (e.g., "0.01", "10", "1000")</value>
- </member>
- <member name="P:ZedGraph.Scale.IsPreventLabelOverlap">
- <summary>
- Gets or sets a <see cref="T:System.Boolean"/> value that determines if ZedGraph will check to
- see if the <see cref="T:ZedGraph.Axis"/> scale labels are close enough to overlap. If so,
- ZedGraph will adjust the step size to prevent overlap.
- </summary>
- <remarks>
- The process of checking for overlap is done during the <see cref="M:ZedGraph.GraphPane.AxisChange"/>
- method call, and affects the selection of the major step size (<see cref="P:ZedGraph.Scale.MajorStep"/>).
- </remarks>
- <value> boolean value; true to check for overlap, false otherwise</value>
- </member>
- <member name="P:ZedGraph.Scale.IsVisible">
- <summary>
- Gets or sets a property that determines whether or not the scale values will be shown.
- </summary>
- <value>true to show the scale values, false otherwise</value>
- <seealso cref="P:ZedGraph.Axis.IsVisible"/>.
- </member>
- <member name="P:ZedGraph.Scale.TextLabels">
- <summary>
- The text labels for this <see cref="T:ZedGraph.Axis"/>.
- </summary>
- <remarks>
- This property is only
- applicable if <see cref="P:ZedGraph.Scale.Type"/> is set to <see cref="F:ZedGraph.AxisType.Text"/>.
- </remarks>
- </member>
- <member name="T:ZedGraph.Scale.Default">
- <summary>
- A simple struct that defines the
- default property values for the <see cref="T:ZedGraph.Scale"/> class.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale.Default.ZeroLever">
- <summary>
- The default "zero lever" for automatically selecting the axis
- scale range (see <see cref="M:ZedGraph.Scale.PickScale(ZedGraph.GraphPane,System.Drawing.Graphics,System.Single)"/>). This number is
- used to determine when an axis scale range should be extended to
- include the zero value. This value is maintained only in the
- <see cref="T:ZedGraph.Scale.Default"/> class, and cannot be changed after compilation.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale.Default.MinGrace">
- <summary> The default "grace" value applied to the minimum data range.
- This value is
- expressed as a fraction of the total data range. For example, assume the data
- range is from 4.0 to 16.0, leaving a range of 12.0. If MinGrace is set to
- 0.1, then 10% of the range, or 1.2 will be subtracted from the minimum data value.
- The scale will then be ranged to cover at least 2.8 to 16.0.
- </summary>
- <seealso cref="F:ZedGraph.Scale.Default.MinGrace"/>
- </member>
- <member name="F:ZedGraph.Scale.Default.MaxGrace">
- <summary> The default "grace" value applied to the maximum data range.
- This value is
- expressed as a fraction of the total data range. For example, assume the data
- range is from 4.0 to 16.0, leaving a range of 12.0. If MaxGrace is set to
- 0.1, then 10% of the range, or 1.2 will be added to the maximum data value.
- The scale will then be ranged to cover at least 4.0 to 17.2.
- </summary>
- <seealso cref="F:ZedGraph.Scale.Default.MinGrace"/>
- <seealso cref="F:ZedGraph.Scale.Default.MaxGrace"/>
- </member>
- <member name="F:ZedGraph.Scale.Default.MaxTextLabels">
- <summary>
- The maximum number of text labels (major tics) that will be allowed on the plot by
- the automatic scaling logic. This value applies only to <see cref="F:ZedGraph.AxisType.Text"/>
- axes. If there are more than MaxTextLabels on the plot, then
- <see cref="P:ZedGraph.Scale.MajorStep"/> will be increased to reduce the number of labels. That is,
- the step size might be increased to 2.0 to show only every other label.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale.Default.TargetXSteps">
- <summary>
- The default target number of steps for automatically selecting the X axis
- scale step size (see <see cref="M:ZedGraph.Scale.PickScale(ZedGraph.GraphPane,System.Drawing.Graphics,System.Single)"/>).
- This number is an initial target value for the number of major steps
- on an axis. This value is maintained only in the
- <see cref="T:ZedGraph.Scale.Default"/> class, and cannot be changed after compilation.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale.Default.TargetYSteps">
- <summary>
- The default target number of steps for automatically selecting the Y or Y2 axis
- scale step size (see <see cref="M:ZedGraph.Scale.PickScale(ZedGraph.GraphPane,System.Drawing.Graphics,System.Single)"/>).
- This number is an initial target value for the number of major steps
- on an axis. This value is maintained only in the
- <see cref="T:ZedGraph.Scale.Default"/> class, and cannot be changed after compilation.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale.Default.TargetMinorXSteps">
- <summary>
- The default target number of minor steps for automatically selecting the X axis
- scale minor step size (see <see cref="M:ZedGraph.Scale.PickScale(ZedGraph.GraphPane,System.Drawing.Graphics,System.Single)"/>).
- This number is an initial target value for the number of minor steps
- on an axis. This value is maintained only in the
- <see cref="T:ZedGraph.Scale.Default"/> class, and cannot be changed after compilation.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale.Default.TargetMinorYSteps">
- <summary>
- The default target number of minor steps for automatically selecting the Y or Y2 axis
- scale minor step size (see <see cref="M:ZedGraph.Scale.PickScale(ZedGraph.GraphPane,System.Drawing.Graphics,System.Single)"/>).
- This number is an initial target value for the number of minor steps
- on an axis. This value is maintained only in the
- <see cref="T:ZedGraph.Scale.Default"/> class, and cannot be changed after compilation.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale.Default.IsReverse">
- <summary>
- The default reverse mode for the <see cref="T:ZedGraph.Axis"/> scale
- (<see cref="F:ZedGraph.Scale.Default.IsReverse"/> property). true for a reversed scale
- (X decreasing to the left, Y/Y2 decreasing upwards), false otherwise.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale.Default.Format">
- <summary>
- The default setting for the <see cref="T:ZedGraph.Axis"/> scale format string
- (<see cref="F:ZedGraph.Scale.Default.Format"/> property). For numeric values, this value is
- setting according to the <see cref="M:System.String.Format(System.String,System.Object)"/> format strings. For date
- type values, this value is set as per the <see cref="M:ZedGraph.XDate.ToString"/> function.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale.Default.RangeYearYear">
- <summary>
- A default setting for the <see cref="F:ZedGraph.AxisType.Date"/> auto-ranging code.
- This values applies only to Date-Time type axes.
- If the total span of data exceeds this number (in days), then the auto-range
- code will select <see cref="P:ZedGraph.Scale.MajorUnit"/> = <see cref="F:ZedGraph.DateUnit.Year"/>
- and <see cref="P:ZedGraph.Scale.MinorUnit"/> = <see cref="F:ZedGraph.DateUnit.Year"/>.
- This value normally defaults to 1825 days (5 years).
- This value is used by the <see cref="M:ZedGraph.DateScale.CalcDateStepSize(System.Double,System.Double,ZedGraph.Scale)"/> method.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale.Default.RangeYearMonth">
- <summary>
- A default setting for the <see cref="F:ZedGraph.AxisType.Date"/> auto-ranging code.
- This values applies only to Date-Time type axes.
- If the total span of data exceeds this number (in days), then the auto-range
- code will select <see cref="P:ZedGraph.Scale.MajorUnit"/> = <see cref="F:ZedGraph.DateUnit.Year"/>
- and <see cref="P:ZedGraph.Scale.MinorUnit"/> = <see cref="F:ZedGraph.DateUnit.Month"/>.
- This value normally defaults to 730 days (2 years).
- This value is used by the <see cref="M:ZedGraph.DateScale.CalcDateStepSize(System.Double,System.Double,ZedGraph.Scale)"/> method.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale.Default.RangeMonthMonth">
- <summary>
- A default setting for the <see cref="F:ZedGraph.AxisType.Date"/> auto-ranging code.
- This values applies only to Date-Time type axes.
- If the total span of data exceeds this number (in days), then the auto-range
- code will select <see cref="P:ZedGraph.Scale.MajorUnit"/> = <see cref="F:ZedGraph.DateUnit.Month"/>
- and <see cref="P:ZedGraph.Scale.MinorUnit"/> = <see cref="F:ZedGraph.DateUnit.Month"/>.
- This value normally defaults to 300 days (10 months).
- This value is used by the <see cref="M:ZedGraph.DateScale.CalcDateStepSize(System.Double,System.Double,ZedGraph.Scale)"/> method.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale.Default.RangeDayDay">
- <summary>
- A default setting for the <see cref="F:ZedGraph.AxisType.Date"/> auto-ranging code.
- This values applies only to Date-Time type axes.
- If the total span of data exceeds this number (in days), then the auto-range
- code will select <see cref="P:ZedGraph.Scale.MajorUnit"/> = <see cref="F:ZedGraph.DateUnit.Day"/>
- and <see cref="P:ZedGraph.Scale.MinorUnit"/> = <see cref="F:ZedGraph.DateUnit.Day"/>.
- This value normally defaults to 10 days.
- This value is used by the <see cref="M:ZedGraph.DateScale.CalcDateStepSize(System.Double,System.Double,ZedGraph.Scale)"/> method.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale.Default.RangeDayHour">
- <summary>
- A default setting for the <see cref="F:ZedGraph.AxisType.Date"/> auto-ranging code.
- This values applies only to Date-Time type axes.
- If the total span of data exceeds this number (in days), then the auto-range
- code will select <see cref="P:ZedGraph.Scale.MajorUnit"/> = <see cref="F:ZedGraph.DateUnit.Day"/>
- and <see cref="P:ZedGraph.Scale.MinorUnit"/> = <see cref="F:ZedGraph.DateUnit.Hour"/>.
- This value normally defaults to 3 days.
- This value is used by the <see cref="M:ZedGraph.DateScale.CalcDateStepSize(System.Double,System.Double,ZedGraph.Scale)"/> method.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale.Default.RangeHourHour">
- <summary>
- A default setting for the <see cref="F:ZedGraph.AxisType.Date"/> auto-ranging code.
- This values applies only to Date-Time type axes.
- If the total span of data exceeds this number (in days), then the auto-range
- code will select <see cref="P:ZedGraph.Scale.MajorUnit"/> = <see cref="F:ZedGraph.DateUnit.Hour"/>
- and <see cref="P:ZedGraph.Scale.MinorUnit"/> = <see cref="F:ZedGraph.DateUnit.Hour"/>.
- This value normally defaults to 0.4167 days (10 hours).
- This value is used by the <see cref="M:ZedGraph.DateScale.CalcDateStepSize(System.Double,System.Double,ZedGraph.Scale)"/> method.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale.Default.RangeHourMinute">
- <summary>
- A default setting for the <see cref="F:ZedGraph.AxisType.Date"/> auto-ranging code.
- This values applies only to Date-Time type axes.
- If the total span of data exceeds this number (in days), then the auto-range
- code will select <see cref="P:ZedGraph.Scale.MajorUnit"/> = <see cref="F:ZedGraph.DateUnit.Hour"/>
- and <see cref="P:ZedGraph.Scale.MinorUnit"/> = <see cref="F:ZedGraph.DateUnit.Minute"/>.
- This value normally defaults to 0.125 days (3 hours).
- This value is used by the <see cref="M:ZedGraph.DateScale.CalcDateStepSize(System.Double,System.Double,ZedGraph.Scale)"/> method.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale.Default.RangeMinuteMinute">
- <summary>
- A default setting for the <see cref="F:ZedGraph.AxisType.Date"/> auto-ranging code.
- This values applies only to Date-Time type axes.
- If the total span of data exceeds this number (in days), then the auto-range
- code will select <see cref="P:ZedGraph.Scale.MajorUnit"/> = <see cref="F:ZedGraph.DateUnit.Minute"/>
- and <see cref="P:ZedGraph.Scale.MinorUnit"/> = <see cref="F:ZedGraph.DateUnit.Minute"/>.
- This value normally defaults to 6.94e-3 days (10 minutes).
- This value is used by the <see cref="M:ZedGraph.DateScale.CalcDateStepSize(System.Double,System.Double,ZedGraph.Scale)"/> method.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale.Default.RangeMinuteSecond">
- <summary>
- A default setting for the <see cref="F:ZedGraph.AxisType.Date"/> auto-ranging code.
- This values applies only to Date-Time type axes.
- If the total span of data exceeds this number (in days), then the auto-range
- code will select <see cref="P:ZedGraph.Scale.MajorUnit"/> = <see cref="F:ZedGraph.DateUnit.Minute"/>
- and <see cref="P:ZedGraph.Scale.MinorUnit"/> = <see cref="F:ZedGraph.DateUnit.Second"/>.
- This value normally defaults to 2.083e-3 days (3 minutes).
- This value is used by the <see cref="M:ZedGraph.DateScale.CalcDateStepSize(System.Double,System.Double,ZedGraph.Scale)"/> method.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale.Default.RangeSecondSecond">
- <summary>
- A default setting for the <see cref="F:ZedGraph.AxisType.Date"/> auto-ranging code.
- This values applies only to Date-Time type axes.
- If the total span of data exceeds this number (in days), then the auto-range
- code will select <see cref="P:ZedGraph.Scale.MajorUnit"/> = <see cref="F:ZedGraph.DateUnit.Second"/>
- and <see cref="P:ZedGraph.Scale.MinorUnit"/> = <see cref="F:ZedGraph.DateUnit.Second"/>.
- This value normally defaults to 3.472e-5 days (3 seconds).
- This value is used by the <see cref="M:ZedGraph.DateScale.CalcDateStepSize(System.Double,System.Double,ZedGraph.Scale)"/> method.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale.Default.FormatYearYear">
- <summary>
- A default setting for the <see cref="F:ZedGraph.AxisType.Date"/> auto-ranging code.
- This values applies only to Date-Time type axes.
- This is the format used for the scale values when auto-ranging code
- selects a <see cref="F:ZedGraph.Scale.Default.Format"/> of <see cref="F:ZedGraph.DateUnit.Year"/>
- for <see cref="P:ZedGraph.Scale.MajorUnit"/> and <see cref="F:ZedGraph.DateUnit.Year"/> for
- for <see cref="P:ZedGraph.Scale.MinorUnit"/>.
- This value is used by the <see cref="M:ZedGraph.DateScale.CalcDateStepSize(System.Double,System.Double,ZedGraph.Scale)"/> method.
- </summary>
- <seealso cref="T:System.Globalization.DateTimeFormatInfo"/>
- </member>
- <member name="F:ZedGraph.Scale.Default.FormatYearMonth">
- <summary>
- A default setting for the <see cref="F:ZedGraph.AxisType.Date"/> auto-ranging code.
- This values applies only to Date-Time type axes.
- This is the format used for the scale values when auto-ranging code
- selects a <see cref="F:ZedGraph.Scale.Default.Format"/> of <see cref="F:ZedGraph.DateUnit.Year"/>
- for <see cref="P:ZedGraph.Scale.MajorUnit"/> and <see cref="F:ZedGraph.DateUnit.Month"/> for
- for <see cref="P:ZedGraph.Scale.MinorUnit"/>.
- This value is used by the <see cref="M:ZedGraph.DateScale.CalcDateStepSize(System.Double,System.Double,ZedGraph.Scale)"/> method.
- </summary>
- <seealso cref="T:System.Globalization.DateTimeFormatInfo"/>
- </member>
- <member name="F:ZedGraph.Scale.Default.FormatMonthMonth">
- <summary>
- A default setting for the <see cref="F:ZedGraph.AxisType.Date"/> auto-ranging code.
- This values applies only to Date-Time type axes.
- This is the format used for the scale values when auto-ranging code
- selects a <see cref="F:ZedGraph.Scale.Default.Format"/> of <see cref="F:ZedGraph.DateUnit.Month"/>
- for <see cref="P:ZedGraph.Scale.MajorUnit"/> and <see cref="F:ZedGraph.DateUnit.Month"/> for
- for <see cref="P:ZedGraph.Scale.MinorUnit"/>.
- This value is used by the <see cref="M:ZedGraph.DateScale.CalcDateStepSize(System.Double,System.Double,ZedGraph.Scale)"/> method.
- </summary>
- <seealso cref="T:System.Globalization.DateTimeFormatInfo"/>
- </member>
- <member name="F:ZedGraph.Scale.Default.FormatDayDay">
- <summary>
- A default setting for the <see cref="F:ZedGraph.AxisType.Date"/> auto-ranging code.
- This values applies only to Date-Time type axes.
- This is the format used for the scale values when auto-ranging code
- selects a <see cref="F:ZedGraph.Scale.Default.Format"/> of <see cref="F:ZedGraph.DateUnit.Day"/>
- for <see cref="P:ZedGraph.Scale.MajorUnit"/> and <see cref="F:ZedGraph.DateUnit.Day"/> for
- for <see cref="P:ZedGraph.Scale.MinorUnit"/>.
- This value is used by the <see cref="M:ZedGraph.DateScale.CalcDateStepSize(System.Double,System.Double,ZedGraph.Scale)"/> method.
- </summary>
- <seealso cref="T:System.Globalization.DateTimeFormatInfo"/>
- </member>
- <member name="F:ZedGraph.Scale.Default.FormatDayHour">
- <summary>
- A default setting for the <see cref="F:ZedGraph.AxisType.Date"/> auto-ranging code.
- This values applies only to Date-Time type axes.
- This is the format used for the scale values when auto-ranging code
- selects a <see cref="F:ZedGraph.Scale.Default.Format"/> of <see cref="F:ZedGraph.DateUnit.Day"/>
- for <see cref="P:ZedGraph.Scale.MajorUnit"/> and <see cref="F:ZedGraph.DateUnit.Hour"/> for
- for <see cref="P:ZedGraph.Scale.MinorUnit"/>.
- This value is used by the <see cref="M:ZedGraph.DateScale.CalcDateStepSize(System.Double,System.Double,ZedGraph.Scale)"/> method.
- </summary>
- <seealso cref="T:System.Globalization.DateTimeFormatInfo"/>
- </member>
- <member name="F:ZedGraph.Scale.Default.FormatHourHour">
- <summary>
- A default setting for the <see cref="F:ZedGraph.AxisType.Date"/> auto-ranging code.
- This values applies only to Date-Time type axes.
- This is the format used for the scale values when auto-ranging code
- selects a <see cref="F:ZedGraph.Scale.Default.Format"/> of <see cref="F:ZedGraph.DateUnit.Hour"/>
- for <see cref="P:ZedGraph.Scale.MajorUnit"/> and <see cref="F:ZedGraph.DateUnit.Hour"/> for
- for <see cref="P:ZedGraph.Scale.MinorUnit"/>.
- This value is used by the <see cref="M:ZedGraph.DateScale.CalcDateStepSize(System.Double,System.Double,ZedGraph.Scale)"/> method.
- </summary>
- <seealso cref="T:System.Globalization.DateTimeFormatInfo"/>
- </member>
- <member name="F:ZedGraph.Scale.Default.FormatHourMinute">
- <summary>
- A default setting for the <see cref="F:ZedGraph.AxisType.Date"/> auto-ranging code.
- This values applies only to Date-Time type axes.
- This is the format used for the scale values when auto-ranging code
- selects a <see cref="F:ZedGraph.Scale.Default.Format"/> of <see cref="F:ZedGraph.DateUnit.Hour"/>
- for <see cref="P:ZedGraph.Scale.MajorUnit"/> and <see cref="F:ZedGraph.DateUnit.Minute"/> for
- for <see cref="P:ZedGraph.Scale.MinorUnit"/>.
- This value is used by the <see cref="M:ZedGraph.DateScale.CalcDateStepSize(System.Double,System.Double,ZedGraph.Scale)"/> method.
- </summary>
- <seealso cref="T:System.Globalization.DateTimeFormatInfo"/>
- </member>
- <member name="F:ZedGraph.Scale.Default.FormatMinuteMinute">
- <summary>
- A default setting for the <see cref="F:ZedGraph.AxisType.Date"/> auto-ranging code.
- This values applies only to Date-Time type axes.
- This is the format used for the scale values when auto-ranging code
- selects a <see cref="F:ZedGraph.Scale.Default.Format"/> of <see cref="F:ZedGraph.DateUnit.Minute"/>
- for <see cref="P:ZedGraph.Scale.MajorUnit"/> and <see cref="F:ZedGraph.DateUnit.Minute"/> for
- for <see cref="P:ZedGraph.Scale.MinorUnit"/>.
- This value is used by the <see cref="M:ZedGraph.DateScale.CalcDateStepSize(System.Double,System.Double,ZedGraph.Scale)"/> method.
- </summary>
- <seealso cref="T:System.Globalization.DateTimeFormatInfo"/>
- </member>
- <member name="F:ZedGraph.Scale.Default.FormatMinuteSecond">
- <summary>
- A default setting for the <see cref="F:ZedGraph.AxisType.Date"/> auto-ranging code.
- This values applies only to Date-Time type axes.
- This is the format used for the scale values when auto-ranging code
- selects a <see cref="F:ZedGraph.Scale.Default.Format"/> of <see cref="F:ZedGraph.DateUnit.Minute"/>
- for <see cref="P:ZedGraph.Scale.MajorUnit"/> and <see cref="F:ZedGraph.DateUnit.Second"/> for
- for <see cref="P:ZedGraph.Scale.MinorUnit"/>.
- This value is used by the <see cref="M:ZedGraph.DateScale.CalcDateStepSize(System.Double,System.Double,ZedGraph.Scale)"/> method.
- </summary>
- <seealso cref="T:System.Globalization.DateTimeFormatInfo"/>
- </member>
- <member name="F:ZedGraph.Scale.Default.FormatSecondSecond">
- <summary>
- A default setting for the <see cref="F:ZedGraph.AxisType.Date"/> auto-ranging code.
- This values applies only to Date-Time type axes.
- This is the format used for the scale values when auto-ranging code
- selects a <see cref="F:ZedGraph.Scale.Default.Format"/> of <see cref="F:ZedGraph.DateUnit.Second"/>
- for <see cref="P:ZedGraph.Scale.MajorUnit"/> and <see cref="F:ZedGraph.DateUnit.Second"/> for
- for <see cref="P:ZedGraph.Scale.MinorUnit"/>.
- This value is used by the <see cref="M:ZedGraph.DateScale.CalcDateStepSize(System.Double,System.Double,ZedGraph.Scale)"/> method.
- </summary>
- <seealso cref="T:System.Globalization.DateTimeFormatInfo"/>
- </member>
- <member name="F:ZedGraph.Scale.Default.FormatMillisecond">
- <summary>
- A default setting for the <see cref="F:ZedGraph.AxisType.Date"/> auto-ranging code.
- This values applies only to Date-Time type axes.
- This is the format used for the scale values when auto-ranging code
- selects a <see cref="F:ZedGraph.Scale.Default.Format"/> of <see cref="F:ZedGraph.DateUnit.Millisecond"/>
- for <see cref="P:ZedGraph.Scale.MajorUnit"/> and <see cref="F:ZedGraph.DateUnit.Millisecond"/> for
- for <see cref="P:ZedGraph.Scale.MinorUnit"/>.
- This value is used by the <see cref="M:ZedGraph.DateScale.CalcDateStepSize(System.Double,System.Double,ZedGraph.Scale)"/> method.
- </summary>
- <seealso cref="T:System.Globalization.DateTimeFormatInfo"/>
- </member>
- <member name="F:ZedGraph.Scale.Default.Align">
- <summary> The default alignment of the <see cref="T:ZedGraph.Axis"/> tic labels.
- This value controls whether the inside, center, or outside edges of the text labels are aligned.
- </summary>
- <seealso cref="T:ZedGraph.AlignP"/>
- </member>
- <member name="F:ZedGraph.Scale.Default.AlignH">
- <summary> The default alignment of the <see cref="T:ZedGraph.Axis"/> tic labels.
- This value controls whether the left, center, or right edges of the text labels are aligned.
- </summary>
- <seealso cref="F:ZedGraph.Scale.Default.AlignH"/>
- </member>
- <member name="F:ZedGraph.Scale.Default.FontFamily">
- <summary>
- The default font family for the <see cref="T:ZedGraph.Axis"/> scale values
- font specification <see cref="P:ZedGraph.Scale.FontSpec"/>
- (<see cref="P:ZedGraph.FontSpec.Family"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.Scale.Default.FontSize">
- <summary>
- The default font size for the <see cref="T:ZedGraph.Axis"/> scale values
- font specification <see cref="P:ZedGraph.Scale.FontSpec"/>
- (<see cref="P:ZedGraph.FontSpec.Size"/> property). Units are
- in points (1/72 inch).
- </summary>
- </member>
- <member name="F:ZedGraph.Scale.Default.FontColor">
- <summary>
- The default font color for the <see cref="T:ZedGraph.Axis"/> scale values
- font specification <see cref="P:ZedGraph.Scale.FontSpec"/>
- (<see cref="P:ZedGraph.FontSpec.FontColor"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.Scale.Default.FontBold">
- <summary>
- The default font bold mode for the <see cref="T:ZedGraph.Axis"/> scale values
- font specification <see cref="P:ZedGraph.Scale.FontSpec"/>
- (<see cref="P:ZedGraph.FontSpec.IsBold"/> property). true
- for a bold typeface, false otherwise.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale.Default.FontItalic">
- <summary>
- The default font italic mode for the <see cref="T:ZedGraph.Axis"/> scale values
- font specification <see cref="P:ZedGraph.Scale.FontSpec"/>
- (<see cref="P:ZedGraph.FontSpec.IsItalic"/> property). true
- for an italic typeface, false otherwise.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale.Default.FontUnderline">
- <summary>
- The default font underline mode for the <see cref="T:ZedGraph.Axis"/> scale values
- font specification <see cref="P:ZedGraph.Scale.FontSpec"/>
- (<see cref="P:ZedGraph.FontSpec.IsUnderline"/> property). true
- for an underlined typeface, false otherwise.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale.Default.FillColor">
- <summary>
- The default color for filling in the scale text background
- (see <see cref="P:ZedGraph.Fill.Color"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.Scale.Default.FillBrush">
- <summary>
- The default custom brush for filling in the scale text background
- (see <see cref="P:ZedGraph.Fill.Brush"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.Scale.Default.FillType">
- <summary>
- The default fill mode for filling in the scale text background
- (see <see cref="P:ZedGraph.Fill.Type"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.Scale.Default.IsVisible">
- <summary>
- The default value for <see cref="F:ZedGraph.Scale.Default.IsVisible"/>, which determines
- whether or not the scale values are displayed.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale.Default.IsLabelsInside">
- <summary>
- The default value for <see cref="F:ZedGraph.Scale.Default.IsLabelsInside"/>, which determines
- whether or not the scale labels and title for the <see cref="T:ZedGraph.Axis"/> will appear
- on the opposite side of the <see cref="T:ZedGraph.Axis"/> that it normally appears.
- </summary>
- </member>
- <member name="F:ZedGraph.Scale.Default.EdgeTolerance">
- <summary>
- Determines the size of the band at the beginning and end of the axis that will have labels
- omitted if the axis is shifted due to a non-default location using the <see cref="P:ZedGraph.Axis.Cross"/>
- property.
- </summary>
- <remarks>
- This parameter applies only when <see cref="P:ZedGraph.Axis.CrossAuto"/> is false. It is scaled according
- to the size of the graph based on <see cref="P:ZedGraph.PaneBase.BaseDimension"/>. When a non-default
- axis location is selected, the first and last labels on that axis will overlap the opposing
- axis frame. This parameter allows those labels to be omitted to avoid the overlap. Set this
- parameter to zero to turn off the effect.
- </remarks>
- </member>
- <member name="F:ZedGraph.Scale.Default.LabelGap">
- <summary>
- The default setting for the gap between the outside tics (or the axis edge
- if there are no outside tics) and the scale labels, expressed as a fraction of
- the major tic size.
- </summary>
- </member>
- <member name="T:ZedGraph.MinorGrid">
- <summary>
- Class that holds the specific properties for the minor grid.
- </summary>
- <author> John Champion </author>
- <version> $Revision: 3.1 $ $Date: 2006-06-24 20:26:44 $ </version>
- </member>
- <member name="F:ZedGraph.MinorGrid.schema">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="M:ZedGraph.MinorGrid.#ctor">
- <summary>
- Default constructor
- </summary>
- </member>
- <member name="M:ZedGraph.MinorGrid.#ctor(ZedGraph.MinorGrid)">
- <summary>
- Copy constructor
- </summary>
- <param name="rhs">The source <see cref="T:ZedGraph.MinorGrid"/> to be copied.</param>
- </member>
- <member name="M:ZedGraph.MinorGrid.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.MinorGrid.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.MinorGrid.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.MinorGrid.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.MinorGrid.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="P:ZedGraph.MinorGrid.IsVisible">
- <summary>
- Gets or sets a value that determines if the major <see cref="T:ZedGraph.Axis"/> gridlines
- (at each labeled value) will be visible
- </summary>
- <value>true to show the gridlines, false otherwise</value>
- <seealso cref="F:ZedGraph.MinorGrid.Default.IsVisible">Default.IsShowGrid</seealso>.
- <seealso cref="P:ZedGraph.MinorGrid.Color"/>
- <seealso cref="P:ZedGraph.MinorGrid.PenWidth"/>
- <seealso cref="P:ZedGraph.MinorGrid.DashOn"/>
- <seealso cref="P:ZedGraph.MinorGrid.DashOff"/>
- <seealso cref="P:ZedGraph.MinorGrid.IsVisible"/>
- </member>
- <member name="P:ZedGraph.MinorGrid.DashOn">
- <summary>
- The "Dash On" mode for drawing the grid.
- </summary>
- <remarks>
- This is the distance,
- in points (1/72 inch), of the dash segments that make up the dashed grid lines.
- </remarks>
- <value>The dash on length is defined in points (1/72 inch)</value>
- <seealso cref="P:ZedGraph.MinorGrid.DashOff"/>
- <seealso cref="P:ZedGraph.MinorGrid.IsVisible"/>
- <seealso cref="F:ZedGraph.MinorGrid.Default.DashOn"/>.
- </member>
- <member name="P:ZedGraph.MinorGrid.DashOff">
- <summary>
- The "Dash Off" mode for drawing the grid.
- </summary>
- <remarks>
- This is the distance,
- in points (1/72 inch), of the spaces between the dash segments that make up
- the dashed grid lines.
- </remarks>
- <value>The dash off length is defined in points (1/72 inch)</value>
- <seealso cref="P:ZedGraph.MinorGrid.DashOn"/>
- <seealso cref="P:ZedGraph.MinorGrid.IsVisible"/>
- <seealso cref="F:ZedGraph.MinorGrid.Default.DashOff"/>.
- </member>
- <member name="P:ZedGraph.MinorGrid.PenWidth">
- <summary>
- The pen width used for drawing the grid lines.
- </summary>
- <value>The grid pen width is defined in points (1/72 inch)</value>
- <seealso cref="P:ZedGraph.MinorGrid.IsVisible"/>
- <seealso cref="F:ZedGraph.MinorGrid.Default.PenWidth"/>.
- <seealso cref="P:ZedGraph.MinorGrid.Color"/>
- </member>
- <member name="P:ZedGraph.MinorGrid.Color">
- <summary>
- The color to use for drawing this <see cref="T:ZedGraph.Axis"/> grid.
- </summary>
- <value> The color is defined using the
- <see cref="T:System.Drawing.Color"/> class</value>
- <seealso cref="F:ZedGraph.MinorGrid.Default.Color"/>.
- <seealso cref="P:ZedGraph.MinorGrid.PenWidth"/>
- </member>
- <member name="T:ZedGraph.MinorGrid.Default">
- <summary>
- A simple struct that defines the
- default property values for the <see cref="T:ZedGraph.MinorGrid"/> class.
- </summary>
- </member>
- <member name="F:ZedGraph.MinorGrid.Default.DashOn">
- <summary>
- The default "dash on" size for drawing the <see cref="T:ZedGraph.Axis"/> minor grid
- (<see cref="P:ZedGraph.MinorGrid.DashOn"/> property). Units are in points (1/72 inch).
- </summary>
- </member>
- <member name="F:ZedGraph.MinorGrid.Default.DashOff">
- <summary>
- The default "dash off" size for drawing the <see cref="T:ZedGraph.Axis"/> minor grid
- (<see cref="P:ZedGraph.MinorGrid.DashOff"/> property). Units are in points (1/72 inch).
- </summary>
- </member>
- <member name="F:ZedGraph.MinorGrid.Default.PenWidth">
- <summary>
- The default pen width for drawing the <see cref="T:ZedGraph.Axis"/> minor grid
- (<see cref="P:ZedGraph.MinorGrid.PenWidth"/> property). Units are in points (1/72 inch).
- </summary>
- </member>
- <member name="F:ZedGraph.MinorGrid.Default.Color">
- <summary>
- The default color for the <see cref="T:ZedGraph.Axis"/> minor grid lines
- (<see cref="P:ZedGraph.MinorGrid.Color"/> property). This color only affects the
- minor grid lines.
- </summary>
- </member>
- <member name="F:ZedGraph.MinorGrid.Default.IsVisible">
- <summary>
- The default display mode for the <see cref="T:ZedGraph.Axis"/> minor grid lines
- (<see cref="P:ZedGraph.MinorGrid.IsVisible"/> property). true
- to show the minor grid lines, false to hide them.
- </summary>
- </member>
- <member name="T:ZedGraph.Location">
- <summary>
- A class than contains information about the position of an object on the graph.
- </summary>
-
- <author> John Champion </author>
- <version> $Revision: 3.14 $ $Date: 2006-06-24 20:26:43 $ </version>
- </member>
- <member name="F:ZedGraph.Location.schema">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="F:ZedGraph.Location._alignV">
- <summary> Private field to store the vertical alignment property for
- this object. Use the public property <see cref="P:ZedGraph.Location.AlignV"/>
- to access this value. The value of this field is a <see cref="P:ZedGraph.Location.AlignV"/> enum.
- </summary>
- </member>
- <member name="F:ZedGraph.Location._alignH">
- <summary> Private field to store the horizontal alignment property for
- this object. Use the public property <see cref="P:ZedGraph.Location.AlignH"/>
- to access this value. The value of this field is a <see cref="P:ZedGraph.Location.AlignH"/> enum.
- </summary>
- </member>
- <member name="F:ZedGraph.Location._x">
- <summary> Private fields to store the X and Y coordinate positions for
- this object. Use the public properties <see cref="P:ZedGraph.Location.X"/> and
- <see cref="P:ZedGraph.Location.Y"/> to access these values. The coordinate type stored here is
- dependent upon the setting of <see cref="P:ZedGraph.Location.CoordinateFrame"/>.
- </summary>
- </member>
- <member name="F:ZedGraph.Location._y">
- <summary> Private fields to store the X and Y coordinate positions for
- this object. Use the public properties <see cref="P:ZedGraph.Location.X"/> and
- <see cref="P:ZedGraph.Location.Y"/> to access these values. The coordinate type stored here is
- dependent upon the setting of <see cref="P:ZedGraph.Location.CoordinateFrame"/>.
- </summary>
- </member>
- <member name="F:ZedGraph.Location._width">
- <summary> Private fields to store the X and Y coordinate positions for
- this object. Use the public properties <see cref="P:ZedGraph.Location.X"/> and
- <see cref="P:ZedGraph.Location.Y"/> to access these values. The coordinate type stored here is
- dependent upon the setting of <see cref="P:ZedGraph.Location.CoordinateFrame"/>.
- </summary>
- </member>
- <member name="F:ZedGraph.Location._height">
- <summary> Private fields to store the X and Y coordinate positions for
- this object. Use the public properties <see cref="P:ZedGraph.Location.X"/> and
- <see cref="P:ZedGraph.Location.Y"/> to access these values. The coordinate type stored here is
- dependent upon the setting of <see cref="P:ZedGraph.Location.CoordinateFrame"/>.
- </summary>
- </member>
- <member name="F:ZedGraph.Location._coordinateFrame">
- <summary>
- Private field to store the coordinate system to be used for defining the
- object position. Use the public property
- <see cref="P:ZedGraph.Location.CoordinateFrame"/> to access this value. The coordinate system
- is defined with the <see cref="T:ZedGraph.CoordType"/> enum.
- </summary>
- </member>
- <member name="M:ZedGraph.Location.#ctor">
- <summary>
- Default constructor for the <see cref="T:ZedGraph.Location"/> class.
- </summary>
- </member>
- <member name="M:ZedGraph.Location.#ctor(System.Double,System.Double,ZedGraph.CoordType)">
- <summary>
- Constructor for the <see cref="T:ZedGraph.Location"/> class that specifies the
- x, y position and the <see cref="T:ZedGraph.CoordType"/>.
- </summary>
- <remarks>
- The (x,y) position corresponds to the top-left corner;
- </remarks>
- <param name="x">The x position, specified in units of <see paramref="coordType"/>.
- </param>
- <param name="y">The y position, specified in units of <see paramref="coordType"/>.
- </param>
- <param name="coordType">The <see cref="T:ZedGraph.CoordType"/> enum that specifies the
- units for <see paramref="x"/> and <see paramref="y"/></param>
- </member>
- <member name="M:ZedGraph.Location.#ctor(System.Double,System.Double,ZedGraph.CoordType,ZedGraph.AlignH,ZedGraph.AlignV)">
- <summary>
- Constructor for the <see cref="T:ZedGraph.Location"/> class that specifies the
- x, y position and the <see cref="T:ZedGraph.CoordType"/>.
- </summary>
- <remarks>
- The (x,y) position corresponds to the top-left corner;
- </remarks>
- <param name="x">The x position, specified in units of <see paramref="coordType"/>.
- </param>
- <param name="y">The y position, specified in units of <see paramref="coordType"/>.
- </param>
- <param name="coordType">The <see cref="T:ZedGraph.CoordType"/> enum that specifies the
- units for <see paramref="x"/> and <see paramref="y"/></param>
- <param name="alignH">The <see cref="T:ZedGraph.AlignH"/> enum that specifies
- the horizontal alignment of the object with respect to the (x,y) location</param>
- <param name="alignV">The <see cref="T:ZedGraph.AlignV"/> enum that specifies
- the vertical alignment of the object with respect to the (x,y) location</param>
- </member>
- <member name="M:ZedGraph.Location.#ctor(System.Double,System.Double,System.Double,System.Double,ZedGraph.CoordType,ZedGraph.AlignH,ZedGraph.AlignV)">
- <summary>
- Constructor for the <see cref="T:ZedGraph.Location"/> class that specifies the
- (x, y), (width, height), and the <see cref="T:ZedGraph.CoordType"/>.
- </summary>
- <remarks>
- The (x,y) position
- corresponds to the starting position, the (x2, y2) coorresponds to the ending position
- (typically used for <see cref="T:ZedGraph.ArrowObj"/>'s).
- </remarks>
- <param name="x">The x position, specified in units of <see paramref="coordType"/>.
- </param>
- <param name="y">The y position, specified in units of <see paramref="coordType"/>.
- </param>
- <param name="width">The width, specified in units of <see paramref="coordType"/>.
- </param>
- <param name="height">The height, specified in units of <see paramref="coordType"/>.
- </param>
- <param name="coordType">The <see cref="T:ZedGraph.CoordType"/> enum that specifies the
- units for <see paramref="x"/> and <see paramref="y"/></param>
- <param name="alignH">The <see cref="T:ZedGraph.AlignH"/> enum that specifies
- the horizontal alignment of the object with respect to the (x,y) location</param>
- <param name="alignV">The <see cref="T:ZedGraph.AlignV"/> enum that specifies
- the vertical alignment of the object with respect to the (x,y) location</param>
- </member>
- <member name="M:ZedGraph.Location.#ctor(ZedGraph.Location)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.Location"/> object from which to copy</param>
- </member>
- <member name="M:ZedGraph.Location.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.Location.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.Location.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.Location.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.Location.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.Location.Transform(ZedGraph.PaneBase)">
- <summary>
- Transform this <see cref="T:ZedGraph.Location"/> object to display device
- coordinates using the properties of the specified <see cref="T:ZedGraph.GraphPane"/>.
- </summary>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.PaneBase"/> object that contains
- the <see cref="T:ZedGraph.Axis"/> classes which will be used for the transform.
- </param>
- <returns>A point in display device coordinates that corresponds to the
- specified user point.</returns>
- </member>
- <member name="M:ZedGraph.Location.Transform(ZedGraph.PaneBase,System.Double,System.Double,ZedGraph.CoordType)">
- <summary>
- Transform a data point from the specified coordinate type
- (<see cref="T:ZedGraph.CoordType"/>) to display device coordinates (pixels).
- </summary>
- <remarks>
- If <see paramref="pane"/> is not of type <see cref="T:ZedGraph.GraphPane"/>, then
- only the <see cref="F:ZedGraph.CoordType.PaneFraction"/> transformation is available.
- </remarks>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.PaneBase"/> object that contains
- the <see cref="T:ZedGraph.Axis"/> classes which will be used for the transform.
- </param>
- <param name="x">The x coordinate that defines the point in user
- space.</param>
- <param name="y">The y coordinate that defines the point in user
- space.</param>
- <param name="coord">A <see cref="T:ZedGraph.CoordType"/> type that defines the
- coordinate system in which the X,Y pair is defined.</param>
- <returns>A point in display device coordinates that corresponds to the
- specified user point.</returns>
- </member>
- <member name="M:ZedGraph.Location.TransformTopLeft(ZedGraph.PaneBase,System.Single,System.Single)">
- <summary>
- Transform this <see cref="T:ZedGraph.Location"/> from the coordinate system
- as specified by <see cref="P:ZedGraph.Location.CoordinateFrame"/> to the device coordinates
- of the specified <see cref="T:ZedGraph.PaneBase"/> object.
- </summary>
- <remarks>
- The returned
- <see cref="T:System.Drawing.PointF"/> struct represents the top-left corner of the
- object that honors the <see cref="T:ZedGraph.Location"/> properties.
- The <see cref="P:ZedGraph.Location.AlignH"/> and <see cref="P:ZedGraph.Location.AlignV"/> properties are honored in
- this transformation.
- </remarks>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.PaneBase"/> object that contains
- the <see cref="T:ZedGraph.Axis"/> classes which will be used for the transform.
- </param>
- <param name="width">The width of the object in device pixels</param>
- <param name="height">The height of the object in device pixels</param>
- <returns>The top-left corner of the object</returns>
- </member>
- <member name="M:ZedGraph.Location.TransformTopLeft(ZedGraph.PaneBase)">
- <summary>
- The <see cref="T:System.Drawing.PointF"/> for this object as defined by the
- <see cref="P:ZedGraph.Location.X"/> and <see cref="P:ZedGraph.Location.Y"/>
- properties.
- </summary>
- <remarks>
- This method transforms the location to output device pixel units.
- The <see cref="P:ZedGraph.Location.AlignH"/> and <see cref="P:ZedGraph.Location.AlignV"/> properties are ignored for
- this transformation (see <see cref="M:ZedGraph.Location.TransformTopLeft(ZedGraph.PaneBase,System.Single,System.Single)"/>).
- </remarks>
- <value>A <see cref="T:System.Drawing.PointF"/> in pixel units.</value>
- </member>
- <member name="M:ZedGraph.Location.TransformBottomRight(ZedGraph.PaneBase)">
- <summary>
- The <see cref="T:System.Drawing.PointF"/> for this object as defined by the
- <see cref="P:ZedGraph.Location.X2"/> and <see cref="P:ZedGraph.Location.Y2"/> properties.
- </summary>
- <remarks>
- This method transforms the location to output device pixel units.
- The <see cref="P:ZedGraph.Location.AlignH"/> and <see cref="P:ZedGraph.Location.AlignV"/> properties are ignored for
- this transformation (see <see cref="M:ZedGraph.Location.TransformTopLeft(ZedGraph.PaneBase,System.Single,System.Single)"/>).
- </remarks>
- <value>A <see cref="T:System.Drawing.PointF"/> in pixel units.</value>
- </member>
- <member name="M:ZedGraph.Location.TransformRect(ZedGraph.PaneBase)">
- <summary>
- Transform the <see cref="T:System.Drawing.RectangleF"/> for this object as defined by the
- <see cref="P:ZedGraph.Location.X"/>, <see cref="P:ZedGraph.Location.Y"/>, <see cref="P:ZedGraph.Location.Width"/>, and
- <see cref="P:ZedGraph.Location.Height"/> properties.
- </summary>
- <remarks>
- This method transforms the location to output device pixel units.
- The <see cref="P:ZedGraph.Location.AlignH"/> and <see cref="P:ZedGraph.Location.AlignV"/> properties are honored in
- this transformation.
- </remarks>
- <value>A <see cref="T:System.Drawing.RectangleF"/> in pixel units.</value>
- </member>
- <member name="P:ZedGraph.Location.AlignH">
- <summary>
- A horizontal alignment parameter for this object specified
- using the <see cref="P:ZedGraph.Location.AlignH"/> enum type.
- </summary>
- </member>
- <member name="P:ZedGraph.Location.AlignV">
- <summary>
- A vertical alignment parameter for this object specified
- using the <see cref="P:ZedGraph.Location.AlignV"/> enum type.
- </summary>
- </member>
- <member name="P:ZedGraph.Location.CoordinateFrame">
- <summary>
- The coordinate system to be used for defining the object position
- </summary>
- <value> The coordinate system is defined with the <see cref="T:ZedGraph.CoordType"/>
- enum</value>
- </member>
- <member name="P:ZedGraph.Location.X">
- <summary>
- The x position of the object.
- </summary>
- <remarks>
- The units of this position
- are specified by the <see cref="P:ZedGraph.Location.CoordinateFrame"/> property.
- The object will be aligned to this position based on the
- <see cref="P:ZedGraph.Location.AlignH"/> property.
- </remarks>
- </member>
- <member name="P:ZedGraph.Location.Y">
- <summary>
- The y position of the object.
- </summary>
- <remarks>
- The units of this position
- are specified by the <see cref="P:ZedGraph.Location.CoordinateFrame"/> property.
- The object will be aligned to this position based on the
- <see cref="P:ZedGraph.Location.AlignV"/> property.
- </remarks>
- </member>
- <member name="P:ZedGraph.Location.X1">
- <summary>
- The x1 position of the object (an alias for the x position).
- </summary>
- <remarks>
- The units of this position
- are specified by the <see cref="P:ZedGraph.Location.CoordinateFrame"/> property.
- The object will be aligned to this position based on the
- <see cref="P:ZedGraph.Location.AlignH"/> property.
- </remarks>
- </member>
- <member name="P:ZedGraph.Location.Y1">
- <summary>
- The y1 position of the object (an alias for the y position).
- </summary>
- <remarks>
- The units of this position
- are specified by the <see cref="P:ZedGraph.Location.CoordinateFrame"/> property.
- The object will be aligned to this position based on the
- <see cref="P:ZedGraph.Location.AlignV"/> property.
- </remarks>
- </member>
- <member name="P:ZedGraph.Location.Width">
- <summary>
- The width of the object.
- </summary>
- <remarks>
- The units of this position are specified by the
- <see cref="P:ZedGraph.Location.CoordinateFrame"/> property.
- </remarks>
- </member>
- <member name="P:ZedGraph.Location.Height">
- <summary>
- The height of the object.
- </summary>
- <remarks>
- The units of this position are specified by the
- <see cref="P:ZedGraph.Location.CoordinateFrame"/> property.
- </remarks>
- </member>
- <member name="P:ZedGraph.Location.X2">
- <summary>
- The x2 position of the object.
- </summary>
- <remarks>
- The units of this position are specified by the
- <see cref="P:ZedGraph.Location.CoordinateFrame"/> property.
- The object will be aligned to this position based on the
- <see cref="P:ZedGraph.Location.AlignH"/> property. This position is only used for
- objects such as <see cref="T:ZedGraph.ArrowObj"/>, where it makes sense
- to have a second coordinate. Note that the X2 position is stored
- internally as a <see cref="P:ZedGraph.Location.Width"/> offset from <see cref="P:ZedGraph.Location.X"/>.
- </remarks>
- </member>
- <member name="P:ZedGraph.Location.Y2">
- <summary>
- The y2 position of the object.
- </summary>
- <remarks>
- The units of this position
- are specified by the <see cref="P:ZedGraph.Location.CoordinateFrame"/> property.
- The object will be aligned to this position based on the
- <see cref="P:ZedGraph.Location.AlignV"/> property. This position is only used for
- objects such as <see cref="T:ZedGraph.ArrowObj"/>, where it makes sense
- to have a second coordinate. Note that the Y2 position is stored
- internally as a <see cref="P:ZedGraph.Location.Height"/> offset from <see cref="P:ZedGraph.Location.Y"/>.
- </remarks>
- </member>
- <member name="P:ZedGraph.Location.Rect">
- <summary>
- The <see cref="T:System.Drawing.RectangleF"/> for this object as defined by the
- <see cref="P:ZedGraph.Location.X"/>, <see cref="P:ZedGraph.Location.Y"/>, <see cref="P:ZedGraph.Location.Width"/>, and
- <see cref="P:ZedGraph.Location.Height"/> properties.
- </summary>
- <remarks>
- Note that this method reduces the precision of the location coordinates from double
- precision to single precision. In some cases, such as <see cref="F:ZedGraph.AxisType.Date"/>, it
- may affect the resolution of the point location.
- </remarks>
- <value>A <see cref="T:System.Drawing.RectangleF"/> in <see cref="P:ZedGraph.Location.CoordinateFrame"/>
- units.</value>
- </member>
- <member name="P:ZedGraph.Location.TopLeft">
- <summary>
- The top-left <see cref="T:System.Drawing.PointF"/> for this <see cref="T:ZedGraph.Location"/>.
- </summary>
- <remarks>
- Note that this method reduces the precision of the location coordinates from double
- precision to single precision. In some cases, such as <see cref="F:ZedGraph.AxisType.Date"/>, it
- may affect the resolution of the point location.
- </remarks>
- <value>A <see cref="T:System.Drawing.PointF"/> in <see cref="P:ZedGraph.Location.CoordinateFrame"/> units.</value>
- </member>
- <member name="P:ZedGraph.Location.BottomRight">
- <summary>
- The bottom-right <see cref="T:System.Drawing.PointF"/> for this <see cref="T:ZedGraph.Location"/>.
- </summary>
- <remarks>
- Note that this method reduces the precision of the location coordinates from double
- precision to single precision. In some cases, such as <see cref="F:ZedGraph.AxisType.Date"/>, it
- may affect the resolution of the point location.
- </remarks>
- <value>A <see cref="T:System.Drawing.PointF"/> in <see cref="P:ZedGraph.Location.CoordinateFrame"/> units.</value>
- </member>
- <member name="T:ZedGraph.JapaneseCandleStick">
- <summary>
- This class handles the drawing of the curve <see cref="T:ZedGraph.JapaneseCandleStick"/> objects.
- </summary>
-
- <author> John Champion </author>
- <version> $Revision: 3.10 $ $Date: 2007-04-16 00:03:02 $ </version>
- </member>
- <member name="T:ZedGraph.OHLCBar">
- <summary>
- This class handles the drawing of the curve <see cref="T:ZedGraph.OHLCBar"/> objects.
- </summary>
-
- <author> John Champion </author>
- <version> $Revision: 3.5 $ $Date: 2007-04-16 00:03:02 $ </version>
- </member>
- <member name="F:ZedGraph.OHLCBar.schema">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="F:ZedGraph.OHLCBar._isOpenCloseVisible">
- <summary>
- Private field that stores the visibility of the <see cref="T:ZedGraph.OHLCBar"/> open and
- close line segments ("wings"). Use the public
- property <see cref="P:ZedGraph.OHLCBar.IsOpenCloseVisible"/> to access this value. If this value is
- false, the wings will not be shown.
- </summary>
- </member>
- <member name="F:ZedGraph.OHLCBar._size">
- <summary>
- Private field that stores the total width for the Opening/Closing line
- segments. Use the public property <see cref="P:ZedGraph.OHLCBar.Size"/> to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.OHLCBar._isAutoSize">
- <summary>
- Private field that determines if the <see cref="P:ZedGraph.OHLCBar.Size"/> property will be
- calculated automatically based on the minimum axis scale step size between
- bars. Use the public property <see cref="P:ZedGraph.OHLCBar.IsAutoSize"/> to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.OHLCBar._userScaleSize">
- <summary>
- The result of the autosize calculation, which is the size of the bars in
- user scale units. This is converted to pixels at draw time.
- </summary>
- </member>
- <member name="M:ZedGraph.OHLCBar.#ctor">
- <summary>
- Default constructor that sets all <see cref="T:ZedGraph.OHLCBar"/> properties to
- default values as defined in the <see cref="T:ZedGraph.OHLCBar.Default"/> class.
- </summary>
- </member>
- <member name="M:ZedGraph.OHLCBar.#ctor(System.Drawing.Color)">
- <summary>
- Default constructor that sets the
- <see cref="T:System.Drawing.Color"/> as specified, and the remaining
- <see cref="T:ZedGraph.OHLCBar"/> properties to default
- values as defined in the <see cref="T:ZedGraph.OHLCBar.Default"/> class.
- </summary>
- <param name="color">A <see cref="T:System.Drawing.Color"/> value indicating
- the color of the symbol
- </param>
- </member>
- <member name="M:ZedGraph.OHLCBar.#ctor(ZedGraph.OHLCBar)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.OHLCBar"/> object from which to copy</param>
- </member>
- <member name="M:ZedGraph.OHLCBar.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.OHLCBar.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.OHLCBar.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.OHLCBar.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.OHLCBar.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.OHLCBar.Draw(System.Drawing.Graphics,ZedGraph.GraphPane,System.Boolean,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Drawing.Pen)">
- <summary>
- Draw the <see cref="T:ZedGraph.OHLCBar"/> to the specified <see cref="T:System.Drawing.Graphics"/>
- device at the specified location.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="isXBase">boolean value that indicates if the "base" axis for this
- <see cref="T:ZedGraph.OHLCBar"/> is the X axis. True for an <see cref="T:ZedGraph.XAxis"/> base,
- false for a <see cref="T:ZedGraph.YAxis"/> or <see cref="T:ZedGraph.Y2Axis"/> base.</param>
- <param name="pixBase">The independent axis position of the center of the candlestick in
- pixel units</param>
- <param name="pixHigh">The dependent axis position of the top of the candlestick in
- pixel units</param>
- <param name="pixLow">The dependent axis position of the bottom of the candlestick in
- pixel units</param>
- <param name="pixOpen">The dependent axis position of the opening value of the candlestick in
- pixel units</param>
- <param name="pixClose">The dependent axis position of the closing value of the candlestick in
- pixel units</param>
- <param name="halfSize">
- The scaled width of the candlesticks, pixels</param>
- <param name="pen">A pen with attributes of <see cref="T:System.Drawing.Color"/> and
- <see cref="P:ZedGraph.LineBase.Width"/> for this <see cref="T:ZedGraph.OHLCBar"/></param>
- </member>
- <member name="M:ZedGraph.OHLCBar.Draw(System.Drawing.Graphics,ZedGraph.GraphPane,ZedGraph.OHLCBarItem,ZedGraph.Axis,ZedGraph.Axis,System.Single)">
- <summary>
- Draw all the <see cref="T:ZedGraph.OHLCBar"/>'s to the specified <see cref="T:System.Drawing.Graphics"/>
- device as a candlestick at each defined point.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="curve">A <see cref="T:ZedGraph.OHLCBarItem"/> object representing the
- <see cref="T:ZedGraph.OHLCBar"/>'s to be drawn.</param>
- <param name="baseAxis">The <see cref="T:ZedGraph.Axis"/> class instance that defines the base (independent)
- axis for the <see cref="T:ZedGraph.OHLCBar"/></param>
- <param name="valueAxis">The <see cref="T:ZedGraph.Axis"/> class instance that defines the value (dependent)
- axis for the <see cref="T:ZedGraph.OHLCBar"/></param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.OHLCBar.GetBarWidth(ZedGraph.GraphPane,ZedGraph.Axis,System.Single)">
- <summary>
- Returns the width of the candleStick, in pixels, based on the settings for
- <see cref="P:ZedGraph.OHLCBar.Size"/> and <see cref="P:ZedGraph.OHLCBar.IsAutoSize"/>.
- </summary>
- <param name="pane">The parent <see cref="T:ZedGraph.GraphPane"/> object.</param>
- <param name="baseAxis">The <see cref="T:ZedGraph.Axis"/> object that
- represents the bar base (independent axis).</param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <returns>The width of each bar, in pixel units</returns>
- </member>
- <member name="P:ZedGraph.OHLCBar.IsOpenCloseVisible">
- <summary>
- Gets or sets a property that shows or hides the <see cref="T:ZedGraph.OHLCBar"/> open/close "wings".
- </summary>
- <value>true to show the CandleStick wings, false to hide them</value>
- <seealso cref="F:ZedGraph.OHLCBar.Default.IsOpenCloseVisible"/>
- </member>
- <member name="P:ZedGraph.OHLCBar.Size">
- <summary>
- Gets or sets the total width to be used for drawing the opening/closing line
- segments ("wings") of the <see cref="T:ZedGraph.OHLCBar"/> items. Units are points.
- </summary>
- <remarks>The size of the candlesticks can be set by this value, which
- is then scaled according to the scaleFactor (see
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/>). Alternatively,
- if <see cref="P:ZedGraph.OHLCBar.IsAutoSize"/> is true, the bar width will
- be set according to the maximum available cluster width less
- the cluster gap (see <see cref="M:ZedGraph.BarSettings.GetClusterWidth"/>
- and <see cref="P:ZedGraph.BarSettings.MinClusterGap"/>). That is, if
- <see cref="P:ZedGraph.OHLCBar.IsAutoSize"/> is true, then the value of
- <see cref="P:ZedGraph.OHLCBar.Size"/> will be ignored. If you modify the value of Size,
- then <see cref="P:ZedGraph.OHLCBar.IsAutoSize"/> will be automatically set to false.
- </remarks>
- <value>Size in points (1/72 inch)</value>
- <seealso cref="F:ZedGraph.OHLCBar.Default.Size"/>
- </member>
- <member name="P:ZedGraph.OHLCBar.IsAutoSize">
- <summary>
- Gets or sets a value that determines if the <see cref="P:ZedGraph.OHLCBar.Size"/> property will be
- calculated automatically based on the minimum axis scale step size between
- bars.
- </summary>
- </member>
- <member name="T:ZedGraph.OHLCBar.Default">
- <summary>
- A simple struct that defines the
- default property values for the <see cref="T:ZedGraph.OHLCBar"/> class.
- </summary>
- </member>
- <member name="F:ZedGraph.OHLCBar.Default.Size">
- <summary>
- The default width for the candlesticks (see <see cref="P:ZedGraph.OHLCBar.Size"/>),
- in units of points.
- </summary>
- </member>
- <member name="F:ZedGraph.OHLCBar.Default.IsOpenCloseVisible">
- <summary>
- The default display mode for symbols (<see cref="P:ZedGraph.OHLCBar.IsOpenCloseVisible"/> property).
- true to display symbols, false to hide them.
- </summary>
- </member>
- <member name="F:ZedGraph.OHLCBar.Default.IsAutoSize">
- <summary>
- The default value for the <see cref="P:ZedGraph.OHLCBar.IsAutoSize"/> property.
- </summary>
- </member>
- <member name="F:ZedGraph.JapaneseCandleStick.schema2">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="F:ZedGraph.JapaneseCandleStick._risingFill">
- <summary>
- Private field to store the <see cref="T:ZedGraph.Fill"/> class to be used for filling the
- candlestick "bars" when the <see cref="F:ZedGraph.StockPt.Close"/> value is greater than
- the <see cref="F:ZedGraph.StockPt.Open"/> value. See the public property
- <see cref="P:ZedGraph.JapaneseCandleStick.RisingFill"/> to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.JapaneseCandleStick._fallingFill">
- <summary>
- Private field to store the <see cref="T:ZedGraph.Fill"/> class to be used for filling the
- candlestick "bars" when the <see cref="F:ZedGraph.StockPt.Close"/> value is less than
- the <see cref="F:ZedGraph.StockPt.Open"/> value. See the public property
- <see cref="P:ZedGraph.JapaneseCandleStick.FallingFill"/> to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.JapaneseCandleStick._risingBorder">
- <summary>
- Private field to store the <see cref="T:ZedGraph.Border"/> class to be used for drawing the
- candlestick "bars" when the <see cref="F:ZedGraph.StockPt.Close"/> value is greater than
- the <see cref="F:ZedGraph.StockPt.Open"/> value. See the public property
- <see cref="P:ZedGraph.JapaneseCandleStick.RisingBorder"/> to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.JapaneseCandleStick._fallingBorder">
- <summary>
- Private field to store the <see cref="T:ZedGraph.Border"/> class to be used for drawing the
- candlestick "bars" when the <see cref="F:ZedGraph.StockPt.Close"/> value is less than
- the <see cref="F:ZedGraph.StockPt.Open"/> value. See the public property
- <see cref="P:ZedGraph.JapaneseCandleStick.FallingBorder"/> to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.JapaneseCandleStick._fallingColor">
- <summary>
- Private field that stores the CandleStick color when the <see cref="F:ZedGraph.StockPt.Close"/>
- value is less than the <see cref="F:ZedGraph.StockPt.Open"/> value. Use the public
- property <see cref="P:ZedGraph.JapaneseCandleStick.FallingColor"/> to access this value.
- </summary>
- </member>
- <member name="M:ZedGraph.JapaneseCandleStick.#ctor">
- <summary>
- Default constructor that sets all <see cref="T:ZedGraph.JapaneseCandleStick"/> properties to
- default values as defined in the <see cref="T:ZedGraph.JapaneseCandleStick.Default"/> class.
- </summary>
- </member>
- <member name="M:ZedGraph.JapaneseCandleStick.#ctor(ZedGraph.JapaneseCandleStick)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.JapaneseCandleStick"/> object from which to copy</param>
- </member>
- <member name="M:ZedGraph.JapaneseCandleStick.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.JapaneseCandleStick.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.JapaneseCandleStick.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.JapaneseCandleStick.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.JapaneseCandleStick.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.JapaneseCandleStick.Draw(System.Drawing.Graphics,ZedGraph.GraphPane,System.Boolean,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Drawing.Pen,ZedGraph.Fill,ZedGraph.Border,ZedGraph.PointPair)">
- <summary>
- Draw the <see cref="T:ZedGraph.JapaneseCandleStick"/> to the specified <see cref="T:System.Drawing.Graphics"/>
- device at the specified location.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="isXBase">boolean value that indicates if the "base" axis for this
- <see cref="T:ZedGraph.JapaneseCandleStick"/> is the X axis. True for an <see cref="T:ZedGraph.XAxis"/> base,
- false for a <see cref="T:ZedGraph.YAxis"/> or <see cref="T:ZedGraph.Y2Axis"/> base.</param>
- <param name="pixBase">The independent axis position of the center of the candlestick in
- pixel units</param>
- <param name="pixHigh">The high value position of the candlestick in
- pixel units</param>
- <param name="pixLow">The low value position of the candlestick in
- pixel units</param>
- <param name="pixOpen">The opening value position of the candlestick in
- pixel units</param>
- <param name="pixClose">The closing value position of the candlestick in
- pixel units</param>
- <param name="halfSize">The scaled width of one-half of a bar, in pixels</param>
- <param name="scaleFactor">
- The scaling factor for the features of the graph based on the <see cref="P:ZedGraph.PaneBase.BaseDimension"/>. This
- scaling factor is calculated by the <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method. The scale factor
- represents a linear multiple to be applied to font sizes, symbol sizes, etc.</param>
- <param name="pen">A pen with the <see cref="T:System.Drawing.Color"/> attribute for this
- <see cref="T:ZedGraph.JapaneseCandleStick"/></param>
- <param name="fill">
- The <see cref="T:ZedGraph.Fill"/> instance to be used for filling this
- <see cref="T:ZedGraph.JapaneseCandleStick"/>
- </param>
- <param name="border">The <see cref="T:ZedGraph.Border"/> instance to be used for drawing the
- border around the <see cref="T:ZedGraph.JapaneseCandleStick"/> filled box</param>
- <param name="pt">The <see cref="T:ZedGraph.PointPair"/> to be used for determining the
- <see cref="T:ZedGraph.Fill"/>, just in case it's a <see cref="F:ZedGraph.FillType.GradientByX"/>,
- <see cref="F:ZedGraph.FillType.GradientByY"/>, or
- <see cref="F:ZedGraph.FillType.GradientByZ"/> <see cref="T:ZedGraph.FillType"/></param>
- </member>
- <member name="M:ZedGraph.JapaneseCandleStick.Draw(System.Drawing.Graphics,ZedGraph.GraphPane,ZedGraph.JapaneseCandleStickItem,ZedGraph.Axis,ZedGraph.Axis,System.Single)">
- <summary>
- Draw all the <see cref="T:ZedGraph.JapaneseCandleStick"/>'s to the specified <see cref="T:System.Drawing.Graphics"/>
- device as a candlestick at each defined point.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="curve">A <see cref="T:ZedGraph.JapaneseCandleStickItem"/> object representing the
- <see cref="T:ZedGraph.JapaneseCandleStick"/>'s to be drawn.</param>
- <param name="baseAxis">The <see cref="T:ZedGraph.Axis"/> class instance that defines the base (independent)
- axis for the <see cref="T:ZedGraph.JapaneseCandleStick"/></param>
- <param name="valueAxis">The <see cref="T:ZedGraph.Axis"/> class instance that defines the value (dependent)
- axis for the <see cref="T:ZedGraph.JapaneseCandleStick"/></param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="P:ZedGraph.JapaneseCandleStick.RisingFill">
- <summary>
- Gets or sets the <see cref="T:ZedGraph.Fill"/> class that is used to fill the candlestick
- "bars" when the <see cref="F:ZedGraph.StockPt.Close"/> value is greater than the
- <see cref="F:ZedGraph.StockPt.Open"/> value.
- </summary>
- </member>
- <member name="P:ZedGraph.JapaneseCandleStick.FallingFill">
- <summary>
- Gets or sets the <see cref="T:ZedGraph.Fill"/> class that is used to fill the candlestick
- "bars" when the <see cref="F:ZedGraph.StockPt.Close"/> value is less than the
- <see cref="F:ZedGraph.StockPt.Open"/> value.
- </summary>
- </member>
- <member name="P:ZedGraph.JapaneseCandleStick.RisingBorder">
- <summary>
- The <see cref="T:ZedGraph.Border"/> instance to be used for drawing the border frame of
- the candlestick "bars" when the <see cref="F:ZedGraph.StockPt.Close"/> value is greater than the
- <see cref="F:ZedGraph.StockPt.Open"/> value.
- </summary>
- </member>
- <member name="P:ZedGraph.JapaneseCandleStick.FallingBorder">
- <summary>
- The <see cref="T:ZedGraph.Border"/> instance to be used for drawing the border frame of
- the candlestick "bars" when the <see cref="F:ZedGraph.StockPt.Close"/> value is less than the
- <see cref="F:ZedGraph.StockPt.Open"/> value.
- </summary>
- </member>
- <member name="P:ZedGraph.JapaneseCandleStick.FallingColor">
- <summary>
- Gets or sets the <see cref="T:System.Drawing.Color"/> data for this
- <see cref="T:ZedGraph.JapaneseCandleStick"/> when the value of the candlestick is
- falling.
- </summary>
- <remarks>This property only controls the color of
- the vertical line when the value is falling. The rising color is controlled
- by the <see cref="P:ZedGraph.LineBase.Color"/> property.
- </remarks>
- </member>
- <member name="T:ZedGraph.JapaneseCandleStick.Default">
- <summary>
- A simple struct that defines the
- default property values for the <see cref="T:ZedGraph.JapaneseCandleStick"/> class.
- </summary>
- </member>
- <member name="F:ZedGraph.JapaneseCandleStick.Default.RisingColor">
- <summary>
- The default fillcolor for drawing the rising case CandleSticks
- (<see cref="P:ZedGraph.JapaneseCandleStick.RisingFill"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.JapaneseCandleStick.Default.FallingColor">
- <summary>
- The default fillcolor for drawing the falling case CandleSticks
- (<see cref="P:ZedGraph.JapaneseCandleStick.FallingFill"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.JapaneseCandleStick.Default.RisingBorder">
- <summary>
- The default color for the border of the rising CandleSticks
- (<see cref="P:ZedGraph.JapaneseCandleStick.RisingBorder"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.JapaneseCandleStick.Default.FallingBorder">
- <summary>
- The default color for the border of the falling CandleSticks
- (<see cref="P:ZedGraph.JapaneseCandleStick.FallingBorder"/> property).
- </summary>
- </member>
- <member name="T:ZedGraph.Y2AxisList">
- <summary>
- A collection class containing a list of <see cref="T:ZedGraph.YAxis"/> objects.
- </summary>
-
- <author>John Champion</author>
- <version> $Revision: 3.3 $ $Date: 2006-06-24 20:26:43 $ </version>
- </member>
- <member name="M:ZedGraph.Y2AxisList.#ctor">
- <summary>
- Default constructor for the collection class.
- </summary>
- </member>
- <member name="M:ZedGraph.Y2AxisList.#ctor(ZedGraph.Y2AxisList)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.Y2AxisList"/> object from which to copy</param>
- </member>
- <member name="M:ZedGraph.Y2AxisList.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.Y2AxisList.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.Y2AxisList.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.Y2AxisList.IndexOf(System.String)">
- <summary>
- Return the zero-based position index of the
- <see cref="T:ZedGraph.Axis"/> with the specified <see cref="P:ZedGraph.Axis.Title"/>.
- </summary>
- <remarks>The comparison of titles is not case sensitive, but it must include
- all characters including punctuation, spaces, etc.</remarks>
- <param name="title">The <see cref="T:System.String"/> label that is in the
- <see cref="P:ZedGraph.Axis.Title"/> attribute of the item to be found.
- </param>
- <returns>The zero-based index of the specified <see cref="T:ZedGraph.Axis"/>,
- or -1 if the <see cref="P:ZedGraph.Axis.Title"/> was not found in the list</returns>
- <seealso cref="M:ZedGraph.Y2AxisList.IndexOfTag(System.String)"/>
- </member>
- <member name="M:ZedGraph.Y2AxisList.IndexOfTag(System.String)">
- <summary>
- Return the zero-based position index of the
- <see cref="T:ZedGraph.Axis"/> with the specified <see cref="F:ZedGraph.Axis.Tag"/>.
- </summary>
- <remarks>In order for this method to work, the <see cref="F:ZedGraph.Axis.Tag"/>
- property must be of type <see cref="T:System.String"/>.</remarks>
- <param name="tagStr">The <see cref="T:System.String"/> tag that is in the
- <see cref="F:ZedGraph.Axis.Tag"/> attribute of the item to be found.
- </param>
- <returns>The zero-based index of the specified <see cref="T:ZedGraph.Axis"/>,
- or -1 if the <see cref="F:ZedGraph.Axis.Tag"/> string is not in the list</returns>
- <seealso cref="M:ZedGraph.Y2AxisList.IndexOf(System.String)"/>
- </member>
- <member name="M:ZedGraph.Y2AxisList.Add(System.String)">
- <summary>
- Create a new <see cref="T:ZedGraph.Y2Axis"/> and add it to this list.
- </summary>
- <param name="title">The title string for the new axis</param>
- <returns>An integer representing the ordinal position of the new <see cref="T:ZedGraph.Y2Axis"/> in
- this <see cref="T:ZedGraph.Y2AxisList"/>. This is the value that you would set the
- <see cref="P:ZedGraph.CurveItem.YAxisIndex"/> property of a given <see cref="T:ZedGraph.CurveItem"/> to
- assign it to this new <see cref="T:ZedGraph.Y2Axis"/>. Note that, for a <see cref="T:ZedGraph.Y2Axis"/>,
- you would also need to set the <see cref="P:ZedGraph.CurveItem.IsY2Axis"/> property to true.</returns>
- </member>
- <member name="P:ZedGraph.Y2AxisList.Item(System.Int32)">
- <summary>
- Indexer to access the specified <see cref="T:ZedGraph.Axis"/> object by
- its ordinal position in the list.
- </summary>
- <param name="index">The ordinal position (zero-based) of the
- <see cref="T:ZedGraph.YAxis"/> object to be accessed.</param>
- <value>An <see cref="T:ZedGraph.Axis"/> object reference.</value>
- </member>
- <member name="P:ZedGraph.Y2AxisList.Item(System.String)">
- <summary>
- Indexer to access the specified <see cref="T:ZedGraph.Axis"/> object by
- its <see cref="P:ZedGraph.Axis.Title"/> string.
- </summary>
- <param name="title">The string title of the
- <see cref="T:ZedGraph.YAxis"/> object to be accessed.</param>
- <value>A <see cref="T:ZedGraph.Axis"/> object reference.</value>
- </member>
- <member name="T:ZedGraph.ScaleStateList">
- <summary>
- A collection class that maintains a list of <see cref="T:ZedGraph.ScaleState"/>
- objects, corresponding to the list of <see cref="T:ZedGraph.Axis"/> objects
- from <see cref="P:ZedGraph.GraphPane.YAxisList"/> or <see cref="P:ZedGraph.GraphPane.Y2AxisList"/>.
- </summary>
- </member>
- <member name="M:ZedGraph.ScaleStateList.#ctor(ZedGraph.YAxisList)">
- <summary>
- Construct a new <see cref="T:ZedGraph.ScaleStateList"/> automatically from an
- existing <see cref="T:ZedGraph.YAxisList"/>.
- </summary>
- <param name="list">The <see cref="T:ZedGraph.YAxisList"/> (a list of Y axes),
- from which to retrieve the state and create the <see cref="T:ZedGraph.ScaleState"/>
- objects.</param>
- </member>
- <member name="M:ZedGraph.ScaleStateList.#ctor(ZedGraph.Y2AxisList)">
- <summary>
- Construct a new <see cref="T:ZedGraph.ScaleStateList"/> automatically from an
- existing <see cref="T:ZedGraph.Y2AxisList"/>.
- </summary>
- <param name="list">The <see cref="T:ZedGraph.Y2AxisList"/> (a list of Y axes),
- from which to retrieve the state and create the <see cref="T:ZedGraph.ScaleState"/>
- objects.</param>
- </member>
- <member name="M:ZedGraph.ScaleStateList.#ctor(ZedGraph.ScaleStateList)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.ScaleStateList"/> object from which to copy</param>
- </member>
- <member name="M:ZedGraph.ScaleStateList.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.ScaleStateList.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.ScaleStateList.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.ScaleStateList.IsChanged(ZedGraph.YAxisList)">
- <summary>
- Iterate through the list of <see cref="T:ZedGraph.ScaleState"/> objects, comparing them
- to the state of the specified <see cref="T:ZedGraph.YAxisList"/> <see cref="T:ZedGraph.Axis"/>
- objects.
- </summary>
- <param name="list">A <see cref="T:ZedGraph.YAxisList"/> object specifying a list of
- <see cref="T:ZedGraph.Axis"/> objects to be compared with this <see cref="T:ZedGraph.ScaleStateList"/>.
- </param>
- <returns>true if a difference is found, false otherwise</returns>
- </member>
- <member name="M:ZedGraph.ScaleStateList.IsChanged(ZedGraph.Y2AxisList)">
- <summary>
- Iterate through the list of <see cref="T:ZedGraph.ScaleState"/> objects, comparing them
- to the state of the specified <see cref="T:ZedGraph.Y2AxisList"/> <see cref="T:ZedGraph.Axis"/>
- objects.
- </summary>
- <param name="list">A <see cref="T:ZedGraph.Y2AxisList"/> object specifying a list of
- <see cref="T:ZedGraph.Axis"/> objects to be compared with this <see cref="T:ZedGraph.ScaleStateList"/>.
- </param>
- <returns>true if a difference is found, false otherwise</returns>
- </member>
- <member name="M:ZedGraph.ScaleStateList.ApplyScale(ZedGraph.YAxisList)">
- <summary>
-
- </summary>
- <param name="list"></param>
- </member>
- <member name="M:ZedGraph.ScaleStateList.ApplyScale(ZedGraph.Y2AxisList)">
- <summary>
-
- </summary>
- <param name="list"></param>
- </member>
- <member name="T:ZedGraph.MasterPane">
- <summary>
- A collection class containing a list of <see cref="T:ZedGraph.GraphPane"/> objects
- organized together in some form.
- </summary>
-
- <author>John Champion</author>
- <version> $Revision: 3.26 $ $Date: 2007-11-05 18:28:56 $ </version>
- </member>
- <member name="T:ZedGraph.PaneBase">
- <summary>
- An abstract base class that defines basic functionality for handling a pane. This class is the
- parent class for <see cref="T:ZedGraph.MasterPane"/> and <see cref="T:ZedGraph.GraphPane"/>.
- </summary>
-
- <author>John Champion</author>
- <version> $Revision: 3.32 $ $Date: 2007-11-05 18:28:56 $ </version>
- </member>
- <member name="F:ZedGraph.PaneBase.schema">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="F:ZedGraph.PaneBase._rect">
- <summary>
- The rectangle that defines the full area into which the pane is rendered. Units are pixels.
- Use the public property <see cref="P:ZedGraph.PaneBase.Rect"/> to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.PaneBase._title">
- <summary>Private field that holds the main title of the pane. Use the
- public property <see cref="P:ZedGraph.PaneBase.Title"/> to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.PaneBase._legend">
- <summary>Private field instance of the <see cref="T:ZedGraph.Legend"/> class. Use the
- public property <see cref="P:ZedGraph.PaneBase.Legend"/> to access this class.</summary>
- </member>
- <member name="F:ZedGraph.PaneBase._tag">
- <summary>
- Private field that stores the user-defined tag for this <see cref="T:ZedGraph.PaneBase"/>. This tag
- can be any user-defined value. If it is a <see cref="T:System.String"/> type, it can be used as
- a parameter to the <see cref="M:ZedGraph.PaneList.IndexOfTag(System.String)"/> method. Use the public property
- <see cref="P:ZedGraph.PaneBase.Tag"/> to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.PaneBase._margin">
- <summary>
- private field to store the margin values for this <see cref="T:ZedGraph.PaneBase"/>. Use the
- public property <see cref="P:ZedGraph.PaneBase.Margin"/> to access this property.
- </summary>
- </member>
- <member name="F:ZedGraph.PaneBase._isFontsScaled">
- <summary>Private field that determines whether or not the fonts, tics, gaps, etc.
- will be scaled according to the actual graph size. true for font and feature scaling
- with graph size, false for fixed font sizes (scaleFactor = 1.0 constant).
- Use the public property <see cref="P:ZedGraph.PaneBase.IsFontsScaled"/> to access this value. </summary>
- <seealso cref="M:ZedGraph.PaneBase.CalcScaleFactor"/>
- <seealso cref="P:ZedGraph.PaneBase.IsPenWidthScaled"/>
- </member>
- <member name="F:ZedGraph.PaneBase._isPenWidthScaled">
- <summary>
- Private field that controls whether or not pen widths are scaled according to the
- size of the graph. This value is only applicable if <see cref="P:ZedGraph.PaneBase.IsFontsScaled"/>
- is true. If <see cref="P:ZedGraph.PaneBase.IsFontsScaled"/> is false, then no scaling will be done,
- regardless of the value of <see cref="P:ZedGraph.PaneBase.IsPenWidthScaled"/>.
- </summary>
- <value>true to scale the pen widths according to the size of the graph,
- false otherwise.</value>
- <seealso cref="P:ZedGraph.PaneBase.IsFontsScaled"/>
- <seealso cref="M:ZedGraph.PaneBase.CalcScaleFactor"/>
- </member>
- <member name="F:ZedGraph.PaneBase._fill">
- <summary>
- Private field that stores the <see cref="T:ZedGraph.Fill"/> data for the
- <see cref="P:ZedGraph.PaneBase.Rect"/> background. Use the public property <see cref="P:ZedGraph.PaneBase.Fill"/> to
- access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.PaneBase._border">
- <summary>
- Private field that stores the <see cref="T:ZedGraph.Border"/> data for the
- <see cref="P:ZedGraph.PaneBase.Rect"/> border. Use the public property <see cref="P:ZedGraph.PaneBase.Border"/> to
- access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.PaneBase._graphObjList">
- <summary>Private field instance of the <see cref="T:ZedGraph.GraphObjList"/> class. Use the
- public property <see cref="P:ZedGraph.PaneBase.GraphObjList"/> to access this class.</summary>
- </member>
- <member name="F:ZedGraph.PaneBase._baseDimension">
- <summary>Private field that determines the base size of the pane, in inches.
- Fonts, tics, gaps, etc. are scaled according to this base size.
- Use the public property <see cref="P:ZedGraph.PaneBase.BaseDimension"/> to access this value. </summary>
- <seealso cref="F:ZedGraph.PaneBase._isFontsScaled"/>
- <seealso cref="M:ZedGraph.PaneBase.CalcScaleFactor"/>
- </member>
- <member name="F:ZedGraph.PaneBase._titleGap">
- <summary>
- private field that stores the gap between the bottom of the pane title and the
- client area of the pane. This is expressed as a fraction of the title character height.
- </summary>
- </member>
- <member name="M:ZedGraph.PaneBase.#ctor">
- <summary>
- Default constructor for the <see cref="T:ZedGraph.PaneBase"/> class. Leaves the <see cref="P:ZedGraph.PaneBase.Rect"/> empty.
- </summary>
- </member>
- <member name="M:ZedGraph.PaneBase.#ctor(System.String,System.Drawing.RectangleF)">
- <summary>
- Default constructor for the <see cref="T:ZedGraph.PaneBase"/> class. Specifies the <see cref="P:ZedGraph.PaneBase.Title"/> of
- the <see cref="T:ZedGraph.PaneBase"/>, and the size of the <see cref="P:ZedGraph.PaneBase.Rect"/>.
- </summary>
- </member>
- <member name="M:ZedGraph.PaneBase.#ctor(ZedGraph.PaneBase)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.PaneBase"/> object from which to copy</param>
- </member>
- <member name="M:ZedGraph.PaneBase.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of Clone
- </summary>
- <remarks>
- Note that this method must be called with an explicit cast to ICloneable, and
- that it is inherently virtual. For example:
- <code>
- ParentClass foo = new ChildClass();
- ChildClass bar = (ChildClass) ((ICloneable)foo).Clone();
- </code>
- Assume that ChildClass is inherited from ParentClass. Even though foo is declared with
- ParentClass, it is actually an instance of ChildClass. Calling the ICloneable implementation
- of Clone() on foo actually calls ChildClass.Clone() as if it were a virtual function.
- </remarks>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.PaneBase.ShallowClone">
- <summary>
- Create a shallow, memberwise copy of this class.
- </summary>
- <remarks>
- Note that this method uses MemberWiseClone, which will copy all
- members (shallow) including those of classes derived from this class.</remarks>
- <returns>a new copy of the class</returns>
- </member>
- <member name="M:ZedGraph.PaneBase.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.PaneBase.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.PaneBase.Draw(System.Drawing.Graphics)">
- <summary>
- Do all rendering associated with this <see cref="T:ZedGraph.PaneBase"/> to the specified
- <see cref="T:System.Drawing.Graphics"/> device. This abstract method is implemented by the child
- classes.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- </member>
- <member name="M:ZedGraph.PaneBase.CalcClientRect(System.Drawing.Graphics,System.Single)">
- <summary>
- Calculate the client area rectangle based on the <see cref="P:ZedGraph.PaneBase.Rect"/>.
- </summary>
- <remarks>The client rectangle is the actual area available for <see cref="T:ZedGraph.GraphPane"/>
- or <see cref="T:ZedGraph.MasterPane"/> items after taking out space for the margins and the title.
- This method does not take out the area required for the <see cref="P:ZedGraph.PaneBase.Legend"/>.
- To do so, you must separately call <see cref="M:ZedGraph.Legend.CalcRect(System.Drawing.Graphics,ZedGraph.PaneBase,System.Single,System.Drawing.RectangleF@)"/>.
- </remarks>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="scaleFactor">
- The scaling factor for the features of the graph based on the <see cref="F:ZedGraph.PaneBase.Default.BaseDimension"/>. This
- scaling factor is calculated by the <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method. The scale factor
- represents a linear multiple to be applied to font sizes, symbol sizes, etc.
- </param>
- <returns>The calculated chart rect, in pixel coordinates.</returns>
- </member>
- <member name="M:ZedGraph.PaneBase.DrawPaneFrame(System.Drawing.Graphics,System.Single)">
- <summary>
- Draw the border _border around the <see cref="P:ZedGraph.PaneBase.Rect"/> area.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="scaleFactor">
- The scaling factor for the features of the graph based on the <see cref="P:ZedGraph.PaneBase.BaseDimension"/>. This
- scaling factor is calculated by the <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method. The scale factor
- represents a linear multiple to be applied to font sizes, symbol sizes, etc.
- </param>
- </member>
- <member name="M:ZedGraph.PaneBase.DrawTitle(System.Drawing.Graphics,System.Single)">
- <summary>
- Draw the <see cref="P:ZedGraph.PaneBase.Title"/> on the graph, centered at the top of the pane.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="scaleFactor">
- The scaling factor for the features of the graph based on the <see cref="P:ZedGraph.PaneBase.BaseDimension"/>. This
- scaling factor is calculated by the <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method. The scale factor
- represents a linear multiple to be applied to font sizes, symbol sizes, etc.
- </param>
- </member>
- <member name="M:ZedGraph.PaneBase.ReSize(System.Drawing.Graphics,System.Drawing.RectangleF)">
- <summary>
- Change the size of the <see cref="P:ZedGraph.PaneBase.Rect"/>. Override this method to handle resizing the contents
- as required.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="rect">The new size for the <see cref="P:ZedGraph.PaneBase.Rect"/>.</param>
- </member>
- <member name="M:ZedGraph.PaneBase.CalcScaleFactor">
- <summary>
- Calculate the scaling factor based on the ratio of the current <see cref="P:ZedGraph.PaneBase.Rect"/> dimensions and
- the <see cref="F:ZedGraph.PaneBase.Default.BaseDimension"/>.
- </summary>
- <remarks>This scaling factor is used to proportionally scale the
- features of the <see cref="T:ZedGraph.MasterPane"/> so that small graphs don't have huge fonts, and vice versa.
- The scale factor represents a linear multiple to be applied to font sizes, symbol sizes, tic sizes,
- gap sizes, pen widths, etc. The units of the scale factor are "World Pixels" per "Standard Point".
- If any object size, in points, is multiplied by this scale factor, the result is the size, in pixels,
- that the object should be drawn using the standard GDI+ drawing instructions. A "Standard Point"
- is a dimension based on points (1/72nd inch) assuming that the <see cref="P:ZedGraph.PaneBase.Rect"/> size
- matches the <see cref="F:ZedGraph.PaneBase.Default.BaseDimension"/>.
- Note that "World Pixels" will still be transformed by the GDI+ transform matrices to result
- in "Output Device Pixels", but "World Pixels" are the reference basis for the drawing commands.
- </remarks>
- <returns>
- A <see cref="T:System.Single"/> value representing the scaling factor to use for the rendering calculations.
- </returns>
- <seealso cref="P:ZedGraph.PaneBase.BaseDimension"/>
- </member>
- <member name="M:ZedGraph.PaneBase.ScaledPenWidth(System.Single,System.Single)">
- <summary>
- Calculate the scaled pen width, taking into account the scaleFactor and the
- setting of the <see cref="P:ZedGraph.PaneBase.IsPenWidthScaled"/> property of the pane.
- </summary>
- <param name="penWidth">The pen width, in points (1/72 inch)</param>
- <param name="scaleFactor">
- The scaling factor for the features of the graph based on the <see cref="P:ZedGraph.PaneBase.BaseDimension"/>. This
- scaling factor is calculated by the <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method. The scale factor
- represents a linear multiple to be applied to font sizes, symbol sizes, etc.
- </param>
- <returns>The scaled pen width, in world pixels</returns>
- </member>
- <member name="M:ZedGraph.PaneBase.GetImage">
- <summary>
- Build a <see cref="T:System.Drawing.Bitmap"/> object containing the graphical rendering of
- all the <see cref="T:ZedGraph.GraphPane"/> objects in this list.
- </summary>
- <value>A <see cref="T:System.Drawing.Bitmap"/> object rendered with the current graph.</value>
- <seealso cref="M:ZedGraph.PaneBase.GetImage(System.Int32,System.Int32,System.Single)"/>
- <seealso cref="M:ZedGraph.PaneBase.GetMetafile"/>
- <seealso cref="M:ZedGraph.PaneBase.GetMetafile(System.Int32,System.Int32)"/>
- </member>
- <member name="M:ZedGraph.PaneBase.GetImage(System.Boolean)">
- <summary>
- Build a <see cref="T:System.Drawing.Bitmap"/> object containing the graphical rendering of
- all the <see cref="T:ZedGraph.GraphPane"/> objects in this list.
- </summary>
- <value>A <see cref="T:System.Drawing.Bitmap"/> object rendered with the current graph.</value>
- <seealso cref="M:ZedGraph.PaneBase.GetImage(System.Int32,System.Int32,System.Single)"/>
- <seealso cref="M:ZedGraph.PaneBase.GetMetafile"/>
- <seealso cref="M:ZedGraph.PaneBase.GetMetafile(System.Int32,System.Int32)"/>
- </member>
- <member name="M:ZedGraph.PaneBase.GetImage(System.Int32,System.Int32,System.Single,System.Boolean)">
- <summary>
- Gets an image for the current GraphPane, scaled to the specified size and resolution.
- </summary>
- <param name="width">The scaled width of the bitmap in pixels</param>
- <param name="height">The scaled height of the bitmap in pixels</param>
- <param name="dpi">The resolution of the bitmap, in dots per inch</param>
- <param name="isAntiAlias">true for anti-aliased rendering, false otherwise</param>
- <seealso cref="M:ZedGraph.PaneBase.GetImage"/>
- <seealso cref="M:ZedGraph.PaneBase.GetMetafile"/>
- <seealso cref="M:ZedGraph.PaneBase.GetMetafile(System.Int32,System.Int32)"/>
- <seealso cref="T:System.Drawing.Bitmap"/>
- </member>
- <member name="M:ZedGraph.PaneBase.GetImage(System.Int32,System.Int32,System.Single)">
- <summary>
- Gets an image for the current GraphPane, scaled to the specified size and resolution.
- </summary>
- <param name="width">The scaled width of the bitmap in pixels</param>
- <param name="height">The scaled height of the bitmap in pixels</param>
- <param name="dpi">The resolution of the bitmap, in dots per inch</param>
- <seealso cref="M:ZedGraph.PaneBase.GetImage"/>
- <seealso cref="M:ZedGraph.PaneBase.GetMetafile"/>
- <seealso cref="M:ZedGraph.PaneBase.GetMetafile(System.Int32,System.Int32)"/>
- <seealso cref="T:System.Drawing.Bitmap"/>
- </member>
- <member name="M:ZedGraph.PaneBase.SetAntiAliasMode(System.Drawing.Graphics,System.Boolean)">
- <summary>
- Setup a <see cref="T:System.Drawing.Graphics"/> instance with appropriate antialias settings.
- </summary>
- <remarks>
- No settings are modified if <paramref name="isAntiAlias"/> is set to false. This method
- does not restore original settings, it presumes that the Graphics instance will be
- disposed.</remarks>
- <param name="g">An existing <see cref="T:System.Drawing.Graphics"/> instance</param>
- <param name="isAntiAlias">true to render in anti-alias mode, false otherwise</param>
- </member>
- <member name="M:ZedGraph.PaneBase.GetMetafile(System.Int32,System.Int32,System.Boolean)">
- <summary>
- Gets an enhanced metafile image for the current GraphPane, scaled to the specified size.
- </summary>
- <remarks>
- By definition, a Metafile is a vector drawing, and therefore scaling should not matter.
- However, this method is provided because certain options in Zedgraph, such as
- <see cref="P:ZedGraph.PaneBase.IsFontsScaled"/> are affected by the size of the expected image.
- </remarks>
- <param name="width">The "effective" scaled width of the bitmap in pixels</param>
- <param name="height">The "effective" scaled height of the bitmap in pixels</param>
- <param name="isAntiAlias">true to use anti-aliased drawing mode, false otherwise</param>
- <seealso cref="M:ZedGraph.PaneBase.GetImage"/>
- <seealso cref="M:ZedGraph.PaneBase.GetImage(System.Int32,System.Int32,System.Single)"/>
- <seealso cref="M:ZedGraph.PaneBase.GetMetafile"/>
- </member>
- <member name="M:ZedGraph.PaneBase.GetMetafile(System.Int32,System.Int32)">
- <summary>
- Gets an enhanced metafile image for the current GraphPane, scaled to the specified size.
- </summary>
- <remarks>
- By definition, a Metafile is a vector drawing, and therefore scaling should not matter.
- However, this method is provided because certain options in Zedgraph, such as
- <see cref="P:ZedGraph.PaneBase.IsFontsScaled"/> are affected by the size of the expected image.
- </remarks>
- <param name="width">The "effective" scaled width of the bitmap in pixels</param>
- <param name="height">The "effective" scaled height of the bitmap in pixels</param>
- <seealso cref="M:ZedGraph.PaneBase.GetImage"/>
- <seealso cref="M:ZedGraph.PaneBase.GetImage(System.Int32,System.Int32,System.Single)"/>
- <seealso cref="M:ZedGraph.PaneBase.GetMetafile"/>
- </member>
- <member name="M:ZedGraph.PaneBase.GetMetafile">
- <summary>
- Gets an enhanced metafile image for the current GraphPane.
- </summary>
- <seealso cref="M:ZedGraph.PaneBase.GetImage"/>
- <seealso cref="M:ZedGraph.PaneBase.GetImage(System.Int32,System.Int32,System.Single)"/>
- <seealso cref="M:ZedGraph.PaneBase.GetMetafile(System.Int32,System.Int32)"/>
- </member>
- <member name="P:ZedGraph.PaneBase.Rect">
- <summary>
- The rectangle that defines the full area into which all graphics
- will be rendered.
- </summary>
- <remarks>Note that this rectangle has x, y, width, and height. Most of the
- GDI+ graphic primitive actually draw one pixel beyond those dimensions. For
- example, for a rectangle of ( X=0, Y=0, Width=100, Height=100 ), GDI+ would
- draw into pixels 0 through 100, which is actually 101 pixels. For the
- ZedGraph Rect, a Width of 100 pixels means that pixels 0 through 99 are used</remarks>
- <value>Units are pixels.</value>
- <seealso cref="M:ZedGraph.PaneBase.ReSize(System.Drawing.Graphics,System.Drawing.RectangleF)"/>
- </member>
- <member name="P:ZedGraph.PaneBase.Legend">
- <summary>
- Accesses the <see cref="P:ZedGraph.PaneBase.Legend"/> for this <see cref="T:ZedGraph.PaneBase"/>
- </summary>
- <value>A reference to a <see cref="P:ZedGraph.PaneBase.Legend"/> object</value>
- </member>
- <member name="P:ZedGraph.PaneBase.Title">
- <summary>
- Gets the <see cref="T:ZedGraph.Label"/> instance that contains the text and attributes of the title.
- This text can be multiple lines separated by newline characters ('\n').
- </summary>
- <seealso cref="T:ZedGraph.FontSpec"/>
- <seealso cref="F:ZedGraph.PaneBase.Default.FontColor"/>
- <seealso cref="F:ZedGraph.PaneBase.Default.FontBold"/>
- <seealso cref="F:ZedGraph.PaneBase.Default.FontItalic"/>
- <seealso cref="F:ZedGraph.PaneBase.Default.FontUnderline"/>
- <seealso cref="F:ZedGraph.PaneBase.Default.FontFamily"/>
- <seealso cref="F:ZedGraph.PaneBase.Default.FontSize"/>
- </member>
- <member name="P:ZedGraph.PaneBase.Tag">
- <summary>
- Gets or sets the user-defined tag for this <see cref="T:ZedGraph.PaneBase"/>. This tag
- can be any user-defined value. If it is a <see cref="T:System.String"/> type, it can be used as
- a parameter to the <see cref="M:ZedGraph.PaneList.IndexOfTag(System.String)"/> method.
- </summary>
- <remarks>
- Note that, if you are going to Serialize ZedGraph data, then any type
- that you store in <see cref="P:ZedGraph.PaneBase.Tag"/> must be a serializable type (or
- it will cause an exception).
- </remarks>
- </member>
- <member name="P:ZedGraph.PaneBase.Border">
- <summary>
- Gets or sets the <see cref="T:ZedGraph.Border"/> class for drawing the border
- border around the <see cref="P:ZedGraph.PaneBase.Rect"/>
- </summary>
- <seealso cref="F:ZedGraph.PaneBase.Default.BorderColor"/>
- <seealso cref="F:ZedGraph.PaneBase.Default.BorderPenWidth"/>
- </member>
- <member name="P:ZedGraph.PaneBase.Fill">
- <summary>
- Gets or sets the <see cref="T:ZedGraph.Fill"/> data for the
- filling the background of the <see cref="P:ZedGraph.PaneBase.Rect"/>.
- </summary>
- </member>
- <member name="P:ZedGraph.PaneBase.GraphObjList">
- <summary>
- Gets or sets the list of <see cref="T:ZedGraph.GraphObj"/> items for this <see cref="T:ZedGraph.GraphPane"/>
- </summary>
- <value>A reference to a <see cref="P:ZedGraph.PaneBase.GraphObjList"/> collection object</value>
- </member>
- <member name="P:ZedGraph.PaneBase.Margin">
- <summary>
- Gets or sets the <see cref="T:ZedGraph.Margin"/> instance that controls the space between
- the edge of the <see cref="P:ZedGraph.PaneBase.Rect"/> and the rendered content of the graph.
- </summary>
- </member>
- <member name="P:ZedGraph.PaneBase.BaseDimension">
- <summary>
- BaseDimension is a double precision value that sets "normal" pane size on
- which all the settings are based. The BaseDimension is in inches. For
- example, if the BaseDimension is 8.0 inches and the
- <see cref="P:ZedGraph.PaneBase.Title"/> size is 14 points. Then the pane title font
- will be 14 points high when the <see cref="P:ZedGraph.PaneBase.Rect"/> is approximately 8.0
- inches wide. If the Rect is 4.0 inches wide, the pane title font will be
- 7 points high. Most features of the graph are scaled in this manner.
- </summary>
- <value>The base dimension reference for the <see cref="P:ZedGraph.PaneBase.Rect"/>, in inches</value>
- <seealso cref="F:ZedGraph.PaneBase.Default.BaseDimension"/>
- <seealso cref="P:ZedGraph.PaneBase.IsFontsScaled"/>
- <seealso cref="M:ZedGraph.PaneBase.CalcScaleFactor"/>
- </member>
- <member name="P:ZedGraph.PaneBase.TitleGap">
- <summary>
- Gets or sets the gap between the bottom of the pane title and the
- client area of the pane. This is expressed as a fraction of the scaled
- <see cref="P:ZedGraph.PaneBase.Title"/> character height.
- </summary>
- </member>
- <member name="P:ZedGraph.PaneBase.IsFontsScaled">
- <summary>
- Determines if the font sizes, tic sizes, gap sizes, etc. will be scaled according to
- the size of the <see cref="P:ZedGraph.PaneBase.Rect"/> and the <see cref="P:ZedGraph.PaneBase.BaseDimension"/>. If this
- value is set to false, then the font sizes and tic sizes will always be exactly as
- specified, without any scaling.
- </summary>
- <value>True to have the fonts and tics scaled, false to have them constant</value>
- <seealso cref="M:ZedGraph.PaneBase.CalcScaleFactor"/>
- </member>
- <member name="P:ZedGraph.PaneBase.IsPenWidthScaled">
- <summary>
- Gets or sets the property that controls whether or not pen widths are scaled for this
- <see cref="T:ZedGraph.PaneBase"/>.
- </summary>
- <remarks>This value is only applicable if <see cref="P:ZedGraph.PaneBase.IsFontsScaled"/>
- is true. If <see cref="P:ZedGraph.PaneBase.IsFontsScaled"/> is false, then no scaling will be done,
- regardless of the value of <see cref="P:ZedGraph.PaneBase.IsPenWidthScaled"/>. Note that scaling the pen
- widths can cause "artifacts" to appear at typical screen resolutions. This occurs
- because of roundoff differences; in some cases the pen width may round to 1 pixel wide
- and in another it may round to 2 pixels wide. The result is typically undesirable.
- Therefore, this option defaults to false. This option is primarily useful for high
- resolution output, such as printer output or high resolution bitmaps (from
- <see cref="M:ZedGraph.PaneBase.GetImage(System.Int32,System.Int32,System.Single)"/>) where it is desirable to have the pen width
- be consistent with the screen image.
- </remarks>
- <value>true to scale the pen widths according to the size of the graph,
- false otherwise.</value>
- <seealso cref="P:ZedGraph.PaneBase.IsFontsScaled"/>
- <seealso cref="M:ZedGraph.PaneBase.CalcScaleFactor"/>
- </member>
- <member name="T:ZedGraph.PaneBase.Default">
- <summary>
- A simple struct that defines the default property values for the <see cref="T:ZedGraph.PaneBase"/> class.
- </summary>
- </member>
- <member name="F:ZedGraph.PaneBase.Default.IsShowTitle">
- <summary>
- The default display mode for the title at the top of the pane
- (<see cref="P:ZedGraph.PaneBase.Title"/> <see cref="P:ZedGraph.Label.IsVisible"/> property). true to
- display a title, false otherwise.
- </summary>
- </member>
- <member name="F:ZedGraph.PaneBase.Default.FontFamily">
- <summary>
- The default font family for the title
- (<see cref="P:ZedGraph.PaneBase.Title"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.PaneBase.Default.FontSize">
- <summary>
- The default font size (points) for the
- <see cref="P:ZedGraph.PaneBase.Title"/> (<see cref="P:ZedGraph.FontSpec.Size"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.PaneBase.Default.FontColor">
- <summary>
- The default font color for the
- <see cref="P:ZedGraph.PaneBase.Title"/>
- (<see cref="P:ZedGraph.FontSpec.FontColor"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.PaneBase.Default.FontBold">
- <summary>
- The default font bold mode for the
- <see cref="P:ZedGraph.PaneBase.Title"/>
- (<see cref="P:ZedGraph.FontSpec.IsBold"/> property). true
- for a bold typeface, false otherwise.
- </summary>
- </member>
- <member name="F:ZedGraph.PaneBase.Default.FontItalic">
- <summary>
- The default font italic mode for the
- <see cref="P:ZedGraph.PaneBase.Title"/>
- (<see cref="P:ZedGraph.FontSpec.IsItalic"/> property). true
- for an italic typeface, false otherwise.
- </summary>
- </member>
- <member name="F:ZedGraph.PaneBase.Default.FontUnderline">
- <summary>
- The default font underline mode for the
- <see cref="P:ZedGraph.PaneBase.Title"/>
- (<see cref="P:ZedGraph.FontSpec.IsUnderline"/> property). true
- for an underlined typeface, false otherwise.
- </summary>
- </member>
- <member name="F:ZedGraph.PaneBase.Default.IsBorderVisible">
- <summary>
- The default border mode for the <see cref="T:ZedGraph.PaneBase"/>.
- (<see cref="P:ZedGraph.PaneBase.Border"/> property). true
- to draw a border around the <see cref="P:ZedGraph.PaneBase.Rect"/>,
- false otherwise.
- </summary>
- </member>
- <member name="F:ZedGraph.PaneBase.Default.BorderColor">
- <summary>
- The default color for the <see cref="T:ZedGraph.PaneBase"/> border.
- (<see cref="P:ZedGraph.PaneBase.Border"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.PaneBase.Default.FillColor">
- <summary>
- The default color for the <see cref="P:ZedGraph.PaneBase.Rect"/> background.
- (<see cref="P:ZedGraph.PaneBase.Fill"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.PaneBase.Default.BorderPenWidth">
- <summary>
- The default pen width for the <see cref="T:ZedGraph.PaneBase"/> border.
- (<see cref="P:ZedGraph.PaneBase.Border"/> property). Units are in points (1/72 inch).
- </summary>
- </member>
- <member name="F:ZedGraph.PaneBase.Default.BaseDimension">
- <summary>
- The default dimension of the <see cref="P:ZedGraph.PaneBase.Rect"/>, which
- defines a normal sized plot. This dimension is used to scale the
- fonts, symbols, etc. according to the actual size of the
- <see cref="P:ZedGraph.PaneBase.Rect"/>.
- </summary>
- <seealso cref="M:ZedGraph.PaneBase.CalcScaleFactor"/>
- </member>
- <member name="F:ZedGraph.PaneBase.Default.IsPenWidthScaled">
- <summary>
- The default setting for the <see cref="P:ZedGraph.PaneBase.IsPenWidthScaled"/> option.
- true to have all pen widths scaled according to <see cref="P:ZedGraph.PaneBase.BaseDimension"/>,
- false otherwise.
- </summary>
- <seealso cref="M:ZedGraph.PaneBase.CalcScaleFactor"/>
- </member>
- <member name="F:ZedGraph.PaneBase.Default.IsFontsScaled">
- <summary>
- The default setting for the <see cref="P:ZedGraph.PaneBase.IsFontsScaled"/> option.
- true to have all fonts scaled according to <see cref="P:ZedGraph.PaneBase.BaseDimension"/>,
- false otherwise.
- </summary>
- <seealso cref="M:ZedGraph.PaneBase.CalcScaleFactor"/>
- </member>
- <member name="F:ZedGraph.PaneBase.Default.TitleGap">
- <summary>
- The default value for the <see cref="P:ZedGraph.PaneBase.TitleGap"/> property, expressed as
- a fraction of the scaled <see cref="P:ZedGraph.PaneBase.Title"/> character height.
- </summary>
- </member>
- <member name="F:ZedGraph.MasterPane.schema2">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="F:ZedGraph.MasterPane._paneList">
- <summary>
- Private field that holds a collection of <see cref="T:ZedGraph.GraphPane"/> objects for inclusion
- in this <see cref="T:ZedGraph.MasterPane"/>. Use the public property <see cref="P:ZedGraph.MasterPane.PaneList"/>
- to access this collection.
- </summary>
- </member>
- <member name="F:ZedGraph.MasterPane._innerPaneGap">
- <summary>
- Private field that sets the amount of space between the GraphPanes. Use the public property
- <see cref="P:ZedGraph.MasterPane.InnerPaneGap"/> to access this value;
- </summary>
- </member>
- <member name="F:ZedGraph.MasterPane._isUniformLegendEntries">
- <summary>
- Private field that stores a boolean value which signifies whether all
- <see cref="T:ZedGraph.GraphPane"/>s in the chart use the same entries in their
- <see cref="T:ZedGraph.Legend"/> If set to true, only one set of entries will be displayed in
- this <see cref="T:ZedGraph.Legend"/> instance. If set to false, this instance will display all
- entries from all <see cref="T:ZedGraph.GraphPane"/>s.
- </summary>
- </member>
- <member name="F:ZedGraph.MasterPane._isCommonScaleFactor">
- <summary>
- private field that determines if the
- <see cref="M:ZedGraph.MasterPane.DoLayout(System.Drawing.Graphics)"/>
- function will automatically set
- the <see cref="P:ZedGraph.PaneBase.BaseDimension"/> of each <see cref="T:ZedGraph.GraphPane"/> in the
- <see cref="P:ZedGraph.MasterPane.PaneList"/> such that the scale factors have the same value.
- </summary>
- </member>
- <member name="F:ZedGraph.MasterPane._paneLayout">
- <summary>
- private field that saves the paneLayout format specified when
- <see cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,ZedGraph.PaneLayout)"/> was called. This value will
- default to <see cref="F:ZedGraph.MasterPane.Default.PaneLayout"/> if
- <see cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,ZedGraph.PaneLayout)"/> (or an overload) was never called.
- </summary>
- </member>
- <member name="F:ZedGraph.MasterPane._isColumnSpecified">
- <summary>
- Private field that stores the boolean value that determines whether
- <see cref="F:ZedGraph.MasterPane._countList"/> is specifying rows or columns.
- </summary>
- </member>
- <member name="F:ZedGraph.MasterPane._countList">
- <summary>
- private field that stores the row/column item count that was specified to the
- <see cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,System.Boolean,System.Int32[],System.Single[])"/> method. This values will be
- null if <see cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,System.Boolean,System.Int32[],System.Single[])"/> was never called.
- </summary>
- </member>
- <member name="F:ZedGraph.MasterPane._prop">
- <summary>
- private field that stores the row/column size proportional values as specified
- to the <see cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,System.Boolean,System.Int32[],System.Single[])"/> method. This
- value will be null if <see cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,System.Boolean,System.Int32[],System.Single[])"/>
- was never called.
- </summary>
- </member>
- <member name="F:ZedGraph.MasterPane._isAntiAlias">
- <summary>
- private field that determines if anti-aliased drawing will be forced on. Use the
- public property <see cref="P:ZedGraph.MasterPane.IsAntiAlias"/> to access this value.
- </summary>
- </member>
- <member name="M:ZedGraph.MasterPane.#ctor">
- <summary>
- Default constructor for the class. Sets the <see cref="P:ZedGraph.PaneBase.Rect"/> to (0, 0, 500, 375).
- </summary>
- </member>
- <member name="M:ZedGraph.MasterPane.#ctor(System.String,System.Drawing.RectangleF)">
- <summary>
- Default constructor for the class. Specifies the <see cref="P:ZedGraph.PaneBase.Title"/> of
- the <see cref="T:ZedGraph.MasterPane"/>, and the size of the <see cref="P:ZedGraph.PaneBase.Rect"/>.
- </summary>
- </member>
- <member name="M:ZedGraph.MasterPane.#ctor(ZedGraph.MasterPane)">
- <summary>
- The Copy Constructor - Make a deep-copy clone of this class instance.
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.MasterPane"/> object from which to copy</param>
- </member>
- <member name="M:ZedGraph.MasterPane.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.MasterPane.Clone"/> to make a deep copy.
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.MasterPane.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.MasterPane.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.MasterPane.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.MasterPane.OnDeserialization(System.Object)">
- <summary>
- Respond to the callback when the MasterPane objects are fully initialized.
- </summary>
- <param name="sender"></param>
- </member>
- <member name="M:ZedGraph.MasterPane.Add(ZedGraph.GraphPane)">
- <summary>
- Add a <see cref="T:ZedGraph.GraphPane"/> object to the <see cref="P:ZedGraph.MasterPane.PaneList"/> collection at the end of the list.
- </summary>
- <param name="pane">A reference to the <see cref="T:ZedGraph.GraphPane"/> object to
- be added</param>
- <seealso cref="M:System.Collections.IList.Add(System.Object)"/>
- </member>
- <member name="M:ZedGraph.MasterPane.AxisChange">
- <summary>
- Call <see cref="M:ZedGraph.GraphPane.AxisChange"/> for all <see cref="T:ZedGraph.GraphPane"/> objects in the
- <see cref="P:ZedGraph.MasterPane.PaneList"/> list.
- </summary>
- <remarks>
- This overload of AxisChange just uses the default Graphics instance for the screen.
- If you have a Graphics instance available from your Windows Form, you should use
- the <see cref="M:ZedGraph.MasterPane.AxisChange(System.Drawing.Graphics)"/> overload instead.
- </remarks>
- </member>
- <member name="M:ZedGraph.MasterPane.AxisChange(System.Drawing.Graphics)">
- <summary>
- Call <see cref="M:ZedGraph.GraphPane.AxisChange"/> for all <see cref="T:ZedGraph.GraphPane"/> objects in the
- <see cref="P:ZedGraph.MasterPane.PaneList"/> list.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- </member>
- <member name="M:ZedGraph.MasterPane.ReSize(System.Drawing.Graphics)">
- <summary>
- Redo the layout using the current size of the <see cref="P:ZedGraph.PaneBase.Rect"/>,
- and also handle resizing the
- contents by calling <see cref="M:ZedGraph.MasterPane.DoLayout(System.Drawing.Graphics)"/>.
- </summary>
- <remarks>This method will use the pane layout that was specified by a call to
- <see cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,ZedGraph.PaneLayout)"/>. If
- <see cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,ZedGraph.PaneLayout)"/> has not previously been called,
- it will default to <see cref="F:ZedGraph.MasterPane.Default.PaneLayout"/>.
- </remarks>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <seealso cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,ZedGraph.PaneLayout)"/>
- <seealso cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,System.Int32,System.Int32)"/>
- <seealso cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,System.Boolean,System.Int32[])"/>
- <seealso cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,System.Boolean,System.Int32[],System.Single[])"/>
- </member>
- <member name="M:ZedGraph.MasterPane.ReSize(System.Drawing.Graphics,System.Drawing.RectangleF)">
- <summary>
- Change the size of the <see cref="P:ZedGraph.PaneBase.Rect"/>, and also handle resizing the
- contents by calling <see cref="M:ZedGraph.MasterPane.DoLayout(System.Drawing.Graphics)"/>.
- </summary>
- <remarks>This method will use the pane layout that was specified by a call to
- <see cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,ZedGraph.PaneLayout)"/>. If
- <see cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,ZedGraph.PaneLayout)"/> has not previously been called,
- it will default to <see cref="F:ZedGraph.MasterPane.Default.PaneLayout"/>.
- </remarks>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="rect"></param>
- <seealso cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,ZedGraph.PaneLayout)"/>
- <seealso cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,System.Int32,System.Int32)"/>
- <seealso cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,System.Boolean,System.Int32[])"/>
- <seealso cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,System.Boolean,System.Int32[],System.Single[])"/>
- </member>
- <member name="M:ZedGraph.MasterPane.CommonScaleFactor">
- <summary>
- Method that forces the scale factor calculations
- (via <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/>),
- to give a common scale factor for all <see cref="T:ZedGraph.GraphPane"/> objects in the
- <see cref="P:ZedGraph.MasterPane.PaneList"/>.
- </summary>
- <remarks>
- This will make it such that a given font size will result in the same output font
- size for all <see cref="T:ZedGraph.GraphPane"/>'s. Note that this does not make the scale
- factor for the <see cref="T:ZedGraph.GraphPane"/>'s the same as that of the
- <see cref="T:ZedGraph.MasterPane"/>.
- </remarks>
- <seealso cref="P:ZedGraph.MasterPane.IsCommonScaleFactor"/>
- </member>
- <member name="M:ZedGraph.MasterPane.Draw(System.Drawing.Graphics)">
- <summary>
- Render all the <see cref="T:ZedGraph.GraphPane"/> objects in the <see cref="P:ZedGraph.MasterPane.PaneList"/> to the
- specified graphics device.
- </summary>
- <remarks>This method should be part of the Paint() update process. Calling this routine
- will redraw all
- features of all the <see cref="T:ZedGraph.GraphPane"/> items. No preparation is required other than
- instantiated <see cref="T:ZedGraph.GraphPane"/> objects that have been added to the list with the
- <see cref="M:ZedGraph.MasterPane.Add(ZedGraph.GraphPane)"/> method.
- </remarks>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- </member>
- <member name="M:ZedGraph.MasterPane.FindNearestPaneObject(System.Drawing.PointF,System.Drawing.Graphics,ZedGraph.GraphPane@,System.Object@,System.Int32@)">
- <summary>
- Find the pane and the object within that pane that lies closest to the specified
- mouse (screen) point.
- </summary>
- <remarks>
- This method first finds the <see cref="T:ZedGraph.GraphPane"/> within the list that contains
- the specified mouse point. It then calls the <see cref="M:ZedGraph.GraphPane.FindNearestObject(System.Drawing.PointF,System.Drawing.Graphics,System.Object@,System.Int32@)"/>
- method to determine which object, if any, was clicked. With the exception of the
- <see paramref="pane"/>, all the parameters in this method are identical to those
- in the <see cref="M:ZedGraph.GraphPane.FindNearestObject(System.Drawing.PointF,System.Drawing.Graphics,System.Object@,System.Int32@)"/> method.
- If the mouse point lies within the <see cref="P:ZedGraph.PaneBase.Rect"/> of any
- <see cref="T:ZedGraph.GraphPane"/> item, then that pane will be returned (otherwise it will be
- null). Further, within the selected pane, if the mouse point is within the
- bounding box of any of the items (or in the case
- of <see cref="T:ZedGraph.ArrowObj"/> and <see cref="T:ZedGraph.CurveItem"/>, within
- <see cref="F:ZedGraph.GraphPane.Default.NearestTol"/> pixels), then the object will be returned.
- You must check the type of the object to determine what object was
- selected (for example, "if ( object is Legend ) ..."). The
- <see paramref="index"/> parameter returns the index number of the item
- within the selected object (such as the point number within a
- <see cref="T:ZedGraph.CurveItem"/> object.
- </remarks>
- <param name="mousePt">The screen point, in pixel coordinates.</param>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">A reference to the <see cref="T:ZedGraph.GraphPane"/> object that was clicked.</param>
- <param name="nearestObj">A reference to the nearest object to the
- specified screen point. This can be any of <see cref="T:ZedGraph.Axis"/>,
- <see cref="T:ZedGraph.Legend"/>, <see cref="P:ZedGraph.PaneBase.Title"/>,
- <see cref="T:ZedGraph.TextObj"/>, <see cref="T:ZedGraph.ArrowObj"/>, or <see cref="T:ZedGraph.CurveItem"/>.
- Note: If the pane title is selected, then the <see cref="T:ZedGraph.GraphPane"/> object
- will be returned.
- </param>
- <param name="index">The index number of the item within the selected object
- (where applicable). For example, for a <see cref="T:ZedGraph.CurveItem"/> object,
- <see paramref="index"/> will be the index number of the nearest data point,
- accessible via <see cref="P:ZedGraph.CurveItem.Points">CurveItem.Points[index]</see>.
- index will be -1 if no data points are available.</param>
- <returns>true if a <see cref="T:ZedGraph.GraphPane"/> was found, false otherwise.</returns>
- <seealso cref="M:ZedGraph.GraphPane.FindNearestObject(System.Drawing.PointF,System.Drawing.Graphics,System.Object@,System.Int32@)"/>
- </member>
- <member name="M:ZedGraph.MasterPane.FindPane(System.Drawing.PointF)">
- <summary>
- Find the <see cref="T:ZedGraph.GraphPane"/> within the <see cref="P:ZedGraph.MasterPane.PaneList"/> that contains the
- <see paramref="mousePt"/> within its <see cref="P:ZedGraph.PaneBase.Rect"/>.
- </summary>
- <param name="mousePt">The mouse point location where you want to search</param>
- <returns>A <see cref="T:ZedGraph.GraphPane"/> object that contains the mouse point, or
- null if no <see cref="T:ZedGraph.GraphPane"/> was found.</returns>
- </member>
- <member name="M:ZedGraph.MasterPane.FindChartRect(System.Drawing.PointF)">
- <summary>
- Find the <see cref="T:ZedGraph.GraphPane"/> within the <see cref="P:ZedGraph.MasterPane.PaneList"/> that contains the
- <see paramref="mousePt"/> within its <see cref="P:ZedGraph.Chart.Rect"/>.
- </summary>
- <param name="mousePt">The mouse point location where you want to search</param>
- <returns>A <see cref="T:ZedGraph.GraphPane"/> object that contains the mouse point, or
- null if no <see cref="T:ZedGraph.GraphPane"/> was found.</returns>
- </member>
- <member name="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,ZedGraph.PaneLayout)">
- <overloads>The SetLayout() methods setup the desired layout of the
- <see cref="T:ZedGraph.GraphPane"/> objects within a <see cref="T:ZedGraph.MasterPane"/>. These functions
- do not make any changes, they merely set the parameters so that future calls
- to <see cref="M:ZedGraph.PaneBase.ReSize(System.Drawing.Graphics,System.Drawing.RectangleF)"/> or <see cref="M:ZedGraph.MasterPane.DoLayout(System.Drawing.Graphics)"/>
- will use the desired layout.<br/><br/>
- The layout options include a set of "canned" layouts provided by the
- <see cref="T:ZedGraph.PaneLayout"/> enumeration, options to just set a specific
- number of rows and columns of panes (and all pane sizes are the same), and more
- customized options of specifying the number or rows in each column or the number of
- columns in each row, along with proportional values that determine the size of each
- individual column or row.
- </overloads>
- <summary>
- Automatically set all of the <see cref="T:ZedGraph.GraphPane"/> <see cref="P:ZedGraph.PaneBase.Rect"/>'s in
- the list to a pre-defined layout configuration from a <see cref="T:ZedGraph.PaneLayout"/>
- enumeration.
- </summary>
- <remarks>This method uses a <see cref="T:ZedGraph.PaneLayout"/> enumeration to describe the type of layout
- to be used. Overloads are available that provide other layout options</remarks>
- <param name="paneLayout">A <see cref="T:ZedGraph.PaneLayout"/> enumeration that describes how
- the panes should be laid out within the <see cref="P:ZedGraph.PaneBase.Rect"/>.</param>
- <param name="g">
- A graphic device object to be drawn into. This is normally created with a call to
- the CreateGraphics() method of the Control or Form.
- </param>
- <seealso cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,System.Int32,System.Int32)"/>
- <seealso cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,System.Boolean,System.Int32[])"/>
- <seealso cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,System.Boolean,System.Int32[],System.Single[])"/>
- </member>
- <member name="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,System.Int32,System.Int32)">
- <summary>
- Automatically set all of the <see cref="T:ZedGraph.GraphPane"/> <see cref="P:ZedGraph.PaneBase.Rect"/>'s in
- the list to a reasonable configuration.
- </summary>
- <remarks>This method explicitly specifies the number of rows and columns to use
- in the layout, and all <see cref="T:ZedGraph.GraphPane"/> objects will have the same size.
- Overloads are available that provide other layout options</remarks>
- <param name="g">
- A graphic device object to be drawn into. This is normally created with a call to
- the CreateGraphics() method of the Control or Form.
- </param>
- <param name="rows">The number of rows of <see cref="T:ZedGraph.GraphPane"/> objects
- to include in the layout</param>
- <param name="columns">The number of columns of <see cref="T:ZedGraph.GraphPane"/> objects
- to include in the layout</param>
- <seealso cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,ZedGraph.PaneLayout)"/>
- <seealso cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,System.Boolean,System.Int32[])"/>
- <seealso cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,System.Boolean,System.Int32[],System.Single[])"/>
- </member>
- <member name="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,System.Boolean,System.Int32[])">
- <summary>
- Automatically set all of the <see cref="T:ZedGraph.GraphPane"/> <see cref="P:ZedGraph.PaneBase.Rect"/>'s in
- the list to the specified configuration.
- </summary>
- <remarks>This method specifies the number of rows in each column, or the number of
- columns in each row, allowing for irregular layouts. Overloads are available that
- provide other layout options.
- </remarks>
- <param name="g">
- A graphic device object to be drawn into. This is normally created with a call to
- the CreateGraphics() method of the Control or Form.
- </param>
- <param name="isColumnSpecified">Specifies whether the number of columns in each row, or
- the number of rows in each column will be specified. A value of true indicates the
- number of columns in each row are specified in <see paramref="countList"/>.</param>
- <param name="countList">An integer array specifying either the number of columns in
- each row or the number of rows in each column, depending on the value of
- <see paramref="isColumnSpecified"/>.</param>
- <seealso cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,ZedGraph.PaneLayout)"/>
- <seealso cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,System.Int32,System.Int32)"/>
- <seealso cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,System.Boolean,System.Int32[],System.Single[])"/>
- </member>
- <member name="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,System.Boolean,System.Int32[],System.Single[])">
- <summary>
- Automatically set all of the <see cref="T:ZedGraph.GraphPane"/> <see cref="P:ZedGraph.PaneBase.Rect"/>'s in
- the list to the specified configuration.
- </summary>
- <remarks>This method specifies the number of panes in each row or column, allowing for
- irregular layouts.</remarks>
- <remarks>This method specifies the number of rows in each column, or the number of
- columns in each row, allowing for irregular layouts. Additionally, a
- <see paramref="proportion"/> parameter is provided that allows varying column or
- row sizes. Overloads for SetLayout() are available that provide other layout options.
- </remarks>
- <param name="g">
- A graphic device object to be drawn into. This is normally created with a call to
- the CreateGraphics() method of the Control or Form.
- </param>
- <param name="isColumnSpecified">Specifies whether the number of columns in each row, or
- the number of rows in each column will be specified. A value of true indicates the
- number of columns in each row are specified in <see paramref="_countList"/>.</param>
- <param name="countList">An integer array specifying either the number of columns in
- each row or the number of rows in each column, depending on the value of
- <see paramref="isColumnSpecified"/>.</param>
- <param name="proportion">An array of float values specifying proportional sizes for each
- row or column. Note that these proportions apply to the non-specified dimension -- that is,
- if <see paramref="isColumnSpecified"/> is true, then these proportions apply to the row
- heights, and if <see paramref="isColumnSpecified"/> is false, then these proportions apply
- to the column widths. The values in this array are arbitrary floats -- the dimension of
- any given row or column is that particular proportional value divided by the sum of all
- the values. For example, let <see paramref="isColumnSpecified"/> be true, and
- <see paramref="proportion"/> is an array with values of { 1.0, 2.0, 3.0 }. The sum of
- those values is 6.0. Therefore, the first row is 1/6th of the available height, the
- second row is 2/6th's of the available height, and the third row is 3/6th's of the
- available height.
- </param>
- <seealso cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,ZedGraph.PaneLayout)"/>
- <seealso cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,System.Int32,System.Int32)"/>
- <seealso cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,System.Boolean,System.Int32[])"/>
- </member>
- <member name="M:ZedGraph.MasterPane.DoLayout(System.Drawing.Graphics)">
- <summary>
- Modify the <see cref="T:ZedGraph.GraphPane"/> <see cref="P:ZedGraph.PaneBase.Rect"/> sizes of each
- <see cref="T:ZedGraph.GraphPane"/> such that they fit within the <see cref="T:ZedGraph.MasterPane"/>
- in a pre-configured layout.
- </summary>
- <remarks>The <see cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,ZedGraph.PaneLayout)"/> method (and overloads) is
- used for setting the layout configuration.</remarks>
- <seealso cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,ZedGraph.PaneLayout)"/>
- <seealso cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,System.Int32,System.Int32)"/>
- <seealso cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,System.Boolean,System.Int32[])"/>
- <seealso cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,System.Boolean,System.Int32[],System.Single[])"/>
- </member>
- <member name="M:ZedGraph.MasterPane.DoLayout(System.Drawing.Graphics,System.Int32,System.Int32)">
- <summary>
- Internal method that applies a previously set layout with a specific
- row and column count. This method is only called by
- <see cref="M:ZedGraph.MasterPane.DoLayout(System.Drawing.Graphics)"/>.
- </summary>
- </member>
- <member name="M:ZedGraph.MasterPane.DoLayout(System.Drawing.Graphics,System.Boolean,System.Int32[],System.Single[])">
- <summary>
- Internal method that applies a previously set layout with a rows per column or
- columns per row configuration. This method is only called by
- <see cref="M:ZedGraph.MasterPane.DoLayout(System.Drawing.Graphics)"/>.
- </summary>
- </member>
- <member name="P:ZedGraph.MasterPane.PaneList">
- <summary>
- Gets or sets the <see cref="P:ZedGraph.MasterPane.PaneList"/> collection instance that holds the list of
- <see cref="T:ZedGraph.GraphPane"/> objects that are included in this <see cref="T:ZedGraph.MasterPane"/>.
- </summary>
- <seealso cref="M:ZedGraph.MasterPane.Add(ZedGraph.GraphPane)"/>
- <seealso cref="P:ZedGraph.MasterPane.Item(System.Int32)"/>
- </member>
- <member name="P:ZedGraph.MasterPane.InnerPaneGap">
- <summary>
- Gets or sets the size of the margin between adjacent <see cref="T:ZedGraph.GraphPane"/>
- objects.
- </summary>
- <remarks>This property is scaled according to <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/>,
- based on <see cref="P:ZedGraph.PaneBase.BaseDimension"/>. The default value comes from
- <see cref="F:ZedGraph.MasterPane.Default.InnerPaneGap"/>.
- </remarks>
- <value>The value is in points (1/72nd inch).</value>
- </member>
- <member name="P:ZedGraph.MasterPane.IsUniformLegendEntries">
- <summary>
- Gets or set the value of the <see cref="P:ZedGraph.MasterPane.IsUniformLegendEntries"/>
- </summary>
- </member>
- <member name="P:ZedGraph.MasterPane.IsCommonScaleFactor">
- <summary>
- Gets or sets a value that determines if the
- <see cref="M:ZedGraph.MasterPane.DoLayout(System.Drawing.Graphics)"/> method will automatically set the
- <see cref="P:ZedGraph.PaneBase.BaseDimension"/>
- of each <see cref="T:ZedGraph.GraphPane"/> in the <see cref="P:ZedGraph.MasterPane.PaneList"/> such that the
- scale factors have the same value.
- </summary>
- <remarks>
- The scale factors, calculated by <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/>, determine
- scaled font sizes, tic lengths, etc. This function will insure that for
- multiple graphpanes, a certain specified font size will be the same for
- all the panes.
- </remarks>
- <seealso cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,ZedGraph.PaneLayout)"/>
- <seealso cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,System.Int32,System.Int32)"/>
- <seealso cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,System.Boolean,System.Int32[])"/>
- <seealso cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,System.Boolean,System.Int32[],System.Single[])"/>
- <seealso cref="M:ZedGraph.MasterPane.ReSize(System.Drawing.Graphics,System.Drawing.RectangleF)"/>
- </member>
- <member name="P:ZedGraph.MasterPane.IsAntiAlias">
- <summary>
- Gets or sets a value that determines if all drawing operations for this
- <see cref="T:ZedGraph.MasterPane"/> will be forced to operate in Anti-alias mode.
- Note that if this value is set to "true", it overrides the setting for sub-objects.
- Otherwise, the sub-object settings (such as <see cref="P:ZedGraph.FontSpec.IsAntiAlias"/>)
- will be honored.
- </summary>
- </member>
- <member name="P:ZedGraph.MasterPane.Item(System.Int32)">
- <summary>
- Indexer to access the specified <see cref="T:ZedGraph.GraphPane"/> object from <see cref="P:ZedGraph.MasterPane.PaneList"/>
- by its ordinal position in the list.
- </summary>
- <param name="index">The ordinal position (zero-based) of the
- <see cref="T:ZedGraph.GraphPane"/> object to be accessed.</param>
- <value>A <see cref="T:ZedGraph.GraphPane"/> object reference.</value>
- </member>
- <member name="P:ZedGraph.MasterPane.Item(System.String)">
- <summary>
- Indexer to access the specified <see cref="T:ZedGraph.GraphPane"/> object from <see cref="P:ZedGraph.MasterPane.PaneList"/>
- by its <see cref="P:ZedGraph.PaneBase.Title"/> string.
- </summary>
- <param name="title">The string title of the
- <see cref="T:ZedGraph.GraphPane"/> object to be accessed.</param>
- <value>A <see cref="T:ZedGraph.GraphPane"/> object reference.</value>
- </member>
- <member name="T:ZedGraph.MasterPane.Default">
- <summary>
- A simple struct that defines the
- default property values for the <see cref="T:ZedGraph.MasterPane"/> class.
- </summary>
- </member>
- <member name="F:ZedGraph.MasterPane.Default.PaneLayout">
- <summary>
- The default pane layout for
- <see cref="M:ZedGraph.MasterPane.DoLayout(System.Drawing.Graphics)"/>
- method calls.
- </summary>
- <seealso cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,ZedGraph.PaneLayout)"/>
- <seealso cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,System.Int32,System.Int32)"/>
- <seealso cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,System.Boolean,System.Int32[])"/>
- <seealso cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,System.Boolean,System.Int32[],System.Single[])"/>
- <seealso cref="M:ZedGraph.MasterPane.ReSize(System.Drawing.Graphics,System.Drawing.RectangleF)"/>
- </member>
- <member name="F:ZedGraph.MasterPane.Default.InnerPaneGap">
- <summary>
- The default value for the <see cref="F:ZedGraph.MasterPane.Default.InnerPaneGap"/> property.
- This is the size of the margin between adjacent <see cref="T:ZedGraph.GraphPane"/>
- objects, in units of points (1/72 inch).
- </summary>
- <seealso cref="P:ZedGraph.MasterPane.InnerPaneGap"/>
- </member>
- <member name="F:ZedGraph.MasterPane.Default.IsShowLegend">
- <summary>
- The default value for the <see cref="P:ZedGraph.Legend.IsVisible"/> property for
- the <see cref="T:ZedGraph.MasterPane"/> class.
- </summary>
- </member>
- <member name="F:ZedGraph.MasterPane.Default.IsUniformLegendEntries">
- <summary>
- The default value for the <see cref="F:ZedGraph.MasterPane.Default.IsUniformLegendEntries"/> property.
- </summary>
- </member>
- <member name="F:ZedGraph.MasterPane.Default.IsCommonScaleFactor">
- <summary>
- The default value for the <see cref="F:ZedGraph.MasterPane.Default.IsCommonScaleFactor"/> property.
- </summary>
- </member>
- <member name="T:ZedGraph.GasGaugeRegion">
- <summary>
- A class representing a region on the GasGuage chart
- <see cref="T:ZedGraph.GasGaugeRegion"/>s.
- </summary>
- <author> Jay Mistry </author>
- <version> $Revision: 1.2 $ $Date: 2007-07-30 05:26:23 $ </version>
- </member>
- <member name="F:ZedGraph.GasGaugeRegion.schema2">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="F:ZedGraph.GasGaugeRegion._minValue">
- <summary>
- Defines the minimum value of this <see cref="T:ZedGraph.GasGaugeRegion"/>
- </summary>
- </member>
- <member name="F:ZedGraph.GasGaugeRegion._maxValue">
- <summary>
- Defines the maximum value of this <see cref="T:ZedGraph.GasGaugeRegion"/>
- </summary>
- </member>
- <member name="F:ZedGraph.GasGaugeRegion._color">
- <summary>
- Defines the Color of this <see cref="T:ZedGraph.GasGaugeRegion"/>
- </summary>
- </member>
- <member name="F:ZedGraph.GasGaugeRegion._startAngle">
- <summary>
- Internally calculated; Start angle of this pie that defines this <see cref="T:ZedGraph.GasGaugeRegion"/>
- </summary>
- </member>
- <member name="F:ZedGraph.GasGaugeRegion._sweepAngle">
- <summary>
- Internally calculated; Sweep angle of this pie that defines this <see cref="T:ZedGraph.GasGaugeRegion"/>
- </summary>
- </member>
- <member name="F:ZedGraph.GasGaugeRegion._fill">
- <summary>
- Private field that stores the <see cref="T:ZedGraph.Fill"/> data for this
- <see cref="T:ZedGraph.GasGaugeRegion"/>. Use the public property <see cref="P:ZedGraph.GasGaugeRegion.Fill"/> to
- access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.GasGaugeRegion._labelDetail">
- <summary>
- A <see cref="T:ZedGraph.TextObj"/> which will customize the label display of this
- <see cref="T:ZedGraph.GasGaugeRegion"/>
- </summary>
- </member>
- <member name="F:ZedGraph.GasGaugeRegion._border">
- <summary>
- Private field that stores the <see cref="P:ZedGraph.GasGaugeRegion.Border"/> class that defines the
- properties of the border around this <see cref="T:ZedGraph.GasGaugeRegion"/>. Use the public
- property <see cref="P:ZedGraph.GasGaugeRegion.Border"/> to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.GasGaugeRegion._boundingRectangle">
- <summary>
- The bounding rectangle for this <see cref="T:ZedGraph.GasGaugeRegion"/>.
- </summary>
- </member>
- <member name="F:ZedGraph.GasGaugeRegion._slicePath">
- <summary>
- Private field to hold the GraphicsPath of this <see cref="T:ZedGraph.GasGaugeRegion"/> to be
- used for 'hit testing'.
- </summary>
- </member>
- <member name="M:ZedGraph.GasGaugeRegion.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.GasGaugeRegion.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.GasGaugeRegion.#ctor(System.String,System.Double,System.Double,System.Drawing.Color)">
- <summary>
- Create a new <see cref="T:ZedGraph.GasGaugeRegion"/>
- </summary>
- <param name="label">The value associated with this <see cref="T:ZedGraph.GasGaugeRegion"/> instance.</param>
- <param name="color">The display color for this <see cref="T:ZedGraph.GasGaugeRegion"/> instance.</param>
- <param name="minVal">The minimum value of this <see cref="T:ZedGraph.GasGaugeNeedle"/>.</param>
- <param name="maxVal">The maximum value of this <see cref="T:ZedGraph.GasGaugeNeedle"/>.</param>
- </member>
- <member name="M:ZedGraph.GasGaugeRegion.#ctor(ZedGraph.GasGaugeRegion)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="ggr">The <see cref="T:ZedGraph.GasGaugeRegion"/> object from which to copy</param>
- </member>
- <member name="M:ZedGraph.GasGaugeRegion.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.GasGaugeRegion.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.GasGaugeRegion.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.GasGaugeRegion.IsZIncluded(ZedGraph.GraphPane)">
- <summary>
- Gets a flag indicating if the Z data range should be included in the axis scaling calculations.
- </summary>
- <param name="pane">The parent <see cref="T:ZedGraph.GraphPane"/> of this <see cref="T:ZedGraph.CurveItem"/>.
- </param>
- <value>true if the Z data are included, false otherwise</value>
- </member>
- <member name="M:ZedGraph.GasGaugeRegion.IsXIndependent(ZedGraph.GraphPane)">
- <summary>
- Gets a flag indicating if the X axis is the independent axis for this <see cref="T:ZedGraph.CurveItem"/>
- </summary>
- <param name="pane">The parent <see cref="T:ZedGraph.GraphPane"/> of this <see cref="T:ZedGraph.CurveItem"/>.
- </param>
- <value>true if the X axis is independent, false otherwise</value>
- </member>
- <member name="M:ZedGraph.GasGaugeRegion.Draw(System.Drawing.Graphics,ZedGraph.GraphPane,System.Int32,System.Single)">
- <summary>
- Do all rendering associated with this <see cref="T:ZedGraph.GasGaugeRegion"/> item to the specified
- <see cref="T:System.Drawing.Graphics"/> device. This method is normally only
- called by the Draw method of the parent <see cref="T:ZedGraph.CurveList"/>
- collection object.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="pos">Not used for rendering GasGaugeNeedle</param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.GasGaugeRegion.DrawLegendKey(System.Drawing.Graphics,ZedGraph.GraphPane,System.Drawing.RectangleF,System.Single)">
- <summary>
- Render the label for this <see cref="T:ZedGraph.GasGaugeRegion"/>.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="rect">Bounding rectangle for this <see cref="T:ZedGraph.GasGaugeRegion"/>.</param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.GasGaugeRegion.GetCoords(ZedGraph.GraphPane,System.Int32,System.String@)">
- <summary>
- Determine the coords for the rectangle associated with a specified point for
- this <see cref="T:ZedGraph.CurveItem"/>
- </summary>
- <param name="pane">The <see cref="T:ZedGraph.GraphPane"/> to which this curve belongs</param>
- <param name="i">The index of the point of interest</param>
- <param name="coords">A list of coordinates that represents the "rect" for
- this point (used in an html AREA tag)</param>
- <returns>true if it's a valid point, false otherwise</returns>
- </member>
- <member name="M:ZedGraph.GasGaugeRegion.CalculateGasGuageParameters(ZedGraph.GraphPane)">
- <summary>
- Calculate the values needed to properly display this <see cref="T:ZedGraph.GasGaugeRegion"/>.
- </summary>
- <param name="pane">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- </member>
- <member name="M:ZedGraph.GasGaugeRegion.CalcRectangle(System.Drawing.Graphics,ZedGraph.GraphPane,System.Single,System.Drawing.RectangleF)">
- <summary>
- Calculate the <see cref="T:System.Drawing.RectangleF"/> that will be used to define the bounding rectangle of
- the GasGaugeNeedle.
- </summary>
- <remarks>This rectangle always lies inside of the <see cref="P:ZedGraph.Chart.Rect"/>, and it is
- normally a square so that the pie itself is not oval-shaped.</remarks>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <param name="chartRect">The <see cref="T:System.Drawing.RectangleF"/> (normally the <see cref="P:ZedGraph.Chart.Rect"/>)
- that bounds this pie.</param>
- <returns></returns>
- </member>
- <member name="P:ZedGraph.GasGaugeRegion.SlicePath">
- <summary>
- Gets or sets the SlicePath of this <see cref="T:ZedGraph.GasGaugeRegion"/>
- </summary>
- </member>
- <member name="P:ZedGraph.GasGaugeRegion.LabelDetail">
- <summary>
- Gets or sets the LabelDetail of this <see cref="T:ZedGraph.GasGaugeRegion"/>
- </summary>
- </member>
- <member name="P:ZedGraph.GasGaugeRegion.Border">
- <summary>
- Gets or sets the Border of this <see cref="T:ZedGraph.GasGaugeRegion"/>
- </summary>
- </member>
- <member name="P:ZedGraph.GasGaugeRegion.RegionColor">
- <summary>
- Gets or sets the RegionColor of this <see cref="T:ZedGraph.GasGaugeRegion"/>
- </summary>
- </member>
- <member name="P:ZedGraph.GasGaugeRegion.Fill">
- <summary>
- Gets or sets the Fill of this <see cref="T:ZedGraph.GasGaugeRegion"/>
- </summary>
- </member>
- <member name="P:ZedGraph.GasGaugeRegion.SweepAngle">
- <summary>
- Gets or sets the SweepAngle of this <see cref="T:ZedGraph.GasGaugeRegion"/>
- </summary>
- </member>
- <member name="P:ZedGraph.GasGaugeRegion.StartAngle">
- <summary>
- Gets or sets the StartAngle of this <see cref="T:ZedGraph.GasGaugeRegion"/>
- </summary>
- </member>
- <member name="P:ZedGraph.GasGaugeRegion.MinValue">
- <summary>
- Gets or sets the MinValue of this <see cref="T:ZedGraph.GasGaugeRegion"/>
- </summary>
- </member>
- <member name="P:ZedGraph.GasGaugeRegion.MaxValue">
- <summary>
- Gets or sets the MaxValue of this <see cref="T:ZedGraph.GasGaugeRegion"/>
- </summary>
- </member>
- <member name="T:ZedGraph.GasGaugeRegion.Default">
- <summary>
- Specify the default property values for the <see cref="T:ZedGraph.GasGaugeRegion"/> class.
- </summary>
- </member>
- <member name="F:ZedGraph.GasGaugeRegion.Default.BorderWidth">
- <summary>
- The default border pen width for the <see cref="T:ZedGraph.GasGaugeRegion"/>
- </summary>
- </member>
- <member name="F:ZedGraph.GasGaugeRegion.Default.FillType">
- <summary>
- The default fill type for the <see cref="T:ZedGraph.GasGaugeRegion"/>
- </summary>
- </member>
- <member name="F:ZedGraph.GasGaugeRegion.Default.IsBorderVisible">
- <summary>
- The default value for the visibility of the <see cref="T:ZedGraph.GasGaugeRegion"/> border.
- </summary>
- </member>
- <member name="F:ZedGraph.GasGaugeRegion.Default.BorderColor">
- <summary>
- The default value for the color of the <see cref="T:ZedGraph.GasGaugeRegion"/> border
- </summary>
- </member>
- <member name="F:ZedGraph.GasGaugeRegion.Default.FillColor">
- <summary>
- The default value for the color of the <see cref="T:ZedGraph.GasGaugeRegion"/> fill
- </summary>
- </member>
- <member name="F:ZedGraph.GasGaugeRegion.Default.FillBrush">
- <summary>
- The default value for the fill brush of the <see cref="T:ZedGraph.GasGaugeRegion"/>
- </summary>
- </member>
- <member name="F:ZedGraph.GasGaugeRegion.Default.isVisible">
- <summary>
- The default value for the visibility of the <see cref="T:ZedGraph.GasGaugeRegion"/> fill.
- </summary>
- </member>
- <member name="F:ZedGraph.GasGaugeRegion.Default.FontSize">
- <summary>
- The default value for the font size of the <see cref="T:ZedGraph.GasGaugeRegion"/> labels.
- </summary>
- </member>
- <member name="T:ZedGraph.ColorSymbolRotator">
- <summary>
- Class used to get the next color/symbol for GraphPane.AddCurve methods.
- </summary>
-
- <author> Jerry Vos modified by John Champion </author>
- <version> $Revision: 3.4 $ $Date: 2006-06-24 20:26:43 $ </version>
- </member>
- <member name="F:ZedGraph.ColorSymbolRotator.COLORS">
- <summary>
- The <see cref="T:System.Drawing.Color"/>s <see cref="T:ZedGraph.ColorSymbolRotator"/>
- rotates through.
- </summary>
- </member>
- <member name="F:ZedGraph.ColorSymbolRotator.SYMBOLS">
- <summary>
- The <see cref="T:ZedGraph.SymbolType"/>s <see cref="T:ZedGraph.ColorSymbolRotator"/>
- rotates through.
- </summary>
- </member>
- <member name="F:ZedGraph.ColorSymbolRotator.colorIndex">
- <summary>
- The index of the next color to be used. Note: may be
- > COLORS.Length, it is reset to 0 on the next call if it is.
- </summary>
- </member>
- <member name="F:ZedGraph.ColorSymbolRotator.symbolIndex">
- <summary>
- The index of the next symbol to be used. Note: may be
- > SYMBOLS.Length, it is reset to 0 on the next call if it is.
- </summary>
- </member>
- <member name="P:ZedGraph.ColorSymbolRotator.NextColor">
- <summary>
- Retrieves the next color in the rotation Calling this
- method has the side effect of incrementing the color index.
- <seealso cref="P:ZedGraph.ColorSymbolRotator.NextSymbol"/>
- <seealso cref="P:ZedGraph.ColorSymbolRotator.NextColorIndex"/>
- </summary>
- </member>
- <member name="P:ZedGraph.ColorSymbolRotator.NextColorIndex">
- <summary>
- Retrieves the index of the next color to be used. Calling this
- method has the side effect of incrementing the color index.
- </summary>
- </member>
- <member name="P:ZedGraph.ColorSymbolRotator.NextSymbol">
- <summary>
- Retrieves the next color in the rotation. Calling this
- method has the side effect of incrementing the symbol index.
- <seealso cref="P:ZedGraph.ColorSymbolRotator.NextColor"/>
- <seealso cref="P:ZedGraph.ColorSymbolRotator.NextSymbolIndex"/>
- </summary>
- </member>
- <member name="P:ZedGraph.ColorSymbolRotator.NextSymbolIndex">
- <summary>
- Retrieves the index of the next symbol to be used. Calling this
- method has the side effect of incrementing the symbol index.
- </summary>
- </member>
- <member name="P:ZedGraph.ColorSymbolRotator.StaticInstance">
- <summary>
- Retrieves the <see cref="T:ZedGraph.ColorSymbolRotator"/> instance used by the
- static methods.
- <seealso cref="P:ZedGraph.ColorSymbolRotator.StaticNextColor"/>
- <seealso cref="P:ZedGraph.ColorSymbolRotator.StaticNextSymbol"/>
- </summary>
- </member>
- <member name="P:ZedGraph.ColorSymbolRotator.StaticNextColor">
- <summary>
- Retrieves the next color from this class's static
- <see cref="T:ZedGraph.ColorSymbolRotator"/> instance
- <seealso cref="P:ZedGraph.ColorSymbolRotator.StaticInstance"/>
- <seealso cref="P:ZedGraph.ColorSymbolRotator.StaticNextSymbol"/>
- </summary>
- </member>
- <member name="P:ZedGraph.ColorSymbolRotator.StaticNextSymbol">
- <summary>
- Retrieves the next symbol type from this class's static
- <see cref="T:ZedGraph.ColorSymbolRotator"/> instance
- <seealso cref="P:ZedGraph.ColorSymbolRotator.StaticInstance"/>
- <seealso cref="P:ZedGraph.ColorSymbolRotator.StaticNextColor"/>
- </summary>
- </member>
- <member name="T:ZedGraph.AxisType">
- <summary>
- Enumeration type for the various axis types that are available
- </summary>
- <seealso cref="P:ZedGraph.Axis.Type"/>
- </member>
- <member name="F:ZedGraph.AxisType.Linear">
- <summary> An ordinary, cartesian axis </summary>
- </member>
- <member name="F:ZedGraph.AxisType.Log">
- <summary> A base 10 log axis </summary>
- </member>
- <member name="F:ZedGraph.AxisType.Date">
- <summary> A cartesian axis with calendar dates or times </summary>
- </member>
- <member name="F:ZedGraph.AxisType.Text">
- <summary> An ordinal axis with user-defined text labels. An ordinal axis means that
- all data points are evenly spaced at integral values, and the actual coordinate values
- for points corresponding to that axis are ignored. That is, if the X axis is an
- ordinal type, then all X values associated with the curves are ignored.</summary>
- <seealso cref="F:ZedGraph.AxisType.Ordinal"/>
- <seealso cref="P:ZedGraph.Scale.IsText"/>
- <seealso cref="F:ZedGraph.Scale.Default.MaxTextLabels"/>
- </member>
- <member name="F:ZedGraph.AxisType.Ordinal">
- <summary> An ordinal axis with regular numeric labels. An ordinal axis means that
- all data points are evenly spaced at integral values, and the actual coordinate values
- for points corresponding to that axis are ignored. That is, if the X axis is an
- ordinal type, then all X values associated with the curves are ignored. </summary>
- <seealso cref="F:ZedGraph.AxisType.Text"/>
- <seealso cref="P:ZedGraph.Scale.IsOrdinal"/>
- </member>
- <member name="F:ZedGraph.AxisType.DateAsOrdinal">
- <summary> An ordinal axis that will have labels formatted with ordinal values corresponding
- to the number of values in each <see cref="T:ZedGraph.CurveItem"/>.
- </summary>
- <remarks>
- The <see cref="T:ZedGraph.CurveItem"/> data points will be evenly-spaced at ordinal locations, and the
- actual data values are ignored. </remarks>
- <seealso cref="F:ZedGraph.AxisType.Text"/>
- <seealso cref="P:ZedGraph.Scale.IsOrdinal"/>
- </member>
- <member name="F:ZedGraph.AxisType.LinearAsOrdinal">
- <summary> An ordinal axis that will have labels formatted with values from the actual data
- values of the first <see cref="T:ZedGraph.CurveItem"/> in the <see cref="T:ZedGraph.CurveList"/>.
- </summary>
- <remarks>
- Although the tics are labeled with real data values, the actual points will be
- evenly-spaced in spite of the data values. For example, if the X values of the first curve
- are 1, 5, and 100, then the tic labels will show 1, 5, and 100, but they will be equal
- distance from each other. </remarks>
- <seealso cref="F:ZedGraph.AxisType.Text"/>
- <seealso cref="P:ZedGraph.Scale.IsOrdinal"/>
- </member>
- <member name="F:ZedGraph.AxisType.Exponent">
- <summary> An exponential axis </summary>
- </member>
- <member name="T:ZedGraph.FillType">
- <summary>
- Enumeration type for the various types of fills that can be used with <see cref="T:ZedGraph.Bar"/>
- charts.
- </summary>
- </member>
- <member name="F:ZedGraph.FillType.None">
- <summary> No fill </summary>
- </member>
- <member name="F:ZedGraph.FillType.Solid">
- <summary> A solid fill using <see cref="T:System.Drawing.SolidBrush"/> </summary>
- </member>
- <member name="F:ZedGraph.FillType.Brush">
- <summary> A custom fill using either <see cref="T:System.Drawing.Drawing2D.LinearGradientBrush"/> or
- <see cref="T:System.Drawing.TextureBrush"/></summary>
- </member>
- <member name="F:ZedGraph.FillType.GradientByX">
- <summary>
- Fill with a single solid color based on the X value of the data.</summary>
- <remarks>The X value is
- used to determine the color value based on a gradient brush, and using a data range
- of <see cref="P:ZedGraph.Fill.RangeMin"/> and <see cref="P:ZedGraph.Fill.RangeMax"/>. You can create a multicolor
- range by initializing the <see cref="T:ZedGraph.Fill"/> class with your own custom
- <see cref="F:ZedGraph.FillType.Brush"/> object based on a <see cref="T:System.Drawing.Drawing2D.ColorBlend"/>. In cases where a
- data value makes no sense (<see cref="P:ZedGraph.PaneBase.Fill"/>, <see cref="P:ZedGraph.Legend.Fill"/>,
- etc.), a default value of 50% of the range is assumed. The default range is 0 to 1.
- </remarks>
- <seealso cref="P:ZedGraph.Fill.RangeMin"/>
- <seealso cref="P:ZedGraph.Fill.RangeMax"/>
- <seealso cref="P:ZedGraph.Fill.RangeDefault"/>
- </member>
- <member name="F:ZedGraph.FillType.GradientByY">
- <summary>
- Fill with a single solid color based on the Z value of the data.</summary>
- <remarks>The Z value is
- used to determine the color value based on a gradient brush, and using a data range
- of <see cref="P:ZedGraph.Fill.RangeMin"/> and <see cref="P:ZedGraph.Fill.RangeMax"/>. You can create a multicolor
- range by initializing the <see cref="T:ZedGraph.Fill"/> class with your own custom
- <see cref="F:ZedGraph.FillType.Brush"/> object based on a <see cref="T:System.Drawing.Drawing2D.ColorBlend"/>. In cases where a
- data value makes no sense (<see cref="P:ZedGraph.PaneBase.Fill"/>, <see cref="P:ZedGraph.Legend.Fill"/>,
- etc.), a default value of 50% of the range is assumed. The default range is 0 to 1.
- </remarks>
- <seealso cref="P:ZedGraph.Fill.RangeMin"/>
- <seealso cref="P:ZedGraph.Fill.RangeMax"/>
- <seealso cref="P:ZedGraph.Fill.RangeDefault"/>
- </member>
- <member name="F:ZedGraph.FillType.GradientByZ">
- <summary>
- Fill with a single solid color based on the Z value of the data.</summary>
- <remarks>The Z value is
- used to determine the color value based on a gradient brush, and using a data range
- of <see cref="P:ZedGraph.Fill.RangeMin"/> and <see cref="P:ZedGraph.Fill.RangeMax"/>. You can create a multicolor
- range by initializing the <see cref="T:ZedGraph.Fill"/> class with your own custom
- <see cref="F:ZedGraph.FillType.Brush"/> object based on a <see cref="T:System.Drawing.Drawing2D.ColorBlend"/>. In cases where a
- data value makes no sense (<see cref="P:ZedGraph.PaneBase.Fill"/>, <see cref="P:ZedGraph.Legend.Fill"/>,
- etc.), a default value of 50% of the range is assumed. The default range is 0 to 1.
- </remarks>
- <seealso cref="P:ZedGraph.Fill.RangeMin"/>
- <seealso cref="P:ZedGraph.Fill.RangeMax"/>
- <seealso cref="P:ZedGraph.Fill.RangeDefault"/>
- </member>
- <member name="F:ZedGraph.FillType.GradientByColorValue">
- <summary>
- Fill with a single solid color based on the "ColorValue" property of the data.</summary>
- <remarks>The "ColorValue" property is
- used to determine the color value based on a gradient brush, and using a data range
- of <see cref="P:ZedGraph.Fill.RangeMin"/> and <see cref="P:ZedGraph.Fill.RangeMax"/>. You can create a multicolor
- range by initializing the <see cref="T:ZedGraph.Fill"/> class with your own custom
- <see cref="F:ZedGraph.FillType.Brush"/> object based on a <see cref="T:System.Drawing.Drawing2D.ColorBlend"/>. In cases where a
- data value makes no sense (<see cref="P:ZedGraph.PaneBase.Fill"/>, <see cref="P:ZedGraph.Legend.Fill"/>,
- etc.), a default value of 50% of the range is assumed. The default range is 0 to 1.
- </remarks>
- <seealso cref="P:ZedGraph.Fill.RangeMin"/>
- <seealso cref="P:ZedGraph.Fill.RangeMax"/>
- <seealso cref="P:ZedGraph.Fill.RangeDefault"/>
- </member>
- <member name="T:ZedGraph.DateUnit">
- <summary>
- Enumeration type for the various axis date and time unit types that are available
- </summary>
- </member>
- <member name="F:ZedGraph.DateUnit.Year">
- <summary> Yearly units <see cref="P:ZedGraph.Scale.MajorUnit"/> and <see cref="P:ZedGraph.Scale.MinorUnit"/>
- </summary>
- </member>
- <member name="F:ZedGraph.DateUnit.Month">
- <summary> Monthly units <see cref="P:ZedGraph.Scale.MajorUnit"/> and <see cref="P:ZedGraph.Scale.MinorUnit"/>
- </summary>
- </member>
- <member name="F:ZedGraph.DateUnit.Day">
- <summary> Daily units <see cref="P:ZedGraph.Scale.MajorUnit"/> and <see cref="P:ZedGraph.Scale.MinorUnit"/>
- </summary>
- </member>
- <member name="F:ZedGraph.DateUnit.Hour">
- <summary> Hourly units <see cref="P:ZedGraph.Scale.MajorUnit"/> and <see cref="P:ZedGraph.Scale.MinorUnit"/>
- </summary>
- </member>
- <member name="F:ZedGraph.DateUnit.Minute">
- <summary> Minute units <see cref="P:ZedGraph.Scale.MajorUnit"/> and <see cref="P:ZedGraph.Scale.MinorUnit"/>
- </summary>
- </member>
- <member name="F:ZedGraph.DateUnit.Second">
- <summary> Second units <see cref="P:ZedGraph.Scale.MajorUnit"/> and <see cref="P:ZedGraph.Scale.MinorUnit"/>
- </summary>
- </member>
- <member name="F:ZedGraph.DateUnit.Millisecond">
- <summary> Millisecond units <see cref="P:ZedGraph.Scale.MajorUnit"/> and <see cref="P:ZedGraph.Scale.MinorUnit"/>
- </summary>
- </member>
- <member name="T:ZedGraph.SymbolType">
- <summary>
- Enumeration type for the various symbol shapes that are available
- </summary>
- <seealso cref="P:ZedGraph.Symbol.Fill"/>
- </member>
- <member name="F:ZedGraph.SymbolType.Square">
- <summary> Square-shaped <see cref="T:ZedGraph.Symbol"/> </summary>
- </member>
- <member name="F:ZedGraph.SymbolType.Diamond">
- <summary> Rhombus-shaped <see cref="T:ZedGraph.Symbol"/> </summary>
- </member>
- <member name="F:ZedGraph.SymbolType.Triangle">
- <summary> Equilateral triangle <see cref="T:ZedGraph.Symbol"/> </summary>
- </member>
- <member name="F:ZedGraph.SymbolType.Circle">
- <summary> Uniform circle <see cref="T:ZedGraph.Symbol"/> </summary>
- </member>
- <member name="F:ZedGraph.SymbolType.XCross">
- <summary> "X" shaped <see cref="T:ZedGraph.Symbol"/>. This symbol cannot
- be filled since it has no outline. </summary>
- </member>
- <member name="F:ZedGraph.SymbolType.Plus">
- <summary> "+" shaped <see cref="T:ZedGraph.Symbol"/>. This symbol cannot
- be filled since it has no outline. </summary>
- </member>
- <member name="F:ZedGraph.SymbolType.Star">
- <summary> Asterisk-shaped <see cref="T:ZedGraph.Symbol"/>. This symbol
- cannot be filled since it has no outline. </summary>
- </member>
- <member name="F:ZedGraph.SymbolType.TriangleDown">
- <summary> Unilateral triangle <see cref="T:ZedGraph.Symbol"/>, pointing
- down. </summary>
- </member>
- <member name="F:ZedGraph.SymbolType.HDash">
- <summary>
- Horizontal dash <see cref="T:ZedGraph.Symbol"/>. This symbol cannot be
- filled since it has no outline.
- </summary>
- </member>
- <member name="F:ZedGraph.SymbolType.VDash">
- <summary>
- Vertical dash <see cref="T:ZedGraph.Symbol"/>. This symbol cannot be
- filled since it has no outline.
- </summary>
- </member>
- <member name="F:ZedGraph.SymbolType.UserDefined">
- <summary> A symbol defined by the <see cref="P:ZedGraph.Symbol.UserSymbol"/> propery.
- If no symbol is defined, the <see cref="F:ZedGraph.Symbol.Default.Type"/>. symbol will
- be used.
- </summary>
- </member>
- <member name="F:ZedGraph.SymbolType.Default">
- <summary> A Default symbol type (the symbol type will be obtained
- from <see cref="F:ZedGraph.Symbol.Default.Type"/>. </summary>
- </member>
- <member name="F:ZedGraph.SymbolType.None">
- <summary> No symbol is shown (this is equivalent to using
- <see cref="P:ZedGraph.Symbol.IsVisible"/> = false.</summary>
- </member>
- <member name="T:ZedGraph.LegendPos">
- <summary>
- Enumeration type that defines the possible legend locations
- </summary>
- <seealso cref="P:ZedGraph.Legend.Position"/>
- </member>
- <member name="F:ZedGraph.LegendPos.Top">
- <summary>
- Locate the <see cref="T:ZedGraph.Legend"/> above the <see cref="P:ZedGraph.Chart.Rect"/>
- </summary>
- </member>
- <member name="F:ZedGraph.LegendPos.Left">
- <summary>
- Locate the <see cref="T:ZedGraph.Legend"/> on the left side of the <see cref="P:ZedGraph.Chart.Rect"/>
- </summary>
- </member>
- <member name="F:ZedGraph.LegendPos.Right">
- <summary>
- Locate the <see cref="T:ZedGraph.Legend"/> on the right side of the <see cref="P:ZedGraph.Chart.Rect"/>
- </summary>
- </member>
- <member name="F:ZedGraph.LegendPos.Bottom">
- <summary>
- Locate the <see cref="T:ZedGraph.Legend"/> below the <see cref="P:ZedGraph.Chart.Rect"/>
- </summary>
- </member>
- <member name="F:ZedGraph.LegendPos.InsideTopLeft">
- <summary>
- Locate the <see cref="T:ZedGraph.Legend"/> inside the <see cref="P:ZedGraph.Chart.Rect"/> in the
- top-left corner.
- </summary>
- </member>
- <member name="F:ZedGraph.LegendPos.InsideTopRight">
- <summary>
- Locate the <see cref="T:ZedGraph.Legend"/> inside the <see cref="P:ZedGraph.Chart.Rect"/> in the
- top-right corner.
- </summary>
- </member>
- <member name="F:ZedGraph.LegendPos.InsideBotLeft">
- <summary>
- Locate the <see cref="T:ZedGraph.Legend"/> inside the <see cref="P:ZedGraph.Chart.Rect"/> in the
- bottom-left corner.
- </summary>
- </member>
- <member name="F:ZedGraph.LegendPos.InsideBotRight">
- <summary>
- Locate the <see cref="T:ZedGraph.Legend"/> inside the <see cref="P:ZedGraph.Chart.Rect"/> in the
- bottom-right corner.
- </summary>
- </member>
- <member name="F:ZedGraph.LegendPos.Float">
- <summary>
- Locate the <see cref="T:ZedGraph.Legend"/> as a floating object above the graph at the
- location specified by <see cref="P:ZedGraph.Legend.Location"/>.
- </summary>
- </member>
- <member name="F:ZedGraph.LegendPos.TopCenter">
- <summary>
- Locate the <see cref="T:ZedGraph.Legend"/> centered above the <see cref="P:ZedGraph.Chart.Rect"/>
- </summary>
- </member>
- <member name="F:ZedGraph.LegendPos.BottomCenter">
- <summary>
- Locate the <see cref="T:ZedGraph.Legend"/> centered below the <see cref="P:ZedGraph.Chart.Rect"/>
- </summary>
- </member>
- <member name="F:ZedGraph.LegendPos.TopFlushLeft">
- <summary>
- Locate the <see cref="T:ZedGraph.Legend"/> above the <see cref="P:ZedGraph.Chart.Rect"/>, but flush
- against the left margin of the <see cref="P:ZedGraph.PaneBase.Rect"/>.
- </summary>
- </member>
- <member name="F:ZedGraph.LegendPos.BottomFlushLeft">
- <summary>
- Locate the <see cref="T:ZedGraph.Legend"/> below the <see cref="P:ZedGraph.Chart.Rect"/>, but flush
- against the left margin of the <see cref="P:ZedGraph.PaneBase.Rect"/>.
- </summary>
- </member>
- <member name="T:ZedGraph.AlignH">
- <summary>
- Enumeration type for the different horizontal text alignment options
- </summary>
- <seealso cref="T:ZedGraph.FontSpec"/>
- </member>
- <member name="F:ZedGraph.AlignH.Left">
- <summary>
- Position the text so that its left edge is aligned with the
- specified X,Y location. Used by the
- <see cref="M:ZedGraph.FontSpec.Draw(System.Drawing.Graphics,ZedGraph.PaneBase,System.String,System.Single,System.Single,ZedGraph.AlignH,ZedGraph.AlignV,System.Single)"/> method.
- </summary>
- </member>
- <member name="F:ZedGraph.AlignH.Center">
- <summary>
- Position the text so that its center is aligned (horizontally) with the
- specified X,Y location. Used by the
- <see cref="M:ZedGraph.FontSpec.Draw(System.Drawing.Graphics,ZedGraph.PaneBase,System.String,System.Single,System.Single,ZedGraph.AlignH,ZedGraph.AlignV,System.Single)"/> method.
- </summary>
- </member>
- <member name="F:ZedGraph.AlignH.Right">
- <summary>
- Position the text so that its right edge is aligned with the
- specified X,Y location. Used by the
- <see cref="M:ZedGraph.FontSpec.Draw(System.Drawing.Graphics,ZedGraph.PaneBase,System.String,System.Single,System.Single,ZedGraph.AlignH,ZedGraph.AlignV,System.Single)"/> method.
- </summary>
- </member>
- <member name="T:ZedGraph.AlignP">
- <summary>
- Enumeration type for the different proximal alignment options
- </summary>
- <seealso cref="T:ZedGraph.FontSpec"/>
- <seealso cref="P:ZedGraph.Scale.Align"/>
- </member>
- <member name="F:ZedGraph.AlignP.Inside">
- <summary>
- Position the text so that its "inside" edge (the edge that is
- nearest to the alignment reference point or object) is aligned.
- Used by the <see cref="P:ZedGraph.Scale.Align"/> method to align text
- to the axis.
- </summary>
- </member>
- <member name="F:ZedGraph.AlignP.Center">
- <summary>
- Position the text so that its center is aligned with the
- reference object or point.
- Used by the <see cref="P:ZedGraph.Scale.Align"/> method to align text
- to the axis.
- </summary>
- </member>
- <member name="F:ZedGraph.AlignP.Outside">
- <summary>
- Position the text so that its right edge (the edge that is
- farthest from the alignment reference point or object) is aligned.
- Used by the <see cref="P:ZedGraph.Scale.Align"/> method to align text
- to the axis.
- </summary>
- </member>
- <member name="T:ZedGraph.AlignV">
- <summary>
- Enumeration type for the different vertical text alignment options
- </summary>
- specified X,Y location. Used by the
- <see cref="M:ZedGraph.FontSpec.Draw(System.Drawing.Graphics,ZedGraph.PaneBase,System.String,System.Single,System.Single,ZedGraph.AlignH,ZedGraph.AlignV,System.Single)"/> method.
- </member>
- <member name="F:ZedGraph.AlignV.Top">
- <summary>
- Position the text so that its top edge is aligned with the
- specified X,Y location. Used by the
- <see cref="M:ZedGraph.FontSpec.Draw(System.Drawing.Graphics,ZedGraph.PaneBase,System.String,System.Single,System.Single,ZedGraph.AlignH,ZedGraph.AlignV,System.Single)"/> method.
- </summary>
- </member>
- <member name="F:ZedGraph.AlignV.Center">
- <summary>
- Position the text so that its center is aligned (vertically) with the
- specified X,Y location. Used by the
- <see cref="M:ZedGraph.FontSpec.Draw(System.Drawing.Graphics,ZedGraph.PaneBase,System.String,System.Single,System.Single,ZedGraph.AlignH,ZedGraph.AlignV,System.Single)"/> method.
- </summary>
- </member>
- <member name="F:ZedGraph.AlignV.Bottom">
- <summary>
- Position the text so that its bottom edge is aligned with the
- specified X,Y location. Used by the
- <see cref="M:ZedGraph.FontSpec.Draw(System.Drawing.Graphics,ZedGraph.PaneBase,System.String,System.Single,System.Single,ZedGraph.AlignH,ZedGraph.AlignV,System.Single)"/> method.
- </summary>
- </member>
- <member name="T:ZedGraph.CoordType">
- <summary>
- Enumeration type for the user-defined coordinate types available.
- These coordinate types are used the <see cref="T:ZedGraph.ArrowObj"/> objects
- and <see cref="T:ZedGraph.TextObj"/> objects only.
- </summary>
- <seealso cref="P:ZedGraph.Location.CoordinateFrame"/>
- </member>
- <member name="F:ZedGraph.CoordType.ChartFraction">
- <summary>
- Coordinates are specified as a fraction of the
- <see cref="P:ZedGraph.Chart.Rect"/>. That is, for the X coordinate, 0.0
- is at the left edge of the ChartRect and 1.0
- is at the right edge of the ChartRect. A value less
- than zero is left of the ChartRect and a value
- greater than 1.0 is right of the ChartRect. For the Y coordinate, 0.0
- is the top and 1.0 is the bottom.
- </summary>
- </member>
- <member name="F:ZedGraph.CoordType.PaneFraction">
- <summary>
- Coordinates are specified as a fraction of the
- <see cref="P:ZedGraph.PaneBase.Rect"/>. That is, for the X coordinate, 0.0
- is at the left edge of the Rect and 1.0
- is at the right edge of the Rect. A value less
- than zero is left of the Rect and a value
- greater than 1.0 is right of the Rect. For the Y coordinate, 0.0
- is the top and 1.0 is the bottom. Note that
- any value less than zero or greater than 1.0 will be outside
- the Rect, and therefore clipped.
- </summary>
- </member>
- <member name="F:ZedGraph.CoordType.AxisXYScale">
- <summary>
- Coordinates are specified according to the user axis scales
- for the <see cref="P:ZedGraph.GraphPane.XAxis"/> and <see cref="P:ZedGraph.GraphPane.YAxis"/>.
- </summary>
- </member>
- <member name="F:ZedGraph.CoordType.AxisXY2Scale">
- <summary>
- Coordinates are specified according to the user axis scales
- for the <see cref="P:ZedGraph.GraphPane.XAxis"/> and <see cref="P:ZedGraph.GraphPane.Y2Axis"/>.
- </summary>
- </member>
- <member name="F:ZedGraph.CoordType.XChartFractionYPaneFraction">
- <summary>
- The X coordinate is specified as a fraction of the <see cref="P:ZedGraph.Chart.Rect"/>,
- and the Y coordinate is specified as a fraction of the <see cref="P:ZedGraph.PaneBase.Rect"/>.
- </summary>
- <remarks>
- For the X coordinate, 0.0
- is at the left edge of the ChartRect and 1.0
- is at the right edge of the ChartRect. A value less
- than zero is left of the ChartRect and a value
- greater than 1.0 is right of the ChartRect. For the Y coordinate, a value of zero is at
- the left side of the pane, and a value of 1.0 is at the right side of the pane.
- </remarks>
- </member>
- <member name="F:ZedGraph.CoordType.XPaneFractionYChartFraction">
- <summary>
- The X coordinate is specified as a fraction of the <see cref="P:ZedGraph.PaneBase.Rect"/>,
- and the Y coordinate is specified as a fraction of the <see cref="P:ZedGraph.Chart.Rect"/>.
- </summary>
- <remarks>
- For the X coordinate, a value of zero is at
- the left side of the pane, and a value of 1.0 is at the right side of the pane.
- For the Y coordinate, 0.0
- is at the top edge of the ChartRect and 1.0
- is at the bottom edge of the ChartRect. A value less
- than zero is above the ChartRect and a value
- greater than 1.0 is below the ChartRect.
- </remarks>
- </member>
- <member name="F:ZedGraph.CoordType.XScaleYChartFraction">
- <summary>
- The X coordinate is specified as an X Scale value, and the Y coordinate
- is specified as a fraction of the <see cref="P:ZedGraph.Chart.Rect"/>.
- </summary>
- <remarks>
- For the X coordinate, the value just corresponds to the values of the X scale.
- Values outside the scale range will be
- outside the <see cref="P:ZedGraph.Chart.Rect"/>. For the Y coordinate, 0.0
- is at the top edge of the ChartRect and 1.0
- is at the bottom edge of the ChartRect. A value less
- than zero is above the ChartRect and a value
- greater than 1.0 is below the ChartRect.
- </remarks>
- </member>
- <member name="F:ZedGraph.CoordType.XChartFractionYScale">
- <summary>
- The X coordinate is specified as a fraction of the
- <see cref="P:ZedGraph.Chart.Rect"/> and the Y coordinate is specified as
- a Y scale value.
- </summary>
- <remarks>
- For the X coordinate, 0.0
- is at the left edge of the ChartRect and 1.0
- is at the right edge of the ChartRect. A value less
- than zero is left of the ChartRect and a value
- greater than 1.0 is right of the ChartRect. For the Y coordinate, the value just
- corresponds to the values of the Y scale. Values outside the scale range will be
- outside the <see cref="P:ZedGraph.Chart.Rect"/>.
- </remarks>
- </member>
- <member name="F:ZedGraph.CoordType.XChartFractionY2Scale">
- <summary>
- The X coordinate is specified as a fraction of the
- <see cref="P:ZedGraph.Chart.Rect"/> and the Y coordinate is specified as
- a Y2 scale value.
- </summary>
- <remarks>
- For the X coordinate, 0.0
- is at the left edge of the ChartRect and 1.0
- is at the right edge of the ChartRect. A value less
- than zero is left of the ChartRect and a value
- greater than 1.0 is right of the ChartRect. For the Y coordinate, the value just
- corresponds to the values of the Y2 scale. Values outside the scale range will be
- outside the <see cref="P:ZedGraph.Chart.Rect"/>.
- </remarks>
- </member>
- <member name="T:ZedGraph.StepType">
- <summary>
- Enumeration type that defines how a curve is drawn. Curves can be drawn
- as ordinary lines by connecting the points directly, or in a stair-step
- fashion as a series of discrete, constant values. In a stair step plot,
- all lines segments are either horizontal or vertical. In a non-step (line)
- plot, the lines can be any angle.
- </summary>
- <seealso cref="P:ZedGraph.Line.StepType"/>
- </member>
- <member name="F:ZedGraph.StepType.ForwardStep">
- <summary>
- Draw the <see cref="T:ZedGraph.CurveItem"/> as a stair-step in which each
- point defines the
- beginning (left side) of a new stair. This implies the points are
- defined at the beginning of an "event."
- </summary>
- </member>
- <member name="F:ZedGraph.StepType.RearwardStep">
- <summary>
- Draw the <see cref="T:ZedGraph.CurveItem"/> as a stair-step in which each
- point defines the end (right side) of a new stair. This implies
- the points are defined at the end of an "event."
- </summary>
- </member>
- <member name="F:ZedGraph.StepType.NonStep">
- <summary>
- Draw the <see cref="T:ZedGraph.CurveItem"/> as an ordinary line, in which the
- points are connected directly by line segments.
- </summary>
- </member>
- <member name="F:ZedGraph.StepType.ForwardSegment">
- <summary>
- Draw the <see cref="T:ZedGraph.CurveItem"/> as a segment in which each point defines the
- beginning (left side) of a new "stair." This implies the points are defined
- at the beginning of an "event." Note that ForwardSegment is different
- from ForwardStep in that it does not draw the vertical portion of the step.
- </summary>
- </member>
- <member name="F:ZedGraph.StepType.RearwardSegment">
- <summary>
- Draw the <see cref="T:ZedGraph.CurveItem"/> as a segment in which each point defines the
- end (right side) of a new "stair." This implies the points are defined
- at the end of an "event." Note that RearwardSegment is different
- from RearwardStep in that it does not draw the vertical portion of the step.
- </summary>
- </member>
- <member name="T:ZedGraph.BarBase">
- <summary>
- Enumeration type that defines the base axis from which <see cref="T:ZedGraph.Bar"/> graphs
- are displayed. The bars can be drawn on any of the four axes (<see cref="T:ZedGraph.XAxis"/>,
- <see cref="T:ZedGraph.X2Axis"/>, <see cref="T:ZedGraph.YAxis"/>, and <see cref="T:ZedGraph.Y2Axis"/>).
- </summary>
- <seealso cref="P:ZedGraph.BarSettings.Base"/>
- </member>
- <member name="F:ZedGraph.BarBase.X">
- <summary>
- Draw the <see cref="T:ZedGraph.Bar"/> chart based from the <see cref="T:ZedGraph.XAxis"/>.
- </summary>
- </member>
- <member name="F:ZedGraph.BarBase.X2">
- <summary>
- Draw the <see cref="T:ZedGraph.Bar"/> chart based from the <see cref="T:ZedGraph.X2Axis"/>.
- </summary>
- </member>
- <member name="F:ZedGraph.BarBase.Y">
- <summary>
- Draw the <see cref="T:ZedGraph.Bar"/> chart based from the <see cref="T:ZedGraph.YAxis"/>.
- </summary>
- </member>
- <member name="F:ZedGraph.BarBase.Y2">
- <summary>
- Draw the <see cref="T:ZedGraph.Bar"/> chart based from the <see cref="T:ZedGraph.Y2Axis"/>.
- </summary>
- </member>
- <member name="T:ZedGraph.LineType">
- <summary>
- Enumeration type that defines the available types of <see cref="T:ZedGraph.LineItem"/> graphs.
- </summary>
- <seealso cref="P:ZedGraph.GraphPane.LineType"/>
- </member>
- <member name="F:ZedGraph.LineType.Normal">
- <summary>
- Draw the lines as normal. Any fill area goes from each line down to the X Axis.
- </summary>
- </member>
- <member name="F:ZedGraph.LineType.Stack">
- <summary>
- Draw the lines stacked on top of each other, accumulating values to a total value.
- </summary>
- </member>
- <member name="T:ZedGraph.BarType">
- <summary>
- Enumeration type that defines the available types of <see cref="T:ZedGraph.BarItem"/> graphs.
- </summary>
- <seealso cref="P:ZedGraph.BarSettings.Type"/>
- </member>
- <member name="F:ZedGraph.BarType.Cluster">
- <summary>
- Draw each <see cref="T:ZedGraph.BarItem"/> side by side in clusters.
- </summary>
- </member>
- <member name="F:ZedGraph.BarType.Overlay">
- <summary>
- Draw the <see cref="T:ZedGraph.BarItem"/> bars one on top of the other. The bars will
- be drawn such that the last bar in the <see cref="T:ZedGraph.CurveList"/> will be behind
- all other bars. Note that the bar values are not summed up for the overlay
- mode. The data values must be summed before being passed
- to <see cref="M:ZedGraph.GraphPane.AddBar(System.String,ZedGraph.IPointList,System.Drawing.Color)"/>.
- For example, if the first bar of
- the first <see cref="T:ZedGraph.BarItem"/> has a value of 100, and the first bar of
- the second <see cref="T:ZedGraph.BarItem"/> has a value of 120, then that bar will
- appear to be 20 units on top of the first bar.
- </summary>
- </member>
- <member name="F:ZedGraph.BarType.SortedOverlay">
- <summary>
- Draw the <see cref="T:ZedGraph.BarItem"/> bars one on top of the other. The bars will
- be drawn such that the bars are sorted according to the maximum value, with
- the tallest bar at each point at the back and the shortest bar at the front.
- This is similar to the <see cref="F:ZedGraph.BarType.Overlay"/> mode, but the bars are sorted at
- each base value.
- The data values must be summed before being passed
- to <see cref="M:ZedGraph.GraphPane.AddBar(System.String,ZedGraph.IPointList,System.Drawing.Color)"/>. For example, if the first bar of
- the first <see cref="T:ZedGraph.BarItem"/> has a value of 100, and the first bar of
- the second <see cref="T:ZedGraph.BarItem"/> has a value of 120, then that bar will
- appear to be 20 units on top of the first bar.
- </summary>
- </member>
- <member name="F:ZedGraph.BarType.Stack">
- <summary>
- Draw the <see cref="T:ZedGraph.BarItem"/> bars in an additive format so that they stack on
- top of one another. The value of the last bar drawn will be the sum of the values
- of all prior bars.
- </summary>
- </member>
- <member name="F:ZedGraph.BarType.PercentStack">
- <summary>
- Draw the <see cref="T:ZedGraph.BarItem"/> bars in a format whereby the height of each
- represents the percentage of the total each one represents. Negative values
- are displayed below the zero line as percentages of the absolute total of all values.
- </summary>
- </member>
- <member name="T:ZedGraph.SortType">
- <summary>
- Enumeration type that defines which set of data points - X or Y - is used
- <seealso cref="M:System.Collections.ArrayList.Sort"/> to perform the sort.
- </summary>
- </member>
- <member name="F:ZedGraph.SortType.YValues">
- <summary>
- Use the Y values to sort the list.
- </summary>
- </member>
- <member name="F:ZedGraph.SortType.XValues">
- <summary>
- Use the X values to sort the list.
- </summary>
- </member>
- <member name="T:ZedGraph.ZOrder">
- <summary>
- Enumeration that specifies a Z-Order position for <see cref="T:ZedGraph.GraphObj"/>
- objects.
- </summary>
- <remarks>This enumeration allows you to set the layering of various graph
- features. Except for the <see cref="T:ZedGraph.GraphObj"/> objects, other feature types
- all have a fixed depth as follows (front to back):
- <list>
- <see cref="T:ZedGraph.Legend"/> objects
- The border around <see cref="P:ZedGraph.Chart.Rect"/>
- <see cref="T:ZedGraph.CurveItem"/> objects
- The <see cref="T:ZedGraph.Axis"/> features
- The background fill of the <see cref="P:ZedGraph.Chart.Rect"/>
- The pane <see cref="P:ZedGraph.PaneBase.Title"/>
- The background fill of the <see cref="P:ZedGraph.PaneBase.Rect"/>
- </list>
- You cannot place anything behind the <see cref="P:ZedGraph.PaneBase.Rect"/>
- background fill, but <see cref="P:ZedGraph.GraphObj.ZOrder"/> allows you to
- explicitly control the depth of <see cref="T:ZedGraph.GraphObj"/> objects
- between all other object types. For items of equal <see cref="T:ZedGraph.ZOrder"/>,
- such as multiple <see cref="T:ZedGraph.CurveItem"/>'s or <see cref="T:ZedGraph.GraphObj"/>'s
- having the same <see cref="T:ZedGraph.ZOrder"/> value, the relative depth is
- controlled by the ordinal position in the list (either
- <see cref="T:ZedGraph.CurveList"/> or <see cref="T:ZedGraph.GraphObjList"/>).
- <see cref="T:ZedGraph.GraphObj"/> objects
- can be placed in the <see cref="T:ZedGraph.GraphObjList"/> of either a
- <see cref="T:ZedGraph.GraphPane"/> or a <see cref="T:ZedGraph.MasterPane"/>. For a
- <see cref="T:ZedGraph.GraphPane"/>-based <see cref="T:ZedGraph.GraphObj"/>, all <see cref="T:ZedGraph.ZOrder"/>
- values are applicable. For a <see cref="T:ZedGraph.MasterPane"/>-based
- <see cref="T:ZedGraph.GraphObj"/>, any <see cref="T:ZedGraph.ZOrder"/> value can be used, but there
- are really only three depths:
- <list><see cref="F:ZedGraph.ZOrder.H_BehindAll"/> will place the item behind the pane title,
- <see cref="F:ZedGraph.ZOrder.A_InFront"/> will place on top of all other graph features,
- any other value places the object above the pane title, but behind the <see cref="T:ZedGraph.GraphPane"/>'s.
- </list>
- </remarks>
- </member>
- <member name="F:ZedGraph.ZOrder.H_BehindAll">
- <summary>
- Specifies that the <see cref="T:ZedGraph.GraphObj"/> will be behind all other
- objects (including the <see cref="T:ZedGraph.PaneBase"/> <see cref="P:ZedGraph.PaneBase.Title"/>).
- </summary>
- </member>
- <member name="F:ZedGraph.ZOrder.G_BehindChartFill">
- <summary>
- Specifies that the <see cref="T:ZedGraph.GraphObj"/> will be behind the
- <see cref="P:ZedGraph.Chart.Rect"/> background <see cref="T:ZedGraph.Fill"/>
- (see <see cref="P:ZedGraph.Chart.Fill"/>).
- </summary>
- </member>
- <member name="F:ZedGraph.ZOrder.F_BehindGrid">
- <summary>
- Specifies that the <see cref="T:ZedGraph.GraphObj"/> will be behind the grid lines.
- </summary>
- </member>
- <member name="F:ZedGraph.ZOrder.E_BehindCurves">
- <summary>
- Specifies that the <see cref="T:ZedGraph.GraphObj"/> will be behind the
- <see cref="T:ZedGraph.CurveItem"/> objects.
- </summary>
- </member>
- <member name="F:ZedGraph.ZOrder.D_BehindAxis">
- <summary>
- Specifies that the <see cref="T:ZedGraph.GraphObj"/> will be behind the
- <see cref="T:ZedGraph.Axis"/> objects.
- </summary>
- </member>
- <member name="F:ZedGraph.ZOrder.C_BehindChartBorder">
- <summary>
- Specifies that the <see cref="T:ZedGraph.GraphObj"/> will be behind the
- <see cref="T:ZedGraph.Chart"/> border.
- </summary>
- </member>
- <member name="F:ZedGraph.ZOrder.B_BehindLegend">
- <summary>
- Specifies that the <see cref="T:ZedGraph.GraphObj"/> will be behind the
- <see cref="T:ZedGraph.Legend"/> object.
- </summary>
- </member>
- <member name="F:ZedGraph.ZOrder.A_InFront">
- <summary>
- Specifies that the <see cref="T:ZedGraph.GraphObj"/> will be in front of
- all other objects, except for the other <see cref="T:ZedGraph.GraphObj"/>
- objects that have the same <see cref="T:ZedGraph.ZOrder"/> and are before
- this object in the <see cref="T:ZedGraph.GraphObjList"/>.
- </summary>
- </member>
- <member name="T:ZedGraph.PieLabelType">
- <summary>
- Enumeration that determines the type of label that is displayed for each pie slice
- (see <see cref="P:ZedGraph.PieItem.LabelType"/>).
- </summary>
- </member>
- <member name="F:ZedGraph.PieLabelType.Name_Value">
- <summary>
- Displays <see cref="P:ZedGraph.CurveItem.Label"/> and <see cref="P:ZedGraph.PieItem.Value"/> for
- a slice in a Pie Chart.
- </summary>
- </member>
- <member name="F:ZedGraph.PieLabelType.Name_Percent">
- <summary>
- Displays <see cref="P:ZedGraph.CurveItem.Label"/> and <see cref="P:ZedGraph.PieItem.Value"/> (as % of total) for
- a slice in a Pie Chart.
- </summary>
- </member>
- <member name="F:ZedGraph.PieLabelType.Name_Value_Percent">
- <summary>
- Displays a <see cref="P:ZedGraph.CurveItem.Label"/> containing the <see cref="P:ZedGraph.PieItem.Value"/> both
- as an absolute number and as percentage of the total.
- </summary>
- </member>
- <member name="F:ZedGraph.PieLabelType.Value">
- <summary>
- Displays <see cref="P:ZedGraph.PieItem.Value"/> for
- a slice in a Pie Chart.
- </summary>
- </member>
- <member name="F:ZedGraph.PieLabelType.Percent">
- <summary>
- Displays <see cref="P:ZedGraph.PieItem.Value"/> (as % of total) for
- a slice in a Pie Chart.
- </summary>
- </member>
- <member name="F:ZedGraph.PieLabelType.Name">
- <summary>
- Displays <see cref="P:ZedGraph.CurveItem.Label"/> for a slice in a Pie Chart.
- </summary>
- </member>
- <member name="F:ZedGraph.PieLabelType.None">
- <summary>
- No label displayed.
- </summary>
- </member>
- <member name="T:ZedGraph.PaneLayout">
- <summary>
- Define the auto layout options for the
- <see cref="M:ZedGraph.MasterPane.SetLayout(System.Drawing.Graphics,ZedGraph.PaneLayout)"/> method.
- </summary>
- </member>
- <member name="F:ZedGraph.PaneLayout.ForceSquare">
- <summary>
- Layout the <see cref="T:ZedGraph.GraphPane"/>'s so they are in a square grid (always 2x2, 3x3, 4x4),
- leaving blank spaces as required.
- </summary>
- <remarks>For example, a single pane would generate a 1x1 grid, between 2 and 4 panes would generate
- a 2x2 grid, 5 to 9 panes would generate a 3x3 grid.</remarks>
- </member>
- <member name="F:ZedGraph.PaneLayout.SquareColPreferred">
- <summary>
- Layout the <see cref="T:ZedGraph.GraphPane"/>'s so they are in a general square (2x2, 3x3, etc.), but use extra
- columns when necessary (row x column = 1x2, 2x3, 3x4, etc.) depending on the total number
- of panes required.
- </summary>
- <remarks>For example, a 2x2 grid has four panes and a 3x3 grid has 9 panes. If there are
- 6 panes required, then this option will eliminate a row (column preferred) to make a
- 2 row x 3 column grid. With 7 panes, it will make a 3x3 grid with 2 empty spaces.</remarks>
- </member>
- <member name="F:ZedGraph.PaneLayout.SquareRowPreferred">
- <summary>
- Layout the <see cref="T:ZedGraph.GraphPane"/>'s so they are in a general square (2x2, 3x3, etc.), but use extra
- rows when necessary (2x1, 3x2, 4x3, etc.) depending on the total number of panes required.
- </summary>
- <remarks>For example, a 2x2 grid has four panes and a 3x3 grid has 9 panes. If there are
- 6 panes required, then this option will eliminate a column (row preferred) to make a
- 3 row x 2 column grid. With 7 panes, it will make a 3x3 grid with 2 empty spaces.</remarks>
- </member>
- <member name="F:ZedGraph.PaneLayout.SingleRow">
- <summary>
- Layout the <see cref="T:ZedGraph.GraphPane"/>'s in a single row
- </summary>
- </member>
- <member name="F:ZedGraph.PaneLayout.SingleColumn">
- <summary>
- Layout the <see cref="T:ZedGraph.GraphPane"/>'s in a single column
- </summary>
- </member>
- <member name="F:ZedGraph.PaneLayout.ExplicitCol12">
- <summary>
- Layout the <see cref="T:ZedGraph.GraphPane"/>'s with an explicit number of columns: The first row has
- 1 column and the second row has 2 columns for a total of 3 panes.
- </summary>
- </member>
- <member name="F:ZedGraph.PaneLayout.ExplicitCol21">
- <summary>
- Layout the <see cref="T:ZedGraph.GraphPane"/>'s with an explicit number of columns: The first row has
- 2 columns and the second row has 1 column for a total of 3 panes.
- </summary>
- </member>
- <member name="F:ZedGraph.PaneLayout.ExplicitCol23">
- <summary>
- Layout the <see cref="T:ZedGraph.GraphPane"/>'s with an explicit number of columns: The first row has
- 2 columns and the second row has 3 columns for a total of 5 panes.
- </summary>
- </member>
- <member name="F:ZedGraph.PaneLayout.ExplicitCol32">
- <summary>
- Layout the <see cref="T:ZedGraph.GraphPane"/>'s with an explicit number of columns: The first row has
- 3 columns and the second row has 2 columns for a total of 5 panes.
- </summary>
- </member>
- <member name="F:ZedGraph.PaneLayout.ExplicitRow12">
- <summary>
- Layout the <see cref="T:ZedGraph.GraphPane"/>'s with an explicit number of rows: The first column has
- 1 row and the second column has 2 rows for a total of 3 panes.
- </summary>
- </member>
- <member name="F:ZedGraph.PaneLayout.ExplicitRow21">
- <summary>
- Layout the <see cref="T:ZedGraph.GraphPane"/>'s with an explicit number of rows: The first column has
- 2 rows and the second column has 1 row for a total of 3 panes.
- </summary>
- </member>
- <member name="F:ZedGraph.PaneLayout.ExplicitRow23">
- <summary>
- Layout the <see cref="T:ZedGraph.GraphPane"/>'s with an explicit number of rows: The first column has
- 2 rows and the second column has 3 rows for a total of 5 panes.
- </summary>
- </member>
- <member name="F:ZedGraph.PaneLayout.ExplicitRow32">
- <summary>
- Layout the <see cref="T:ZedGraph.GraphPane"/>'s with an explicit number of rows: The first column has
- 3 rows and the second column has 2 rows for a total of 5 panes.
- </summary>
- </member>
- <member name="T:ZedGraph.RenderModeType">
- <summary>
- Enum for specifying the type of data to be returned by the ZedGraphWeb Render() method.
- </summary>
- </member>
- <member name="F:ZedGraph.RenderModeType.ImageTag">
- <summary>
- Renders as an IMG tag referencing a local generated image. ContentType stays text.
- </summary>
- </member>
- <member name="F:ZedGraph.RenderModeType.RawImage">
- <summary>
- Renders the binary image. ContentType is changed accordingly.
- </summary>
- </member>
- <member name="T:ZedGraph.PieItem">
- <summary>
- A class representing a pie chart object comprised of one or more
- <see cref="T:ZedGraph.PieItem"/>s.
- </summary>
- <author> Bob Kaye </author>
- <version> $Revision: 1.32 $ $Date: 2007-07-30 05:26:23 $ </version>
- </member>
- <member name="F:ZedGraph.PieItem.schema2">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="F:ZedGraph.PieItem._displacement">
- <summary>
- Percentage (expressed as #.##) of <see cref="T:ZedGraph.PieItem"/> radius to
- which this <see cref="T:ZedGraph.PieItem"/> is to be displaced from the center.
- Displacement is done outward along the radius
- bisecting the chord of this <see cref="T:ZedGraph.PieItem"/>. Maximum allowable value
- is 0.5.
- </summary>
- </member>
- <member name="F:ZedGraph.PieItem._labelDetail">
- <summary>
- A <see cref="T:ZedGraph.TextObj"/> which will customize the label display of this
- <see cref="T:ZedGraph.PieItem"/>
- </summary>
- </member>
- <member name="F:ZedGraph.PieItem._fill">
- <summary>
- Private field that stores the <see cref="T:ZedGraph.Fill"/> data for this
- <see cref="T:ZedGraph.PieItem"/>. Use the public property <see cref="P:ZedGraph.PieItem.Fill"/> to
- access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.PieItem._border">
- <summary>
- Private field that stores the <see cref="P:ZedGraph.PieItem.Border"/> class that defines the
- properties of the border around this <see cref="T:ZedGraph.PieItem"/>. Use the public
- property <see cref="P:ZedGraph.PieItem.Border"/> to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.PieItem._pieValue">
- <summary>
- Private field that stores the absolute value of this <see cref="T:ZedGraph.PieItem"/> instance.
- Value will be set to zero if submitted value is less than zero.
- </summary>
- </member>
- <member name="F:ZedGraph.PieItem._labelType">
- <summary>
- An enum that specifies how each <see cref="P:ZedGraph.CurveItem.Label"/> for this <see cref="T:ZedGraph.PieItem"/> object
- will be displayed. Use the public property <see cref="P:ZedGraph.PieItem.LabelType"/> to access this data.
- Use enum <see cref="T:ZedGraph.PieLabelType"/>.
- </summary>
- </member>
- <member name="F:ZedGraph.PieItem._intersectionPoint">
- <summary>
- The point on the arc of this <see cref="T:ZedGraph.PieItem"/> representing the intersection of
- the arc and the explosion radius.
- </summary>
- </member>
- <member name="F:ZedGraph.PieItem._boundingRectangle">
- <summary>
- The bounding rectangle for this <see cref="T:ZedGraph.PieItem"/>.
- </summary>
- </member>
- <member name="F:ZedGraph.PieItem._labelStr">
- <summary>
- The formatted string for this <see cref="T:ZedGraph.PieItem"/>'s label. Formatting is
- done based on the <see cref="T:ZedGraph.PieLabelType"/>.
- </summary>
- </member>
- <member name="F:ZedGraph.PieItem._pivotPoint">
- <summary>
- The point at which the line between this <see cref="T:ZedGraph.PieItem"/> and its
- label bends to the horizontal.
- </summary>
- </member>
- <member name="F:ZedGraph.PieItem._endPoint">
- <summary>
- The point at the end of the line between this <see cref="T:ZedGraph.PieItem"/> and
- it's label (i.e. the beginning of the label display)
- </summary>
- </member>
- <member name="F:ZedGraph.PieItem._slicePath">
- <summary>
- Private field to hold the GraphicsPath of this <see cref="T:ZedGraph.PieItem"/> to be
- used for 'hit testing'.
- </summary>
- </member>
- <member name="F:ZedGraph.PieItem._startAngle">
- <summary>
- Private field which holds the angle (in degrees) at which the display of this <see cref="T:ZedGraph.PieItem"/>
- object will begin.
- </summary>
- </member>
- <member name="F:ZedGraph.PieItem._sweepAngle">
- <summary>
- Private field which holds the length (in degrees) of the arc representing this <see cref="T:ZedGraph.PieItem"/>
- object.
- </summary>
- </member>
- <member name="F:ZedGraph.PieItem._midAngle">
- <summary>
- Private field which represents the angle (in degrees) of the radius along which this <see cref="T:ZedGraph.PieItem"/>
- object will be displaced, if desired.
- </summary>
- </member>
- <member name="F:ZedGraph.PieItem._valueDecimalDigits">
- <summary>
- Private field which determines the number of decimal digits displayed to
- in a <see cref="T:ZedGraph.PieItem"/> label containing a value.
- </summary>
- </member>
- <member name="F:ZedGraph.PieItem._percentDecimalDigits">
- <summary>
- Private field which determines the number of decimal digits displayed
- in a <see cref="T:ZedGraph.PieItem"/> label containing a percent.
- </summary>
- </member>
- <member name="M:ZedGraph.PieItem.IsZIncluded(ZedGraph.GraphPane)">
- <summary>
- Gets a flag indicating if the Z data range should be included in the axis scaling calculations.
- </summary>
- <param name="pane">The parent <see cref="T:ZedGraph.GraphPane"/> of this <see cref="T:ZedGraph.CurveItem"/>.
- </param>
- <value>true if the Z data are included, false otherwise</value>
- </member>
- <member name="M:ZedGraph.PieItem.IsXIndependent(ZedGraph.GraphPane)">
- <summary>
- Gets a flag indicating if the X axis is the independent axis for this <see cref="T:ZedGraph.CurveItem"/>
- </summary>
- <param name="pane">The parent <see cref="T:ZedGraph.GraphPane"/> of this <see cref="T:ZedGraph.CurveItem"/>.
- </param>
- <value>true if the X axis is independent, false otherwise</value>
- </member>
- <member name="M:ZedGraph.PieItem.#ctor(System.Double,System.Drawing.Color,System.Drawing.Color,System.Single,System.Double,System.String)">
- <summary>
- Create a new <see cref="T:ZedGraph.PieItem"/>, providing a gradient fill for the pie color.
- </summary>
- <param name="pieValue">The value associated with this <see cref="T:ZedGraph.PieItem"/> instance.</param>
- <param name="color1">The starting display color for the gradient <see cref="P:ZedGraph.PieItem.Fill"/> for this
- <see cref="T:ZedGraph.PieItem"/> instance.</param>
- <param name="color2">The ending display color for the gradient <see cref="P:ZedGraph.PieItem.Fill"/> for this
- <see cref="T:ZedGraph.PieItem"/> instance.</param>
- <param name="fillAngle">The angle for the gradient <see cref="P:ZedGraph.PieItem.Fill"/>.</param>
- <param name="displacement">The amount this <see cref="T:ZedGraph.PieItem"/> instance will be
- displaced from the center point.</param>
- <param name="label">Text label for this <see cref="T:ZedGraph.PieItem"/> instance.</param>
- </member>
- <member name="M:ZedGraph.PieItem.#ctor(System.Double,System.Drawing.Color,System.Double,System.String)">
- <summary>
- Create a new <see cref="T:ZedGraph.PieItem"/>.
- </summary>
- <param name="pieValue">The value associated with this <see cref="T:ZedGraph.PieItem"/> instance.</param>
- <param name="color">The display color for this <see cref="T:ZedGraph.PieItem"/> instance.</param>
- <param name="displacement">The amount this <see cref="T:ZedGraph.PieItem"/> instance will be
- displaced from the center point.</param>
- <param name="label">Text label for this <see cref="T:ZedGraph.PieItem"/> instance.</param>
- </member>
- <member name="M:ZedGraph.PieItem.#ctor(System.Double,System.String)">
- <summary>
- Create a new <see cref="T:ZedGraph.PieItem"/>.
- </summary>
- <param name="pieValue">The value associated with this <see cref="T:ZedGraph.PieItem"/> instance.</param>
- <param name="label">Text label for this <see cref="T:ZedGraph.PieItem"/> instance</param>
- </member>
- <member name="M:ZedGraph.PieItem.#ctor(ZedGraph.PieItem)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.PieItem"/> object from which to copy</param>
- </member>
- <member name="M:ZedGraph.PieItem.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.PieItem.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.PieItem.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.PieItem.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.PieItem.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.PieItem.Draw(System.Drawing.Graphics,ZedGraph.GraphPane,System.Int32,System.Single)">
- <summary>
- Do all rendering associated with this <see cref="T:ZedGraph.PieItem"/> item to the specified
- <see cref="T:System.Drawing.Graphics"/> device. This method is normally only
- called by the Draw method of the parent <see cref="T:ZedGraph.CurveList"/>
- collection object.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="pos">Not used for rendering Pies</param>param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.PieItem.CalcPieRect(System.Drawing.Graphics,ZedGraph.GraphPane,System.Single,System.Drawing.RectangleF)">
- <summary>
- Calculate the <see cref="T:System.Drawing.RectangleF"/> that will be used to define the bounding rectangle of
- the Pie.
- </summary>
- <remarks>This rectangle always lies inside of the <see cref="P:ZedGraph.Chart.Rect"/>, and it is
- normally a square so that the pie itself is not oval-shaped.</remarks>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <param name="chartRect">The <see cref="T:System.Drawing.RectangleF"/> (normally the <see cref="P:ZedGraph.Chart.Rect"/>)
- that bounds this pie.</param>
- <returns></returns>
- </member>
- <member name="M:ZedGraph.PieItem.CalcExplodedRect(System.Drawing.RectangleF@)">
- <summary>
- Recalculate the bounding rectangle when a piee slice is displaced.
- </summary>
- <param name="explRect">rectangle to be used for drawing exploded pie</param>
- </member>
- <member name="M:ZedGraph.PieItem.CalculatePieChartParams(ZedGraph.GraphPane,System.Double@)">
- <summary>
- Calculate the values needed to properly display this <see cref="T:ZedGraph.PieItem"/>.
- </summary>
- <param name="pane">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="maxDisplacement">maximum slice displacement</param>
- </member>
- <member name="M:ZedGraph.PieItem.DrawLabel(System.Drawing.Graphics,ZedGraph.GraphPane,System.Drawing.RectangleF,System.Single)">
- <summary>
- Render the label for this <see cref="T:ZedGraph.PieItem"/>.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="rect">Bounding rectangle for this <see cref="T:ZedGraph.PieItem"/>.</param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.PieItem.DesignLabel(System.Drawing.Graphics,ZedGraph.GraphPane,System.Drawing.RectangleF,System.Single)">
- <summary>
- This method collects all the data relative to rendering this <see cref="T:ZedGraph.PieItem"/>'s label.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="rect">The rectangle used for rendering this <see cref="T:ZedGraph.PieItem"/>
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.PieItem.CalculateLinePoints(System.Drawing.RectangleF,System.Double)">
- <summary>
-
- </summary>
- <param name="rect"></param>
- <param name="midAngle"></param>
- </member>
- <member name="M:ZedGraph.PieItem.BuildLabelString(ZedGraph.PieItem)">
- <summary>
- Build the string that will be displayed as the slice label as determined by
- <see cref="P:ZedGraph.PieItem.LabelType"/>.
- </summary>
- <param name="curve">reference to the <see cref="T:ZedGraph.PieItem"/></param>
- </member>
- <member name="M:ZedGraph.PieItem.CalcNewBaseRect(System.Double,System.Drawing.RectangleF@)">
- <summary>
- A method which calculates a new size for the bounding rectangle for the non-displaced
- <see cref="T:ZedGraph.PieItem"/>'s in the pie chart. This method is called after it is found
- that at least one slice is displaced.
- </summary>
- <param name="maxDisplacement">The biggest displacement among the <see cref="T:ZedGraph.PieItem"/>s
- making up the pie chart.</param>
- <param name="baseRect">The current bounding rectangle</param>
- </member>
- <member name="M:ZedGraph.PieItem.DrawLegendKey(System.Drawing.Graphics,ZedGraph.GraphPane,System.Drawing.RectangleF,System.Single)">
- <summary>
- Draw a legend key entry for this <see cref="T:ZedGraph.PieItem"/> at the specified location
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="rect">The <see cref="T:System.Drawing.RectangleF"/> struct that specifies the
- location for the legend key</param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.PieItem.GetCoords(ZedGraph.GraphPane,System.Int32,System.String@)">
- <summary>
- Determine the coords for the rectangle associated with a specified point for
- this <see cref="T:ZedGraph.CurveItem"/>
- </summary>
- <param name="pane">The <see cref="T:ZedGraph.GraphPane"/> to which this curve belongs</param>
- <param name="i">The index of the point of interest</param>
- <param name="coords">A list of coordinates that represents the "rect" for
- this point (used in an html AREA tag)</param>
- <returns>true if it's a valid point, false otherwise</returns>
- </member>
- <member name="P:ZedGraph.PieItem.Displacement">
- <summary>
- Gets or sets the a value which determines the amount, if any, of this <see cref="T:ZedGraph.PieItem"/>
- displacement.
- </summary>
- </member>
- <member name="P:ZedGraph.PieItem.SlicePath">
- <summary>
- Gets a path representing this <see cref="T:ZedGraph.PieItem"/>
- </summary>
- </member>
- <member name="P:ZedGraph.PieItem.LabelDetail">
- <summary>
- Gets or sets the <see cref="T:ZedGraph.TextObj"/> to be used
- for displaying this <see cref="T:ZedGraph.PieItem"/>'s label.
- </summary>
- </member>
- <member name="P:ZedGraph.PieItem.Border">
- <summary>
- Gets or sets the <see cref="P:ZedGraph.PieItem.Border"/> object so as to be able to modify
- its properties.
- </summary>
- </member>
- <member name="P:ZedGraph.PieItem.Fill">
- <summary>
- Gets or sets the <see cref="P:ZedGraph.PieItem.Fill"/> object which is used to fill the
- pie slice with color.
- </summary>
- </member>
- <member name="P:ZedGraph.PieItem.SweepAngle">
- <summary>
- Gets or sets the arc length (in degrees) of this <see cref="T:ZedGraph.PieItem"/>.
- </summary>
- </member>
- <member name="P:ZedGraph.PieItem.StartAngle">
- <summary>
- Gets or sets the starting angle (in degrees) of this <see cref="T:ZedGraph.PieItem"/>.
- </summary>
- </member>
- <member name="P:ZedGraph.PieItem.MidAngle">
- <summary>
- Gets or sets the angle (in degrees) of the radius along which
- this <see cref="T:ZedGraph.PieItem"/> will be displaced.
- </summary>
- </member>
- <member name="P:ZedGraph.PieItem.Value">
- <summary>
- Gets or sets the value of this <see cref="T:ZedGraph.PieItem"/>.
- Minimum value is 0.
- </summary>
- </member>
- <member name="P:ZedGraph.PieItem.LabelType">
- <summary>
- Gets or sets the <see cref="T:ZedGraph.PieLabelType"/> to be used in displaying
- <see cref="T:ZedGraph.PieItem"/> labels.
- </summary>
- </member>
- <member name="P:ZedGraph.PieItem.ValueDecimalDigits">
- <summary>
- Gets or sets the number of decimal digits to be displayed in a <see cref="T:ZedGraph.PieItem"/>
- value label.
- </summary>
- </member>
- <member name="P:ZedGraph.PieItem.PercentDecimalDigits">
- <summary>
- Gets or sets the number of decimal digits to be displayed in a <see cref="T:ZedGraph.PieItem"/>
- percent label.
- </summary>
- </member>
- <member name="T:ZedGraph.PieItem.Default">
- <summary>
- Specify the default property values for the <see cref="T:ZedGraph.PieItem"/> class.
- </summary>
- </member>
- <member name="F:ZedGraph.PieItem.Default.Displacement">
- <summary>
- Default <see cref="T:ZedGraph.PieItem"/> displacement.
- </summary>
- </member>
- <member name="F:ZedGraph.PieItem.Default.BorderWidth">
- <summary>
- The default pen width to be used for drawing the border around the PieItem
- (<see cref="P:ZedGraph.LineBase.Width"/> property). Units are points.
- </summary>
- </member>
- <member name="F:ZedGraph.PieItem.Default.FillType">
- <summary>
- The default fill mode for this PieItem (<see cref="P:ZedGraph.Fill.Type"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.PieItem.Default.IsBorderVisible">
- <summary>
- The default border mode for PieItem (<see cref="P:ZedGraph.LineBase.IsVisible"/> property).
- true to display frame around PieItem, false otherwise
- </summary>
- </member>
- <member name="F:ZedGraph.PieItem.Default.BorderColor">
- <summary>
- The default color for drawing frames around PieItem
- (<see cref="P:ZedGraph.LineBase.Color"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.PieItem.Default.FillColor">
- <summary>
- The default color for filling in the PieItem
- (<see cref="P:ZedGraph.Fill.Color"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.PieItem.Default.FillBrush">
- <summary>
- The default custom brush for filling in the PieItem.
- (<see cref="P:ZedGraph.Fill.Brush"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.PieItem.Default.isVisible">
- <summary>
- Default value for controlling <see cref="T:ZedGraph.PieItem"/> display.
- </summary>
- </member>
- <member name="F:ZedGraph.PieItem.Default.LabelType">
- <summary>
- Default value for <see cref="P:ZedGraph.PieItem.LabelType"/>.
- </summary>
- </member>
- <member name="F:ZedGraph.PieItem.Default.FontSize">
- <summary>
- The default font size for <see cref="P:ZedGraph.PieItem.LabelDetail"/> entries
- (<see cref="P:ZedGraph.FontSpec.Size"/> property). Units are
- in points (1/72 inch).
- </summary>
- </member>
- <member name="F:ZedGraph.PieItem.Default.ValueDecimalDigits">
- <summary>
- Default value for the number of decimal digits
- to be displayed when <see cref="F:ZedGraph.PieItem.Default.LabelType"/> contains a value.
- </summary>
- </member>
- <member name="F:ZedGraph.PieItem.Default.PercentDecimalDigits">
- <summary>
- Default value for the number of decimal digits
- to be displayed where <see cref="F:ZedGraph.PieItem.Default.LabelType"/> contains a percent.
- </summary>
- </member>
- <member name="T:ZedGraph.FontSpec">
- <summary>
- The <see cref="T:ZedGraph.FontSpec"/> class is a generic font class that maintains the font family,
- attributes, colors, border and fill modes, font size, and angle information.
- This class can render text with a variety of alignment options using the
- <see cref="T:ZedGraph.AlignH"/> and <see cref="T:ZedGraph.AlignV"/> parameters in the
- <see cref="M:ZedGraph.FontSpec.Draw(System.Drawing.Graphics,ZedGraph.PaneBase,System.String,System.Single,System.Single,ZedGraph.AlignH,ZedGraph.AlignV,System.Single)"/> method.
- </summary>
-
- <author> John Champion </author>
- <version> $Revision: 3.24 $ $Date: 2007-01-25 07:56:08 $ </version>
- </member>
- <member name="F:ZedGraph.FontSpec.schema">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="F:ZedGraph.FontSpec._fontColor">
- <summary>
- Private field that stores the color of the font characters for this
- <see cref="T:ZedGraph.FontSpec"/>. Use the public property <see cref="P:ZedGraph.FontSpec.FontColor"/>
- to access this value.
- </summary>
- <value>A system <see cref="T:System.Drawing.Color"/> reference.</value>
- </member>
- <member name="F:ZedGraph.FontSpec._family">
- <summary>
- Private field that stores the font family name for this <see cref="T:ZedGraph.FontSpec"/>.
- Use the public property <see cref="P:ZedGraph.FontSpec.Family"/> to access this value.
- </summary>
- <value>A text string with the font family name, e.g., "Arial"</value>
- </member>
- <member name="F:ZedGraph.FontSpec._isBold">
- <summary>
- Private field that determines whether this <see cref="T:ZedGraph.FontSpec"/> is
- drawn with bold typeface.
- Use the public property <see cref="P:ZedGraph.FontSpec.IsBold"/> to access this value.
- </summary>
- <value>A boolean value, true for bold, false for normal</value>
- </member>
- <member name="F:ZedGraph.FontSpec._isItalic">
- <summary>
- Private field that determines whether this <see cref="T:ZedGraph.FontSpec"/> is
- drawn with italic typeface.
- Use the public property <see cref="P:ZedGraph.FontSpec.IsItalic"/> to access this value.
- </summary>
- <value>A boolean value, true for italic, false for normal</value>
- </member>
- <member name="F:ZedGraph.FontSpec._isUnderline">
- <summary>
- Private field that determines whether this <see cref="T:ZedGraph.FontSpec"/> is
- drawn with underlined typeface.
- Use the public property <see cref="P:ZedGraph.FontSpec.IsUnderline"/> to access this value.
- </summary>
- <value>A boolean value, true for underline, false for normal</value>
- </member>
- <member name="F:ZedGraph.FontSpec._fill">
- <summary>
- Private field that stores the <see cref="T:ZedGraph.Fill"/> data for this
- <see cref="T:ZedGraph.FontSpec"/>. Use the public property <see cref="P:ZedGraph.FontSpec.Fill"/> to
- access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.FontSpec._border">
- <summary>
- Private field that determines the properties of the border around the text.
- Use the public property <see cref="P:ZedGraph.FontSpec.Border"/> to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.FontSpec._angle">
- <summary>
- Private field that determines the angle at which this
- <see cref="T:ZedGraph.FontSpec"/> object is drawn. Use the public property
- <see cref="P:ZedGraph.FontSpec.Angle"/> to access this value.
- </summary>
- <value>The angle of the font, measured in anti-clockwise degrees from
- horizontal. Negative values are permitted.</value>
- </member>
- <member name="F:ZedGraph.FontSpec._stringAlignment">
- <summary>
- Private field that determines the alignment with which this
- <see cref="T:ZedGraph.FontSpec"/> object is drawn. This alignment really only
- affects multi-line strings. Use the public property
- <see cref="P:ZedGraph.FontSpec.StringAlignment"/> to access this value.
- </summary>
- <value>A <see cref="P:ZedGraph.FontSpec.StringAlignment"/> enumeration.</value>
- </member>
- <member name="F:ZedGraph.FontSpec._size">
- <summary>
- Private field that determines the size of the font for this
- <see cref="T:ZedGraph.FontSpec"/> object. Use the public property
- <see cref="P:ZedGraph.FontSpec.Size"/> to access this value.
- </summary>
- <value>The size of the font, measured in points (1/72 inch).</value>
- </member>
- <member name="F:ZedGraph.FontSpec._font">
- <summary>
- Private field that stores a reference to the <see cref="T:System.Drawing.Font"/>
- object for this <see cref="T:ZedGraph.FontSpec"/>. This font object will be at
- the actual drawn size <see cref="F:ZedGraph.FontSpec._scaledSize"/> according to the current
- size of the <see cref="T:ZedGraph.GraphPane"/>. Use the public method
- <see cref="M:ZedGraph.FontSpec.GetFont(System.Single)"/> to access this font object.
- </summary>
- <value>A reference to a <see cref="T:System.Drawing.Font"/> object</value>
- </member>
- <member name="F:ZedGraph.FontSpec._isAntiAlias">
- <summary>
- Private field that determines if the <see cref="T:ZedGraph.FontSpec"/> will be
- displayed using anti-aliasing logic.
- Use the public property <see cref="P:ZedGraph.FontSpec.IsAntiAlias"/> to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.FontSpec._isDropShadow">
- <summary>
- Private field that determines if the <see cref="T:ZedGraph.FontSpec"/> will be
- displayed with a drop shadow.
- Use the public property <see cref="P:ZedGraph.FontSpec.IsDropShadow"/> to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.FontSpec._dropShadowColor">
- <summary>
- Private field that determines the color of the dropshadow for this
- <see cref="T:ZedGraph.FontSpec"/>.
- Use the public property <see cref="P:ZedGraph.FontSpec.DropShadowColor"/> to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.FontSpec._dropShadowAngle">
- <summary>
- Private field that determines the offset angle of the dropshadow for this
- <see cref="T:ZedGraph.FontSpec"/>.
- Use the public property <see cref="P:ZedGraph.FontSpec.DropShadowAngle"/> to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.FontSpec._dropShadowOffset">
- <summary>
- Private field that determines the offset distance of the dropshadow for this
- <see cref="T:ZedGraph.FontSpec"/>.
- Use the public property <see cref="P:ZedGraph.FontSpec.DropShadowOffset"/> to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.FontSpec._superScriptFont">
- <summary>
- Private field that stores a reference to the <see cref="T:System.Drawing.Font"/>
- object that will be used for superscripts. This font object will be a
- fraction of the <see cref="T:ZedGraph.FontSpec"/> <see cref="F:ZedGraph.FontSpec._scaledSize"/>,
- based on the value of <see cref="F:ZedGraph.FontSpec.Default.SuperSize"/>. This
- property is internal, and has no public access.
- </summary>
- <value>A reference to a <see cref="T:System.Drawing.Font"/> object</value>
- </member>
- <member name="F:ZedGraph.FontSpec._scaledSize">
- <summary>
- Private field that temporarily stores the scaled size of the font for this
- <see cref="T:ZedGraph.FontSpec"/> object. This represents the actual on-screen
- size, rather than the <see cref="P:ZedGraph.FontSpec.Size"/> that represents the reference
- size for a "full-sized" <see cref="T:ZedGraph.GraphPane"/>.
- </summary>
- <value>The size of the font, measured in points (1/72 inch).</value>
- </member>
- <member name="M:ZedGraph.FontSpec.#ctor">
- <summary>
- Construct a <see cref="T:ZedGraph.FontSpec"/> object with default properties.
- </summary>
- </member>
- <member name="M:ZedGraph.FontSpec.#ctor(System.String,System.Single,System.Drawing.Color,System.Boolean,System.Boolean,System.Boolean)">
- <summary>
- Construct a <see cref="T:ZedGraph.FontSpec"/> object with the given properties. All other properties
- are defaulted according to the values specified in the <see cref="T:ZedGraph.FontSpec.Default"/>
- default class.
- </summary>
- <param name="family">A text string representing the font family
- (default is "Arial")</param>
- <param name="size">A size of the font in points. This size will be scaled
- based on the ratio of the <see cref="P:ZedGraph.PaneBase.Rect"/> dimension to the
- <see cref="P:ZedGraph.PaneBase.BaseDimension"/> of the <see cref="T:ZedGraph.GraphPane"/> object. </param>
- <param name="color">The color with which to render the font</param>
- <param name="isBold">true for a bold typeface, false otherwise</param>
- <param name="isItalic">true for an italic typeface, false otherwise</param>
- <param name="isUnderline">true for an underlined font, false otherwise</param>
- </member>
- <member name="M:ZedGraph.FontSpec.#ctor(System.String,System.Single,System.Drawing.Color,System.Boolean,System.Boolean,System.Boolean,System.Drawing.Color,System.Drawing.Brush,ZedGraph.FillType)">
- <summary>
- Construct a <see cref="T:ZedGraph.FontSpec"/> object with the given properties. All other properties
- are defaulted according to the values specified in the <see cref="T:ZedGraph.FontSpec.Default"/>
- default class.
- </summary>
- <param name="family">A text string representing the font family
- (default is "Arial")</param>
- <param name="size">A size of the font in points. This size will be scaled
- based on the ratio of the <see cref="P:ZedGraph.PaneBase.Rect"/> dimension to the
- <see cref="P:ZedGraph.PaneBase.BaseDimension"/> of the <see cref="T:ZedGraph.GraphPane"/> object. </param>
- <param name="color">The color with which to render the font</param>
- <param name="isBold">true for a bold typeface, false otherwise</param>
- <param name="isItalic">true for an italic typeface, false otherwise</param>
- <param name="isUnderline">true for an underlined font, false otherwise</param>
- <param name="fillColor">The <see cref="T:System.Drawing.Color"/> to use for filling in the text background</param>
- <param name="fillBrush">The <see cref="T:System.Drawing.Brush"/> to use for filling in the text background</param>
- <param name="fillType">The <see cref="T:ZedGraph.FillType"/> to use for the
- text background</param>
- </member>
- <member name="M:ZedGraph.FontSpec.#ctor(ZedGraph.FontSpec)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The FontSpec object from which to copy</param>
- </member>
- <member name="M:ZedGraph.FontSpec.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.FontSpec.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.FontSpec.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.FontSpec.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.FontSpec.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.FontSpec.Remake(System.Single,System.Single,System.Single@,System.Drawing.Font@)">
- <summary>
- Recreate the font based on a new scaled size. The font
- will only be recreated if the scaled size has changed by
- at least 0.1 points.
- </summary>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <param name="size">The unscaled size of the font, in points</param>
- <param name="scaledSize">The scaled size of the font, in points</param>
- <param name="font">A reference to the <see cref="T:System.Drawing.Font"/> object</param>
- </member>
- <member name="M:ZedGraph.FontSpec.GetFont(System.Single)">
- <summary>
- Get the <see cref="T:System.Drawing.Font"/> class for the current scaled font.
- </summary>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <returns>Returns a reference to a <see cref="T:System.Drawing.Font"/> object
- with a size of <see cref="F:ZedGraph.FontSpec._scaledSize"/>, and font <see cref="P:ZedGraph.FontSpec.Family"/>.
- </returns>
- </member>
- <member name="M:ZedGraph.FontSpec.Draw(System.Drawing.Graphics,ZedGraph.PaneBase,System.String,System.Single,System.Single,ZedGraph.AlignH,ZedGraph.AlignV,System.Single)">
- <summary>
- Render the specified <paramref name="text"/> to the specifed
- <see cref="T:System.Drawing.Graphics"/> device. The text, border, and fill options
- will be rendered as required.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.PaneBase"/> object that is the parent or
- owner of this object.
- </param>
- <param name="text">A string value containing the text to be
- displayed. This can be multiple lines, separated by newline ('\n')
- characters</param>
- <param name="x">The X location to display the text, in screen
- coordinates, relative to the horizontal (<see cref="T:ZedGraph.AlignH"/>)
- alignment parameter <paramref name="alignH"/></param>
- <param name="y">The Y location to display the text, in screen
- coordinates, relative to the vertical (<see cref="T:ZedGraph.AlignV"/>
- alignment parameter <paramref name="alignV"/></param>
- <param name="alignH">A horizontal alignment parameter specified
- using the <see cref="T:ZedGraph.AlignH"/> enum type</param>
- <param name="alignV">A vertical alignment parameter specified
- using the <see cref="T:ZedGraph.AlignV"/> enum type</param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.FontSpec.Draw(System.Drawing.Graphics,ZedGraph.PaneBase,System.String,System.Single,System.Single,ZedGraph.AlignH,ZedGraph.AlignV,System.Single,System.Drawing.SizeF)">
- <summary>
- Render the specified <paramref name="text"/> to the specifed
- <see cref="T:System.Drawing.Graphics"/> device. The text, border, and fill options
- will be rendered as required.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.PaneBase"/> object that is the parent or
- owner of this object.
- </param>
- <param name="text">A string value containing the text to be
- displayed. This can be multiple lines, separated by newline ('\n')
- characters</param>
- <param name="x">The X location to display the text, in screen
- coordinates, relative to the horizontal (<see cref="T:ZedGraph.AlignH"/>)
- alignment parameter <paramref name="alignH"/></param>
- <param name="y">The Y location to display the text, in screen
- coordinates, relative to the vertical (<see cref="T:ZedGraph.AlignV"/>
- alignment parameter <paramref name="alignV"/></param>
- <param name="alignH">A horizontal alignment parameter specified
- using the <see cref="T:ZedGraph.AlignH"/> enum type</param>
- <param name="alignV">A vertical alignment parameter specified
- using the <see cref="T:ZedGraph.AlignV"/> enum type</param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <param name="layoutArea">The limiting area (<see cref="T:System.Drawing.SizeF"/>) into which the text
- must fit. The actual rectangle may be smaller than this, but the text will be wrapped
- to accomodate the area.</param>
- </member>
- <member name="M:ZedGraph.FontSpec.DrawTenPower(System.Drawing.Graphics,ZedGraph.GraphPane,System.String,System.Single,System.Single,ZedGraph.AlignH,ZedGraph.AlignV,System.Single)">
- <summary>
- Render the specified <paramref name="text"/> to the specifed
- <see cref="T:System.Drawing.Graphics"/> device. The text, border, and fill options
- will be rendered as required. This special case method will show the
- specified text as a power of 10, using the <see cref="F:ZedGraph.FontSpec.Default.SuperSize"/>
- and <see cref="F:ZedGraph.FontSpec.Default.SuperShift"/>.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="text">A string value containing the text to be
- displayed. This can be multiple lines, separated by newline ('\n')
- characters</param>
- <param name="x">The X location to display the text, in screen
- coordinates, relative to the horizontal (<see cref="T:ZedGraph.AlignH"/>)
- alignment parameter <paramref name="alignH"/></param>
- <param name="y">The Y location to display the text, in screen
- coordinates, relative to the vertical (<see cref="T:ZedGraph.AlignV"/>
- alignment parameter <paramref name="alignV"/></param>
- <param name="alignH">A horizontal alignment parameter specified
- using the <see cref="T:ZedGraph.AlignH"/> enum type</param>
- <param name="alignV">A vertical alignment parameter specified
- using the <see cref="T:ZedGraph.AlignV"/> enum type</param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.FontSpec.GetHeight(System.Single)">
- <summary>
- Get the height of the scaled font
- </summary>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <returns>The scaled font height, in pixels</returns>
- </member>
- <member name="M:ZedGraph.FontSpec.GetWidth(System.Drawing.Graphics,System.Single)">
- <summary>
- Get the average character width of the scaled font. The average width is
- based on the character 'x'
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <returns>The scaled font width, in pixels</returns>
- </member>
- <member name="M:ZedGraph.FontSpec.GetWidth(System.Drawing.Graphics,System.String,System.Single)">
- <summary>
- Get the total width of the specified text string
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="text">The text string for which the width is to be calculated
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <returns>The scaled text width, in pixels</returns>
- </member>
- <member name="M:ZedGraph.FontSpec.MeasureString(System.Drawing.Graphics,System.String,System.Single)">
- <summary>
- Get a <see cref="T:System.Drawing.SizeF"/> struct representing the width and height
- of the specified text string, based on the scaled font size
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="text">The text string for which the width is to be calculated
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <returns>The scaled text dimensions, in pixels, in the form of
- a <see cref="T:System.Drawing.SizeF"/> struct</returns>
- </member>
- <member name="M:ZedGraph.FontSpec.MeasureString(System.Drawing.Graphics,System.String,System.Single,System.Drawing.SizeF)">
- <summary>
- Get a <see cref="T:System.Drawing.SizeF"/> struct representing the width and height
- of the specified text string, based on the scaled font size, and using
- the specified <see cref="T:System.Drawing.SizeF"/> as an outer limit.
- </summary>
- <remarks>
- This method will allow the text to wrap as necessary to fit the
- <see paramref="layoutArea"/>.
- </remarks>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="text">The text string for which the width is to be calculated
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <param name="layoutArea">The limiting area (<see cref="T:System.Drawing.SizeF"/>) into which the text
- must fit. The actual rectangle may be smaller than this, but the text will be wrapped
- to accomodate the area.</param>
- <returns>The scaled text dimensions, in pixels, in the form of
- a <see cref="T:System.Drawing.SizeF"/> struct</returns>
- </member>
- <member name="M:ZedGraph.FontSpec.BoundingBox(System.Drawing.Graphics,System.String,System.Single)">
- <summary>
- Get a <see cref="T:System.Drawing.SizeF"/> struct representing the width and height
- of the bounding box for the specified text string, based on the scaled font size.
- </summary>
- <remarks>
- This routine differs from <see cref="M:ZedGraph.FontSpec.MeasureString(System.Drawing.Graphics,System.String,System.Single)"/> in that it takes into
- account the rotation angle of the font, and gives the dimensions of the
- bounding box that encloses the text at the specified angle.
- </remarks>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="text">The text string for which the width is to be calculated
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <returns>The scaled text dimensions, in pixels, in the form of
- a <see cref="T:System.Drawing.SizeF"/> struct</returns>
- </member>
- <member name="M:ZedGraph.FontSpec.BoundingBox(System.Drawing.Graphics,System.String,System.Single,System.Drawing.SizeF)">
- <summary>
- Get a <see cref="T:System.Drawing.SizeF"/> struct representing the width and height
- of the bounding box for the specified text string, based on the scaled font size.
- </summary>
- <remarks>
- This routine differs from <see cref="M:ZedGraph.FontSpec.MeasureString(System.Drawing.Graphics,System.String,System.Single)"/> in that it takes into
- account the rotation angle of the font, and gives the dimensions of the
- bounding box that encloses the text at the specified angle.
- </remarks>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="text">The text string for which the width is to be calculated
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <param name="layoutArea">The limiting area (<see cref="T:System.Drawing.SizeF"/>) into which the text
- must fit. The actual rectangle may be smaller than this, but the text will be wrapped
- to accomodate the area.</param>
- <returns>The scaled text dimensions, in pixels, in the form of
- a <see cref="T:System.Drawing.SizeF"/> struct</returns>
- </member>
- <member name="M:ZedGraph.FontSpec.BoundingBoxTenPower(System.Drawing.Graphics,System.String,System.Single)">
- <summary>
- Get a <see cref="T:System.Drawing.SizeF"/> struct representing the width and height
- of the bounding box for the specified text string, based on the scaled font size.
- </summary>
- <remarks>
- This special case method will show the specified string as a power of 10,
- superscripted and downsized according to the
- <see cref="F:ZedGraph.FontSpec.Default.SuperSize"/> and <see cref="F:ZedGraph.FontSpec.Default.SuperShift"/>.
- This routine differs from <see cref="M:ZedGraph.FontSpec.MeasureString(System.Drawing.Graphics,System.String,System.Single)"/> in that it takes into
- account the rotation angle of the font, and gives the dimensions of the
- bounding box that encloses the text at the specified angle.
- </remarks>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="text">The text string for which the width is to be calculated
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <returns>The scaled text dimensions, in pixels, in the form of
- a <see cref="T:System.Drawing.SizeF"/> struct</returns>
- </member>
- <member name="M:ZedGraph.FontSpec.PointInBox(System.Drawing.PointF,System.Drawing.Graphics,System.String,System.Single,System.Single,ZedGraph.AlignH,ZedGraph.AlignV,System.Single)">
- <summary>
- Determines if the specified screen point lies within the bounding box of
- the text, taking into account alignment and rotation parameters.
- </summary>
- <param name="pt">The screen point, in pixel units</param>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="text">A string value containing the text to be
- displayed. This can be multiple lines, separated by newline ('\n')
- characters</param>
- <param name="x">The X location to display the text, in screen
- coordinates, relative to the horizontal (<see cref="T:ZedGraph.AlignH"/>)
- alignment parameter <paramref name="alignH"/></param>
- <param name="y">The Y location to display the text, in screen
- coordinates, relative to the vertical (<see cref="T:ZedGraph.AlignV"/>
- alignment parameter <paramref name="alignV"/></param>
- <param name="alignH">A horizontal alignment parameter specified
- using the <see cref="T:ZedGraph.AlignH"/> enum type</param>
- <param name="alignV">A vertical alignment parameter specified
- using the <see cref="T:ZedGraph.AlignV"/> enum type</param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <returns>true if the point lies within the bounding box, false otherwise</returns>
- </member>
- <member name="M:ZedGraph.FontSpec.PointInBox(System.Drawing.PointF,System.Drawing.Graphics,System.String,System.Single,System.Single,ZedGraph.AlignH,ZedGraph.AlignV,System.Single,System.Drawing.SizeF)">
- <summary>
- Determines if the specified screen point lies within the bounding box of
- the text, taking into account alignment and rotation parameters.
- </summary>
- <param name="pt">The screen point, in pixel units</param>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="text">A string value containing the text to be
- displayed. This can be multiple lines, separated by newline ('\n')
- characters</param>
- <param name="x">The X location to display the text, in screen
- coordinates, relative to the horizontal (<see cref="T:ZedGraph.AlignH"/>)
- alignment parameter <paramref name="alignH"/></param>
- <param name="y">The Y location to display the text, in screen
- coordinates, relative to the vertical (<see cref="T:ZedGraph.AlignV"/>
- alignment parameter <paramref name="alignV"/></param>
- <param name="alignH">A horizontal alignment parameter specified
- using the <see cref="T:ZedGraph.AlignH"/> enum type</param>
- <param name="alignV">A vertical alignment parameter specified
- using the <see cref="T:ZedGraph.AlignV"/> enum type</param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <param name="layoutArea">The limiting area (<see cref="T:System.Drawing.SizeF"/>) into which the text
- must fit. The actual rectangle may be smaller than this, but the text will be wrapped
- to accomodate the area.</param>
- <returns>true if the point lies within the bounding box, false otherwise</returns>
- </member>
- <member name="M:ZedGraph.FontSpec.GetBox(System.Drawing.Graphics,System.String,System.Single,System.Single,ZedGraph.AlignH,ZedGraph.AlignV,System.Single,System.Drawing.SizeF)">
- <summary>
- Returns a polygon that defines the bounding box of
- the text, taking into account alignment and rotation parameters.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="text">A string value containing the text to be
- displayed. This can be multiple lines, separated by newline ('\n')
- characters</param>
- <param name="x">The X location to display the text, in screen
- coordinates, relative to the horizontal (<see cref="T:ZedGraph.AlignH"/>)
- alignment parameter <paramref name="alignH"/></param>
- <param name="y">The Y location to display the text, in screen
- coordinates, relative to the vertical (<see cref="T:ZedGraph.AlignV"/>
- alignment parameter <paramref name="alignV"/></param>
- <param name="alignH">A horizontal alignment parameter specified
- using the <see cref="T:ZedGraph.AlignH"/> enum type</param>
- <param name="alignV">A vertical alignment parameter specified
- using the <see cref="T:ZedGraph.AlignV"/> enum type</param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <param name="layoutArea">The limiting area (<see cref="T:System.Drawing.SizeF"/>) into which the text
- must fit. The actual rectangle may be smaller than this, but the text will be wrapped
- to accomodate the area.</param>
- <returns>A polygon of 4 points defining the area of this text</returns>
- </member>
- <member name="P:ZedGraph.FontSpec.FontColor">
- <summary>
- The color of the font characters for this <see cref="T:ZedGraph.FontSpec"/>.
- Note that the border and background
- colors are set using the <see cref="P:ZedGraph.LineBase.Color"/> and
- <see cref="P:ZedGraph.Fill.Color"/> properties, respectively.
- </summary>
- <value>A system <see cref="T:System.Drawing.Color"/> reference.</value>
- </member>
- <member name="P:ZedGraph.FontSpec.Family">
- <summary>
- The font family name for this <see cref="T:ZedGraph.FontSpec"/>.
- </summary>
- <value>A text string with the font family name, e.g., "Arial"</value>
- </member>
- <member name="P:ZedGraph.FontSpec.IsBold">
- <summary>
- Determines whether this <see cref="T:ZedGraph.FontSpec"/> is
- drawn with bold typeface.
- </summary>
- <value>A boolean value, true for bold, false for normal</value>
- </member>
- <member name="P:ZedGraph.FontSpec.IsItalic">
- <summary>
- Determines whether this <see cref="T:ZedGraph.FontSpec"/> is
- drawn with italic typeface.
- </summary>
- <value>A boolean value, true for italic, false for normal</value>
- </member>
- <member name="P:ZedGraph.FontSpec.IsUnderline">
- <summary>
- Determines whether this <see cref="T:ZedGraph.FontSpec"/> is
- drawn with underlined typeface.
- </summary>
- <value>A boolean value, true for underline, false for normal</value>
- </member>
- <member name="P:ZedGraph.FontSpec.Angle">
- <summary>
- The angle at which this <see cref="T:ZedGraph.FontSpec"/> object is drawn.
- </summary>
- <value>The angle of the font, measured in anti-clockwise degrees from
- horizontal. Negative values are permitted.</value>
- </member>
- <member name="P:ZedGraph.FontSpec.StringAlignment">
- <summary>
- Determines the alignment with which this
- <see cref="T:ZedGraph.FontSpec"/> object is drawn. This alignment really only
- affects multi-line strings.
- </summary>
- <value>A <see cref="P:ZedGraph.FontSpec.StringAlignment"/> enumeration.</value>
- </member>
- <member name="P:ZedGraph.FontSpec.Size">
- <summary>
- The size of the font for this <see cref="T:ZedGraph.FontSpec"/> object.
- </summary>
- <value>The size of the font, measured in points (1/72 inch).</value>
- </member>
- <member name="P:ZedGraph.FontSpec.Border">
- <summary>
- Gets or sets the <see cref="P:ZedGraph.FontSpec.Border"/> class used to draw the border border
- around this text.
- </summary>
- </member>
- <member name="P:ZedGraph.FontSpec.Fill">
- <summary>
- Gets or sets the <see cref="T:ZedGraph.Fill"/> data for this
- <see cref="T:ZedGraph.FontSpec"/>, which controls how the background
- behind the text is filled.
- </summary>
- </member>
- <member name="P:ZedGraph.FontSpec.IsAntiAlias">
- <summary>
- Gets or sets a value that determines if the <see cref="T:ZedGraph.FontSpec"/> will be
- drawn using anti-aliasing logic within GDI+.
- </summary>
- <remarks>
- If this property is set to true, it will override the current setting of
- <see cref="P:System.Drawing.Graphics.SmoothingMode"/> by setting the value temporarily to
- <see cref="F:System.Drawing.Drawing2D.SmoothingMode.HighQuality"/>. If this property is set to false,
- the the current setting of <see cref="P:System.Drawing.Graphics.SmoothingMode"/> will be
- left as-is.
- </remarks>
- </member>
- <member name="P:ZedGraph.FontSpec.IsDropShadow">
- <summary>
- Gets or sets a value that determines if the <see cref="T:ZedGraph.FontSpec"/> will be
- displayed with a drop shadow.
- </summary>
- <seealso cref="P:ZedGraph.FontSpec.DropShadowColor"/>
- <seealso cref="P:ZedGraph.FontSpec.DropShadowAngle"/>
- <seealso cref="P:ZedGraph.FontSpec.DropShadowOffset"/>
- </member>
- <member name="P:ZedGraph.FontSpec.DropShadowColor">
- <summary>
- Gets or sets the color of the drop shadow for this <see cref="T:ZedGraph.FontSpec"/>.
- </summary>
- <remarks>
- This value only applies if <see cref="P:ZedGraph.FontSpec.IsDropShadow"/> is true.
- </remarks>
- <seealso cref="P:ZedGraph.FontSpec.IsDropShadow"/>
- <seealso cref="P:ZedGraph.FontSpec.DropShadowAngle"/>
- <seealso cref="P:ZedGraph.FontSpec.DropShadowOffset"/>
- </member>
- <member name="P:ZedGraph.FontSpec.DropShadowAngle">
- <summary>
- Gets or sets the offset angle of the drop shadow for this <see cref="T:ZedGraph.FontSpec"/>.
- </summary>
- <remarks>
- This value only applies if <see cref="P:ZedGraph.FontSpec.IsDropShadow"/> is true.
- </remarks>
- <value>The angle, measured in anti-clockwise degrees from
- horizontal. Negative values are permitted.</value>
- <seealso cref="P:ZedGraph.FontSpec.IsDropShadow"/>
- <seealso cref="P:ZedGraph.FontSpec.DropShadowColor"/>
- <seealso cref="P:ZedGraph.FontSpec.DropShadowOffset"/>
- </member>
- <member name="P:ZedGraph.FontSpec.DropShadowOffset">
- <summary>
- Gets or sets the offset distance of the drop shadow for this <see cref="T:ZedGraph.FontSpec"/>.
- </summary>
- <remarks>
- This value only applies if <see cref="P:ZedGraph.FontSpec.IsDropShadow"/> is true.
- </remarks>
- <value>The offset distance, measured as a fraction of the scaled font height.</value>
- <seealso cref="P:ZedGraph.FontSpec.IsDropShadow"/>
- <seealso cref="P:ZedGraph.FontSpec.DropShadowColor"/>
- <seealso cref="P:ZedGraph.FontSpec.DropShadowAngle"/>
- </member>
- <member name="T:ZedGraph.FontSpec.Default">
- <summary>
- A simple struct that defines the
- default property values for the <see cref="T:ZedGraph.FontSpec"/> class.
- </summary>
- </member>
- <member name="F:ZedGraph.FontSpec.Default.SuperSize">
- <summary>
- The default size fraction of the superscript font, expressed as a fraction
- of the size of the main font.
- </summary>
- </member>
- <member name="F:ZedGraph.FontSpec.Default.SuperShift">
- <summary>
- The default shift fraction of the superscript, expressed as a
- fraction of the superscripted character height. This is the height
- above the main font (a zero shift means the main font and the superscript
- font have the tops aligned).
- </summary>
- </member>
- <member name="F:ZedGraph.FontSpec.Default.FillColor">
- <summary>
- The default color for filling in the background of the text block
- (<see cref="P:ZedGraph.Fill.Color"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.FontSpec.Default.FillBrush">
- <summary>
- The default custom brush for filling in this <see cref="T:ZedGraph.FontSpec"/>
- (<see cref="P:ZedGraph.Fill.Brush"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.FontSpec.Default.FillType">
- <summary>
- The default fill mode for this <see cref="T:ZedGraph.FontSpec"/>
- (<see cref="P:ZedGraph.Fill.Type"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.FontSpec.Default.StringAlignment">
- <summary>
- Default value for the alignment with which this
- <see cref="T:ZedGraph.FontSpec"/> object is drawn. This alignment really only
- affects multi-line strings.
- </summary>
- <value>A <see cref="F:ZedGraph.FontSpec.Default.StringAlignment"/> enumeration.</value>
- </member>
- <member name="F:ZedGraph.FontSpec.Default.IsDropShadow">
- <summary>
- Default value for <see cref="P:ZedGraph.FontSpec.IsDropShadow"/>, which determines
- if the drop shadow is displayed for this <see cref="T:ZedGraph.FontSpec"/>.
- </summary>
- </member>
- <member name="F:ZedGraph.FontSpec.Default.IsAntiAlias">
- <summary>
- Default value for <see cref="P:ZedGraph.FontSpec.IsAntiAlias"/>, which determines
- if anti-aliasing logic is used for this <see cref="T:ZedGraph.FontSpec"/>.
- </summary>
- </member>
- <member name="F:ZedGraph.FontSpec.Default.DropShadowColor">
- <summary>
- Default value for <see cref="P:ZedGraph.FontSpec.DropShadowColor"/>, which determines
- the color of the drop shadow for this <see cref="T:ZedGraph.FontSpec"/>.
- </summary>
- </member>
- <member name="F:ZedGraph.FontSpec.Default.DropShadowAngle">
- <summary>
- Default value for <see cref="P:ZedGraph.FontSpec.DropShadowAngle"/>, which determines
- the offset angle of the drop shadow for this <see cref="T:ZedGraph.FontSpec"/>.
- </summary>
- </member>
- <member name="F:ZedGraph.FontSpec.Default.DropShadowOffset">
- <summary>
- Default value for <see cref="P:ZedGraph.FontSpec.DropShadowOffset"/>, which determines
- the offset distance of the drop shadow for this <see cref="T:ZedGraph.FontSpec"/>.
- </summary>
- </member>
- <member name="T:ZedGraph.StockPointList">
- <summary>
- A collection class containing a list of <see cref="T:ZedGraph.StockPt"/> objects
- that define the set of points to be displayed on the curve.
- </summary>
-
- <author> John Champion based on code by Jerry Vos</author>
- <version> $Revision: 3.4 $ $Date: 2007-02-18 05:51:54 $ </version>
- </member>
- <member name="M:ZedGraph.StockPointList.#ctor">
- <summary>
- Default constructor for the collection class
- </summary>
- </member>
- <member name="M:ZedGraph.StockPointList.#ctor(ZedGraph.StockPointList)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The StockPointList from which to copy</param>
- </member>
- <member name="M:ZedGraph.StockPointList.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.StockPointList.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.StockPointList.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.StockPointList.Add(ZedGraph.StockPt)">
- <summary>
- Add a <see cref="T:ZedGraph.StockPt"/> object to the collection at the end of the list.
- </summary>
- <param name="point">The <see cref="T:ZedGraph.StockPt"/> object to
- be added</param>
- </member>
- <member name="M:ZedGraph.StockPointList.Add(ZedGraph.PointPair)">
- <summary>
- Add a <see cref="T:ZedGraph.PointPair"/> object to the collection at the end of the list.
- </summary>
- <param name="point">The <see cref="T:ZedGraph.PointPair"/> object to be added</param>
- </member>
- <member name="M:ZedGraph.StockPointList.Add(System.Double,System.Double)">
- <summary>
- Add a <see cref="T:ZedGraph.StockPt"/> object to the collection at the end of the list using
- the specified values. The unspecified values (low, open, close) are all set to
- <see cref="F:ZedGraph.PointPairBase.Missing"/>.
- </summary>
- <param name="date">An <see cref="T:ZedGraph.XDate"/> value</param>
- <param name="high">The high value for the day</param>
- <returns>The zero-based ordinal index where the point was added in the list.</returns>
- </member>
- <member name="M:ZedGraph.StockPointList.Add(System.Double,System.Double,System.Double,System.Double,System.Double,System.Double)">
- <summary>
- Add a single point to the <see cref="T:ZedGraph.PointPairList"/> from values of type double.
- </summary>
- <param name="date">An <see cref="T:ZedGraph.XDate"/> value</param>
- <param name="high">The high value for the day</param>
- <param name="low">The low value for the day</param>
- <param name="open">The opening value for the day</param>
- <param name="close">The closing value for the day</param>
- <param name="vol">The trading volume for the day</param>
- <returns>The zero-based ordinal index where the point was added in the list.</returns>
- </member>
- <member name="M:ZedGraph.StockPointList.GetAt(System.Int32)">
- <summary>
- Access the <see cref="T:ZedGraph.StockPt"/> at the specified ordinal index.
- </summary>
- <remarks>
- To be compatible with the <see cref="T:ZedGraph.IPointList"/> interface, the
- <see cref="T:ZedGraph.StockPointList"/> must implement an index that returns a
- <see cref="T:ZedGraph.PointPair"/> rather than a <see cref="T:ZedGraph.StockPt"/>. This method
- will return the actual <see cref="T:ZedGraph.StockPt"/> at the specified position.
- </remarks>
- <param name="index">The ordinal position (zero-based) in the list</param>
- <returns>The specified <see cref="T:ZedGraph.StockPt"/>.
- </returns>
- </member>
- <member name="P:ZedGraph.StockPointList.Item(System.Int32)">
- <summary>
- Indexer to access the specified <see cref="T:ZedGraph.StockPt"/> object by
- its ordinal position in the list.
- </summary>
- <param name="index">The ordinal position (zero-based) of the
- <see cref="T:ZedGraph.StockPt"/> object to be accessed.</param>
- <value>A <see cref="T:ZedGraph.StockPt"/> object reference.</value>
- </member>
- <member name="T:ZedGraph.ErrorBarItem">
- <summary>
- Encapsulates an "Error Bar" curve type that displays a vertical or horizontal
- line with a symbol at each end.
- </summary>
- <remarks>The <see cref="T:ZedGraph.ErrorBarItem"/> type is intended for displaying
- confidence intervals, candlesticks, stock High-Low charts, etc. It is
- technically not a bar, since it is drawn as a vertical or horizontal line.
- The default symbol at each end of the "bar" is <see cref="F:ZedGraph.SymbolType.HDash"/>,
- which creates an "I-Beam". For horizontal bars
- (<see cref="F:ZedGraph.BarBase.Y"/> or
- <see cref="F:ZedGraph.BarBase.Y2"/>), you will need to change the symbol to
- <see cref="F:ZedGraph.SymbolType.VDash"/> to get horizontal "I-Beams".
- Since the horizontal segments are actually symbols, their widths are
- controlled by the symbol size in <see cref="P:ZedGraph.ErrorBar.Symbol"/>,
- specified in points (1/72nd inch). The position of each "I-Beam" is set
- according to the <see cref="T:ZedGraph.PointPair"/> values. The independent axis
- is assigned with <see cref="P:ZedGraph.BarSettings.Base"/>, and is a
- <see cref="T:ZedGraph.BarBase"/> enum type.</remarks>
- <author> John Champion </author>
- <version> $Revision: 3.19 $ $Date: 2007-04-16 00:03:01 $ </version>
- </member>
- <member name="F:ZedGraph.ErrorBarItem.schema2">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="F:ZedGraph.ErrorBarItem._bar">
- <summary>
- Private field that stores a reference to the <see cref="T:ZedGraph.ErrorBar"/>
- class defined for this <see cref="T:ZedGraph.ErrorBarItem"/>. Use the public
- property <see cref="T:ZedGraph.ErrorBar"/> to access this value.
- </summary>
- </member>
- <member name="M:ZedGraph.ErrorBarItem.IsZIncluded(ZedGraph.GraphPane)">
- <summary>
- Gets a flag indicating if the Z data range should be included in the axis scaling calculations.
- </summary>
- <param name="pane">The parent <see cref="T:ZedGraph.GraphPane"/> of this <see cref="T:ZedGraph.CurveItem"/>.
- </param>
- <value>true if the Z data are included, false otherwise</value>
- </member>
- <member name="M:ZedGraph.ErrorBarItem.IsXIndependent(ZedGraph.GraphPane)">
- <summary>
- Gets a flag indicating if the X axis is the independent axis for this <see cref="T:ZedGraph.CurveItem"/>
- </summary>
- <param name="pane">The parent <see cref="T:ZedGraph.GraphPane"/> of this <see cref="T:ZedGraph.CurveItem"/>.
- </param>
- <value>true if the X axis is independent, false otherwise</value>
- </member>
- <member name="M:ZedGraph.ErrorBarItem.#ctor(System.String)">
- <summary>
- Create a new <see cref="T:ZedGraph.ErrorBarItem"/>, specifying only the legend label.
- </summary>
- <param name="label">The label that will appear in the legend.</param>
- </member>
- <member name="M:ZedGraph.ErrorBarItem.#ctor(System.String,System.Double[],System.Double[],System.Double[],System.Drawing.Color)">
- <summary>
- Create a new <see cref="T:ZedGraph.ErrorBarItem"/> using the specified properties.
- </summary>
- <param name="label">The label that will appear in the legend.</param>
- <param name="x">An array of double precision values that define
- the X axis values for this curve</param>
- <param name="y">An array of double precision values that define
- the Y axis values for this curve</param>
- <param name="lowValue">An array of double precision values that define
- the lower dependent values for this curve</param>
- <param name="color">A <see cref="T:System.Drawing.Color"/> value that will be applied to
- the <see cref="T:ZedGraph.Line"/> properties.
- </param>
- </member>
- <member name="M:ZedGraph.ErrorBarItem.#ctor(System.String,ZedGraph.IPointList,System.Drawing.Color)">
- <summary>
- Create a new <see cref="T:ZedGraph.ErrorBarItem"/> using the specified properties.
- </summary>
- <param name="label">The label that will appear in the legend.</param>
- <param name="points">A <see cref="T:ZedGraph.IPointList"/> of double precision values that define
- the X, Y and lower dependent values for this curve</param>
- <param name="color">A <see cref="T:System.Drawing.Color"/> value that will be applied to
- the <see cref="T:ZedGraph.Line"/> properties.
- </param>
- </member>
- <member name="M:ZedGraph.ErrorBarItem.#ctor(ZedGraph.ErrorBarItem)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.ErrorBarItem"/> object from which to copy</param>
- </member>
- <member name="M:ZedGraph.ErrorBarItem.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.ErrorBarItem.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.ErrorBarItem.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.ErrorBarItem.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.ErrorBarItem.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.ErrorBarItem.Draw(System.Drawing.Graphics,ZedGraph.GraphPane,System.Int32,System.Single)">
- <summary>
- Do all rendering associated with this <see cref="T:ZedGraph.ErrorBarItem"/> to the specified
- <see cref="T:System.Drawing.Graphics"/> device. This method is normally only
- called by the Draw method of the parent <see cref="T:ZedGraph.CurveList"/>
- collection object.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="pos">The ordinal position of the current <see cref="T:ZedGraph.ErrorBarItem"/>
- curve.</param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.ErrorBarItem.DrawLegendKey(System.Drawing.Graphics,ZedGraph.GraphPane,System.Drawing.RectangleF,System.Single)">
- <summary>
- Draw a legend key entry for this <see cref="T:ZedGraph.ErrorBarItem"/> at the specified location
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="rect">The <see cref="T:System.Drawing.RectangleF"/> struct that specifies the
- location for the legend key</param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.ErrorBarItem.GetCoords(ZedGraph.GraphPane,System.Int32,System.String@)">
- <summary>
- Determine the coords for the rectangle associated with a specified point for
- this <see cref="T:ZedGraph.CurveItem"/>
- </summary>
- <param name="pane">The <see cref="T:ZedGraph.GraphPane"/> to which this curve belongs</param>
- <param name="i">The index of the point of interest</param>
- <param name="coords">A list of coordinates that represents the "rect" for
- this point (used in an html AREA tag)</param>
- <returns>true if it's a valid point, false otherwise</returns>
- </member>
- <member name="P:ZedGraph.ErrorBarItem.Bar">
- <summary>
- Gets a reference to the <see cref="T:ZedGraph.ErrorBar"/> class defined
- for this <see cref="T:ZedGraph.ErrorBarItem"/>.
- </summary>
- </member>
- <member name="T:ZedGraph.DateScale">
- <summary>
- The DateScale class inherits from the <see cref="T:ZedGraph.Scale"/> class, and implements
- the features specific to <see cref="F:ZedGraph.AxisType.Date"/>.
- </summary>
- <remarks>
- DateScale is a cartesian axis with calendar dates or times. The actual data values should
- be created with the <see cref="T:ZedGraph.XDate"/> type, which is directly translatable to a
- <see cref="T:System.Double"/> type for storage in the point value arrays.
- </remarks>
-
- <author> John Champion </author>
- <version> $Revision: 1.15 $ $Date: 2007-09-19 06:41:56 $ </version>
- </member>
- <member name="F:ZedGraph.DateScale.schema2">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="M:ZedGraph.DateScale.#ctor(ZedGraph.Axis)">
- <summary>
- Default constructor that defines the owner <see cref="T:ZedGraph.Axis"/>
- (containing object) for this new object.
- </summary>
- <param name="owner">The owner, or containing object, of this instance</param>
- </member>
- <member name="M:ZedGraph.DateScale.#ctor(ZedGraph.Scale,ZedGraph.Axis)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.DateScale"/> object from which to copy</param>
- <param name="owner">The <see cref="T:ZedGraph.Axis"/> object that will own the
- new instance of <see cref="T:ZedGraph.DateScale"/></param>
- </member>
- <member name="M:ZedGraph.DateScale.Clone(ZedGraph.Axis)">
- <summary>
- Create a new clone of the current item, with a new owner assignment
- </summary>
- <param name="owner">The new <see cref="T:ZedGraph.Axis"/> instance that will be
- the owner of the new Scale</param>
- <returns>A new <see cref="T:ZedGraph.Scale"/> clone.</returns>
- </member>
- <member name="M:ZedGraph.DateScale.CalcMajorTicValue(System.Double,System.Double)">
- <summary>
- Determine the value for any major tic.
- </summary>
- <remarks>
- This method properly accounts for <see cref="P:ZedGraph.Scale.IsLog"/>, <see cref="P:ZedGraph.Scale.IsText"/>,
- and other axis format settings.
- </remarks>
- <param name="baseVal">
- The value of the first major tic (floating point double)
- </param>
- <param name="tic">
- The major tic number (0 = first major tic). For log scales, this is the actual power of 10.
- </param>
- <returns>
- The specified major tic value (floating point double).
- </returns>
- </member>
- <member name="M:ZedGraph.DateScale.CalcMinorTicValue(System.Double,System.Int32)">
- <summary>
- Determine the value for any minor tic.
- </summary>
- <remarks>
- This method properly accounts for <see cref="P:ZedGraph.Scale.IsLog"/>, <see cref="P:ZedGraph.Scale.IsText"/>,
- and other axis format settings.
- </remarks>
- <param name="baseVal">
- The value of the first major tic (floating point double). This tic value is the base
- reference for all tics (including minor ones).
- </param>
- <param name="iTic">
- The major tic number (0 = first major tic). For log scales, this is the actual power of 10.
- </param>
- <returns>
- The specified minor tic value (floating point double).
- </returns>
- </member>
- <member name="M:ZedGraph.DateScale.CalcMinorStart(System.Double)">
- <summary>
- Internal routine to determine the ordinals of the first minor tic mark
- </summary>
- <param name="baseVal">
- The value of the first major tic for the axis.
- </param>
- <returns>
- The ordinal position of the first minor tic, relative to the first major tic.
- This value can be negative (e.g., -3 means the first minor tic is 3 minor step
- increments before the first major tic.
- </returns>
- </member>
- <member name="M:ZedGraph.DateScale.CalcBaseTic">
- <summary>
- Determine the value for the first major tic.
- </summary>
- <remarks>
- This is done by finding the first possible value that is an integral multiple of
- the step size, taking into account the date/time units if appropriate.
- This method properly accounts for <see cref="P:ZedGraph.Scale.IsLog"/>, <see cref="P:ZedGraph.Scale.IsText"/>,
- and other axis format settings.
- </remarks>
- <returns>
- First major tic value (floating point double).
- </returns>
- </member>
- <member name="M:ZedGraph.DateScale.CalcNumTics">
- <summary>
- Internal routine to determine the ordinals of the first and last major axis label.
- </summary>
- <returns>
- This is the total number of major tics for this axis.
- </returns>
- </member>
- <member name="M:ZedGraph.DateScale.PickScale(ZedGraph.GraphPane,System.Drawing.Graphics,System.Single)">
- <summary>
- Select a reasonable date-time axis scale given a range of data values.
- </summary>
- <remarks>
- This method only applies to <see cref="F:ZedGraph.AxisType.Date"/> type axes, and it
- is called by the general <see cref="M:ZedGraph.DateScale.PickScale(ZedGraph.GraphPane,System.Drawing.Graphics,System.Single)"/> method. The scale range is chosen
- based on increments of 1, 2, or 5 (because they are even divisors of 10).
- Note that the <see cref="P:ZedGraph.Scale.MajorStep"/> property setting can have multiple unit
- types (<see cref="P:ZedGraph.Scale.MajorUnit"/> and <see cref="P:ZedGraph.Scale.MinorUnit"/>),
- but the <see cref="P:ZedGraph.Scale.Min"/> and
- <see cref="P:ZedGraph.Scale.Max"/> units are always days (<see cref="T:ZedGraph.XDate"/>). This
- method honors the <see cref="P:ZedGraph.Scale.MinAuto"/>, <see cref="P:ZedGraph.Scale.MaxAuto"/>,
- and <see cref="P:ZedGraph.Scale.MajorStepAuto"/> autorange settings.
- In the event that any of the autorange settings are false, the
- corresponding <see cref="P:ZedGraph.Scale.Min"/>, <see cref="P:ZedGraph.Scale.Max"/>, or <see cref="P:ZedGraph.Scale.MajorStep"/>
- setting is explicitly honored, and the remaining autorange settings (if any) will
- be calculated to accomodate the non-autoranged values. The basic default for
- scale selection is defined with
- <see cref="F:ZedGraph.Scale.Default.TargetXSteps"/> and <see cref="F:ZedGraph.Scale.Default.TargetYSteps"/>
- from the <see cref="T:ZedGraph.Scale.Default"/> default class.
- <para>On Exit:</para>
- <para><see cref="P:ZedGraph.Scale.Min"/> is set to scale minimum (if <see cref="P:ZedGraph.Scale.MinAuto"/> = true)</para>
- <para><see cref="P:ZedGraph.Scale.Max"/> is set to scale maximum (if <see cref="P:ZedGraph.Scale.MaxAuto"/> = true)</para>
- <para><see cref="P:ZedGraph.Scale.MajorStep"/> is set to scale step size (if <see cref="P:ZedGraph.Scale.MajorStepAuto"/> = true)</para>
- <para><see cref="P:ZedGraph.Scale.MinorStep"/> is set to scale minor step size (if <see cref="P:ZedGraph.Scale.MinorStepAuto"/> = true)</para>
- <para><see cref="P:ZedGraph.Scale.Mag"/> is set to a magnitude multiplier according to the data</para>
- <para><see cref="P:ZedGraph.Scale.Format"/> is set to the display format for the values (this controls the
- number of decimal places, whether there are thousands separators, currency types, etc.)</para>
- </remarks>
- <param name="pane">A reference to the <see cref="T:ZedGraph.GraphPane"/> object
- associated with this <see cref="T:ZedGraph.Axis"/></param>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <seealso cref="M:ZedGraph.Scale.PickScale(ZedGraph.GraphPane,System.Drawing.Graphics,System.Single)"/>
- <seealso cref="F:ZedGraph.AxisType.Date"/>
- <seealso cref="P:ZedGraph.Scale.MajorUnit"/>
- <seealso cref="P:ZedGraph.Scale.MinorUnit"/>
- </member>
- <member name="M:ZedGraph.DateScale.CalcDateStepSize(System.Double,System.Double)">
- <summary>
- Calculate a step size for a <see cref="F:ZedGraph.AxisType.Date"/> scale.
- This method is used by <see cref="M:ZedGraph.DateScale.PickScale(ZedGraph.GraphPane,System.Drawing.Graphics,System.Single)"/>.
- </summary>
- <param name="range">The range of data in units of days</param>
- <param name="targetSteps">The desired "typical" number of steps
- to divide the range into</param>
- <returns>The calculated step size for the specified data range. Also
- calculates and sets the values for <see cref="P:ZedGraph.Scale.MajorUnit"/>,
- <see cref="P:ZedGraph.Scale.MinorUnit"/>, <see cref="P:ZedGraph.Scale.MinorStep"/>, and
- <see cref="P:ZedGraph.Scale.Format"/></returns>
- </member>
- <member name="M:ZedGraph.DateScale.CalcDateStepSize(System.Double,System.Double,ZedGraph.Scale)">
- <summary>
- Calculate a step size for a <see cref="F:ZedGraph.AxisType.Date"/> scale.
- This method is used by <see cref="M:ZedGraph.DateScale.PickScale(ZedGraph.GraphPane,System.Drawing.Graphics,System.Single)"/>.
- </summary>
- <param name="range">The range of data in units of days</param>
- <param name="targetSteps">The desired "typical" number of steps
- to divide the range into</param>
- <param name="scale">
- The <see cref="T:ZedGraph.Scale"/> object on which to calculate the Date step size.</param>
- <returns>The calculated step size for the specified data range. Also
- calculates and sets the values for <see cref="P:ZedGraph.Scale.MajorUnit"/>,
- <see cref="P:ZedGraph.Scale.MinorUnit"/>, <see cref="P:ZedGraph.Scale.MinorStep"/>, and
- <see cref="P:ZedGraph.Scale.Format"/></returns>
- </member>
- <member name="M:ZedGraph.DateScale.CalcEvenStepDate(System.Double,System.Int32)">
- <summary>
- Calculate a date that is close to the specified date and an
- even multiple of the selected
- <see cref="P:ZedGraph.Scale.MajorUnit"/> for a <see cref="F:ZedGraph.AxisType.Date"/> scale.
- This method is used by <see cref="M:ZedGraph.DateScale.PickScale(ZedGraph.GraphPane,System.Drawing.Graphics,System.Single)"/>.
- </summary>
- <param name="date">The date which the calculation should be close to</param>
- <param name="direction">The desired direction for the date to take.
- 1 indicates the result date should be greater than the specified
- date parameter. -1 indicates the other direction.</param>
- <returns>The calculated date</returns>
- </member>
- <member name="M:ZedGraph.DateScale.MakeLabel(ZedGraph.GraphPane,System.Int32,System.Double)">
- <summary>
- Make a value label for an <see cref="F:ZedGraph.AxisType.Date"/> <see cref="T:ZedGraph.Axis"/>.
- </summary>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="index">
- The zero-based, ordinal index of the label to be generated. For example, a value of 2 would
- cause the third value label on the axis to be generated.
- </param>
- <param name="dVal">
- The numeric value associated with the label. This value is ignored for log (<see cref="P:ZedGraph.Scale.IsLog"/>)
- and text (<see cref="P:ZedGraph.Scale.IsText"/>) type axes.
- </param>
- <returns>The resulting value label as a <see cref="T:System.String"/></returns>
- </member>
- <member name="M:ZedGraph.DateScale.GetUnitMultiple(ZedGraph.DateUnit)">
- <summary>
- Internal routine to calculate a multiplier to the selected unit back to days.
- </summary>
- <param name="unit">The unit type for which the multiplier is to be
- calculated</param>
- <returns>
- This is ratio of days/selected unit
- </returns>
- </member>
- <member name="M:ZedGraph.DateScale.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.DateScale.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="P:ZedGraph.DateScale.Type">
- <summary>
- Return the <see cref="T:ZedGraph.AxisType"/> for this <see cref="T:ZedGraph.Scale"/>, which is
- <see cref="F:ZedGraph.AxisType.Date"/>.
- </summary>
- </member>
- <member name="P:ZedGraph.DateScale.Min">
- <summary>
- Gets or sets the minimum value for this scale.
- </summary>
- <remarks>
- The set property is specifically adapted for <see cref="F:ZedGraph.AxisType.Date"/> scales,
- in that it automatically limits the value to the range of valid dates for the
- <see cref="T:ZedGraph.XDate"/> struct.
- </remarks>
- </member>
- <member name="P:ZedGraph.DateScale.Max">
- <summary>
- Gets or sets the maximum value for this scale.
- </summary>
- <remarks>
- The set property is specifically adapted for <see cref="F:ZedGraph.AxisType.Date"/> scales,
- in that it automatically limits the value to the range of valid dates for the
- <see cref="T:ZedGraph.XDate"/> struct.
- </remarks>
- </member>
- <member name="P:ZedGraph.DateScale.MajorUnitMultiplier">
- <summary>
- Gets the major unit multiplier for this scale type, if any.
- </summary>
- <remarks>The major unit multiplier will correct the units of
- <see cref="P:ZedGraph.Scale.MajorStep"/> to match the units of <see cref="P:ZedGraph.Scale.Min"/>
- and <see cref="P:ZedGraph.Scale.Max"/>. This reflects the setting of
- <see cref="P:ZedGraph.Scale.MajorUnit"/>.
- </remarks>
- </member>
- <member name="P:ZedGraph.DateScale.MinorUnitMultiplier">
- <summary>
- Gets the minor unit multiplier for this scale type, if any.
- </summary>
- <remarks>The minor unit multiplier will correct the units of
- <see cref="P:ZedGraph.Scale.MinorStep"/> to match the units of <see cref="P:ZedGraph.Scale.Min"/>
- and <see cref="P:ZedGraph.Scale.Max"/>. This reflects the setting of
- <see cref="P:ZedGraph.Scale.MinorUnit"/>.
- </remarks>
- </member>
- <member name="T:ZedGraph.Axis">
- <summary>
- The Axis class is an abstract base class that encompasses all properties
- and methods required to define a graph Axis.
- </summary>
- <remarks>This class is inherited by the
- <see cref="T:ZedGraph.XAxis"/>, <see cref="T:ZedGraph.YAxis"/>, and <see cref="T:ZedGraph.Y2Axis"/> classes
- to define specific characteristics for those types.
- </remarks>
-
- <author> John Champion modified by Jerry Vos </author>
- <version> $Revision: 3.76 $ $Date: 2008-02-16 23:21:48 $ </version>
- </member>
- <member name="F:ZedGraph.Axis.schema">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="F:ZedGraph.Axis._scale">
- <summary>
- private field that stores the <see cref="T:ZedGraph.Scale"/> class, which implements all the
- calculations and methods associated with the numeric scale for this
- <see cref="T:ZedGraph.Axis"/>. See the public property <see cref="P:ZedGraph.Axis.Scale"/> to access this class.
- </summary>
- </member>
- <member name="F:ZedGraph.Axis._minorTic">
- <summary>
- Private field that stores the <see cref="T:ZedGraph.MinorTic"/> class, which handles all
- the minor tic information. See the public property <see cref="P:ZedGraph.Axis.MinorTic"/> to access this class.
- </summary>
- </member>
- <member name="F:ZedGraph.Axis._majorTic">
- <summary>
- Private field that stores the <see cref="T:ZedGraph.MajorTic"/> class, which handles all
- the major tic information. See the public property <see cref="P:ZedGraph.Axis.MajorTic"/> to access this class.
- </summary>
- </member>
- <member name="F:ZedGraph.Axis._majorGrid">
- <summary>
- Private field that stores the <see cref="T:ZedGraph.MajorGrid"/> class, which handles all
- the major grid information. See the public property <see cref="P:ZedGraph.Axis.MajorGrid"/> to access this class.
- </summary>
- </member>
- <member name="F:ZedGraph.Axis._minorGrid">
- <summary>
- Private field that stores the <see cref="T:ZedGraph.MinorGrid"/> class, which handles all
- the minor grid information. See the public property <see cref="P:ZedGraph.Axis.MinorGrid"/> to access this class.
- </summary>
- </member>
- <member name="F:ZedGraph.Axis._cross">
- <summary> Private fields for the <see cref="T:ZedGraph.Axis"/> scale rendering properties.
- Use the public properties <see cref="P:ZedGraph.Axis.Cross"/> and <see cref="P:ZedGraph.Scale.BaseTic"/>
- for access to these values.
- </summary>
- </member>
- <member name="F:ZedGraph.Axis._crossAuto">
- <summary> Private field for the <see cref="T:ZedGraph.Axis"/> automatic cross position mode.
- Use the public property <see cref="P:ZedGraph.Axis.CrossAuto"/> for access to this value.
- </summary>
- </member>
- <member name="F:ZedGraph.Axis._isVisible">
- <summary> Private fields for the <see cref="T:ZedGraph.Axis"/> attributes.
- Use the public properties <see cref="P:ZedGraph.Axis.IsVisible"/>, <see cref="P:ZedGraph.Axis.IsAxisSegmentVisible"/>
- for access to these values.
- </summary>
- </member>
- <member name="F:ZedGraph.Axis._isAxisSegmentVisible">
- <summary> Private fields for the <see cref="T:ZedGraph.Axis"/> attributes.
- Use the public properties <see cref="P:ZedGraph.Axis.IsVisible"/>, <see cref="P:ZedGraph.Axis.IsAxisSegmentVisible"/>
- for access to these values.
- </summary>
- </member>
- <member name="F:ZedGraph.Axis._title">
- <summary> Private field for the <see cref="T:ZedGraph.Axis"/> title string.
- Use the public property <see cref="P:ZedGraph.Axis.Title"/> for access to this value.
- </summary>
- </member>
- <member name="F:ZedGraph.Axis.Tag">
- <summary>
- A tag object for use by the user. This can be used to store additional
- information associated with the <see cref="T:ZedGraph.Axis"/>. ZedGraph does
- not use this value for any purpose.
- </summary>
- <remarks>
- Note that, if you are going to Serialize ZedGraph data, then any type
- that you store in <see cref="F:ZedGraph.Axis.Tag"/> must be a serializable type (or
- it will cause an exception).
- </remarks>
- </member>
- <member name="F:ZedGraph.Axis._axisGap">
- <summary> Private field for the <see cref="T:ZedGraph.Axis"/> drawing dimensions.
- Use the public property <see cref="P:ZedGraph.Axis.AxisGap"/>
- for access to these values. </summary>
- </member>
- <member name="F:ZedGraph.Axis._minSpace">
- <summary>
- Private field for the <see cref="T:ZedGraph.Axis"/> minimum allowable space allocation.
- Use the public property <see cref="P:ZedGraph.Axis.MinSpace"/> to access this value.
- </summary>
- <seealso cref="F:ZedGraph.Axis.Default.MinSpace"/>
- </member>
- <member name="F:ZedGraph.Axis._color">
- <summary> Private fields for the <see cref="T:ZedGraph.Axis"/> colors.
- Use the public property <see cref="P:ZedGraph.Axis.Color"/> for access to this values.
- </summary>
- </member>
- <member name="F:ZedGraph.Axis._tmpSpace">
- <summary>
- Temporary values for axis space calculations (see <see cref="M:ZedGraph.Axis.CalcSpace(System.Drawing.Graphics,ZedGraph.GraphPane,System.Single,System.Single@)"/>).
- </summary>
- </member>
- <member name="M:ZedGraph.Axis.#ctor">
- <summary>
- Default constructor for <see cref="T:ZedGraph.Axis"/> that sets all axis properties
- to default values as defined in the <see cref="T:ZedGraph.Axis.Default"/> class.
- </summary>
- </member>
- <member name="M:ZedGraph.Axis.#ctor(System.String)">
- <summary>
- Constructor for <see cref="T:ZedGraph.Axis"/> that sets all axis properties
- to default values as defined in the <see cref="T:ZedGraph.Axis.Default"/> class,
- except for the <see cref="P:ZedGraph.Axis.Title"/>.
- </summary>
- <param name="title">A string containing the axis title</param>
- </member>
- <member name="M:ZedGraph.Axis.#ctor(ZedGraph.Axis)">
- <summary>
- The Copy Constructor.
- </summary>
- <param name="rhs">The Axis object from which to copy</param>
- </member>
- <member name="M:ZedGraph.Axis.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of Clone.
- </summary>
- <remarks>
- Note that this method must be called with an explicit cast to ICloneable, and
- that it is inherently virtual. For example:
- <code>
- ParentClass foo = new ChildClass();
- ChildClass bar = (ChildClass) ((ICloneable)foo).Clone();
- </code>
- Assume that ChildClass is inherited from ParentClass. Even though foo is declared with
- ParentClass, it is actually an instance of ChildClass. Calling the ICloneable implementation
- of Clone() on foo actually calls ChildClass.Clone() as if it were a virtual function.
- </remarks>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.Axis.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.Axis.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.Axis.ResetAutoScale(ZedGraph.GraphPane,System.Drawing.Graphics)">
- <summary>
- Restore the scale ranging to automatic mode, and recalculate the
- <see cref="T:ZedGraph.Axis"/> scale ranges
- </summary>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <seealso cref="P:ZedGraph.Scale.MinAuto"/>
- <seealso cref="P:ZedGraph.Scale.MaxAuto"/>
- <seealso cref="P:ZedGraph.Scale.MajorStepAuto"/>
- <seealso cref="P:ZedGraph.Scale.MagAuto"/>
- <seealso cref="P:ZedGraph.Scale.FormatAuto"/>
- </member>
- <member name="M:ZedGraph.Axis.Draw(System.Drawing.Graphics,ZedGraph.GraphPane,System.Single,System.Single)">
- <summary>
- Do all rendering associated with this <see cref="T:ZedGraph.Axis"/> to the specified
- <see cref="T:System.Drawing.Graphics"/> device.
- </summary>
- <remarks>
- This method is normally only
- called by the Draw method of the parent <see cref="T:ZedGraph.GraphPane"/> object.
- </remarks>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <param name="shiftPos">
- The number of pixels to shift to account for non-primary axis position (e.g.,
- the second, third, fourth, etc. <see cref="T:ZedGraph.YAxis"/> or <see cref="T:ZedGraph.Y2Axis"/>.
- </param>
- </member>
- <member name="M:ZedGraph.Axis.SetMinSpaceBuffer(System.Drawing.Graphics,ZedGraph.GraphPane,System.Single,System.Boolean)">
- <summary>
- This method will set the <see cref="P:ZedGraph.Axis.MinSpace"/> property for this <see cref="T:ZedGraph.Axis"/>
- using the currently required space multiplied by a fraction (<paramref>bufferFraction</paramref>).
- </summary>
- <remarks>
- The currently required space is calculated using <see cref="M:ZedGraph.Axis.CalcSpace(System.Drawing.Graphics,ZedGraph.GraphPane,System.Single,System.Single@)"/>, and is
- based on current data ranges, font sizes, etc. The "space" is actually the amount of space
- required to fit the tic marks, scale labels, and axis title.
- </remarks>
- <param name="g">A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.</param>
- <param name="pane">A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.</param>
- <param name="bufferFraction">The amount of space to allocate for the axis, expressed
- as a fraction of the currently required space. For example, a value of 1.2 would
- allow for 20% extra above the currently required space.</param>
- <param name="isGrowOnly">If true, then this method will only modify the <see cref="P:ZedGraph.Axis.MinSpace"/>
- property if the calculated result is more than the current value.</param>
- </member>
- <member name="M:ZedGraph.Axis.SetTransformMatrix(System.Drawing.Graphics,ZedGraph.GraphPane,System.Single)">
- <summary>
- Setup the Transform Matrix to handle drawing of this <see cref="T:ZedGraph.Axis"/>
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.Axis.CalcCrossShift(ZedGraph.GraphPane)">
- <summary>
- Calculate the "shift" size, in pixels, in order to shift the axis from its default
- location to the value specified by <see cref="P:ZedGraph.Axis.Cross"/>.
- </summary>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <returns>The shift amount measured in pixels</returns>
- </member>
- <member name="M:ZedGraph.Axis.GetCrossAxis(ZedGraph.GraphPane)">
- <summary>
- Gets the "Cross" axis that corresponds to this axis.
- </summary>
- <remarks>
- The cross axis is the axis which determines the of this Axis when the
- <see cref="P:ZedGraph.Axis.Cross">Axis.Cross</see> property is used. The
- cross axis for any <see cref="T:ZedGraph.XAxis"/> or <see cref="T:ZedGraph.X2Axis"/>
- is always the primary <see cref="T:ZedGraph.YAxis"/>, and
- the cross axis for any <see cref="T:ZedGraph.YAxis"/> or <see cref="T:ZedGraph.Y2Axis"/> is
- always the primary <see cref="T:ZedGraph.XAxis"/>.
- </remarks>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- </member>
- <member name="M:ZedGraph.Axis.EffectiveCrossValue(ZedGraph.GraphPane)">
- <summary>
- Returns the linearized actual cross position for this axis, reflecting the settings of
- <see cref="P:ZedGraph.Axis.Cross"/>, <see cref="P:ZedGraph.Axis.CrossAuto"/>, and <see cref="P:ZedGraph.Scale.IsReverse"/>.
- </summary>
- <remarks>
- If the value of <see cref="P:ZedGraph.Axis.Cross"/> lies outside the axis range, it is
- limited to the axis range.
- </remarks>
- </member>
- <member name="M:ZedGraph.Axis.IsCrossShifted(ZedGraph.GraphPane)">
- <summary>
- Returns true if the axis is shifted at all due to the setting of
- <see cref="P:ZedGraph.Axis.Cross"/>. This function will always return false if
- <see cref="P:ZedGraph.Axis.CrossAuto"/> is true.
- </summary>
- </member>
- <member name="M:ZedGraph.Axis.CalcCrossFraction(ZedGraph.GraphPane)">
- <summary>
- Calculates the proportional fraction of the total cross axis width at which
- this axis is located.
- </summary>
- <param name="pane"></param>
- <returns></returns>
- </member>
- <member name="M:ZedGraph.Axis.CalcSpace(System.Drawing.Graphics,ZedGraph.GraphPane,System.Single,System.Single@)">
- <summary>
- Calculate the space required (pixels) for this <see cref="T:ZedGraph.Axis"/> object.
- </summary>
- <remarks>
- This is the total space (vertical space for the X axis, horizontal space for
- the Y axes) required to contain the axis. If <see cref="P:ZedGraph.Axis.Cross"/> is zero, then
- this space will be the space required between the <see cref="P:ZedGraph.Chart.Rect"/> and
- the <see cref="P:ZedGraph.PaneBase.Rect"/>. This method sets the internal values of
- <see cref="F:ZedGraph.Axis._tmpSpace"/> for use by the <see cref="M:ZedGraph.GraphPane.CalcChartRect(System.Drawing.Graphics)"/>
- method.
- </remarks>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <param name="fixedSpace">The amount of space (pixels) at the edge of the ChartRect
- that is always required for this axis, even if the axis is shifted by the
- <see cref="P:ZedGraph.Axis.Cross"/> value.</param>
- <returns>Returns the space, in pixels, required for this axis (between the
- rect and ChartRect)</returns>
- </member>
- <member name="M:ZedGraph.Axis.IsPrimary(ZedGraph.GraphPane)">
- <summary>
- Determines if this <see cref="T:ZedGraph.Axis"/> object is a "primary" one.
- </summary>
- <remarks>
- The primary axes are the <see cref="T:ZedGraph.XAxis"/> (always), the first
- <see cref="T:ZedGraph.YAxis"/> in the <see cref="P:ZedGraph.GraphPane.YAxisList"/>
- (<see cref="P:ZedGraph.CurveItem.YAxisIndex"/> = 0), and the first
- <see cref="T:ZedGraph.Y2Axis"/> in the <see cref="P:ZedGraph.GraphPane.Y2AxisList"/>
- (<see cref="P:ZedGraph.CurveItem.YAxisIndex"/> = 0). Note that
- <see cref="P:ZedGraph.GraphPane.YAxis"/> and <see cref="P:ZedGraph.GraphPane.Y2Axis"/>
- always reference the primary axes.
- </remarks>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <returns>true for a primary <see cref="T:ZedGraph.Axis"/> (for the <see cref="T:ZedGraph.XAxis"/>,
- this is always true), false otherwise</returns>
- </member>
- <member name="M:ZedGraph.Axis.DrawMinorTics(System.Drawing.Graphics,ZedGraph.GraphPane,System.Double,System.Single,System.Single,System.Single)">
- <summary>
- Draw the minor tic marks as required for this <see cref="T:ZedGraph.Axis"/>.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="baseVal">
- The scale value for the first major tic position. This is the reference point
- for all other tic marks.
- </param>
- <param name="shift">The number of pixels to shift this axis, based on the
- value of <see cref="P:ZedGraph.Axis.Cross"/>. A positive value is into the ChartRect relative to
- the default axis position.</param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <param name="topPix">
- The pixel location of the far side of the ChartRect from this axis.
- This value is the ChartRect.Height for the XAxis, or the ChartRect.Width
- for the YAxis and Y2Axis.
- </param>
- </member>
- <member name="M:ZedGraph.Axis.DrawTitle(System.Drawing.Graphics,ZedGraph.GraphPane,System.Single,System.Single)">
- <summary>
- Draw the title for this <see cref="T:ZedGraph.Axis"/>.
- </summary>
- <remarks>On entry, it is assumed that the
- graphics transform has been configured so that the origin is at the left side
- of this axis, and the axis is aligned along the X coordinate direction.
- </remarks>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="shiftPos">The number of pixels to shift this axis, based on the
- value of <see cref="P:ZedGraph.Axis.Cross"/>. A positive value is into the ChartRect relative to
- the default axis position.</param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.Axis.MakeLabelEventWorks(ZedGraph.GraphPane,System.Int32,System.Double)">
- <summary>
- Make a value label for the axis at the specified ordinal position.
- </summary>
- <remarks>
- This method properly accounts for <see cref="P:ZedGraph.Scale.IsLog"/>,
- <see cref="P:ZedGraph.Scale.IsText"/>,
- and other axis format settings. It also implements the ScaleFormatEvent such that
- custom labels can be created.
- </remarks>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="index">
- The zero-based, ordinal index of the label to be generated. For example, a value of 2 would
- cause the third value label on the axis to be generated.
- </param>
- <param name="dVal">
- The numeric value associated with the label. This value is ignored for log
- (<see cref="P:ZedGraph.Scale.IsLog"/>)
- and text (<see cref="P:ZedGraph.Scale.IsText"/>) type axes.
- </param>
- <returns>The resulting value label as a <see cref="T:System.String"/></returns>
- </member>
- <member name="E:ZedGraph.Axis.ScaleFormatEvent">
- <summary>
- Subscribe to this event to handle custom formatting of the scale labels.
- </summary>
- </member>
- <member name="E:ZedGraph.Axis.ScaleTitleEvent">
- <summary>
- Allow customization of the title when the scale is very large
- Subscribe to this event to handle custom formatting of the scale axis label.
- </summary>
- </member>
- <member name="P:ZedGraph.Axis.Scale">
- <summary>
- Gets the <see cref="P:ZedGraph.Axis.Scale"/> instance associated with this <see cref="T:ZedGraph.Axis"/>.
- </summary>
- </member>
- <member name="P:ZedGraph.Axis.Cross">
- <summary>
- Gets or sets the scale value at which this axis should cross the "other" axis.
- </summary>
- <remarks>This property allows the axis to be shifted away from its default location.
- For example, for a graph with an X range from -100 to +100, the Y Axis can be located
- at the X=0 value rather than the left edge of the ChartRect. This value can be set
- automatically based on the state of <see cref="P:ZedGraph.Axis.CrossAuto"/>. If
- this value is set manually, then <see cref="P:ZedGraph.Axis.CrossAuto"/> will
- also be set to false. The "other" axis is the axis the handles the second dimension
- for the graph. For the XAxis, the "other" axis is the YAxis. For the YAxis or
- Y2Axis, the "other" axis is the XAxis.
- </remarks>
- <value> The value is defined in user scale units </value>
- <seealso cref="P:ZedGraph.Scale.Min"/>
- <seealso cref="P:ZedGraph.Scale.Max"/>
- <seealso cref="P:ZedGraph.Scale.MajorStep"/>
- <seealso cref="P:ZedGraph.Axis.CrossAuto"/>
- </member>
- <member name="P:ZedGraph.Axis.CrossAuto">
- <summary>
- Gets or sets a value that determines whether or not the <see cref="P:ZedGraph.Axis.Cross"/> value
- is set automatically.
- </summary>
- <value>Set to true to have ZedGraph put the axis in the default location, or false
- to specify the axis location manually with a <see cref="P:ZedGraph.Axis.Cross"/> value.</value>
- <seealso cref="P:ZedGraph.Scale.Min"/>
- <seealso cref="P:ZedGraph.Scale.Max"/>
- <seealso cref="P:ZedGraph.Scale.MajorStep"/>
- <seealso cref="P:ZedGraph.Axis.Cross"/>
- </member>
- <member name="P:ZedGraph.Axis.MinSpace">
- <summary>
- Gets or sets the minimum axis space allocation.
- </summary>
- <remarks>
- This term, expressed in
- points (1/72 inch) and scaled according to <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/>
- for the <see cref="T:ZedGraph.GraphPane"/>, determines the minimum amount of space
- an axis must have between the <see cref="P:ZedGraph.Chart.Rect">Chart.Rect</see> and the
- <see cref="P:ZedGraph.PaneBase.Rect">GraphPane.Rect</see>. This minimum space
- applies whether <see cref="P:ZedGraph.Axis.IsVisible"/> is true or false.
- </remarks>
- </member>
- <member name="P:ZedGraph.Axis.Color">
- <summary>
- The color to use for drawing this <see cref="T:ZedGraph.Axis"/>.
- </summary>
- <remarks>
- This affects only the axis segment (see <see cref="P:ZedGraph.Axis.IsAxisSegmentVisible"/>),
- since the <see cref="P:ZedGraph.Axis.Title"/>,
- <see cref="P:ZedGraph.Axis.Scale"/>, <see cref="P:ZedGraph.Axis.MajorTic"/>, <see cref="P:ZedGraph.Axis.MinorTic"/>,
- <see cref="P:ZedGraph.Axis.MajorGrid"/>, and <see cref="P:ZedGraph.Axis.MinorGrid"/>
- all have their own color specification.
- </remarks>
- <value> The color is defined using the
- <see cref="T:System.Drawing.Color"/> class</value>
- <seealso cref="F:ZedGraph.Axis.Default.Color"/>.
- <seealso cref="P:ZedGraph.Axis.IsVisible"/>
- </member>
- <member name="P:ZedGraph.Axis.MajorTic">
- <summary>
- Gets a reference to the <see cref="T:ZedGraph.MajorTic"/> class instance
- for this <see cref="T:ZedGraph.Axis"/>. This class stores all the major tic settings.
- </summary>
- </member>
- <member name="P:ZedGraph.Axis.MinorTic">
- <summary>
- Gets a reference to the <see cref="T:ZedGraph.MinorTic"/> class instance
- for this <see cref="T:ZedGraph.Axis"/>. This class stores all the minor tic settings.
- </summary>
- </member>
- <member name="P:ZedGraph.Axis.MajorGrid">
- <summary>
- Gets a reference to the <see cref="P:ZedGraph.Axis.MajorGrid"/> class that contains the properties
- of the major grid.
- </summary>
- </member>
- <member name="P:ZedGraph.Axis.MinorGrid">
- <summary>
- Gets a reference to the <see cref="P:ZedGraph.Axis.MinorGrid"/> class that contains the properties
- of the minor grid.
- </summary>
- </member>
- <member name="P:ZedGraph.Axis.IsVisible">
- <summary>
- This property determines whether or not the <see cref="T:ZedGraph.Axis"/> is shown.
- </summary>
- <remarks>
- Note that even if
- the axis is not visible, it can still be actively used to draw curves on a
- graph, it will just be invisible to the user
- </remarks>
- <value>true to show the axis, false to disable all drawing of this axis</value>
- <seealso cref="P:ZedGraph.Scale.IsVisible"/>.
- <seealso cref="F:ZedGraph.XAxis.Default.IsVisible"/>.
- <seealso cref="F:ZedGraph.YAxis.Default.IsVisible"/>.
- <seealso cref="F:ZedGraph.Y2Axis.Default.IsVisible"/>.
- </member>
- <member name="P:ZedGraph.Axis.IsAxisSegmentVisible">
- <summary>
- Gets or sets a property that determines whether or not the axis segment (the line that
- represents the axis itself) is drawn.
- </summary>
- <remarks>
- Under normal circumstances, this value won't affect the appearance of the display because
- the Axis segment is overlain by the Axis border (see <see cref="P:ZedGraph.Chart.Border"/>).
- However, when the border is not visible, or when <see cref="P:ZedGraph.Axis.CrossAuto"/> is set to
- false, this value will make a difference.
- </remarks>
- </member>
- <member name="P:ZedGraph.Axis.Type">
- <summary>
- Gets or sets the <see cref="T:ZedGraph.AxisType"/> for this <see cref="T:ZedGraph.Axis"/>.
- </summary>
- <remarks>
- The type can be either <see cref="F:ZedGraph.AxisType.Linear"/>,
- <see cref="F:ZedGraph.AxisType.Log"/>, <see cref="F:ZedGraph.AxisType.Date"/>,
- or <see cref="F:ZedGraph.AxisType.Text"/>.
- </remarks>
- <seealso cref="P:ZedGraph.Scale.IsLog"/>
- <seealso cref="P:ZedGraph.Scale.IsText"/>
- <seealso cref="P:ZedGraph.Scale.IsOrdinal"/>
- <seealso cref="P:ZedGraph.Scale.IsDate"/>
- <seealso cref="P:ZedGraph.Scale.IsReverse"/>
- </member>
- <member name="P:ZedGraph.Axis.Title">
- <summary>
- Gets or sets the <see cref="T:ZedGraph.Label"/> class that contains the title of this
- <see cref="T:ZedGraph.Axis"/>.
- </summary>
- <remarks>The title normally shows the basis and dimensions of
- the scale range, such as "Time (Years)". The title is only shown if the
- <see cref="P:ZedGraph.Label.IsVisible"/> property is set to true. If the Title text is empty,
- then no title is shown, and no space is "reserved" for the title on the graph.
- </remarks>
- <value>the title is a string value</value>
- <seealso cref="P:ZedGraph.AxisLabel.IsOmitMag"/>
- </member>
- <member name="P:ZedGraph.Axis.AxisGap">
- <summary>
- The size of the gap between multiple axes (see <see cref="P:ZedGraph.GraphPane.YAxisList"/> and
- <see cref="P:ZedGraph.GraphPane.Y2AxisList"/>).
- </summary>
- <remarks>
- This size will be scaled
- according to the <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> for the
- <see cref="T:ZedGraph.GraphPane"/>
- </remarks>
- <value>The axis gap is measured in points (1/72 inch)</value>
- <seealso cref="F:ZedGraph.Axis.Default.AxisGap"/>.
- </member>
- <member name="T:ZedGraph.Axis.ScaleFormatHandler">
- <summary>
- A delegate that allows full custom formatting of the Axis labels
- </summary>
- <param name="pane">The <see cref="T:ZedGraph.GraphPane"/> for which the label is to be
- formatted</param>
- <param name="axis">The <see cref="P:ZedGraph.Axis.Scale"/> of interest.</param>
- <param name="val">The value to be formatted</param>
- <param name="index">The zero-based index of the label to be formatted</param>
- <returns>
- A string value representing the label, or null if the ZedGraph should go ahead
- and generate the label according to the current settings</returns>
- <seealso cref="E:ZedGraph.Axis.ScaleFormatEvent"/>
- </member>
- <member name="T:ZedGraph.Axis.ScaleTitleEventHandler">
- <summary>
- Allow customization of title based on user preferences.
- </summary>
- <param name="axis">The <see cref="T:ZedGraph.Axis"/> of interest.</param>
- <returns>
- A string value representing the label, or null if the ZedGraph should go ahead
- and generate the label according to the current settings. To make the title
- blank, return "".</returns>
- <seealso cref="E:ZedGraph.Axis.ScaleFormatEvent"/>
- </member>
- <member name="T:ZedGraph.Axis.Default">
- <summary>
- A simple struct that defines the
- default property values for the <see cref="T:ZedGraph.Axis"/> class.
- </summary>
- </member>
- <member name="F:ZedGraph.Axis.Default.AxisGap">
- <summary>
- The default size for the gap between multiple axes
- (<see cref="P:ZedGraph.Axis.AxisGap"/> property). Units are in points (1/72 inch).
- </summary>
- </member>
- <member name="F:ZedGraph.Axis.Default.TitleGap">
- <summary>
- The default setting for the gap between the scale labels and the axis title.
- </summary>
- </member>
- <member name="F:ZedGraph.Axis.Default.TitleFontFamily">
- <summary>
- The default font family for the <see cref="T:ZedGraph.Axis"/> <see cref="P:ZedGraph.Axis.Title"/> text
- font specification <see cref="T:ZedGraph.FontSpec"/>
- (<see cref="P:ZedGraph.FontSpec.Family"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.Axis.Default.TitleFontSize">
- <summary>
- The default font size for the <see cref="T:ZedGraph.Axis"/> <see cref="P:ZedGraph.Axis.Title"/> text
- font specification <see cref="T:ZedGraph.FontSpec"/>
- (<see cref="P:ZedGraph.FontSpec.Size"/> property). Units are
- in points (1/72 inch).
- </summary>
- </member>
- <member name="F:ZedGraph.Axis.Default.TitleFontColor">
- <summary>
- The default font color for the <see cref="T:ZedGraph.Axis"/> <see cref="P:ZedGraph.Axis.Title"/> text
- font specification <see cref="T:ZedGraph.FontSpec"/>
- (<see cref="P:ZedGraph.FontSpec.FontColor"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.Axis.Default.TitleFontBold">
- <summary>
- The default font bold mode for the <see cref="T:ZedGraph.Axis"/> <see cref="P:ZedGraph.Axis.Title"/> text
- font specification <see cref="T:ZedGraph.FontSpec"/>
- (<see cref="P:ZedGraph.FontSpec.IsBold"/> property). true
- for a bold typeface, false otherwise.
- </summary>
- </member>
- <member name="F:ZedGraph.Axis.Default.TitleFontItalic">
- <summary>
- The default font italic mode for the <see cref="T:ZedGraph.Axis"/> <see cref="P:ZedGraph.Axis.Title"/> text
- font specification <see cref="T:ZedGraph.FontSpec"/>
- (<see cref="P:ZedGraph.FontSpec.IsItalic"/> property). true
- for an italic typeface, false otherwise.
- </summary>
- </member>
- <member name="F:ZedGraph.Axis.Default.TitleFontUnderline">
- <summary>
- The default font underline mode for the <see cref="T:ZedGraph.Axis"/> <see cref="P:ZedGraph.Axis.Title"/> text
- font specification <see cref="T:ZedGraph.FontSpec"/>
- (<see cref="P:ZedGraph.FontSpec.IsUnderline"/> property). true
- for an underlined typeface, false otherwise.
- </summary>
- </member>
- <member name="F:ZedGraph.Axis.Default.TitleFillColor">
- <summary>
- The default color for filling in the <see cref="P:ZedGraph.Axis.Title"/> text background
- (see <see cref="P:ZedGraph.Fill.Color"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.Axis.Default.TitleFillBrush">
- <summary>
- The default custom brush for filling in the <see cref="P:ZedGraph.Axis.Title"/> text background
- (see <see cref="P:ZedGraph.Fill.Brush"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.Axis.Default.TitleFillType">
- <summary>
- The default fill mode for filling in the <see cref="P:ZedGraph.Axis.Title"/> text background
- (see <see cref="P:ZedGraph.Fill.Type"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.Axis.Default.BorderColor">
- <summary>
- The default color for the <see cref="T:ZedGraph.Axis"/> itself
- (<see cref="P:ZedGraph.Axis.Color"/> property). This color only affects the
- the axis border.
- </summary>
- </member>
- <member name="F:ZedGraph.Axis.Default.IsAxisSegmentVisible">
- <summary>
- The default value for <see cref="P:ZedGraph.Axis.IsAxisSegmentVisible"/>, which determines
- whether or not the scale segment itself is visible
- </summary>
- </member>
- <member name="F:ZedGraph.Axis.Default.Type">
- <summary>
- The default setting for the <see cref="T:ZedGraph.Axis"/> scale axis type
- (<see cref="P:ZedGraph.Axis.Type"/> property). This value is set as per
- the <see cref="T:ZedGraph.AxisType"/> enumeration
- </summary>
- </member>
- <member name="F:ZedGraph.Axis.Default.Color">
- <summary>
- The default color for the axis segment.
- </summary>
- </member>
- <member name="F:ZedGraph.Axis.Default.MinSpace">
- <summary>
- The default setting for the axis space allocation. This term, expressed in
- points (1/72 inch) and scaled according to <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> for the
- <see cref="T:ZedGraph.GraphPane"/>, determines the minimum amount of space an axis must
- have between the <see cref="P:ZedGraph.Chart.Rect"/> and the
- <see cref="P:ZedGraph.PaneBase.Rect"/>. This minimum space
- applies whether <see cref="P:ZedGraph.Axis.IsVisible"/> is true or false.
- </summary>
- </member>
- <member name="T:ZedGraph.MinorTic">
- <summary>
- Class that holds the specific properties for the minor tics.
- </summary>
- <author> John Champion </author>
- <version> $Revision: 3.1 $ $Date: 2006-06-24 20:26:44 $ </version>
- </member>
- <member name="F:ZedGraph.MinorTic.schema">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="M:ZedGraph.MinorTic.#ctor">
- <summary>
- Default Constructor
- </summary>
- </member>
- <member name="M:ZedGraph.MinorTic.#ctor(ZedGraph.MinorTic)">
- <summary>
- Copy constructor.
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.MinorTic"/> that is to be copied.</param>
- </member>
- <member name="M:ZedGraph.MinorTic.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.MinorTic.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.MinorTic.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.MinorTic.ScaledTic(System.Single)">
- <summary>
- Calculate the scaled tic size for this <see cref="T:ZedGraph.Axis"/>
- </summary>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <returns>The scaled tic size, in points (1/72 inch)</returns>
- <seealso cref="P:ZedGraph.MinorTic.Size"/>
- <seealso cref="P:ZedGraph.Scale.FontSpec"/>
- <seealso cref="M:ZedGraph.PaneBase.CalcScaleFactor"/>
- </member>
- <member name="M:ZedGraph.MinorTic.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.MinorTic.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.MinorTic.Draw(System.Drawing.Graphics,ZedGraph.GraphPane,System.Drawing.Pen,System.Single,System.Single,System.Single,System.Single)">
- <summary>
- Draw a tic mark at the specified single position. This includes the inner, outer,
- cross and opposite tic marks as required.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="pen">Graphic <see cref="T:System.Drawing.Pen"/> with which to draw the tic mark.</param>
- <param name="pixVal">The pixel location of the tic mark on this
- <see cref="T:ZedGraph.Axis"/></param>
- <param name="topPix">The pixel value of the top of the axis border</param>
- <param name="shift">The number of pixels to shift this axis, based on the
- value of <see cref="P:ZedGraph.Axis.Cross"/>. A positive value is into the ChartRect relative to
- the default axis position.</param>
- <param name="scaledTic">The scaled size of a minor tic, in pixel units</param>
- </member>
- <member name="P:ZedGraph.MinorTic.Color">
- <summary>
- The color to use for drawing the tics of this class instance
- </summary>
- <value> The color is defined using the
- <see cref="T:System.Drawing.Color"/> class</value>
- <seealso cref="F:ZedGraph.MinorTic.Default.Color"/>.
- <seealso cref="P:ZedGraph.MinorTic.IsOutside"/>
- <seealso cref="P:ZedGraph.Axis.IsVisible"/>
- </member>
- <member name="P:ZedGraph.MinorTic.Size">
- <summary>
- The length of the major tic marks.
- </summary>
- <remarks>
- This length will be scaled
- according to the <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> for the
- <see cref="T:ZedGraph.GraphPane"/>
- </remarks>
- <value>The tic size is measured in points (1/72 inch)</value>
- <seealso cref="F:ZedGraph.MinorTic.Default.Size"/>.
- <seealso cref="P:ZedGraph.MinorTic.IsOutside"/>
- <seealso cref="P:ZedGraph.Axis.IsVisible"/>
- <seealso cref="P:ZedGraph.MinorTic.Color"/>
- </member>
- <member name="P:ZedGraph.MinorTic.IsAllTics">
- <summary>
- This is convenience property sets the status of all the different
- tic properties in this instance to the same value. true to activate all tics,
- false to clear all tics.
- </summary>
- <remarks>
- This setting does not persist. That is, you can clear all the tics with
- <see cref="P:ZedGraph.MinorTic.IsAllTics"/> = false, then activate them individually (example:
- <see cref="P:ZedGraph.MinorTic.IsOutside"/> = true).
- </remarks>
- <seealso cref="P:ZedGraph.MinorTic.IsOutside"/>
- <seealso cref="P:ZedGraph.MinorTic.IsInside"/>
- <seealso cref="P:ZedGraph.MinorTic.IsOpposite"/>
- <seealso cref="P:ZedGraph.MinorTic.IsCrossInside"/>
- <seealso cref="P:ZedGraph.MinorTic.IsCrossOutside"/>
- </member>
- <member name="P:ZedGraph.MinorTic.IsOutside">
- <summary>
- Gets or sets a property that determines whether or not the minor outside tic marks
- are shown.
- </summary>
- <remarks>
- These are the tic marks on the outside of the <see cref="T:ZedGraph.Axis"/> border.
- The minor tic spacing is controlled by <see cref="P:ZedGraph.Scale.MinorStep"/>.
- </remarks>
- <value>true to show the minor outside tic marks, false otherwise</value>
- <seealso cref="F:ZedGraph.MinorTic.Default.IsOutside"/>.
- <seealso cref="P:ZedGraph.MinorTic.IsOutside"/>
- <seealso cref="P:ZedGraph.MinorTic.IsInside"/>
- <seealso cref="P:ZedGraph.MinorTic.IsOpposite"/>
- <seealso cref="P:ZedGraph.MinorTic.IsCrossInside"/>
- <seealso cref="P:ZedGraph.MinorTic.IsCrossOutside"/>
- </member>
- <member name="P:ZedGraph.MinorTic.IsInside">
- <summary>
- Gets or sets a property that determines whether or not the major inside tic marks
- are shown.
- </summary>
- <remarks>
- These are the tic marks on the inside of the <see cref="T:ZedGraph.Axis"/> border.
- The major tic spacing is controlled by <see cref="P:ZedGraph.Scale.MajorStep"/>.
- </remarks>
- <value>true to show the major inside tic marks, false otherwise</value>
- <seealso cref="F:ZedGraph.MinorTic.Default.IsInside"/>.
- <seealso cref="P:ZedGraph.MinorTic.IsOutside"/>
- <seealso cref="P:ZedGraph.MinorTic.IsInside"/>
- <seealso cref="P:ZedGraph.MinorTic.IsOpposite"/>
- <seealso cref="P:ZedGraph.MinorTic.IsCrossInside"/>
- <seealso cref="P:ZedGraph.MinorTic.IsCrossOutside"/>
- </member>
- <member name="P:ZedGraph.MinorTic.IsOpposite">
- <summary>
- Gets or sets a property that determines whether or not the major opposite tic marks
- are shown.
- </summary>
- <remarks>
- These are the tic marks on the inside of the <see cref="T:ZedGraph.Axis"/> border on
- the opposite side from the axis.
- The major tic spacing is controlled by <see cref="P:ZedGraph.Scale.MajorStep"/>.
- </remarks>
- <value>true to show the major opposite tic marks, false otherwise</value>
- <seealso cref="F:ZedGraph.MinorTic.Default.IsOpposite"/>.
- <seealso cref="P:ZedGraph.MinorTic.IsOutside"/>
- <seealso cref="P:ZedGraph.MinorTic.IsInside"/>
- <seealso cref="P:ZedGraph.MinorTic.IsOpposite"/>
- <seealso cref="P:ZedGraph.MinorTic.IsCrossInside"/>
- <seealso cref="P:ZedGraph.MinorTic.IsCrossOutside"/>
- </member>
- <member name="P:ZedGraph.MinorTic.IsCrossOutside">
- <summary>
- Gets or sets the display mode for the <see cref="T:ZedGraph.Axis"/> major outside
- "cross" tic marks.
- </summary>
- <remarks>
- The "cross" tics are a special, additional set of tic marks that
- always appear on the actual axis, even if it has been shifted due
- to the <see cref="P:ZedGraph.Axis.Cross"/> setting. The other tic marks are always
- fixed to the edges of the <see cref="P:ZedGraph.Chart.Rect"/>. The cross tics
- are normally not displayed, since, if <see cref="P:ZedGraph.Axis.CrossAuto"/> is true,
- they will exactly overlay the "normal" and "inside" tics. If
- <see cref="P:ZedGraph.Axis.CrossAuto"/> is false, then you will most likely want to
- enable the cross tics.
- The major tic spacing is controlled by <see cref="P:ZedGraph.Scale.MajorStep"/>.
- </remarks>
- <value>true to show the major cross tic marks, false otherwise</value>
- </member>
- <member name="P:ZedGraph.MinorTic.IsCrossInside">
- <summary>
- Gets or sets the display mode for the <see cref="T:ZedGraph.Axis"/> major inside
- "cross" tic marks.
- </summary>
- <remarks>
- The "cross" tics are a special, additional set of tic marks that
- always appear on the actual axis, even if it has been shifted due
- to the <see cref="P:ZedGraph.Axis.Cross"/> setting. The other tic marks are always
- fixed to the edges of the <see cref="P:ZedGraph.Chart.Rect"/>. The cross tics
- are normally not displayed, since, if <see cref="P:ZedGraph.Axis.CrossAuto"/> is true,
- they will exactly overlay the "normal" and "inside" tics. If
- <see cref="P:ZedGraph.Axis.CrossAuto"/> is false, then you will most likely want to
- enable the cross tics.
- The major tic spacing is controlled by <see cref="P:ZedGraph.Scale.MajorStep"/>.
- </remarks>
- <value>true to show the major cross tic marks, false otherwise</value>
- </member>
- <member name="P:ZedGraph.MinorTic.PenWidth">
- <summary>
- Gets or sets the pen width to be used when drawing the tic marks for
- this <see cref="T:ZedGraph.Axis"/>
- </summary>
- <value>The pen width is defined in points (1/72 inch)</value>
- <seealso cref="F:ZedGraph.MinorTic.Default.PenWidth"/>.
- <seealso cref="P:ZedGraph.MinorTic.IsOutside"/>
- <seealso cref="P:ZedGraph.MinorTic.Color"/>
- </member>
- <member name="T:ZedGraph.MinorTic.Default">
- <summary>
- A simple struct that defines the
- default property values for the <see cref="T:ZedGraph.MinorTic"/> class.
- </summary>
- </member>
- <member name="F:ZedGraph.MinorTic.Default.Size">
- <summary>
- The default size for the <see cref="T:ZedGraph.Axis"/> minor tic marks.
- (<see cref="P:ZedGraph.MinorTic.Size"/> property). Units are in points (1/72 inch).
- </summary>
- </member>
- <member name="F:ZedGraph.MinorTic.Default.PenWidth">
- <summary>
- The default pen width for drawing the <see cref="T:ZedGraph.Axis"/> tic marks.
- (<see cref="P:ZedGraph.MinorTic.PenWidth"/> property). Units are in points (1/72 inch).
- </summary>
- </member>
- <member name="F:ZedGraph.MinorTic.Default.IsOutside">
- <summary>
- The display mode for the <see cref="T:ZedGraph.Axis"/> minor outside tic marks
- (<see cref="P:ZedGraph.MinorTic.IsOutside"/> property).
- The minor tic spacing is controlled by <see cref="P:ZedGraph.Scale.MinorStep"/>.
- </summary>
- <value>true to show the minor tic marks (outside the axis),
- false otherwise</value>
- </member>
- <member name="F:ZedGraph.MinorTic.Default.IsInside">
- <summary>
- The display mode for the <see cref="T:ZedGraph.Axis"/> minor inside tic marks
- (<see cref="P:ZedGraph.MinorTic.IsInside"/> property).
- The minor tic spacing is controlled by <see cref="P:ZedGraph.Scale.MinorStep"/>.
- </summary>
- <value>true to show the minor tic marks (inside the axis),
- false otherwise</value>
- </member>
- <member name="F:ZedGraph.MinorTic.Default.IsOpposite">
- <summary>
- The display mode for the <see cref="T:ZedGraph.Axis"/> minor opposite tic marks
- (<see cref="P:ZedGraph.MinorTic.IsOpposite"/> property).
- The minor tic spacing is controlled by <see cref="P:ZedGraph.Scale.MinorStep"/>.
- </summary>
- <value>true to show the minor tic marks
- (inside the axis on the opposite side),
- false otherwise</value>
- </member>
- <member name="F:ZedGraph.MinorTic.Default.IsCrossOutside">
- <summary>
- The default display mode for the <see cref="T:ZedGraph.Axis"/> minor outside
- "cross" tic marks (<see cref="P:ZedGraph.MinorTic.IsCrossOutside"/> property).
- </summary>
- <remarks>
- The "cross" tics are a special, additional set of tic marks that
- always appear on the actual axis, even if it has been shifted due
- to the <see cref="P:ZedGraph.Axis.Cross"/> setting. The other tic marks are always
- fixed to the edges of the <see cref="P:ZedGraph.Chart.Rect"/>. The cross tics
- are normally not displayed, since, if <see cref="P:ZedGraph.Axis.CrossAuto"/> is true,
- they will exactly overlay the "normal" and "inside" tics. If
- <see cref="P:ZedGraph.Axis.CrossAuto"/> is false, then you will most likely want to
- enable the cross tics.
- The minor tic spacing is controlled by <see cref="P:ZedGraph.Scale.MinorStep"/>.
- </remarks>
- <value>true to show the major cross tic marks, false otherwise</value>
- </member>
- <member name="F:ZedGraph.MinorTic.Default.IsCrossInside">
- <summary>
- The default display mode for the <see cref="T:ZedGraph.Axis"/> minor inside
- "cross" tic marks (<see cref="P:ZedGraph.MinorTic.IsCrossInside"/> property).
- </summary>
- <remarks>
- The "cross" tics are a special, additional set of tic marks that
- always appear on the actual axis, even if it has been shifted due
- to the <see cref="P:ZedGraph.Axis.Cross"/> setting. The other tic marks are always
- fixed to the edges of the <see cref="P:ZedGraph.Chart.Rect"/>. The cross tics
- are normally not displayed, since, if <see cref="P:ZedGraph.Axis.CrossAuto"/> is true,
- they will exactly overlay the "normal" and "inside" tics. If
- <see cref="P:ZedGraph.Axis.CrossAuto"/> is false, then you will most likely want to
- enable the cross tics.
- The major tic spacing is controlled by <see cref="P:ZedGraph.Scale.MinorStep"/>.
- </remarks>
- <value>true to show the major cross tic marks, false otherwise</value>
- </member>
- <member name="F:ZedGraph.MinorTic.Default.Color">
- <summary>
- The default color for minor tics (<see cref="P:ZedGraph.MinorTic.Color"/> property).
- </summary>
- </member>
- <member name="T:ZedGraph.LinearAsOrdinalScale">
- <summary>
- The LinearAsOrdinalScale class inherits from the <see cref="T:ZedGraph.Scale"/> class, and implements
- the features specific to <see cref="F:ZedGraph.AxisType.LinearAsOrdinal"/>.
- </summary>
- <remarks>
- LinearAsOrdinal is an ordinal axis that will have labels formatted with values from the actual data
- values of the first <see cref="T:ZedGraph.CurveItem"/> in the <see cref="T:ZedGraph.CurveList"/>.
- Although the tics are labeled with real data values, the actual points will be
- evenly-spaced in spite of the data values. For example, if the X values of the first curve
- are 1, 5, and 100, then the tic labels will show 1, 5, and 100, but they will be equal
- distance from each other.
- </remarks>
-
- <author> John Champion </author>
- <version> $Revision: 1.10 $ $Date: 2007-04-16 00:03:02 $ </version>
- </member>
- <member name="F:ZedGraph.LinearAsOrdinalScale.schema2">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="M:ZedGraph.LinearAsOrdinalScale.#ctor(ZedGraph.Axis)">
- <summary>
- Default constructor that defines the owner <see cref="T:ZedGraph.Axis"/>
- (containing object) for this new object.
- </summary>
- <param name="owner">The owner, or containing object, of this instance</param>
- </member>
- <member name="M:ZedGraph.LinearAsOrdinalScale.#ctor(ZedGraph.Scale,ZedGraph.Axis)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.LinearAsOrdinalScale"/> object from which to copy</param>
- <param name="owner">The <see cref="T:ZedGraph.Axis"/> object that will own the
- new instance of <see cref="T:ZedGraph.LinearAsOrdinalScale"/></param>
- </member>
- <member name="M:ZedGraph.LinearAsOrdinalScale.Clone(ZedGraph.Axis)">
- <summary>
- Create a new clone of the current item, with a new owner assignment
- </summary>
- <param name="owner">The new <see cref="T:ZedGraph.Axis"/> instance that will be
- the owner of the new Scale</param>
- <returns>A new <see cref="T:ZedGraph.Scale"/> clone.</returns>
- </member>
- <member name="M:ZedGraph.LinearAsOrdinalScale.PickScale(ZedGraph.GraphPane,System.Drawing.Graphics,System.Single)">
- <summary>
- Select a reasonable ordinal axis scale given a range of data values, with the expectation that
- linear values will be displayed.
- </summary>
- <remarks>
- This method only applies to <see cref="F:ZedGraph.AxisType.DateAsOrdinal"/> type axes, and it
- is called by the general <see cref="M:ZedGraph.Scale.PickScale(ZedGraph.GraphPane,System.Drawing.Graphics,System.Single)"/> method. For this type,
- the first curve is the "master", which contains the dates to be applied.
- <para>On Exit:</para>
- <para><see cref="P:ZedGraph.Scale.Min"/> is set to scale minimum (if <see cref="P:ZedGraph.Scale.MinAuto"/> = true)</para>
- <para><see cref="P:ZedGraph.Scale.Max"/> is set to scale maximum (if <see cref="P:ZedGraph.Scale.MaxAuto"/> = true)</para>
- <para><see cref="P:ZedGraph.Scale.MajorStep"/> is set to scale step size (if <see cref="P:ZedGraph.Scale.MajorStepAuto"/> = true)</para>
- <para><see cref="P:ZedGraph.Scale.MinorStep"/> is set to scale minor step size (if <see cref="P:ZedGraph.Scale.MinorStepAuto"/> = true)</para>
- <para><see cref="P:ZedGraph.Scale.Mag"/> is set to a magnitude multiplier according to the data</para>
- <para><see cref="P:ZedGraph.Scale.Format"/> is set to the display format for the values (this controls the
- number of decimal places, whether there are thousands separators, currency types, etc.)</para>
- </remarks>
- <param name="pane">A reference to the <see cref="T:ZedGraph.GraphPane"/> object
- associated with this <see cref="T:ZedGraph.Axis"/></param>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <seealso cref="M:ZedGraph.LinearAsOrdinalScale.PickScale(ZedGraph.GraphPane,System.Drawing.Graphics,System.Single)"/>
- <seealso cref="F:ZedGraph.AxisType.Ordinal"/>
- </member>
- <member name="M:ZedGraph.LinearAsOrdinalScale.MakeLabel(ZedGraph.GraphPane,System.Int32,System.Double)">
- <summary>
- Make a value label for an <see cref="F:ZedGraph.AxisType.LinearAsOrdinal"/> <see cref="T:ZedGraph.Axis"/>.
- </summary>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="index">
- The zero-based, ordinal index of the label to be generated. For example, a value of 2 would
- cause the third value label on the axis to be generated.
- </param>
- <param name="dVal">
- The numeric value associated with the label. This value is ignored for log (<see cref="P:ZedGraph.Scale.IsLog"/>)
- and text (<see cref="P:ZedGraph.Scale.IsText"/>) type axes.
- </param>
- <returns>The resulting value label as a <see cref="T:System.String"/></returns>
- </member>
- <member name="M:ZedGraph.LinearAsOrdinalScale.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.LinearAsOrdinalScale.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="P:ZedGraph.LinearAsOrdinalScale.Type">
- <summary>
- Return the <see cref="T:ZedGraph.AxisType"/> for this <see cref="T:ZedGraph.Scale"/>, which is
- <see cref="F:ZedGraph.AxisType.LinearAsOrdinal"/>.
- </summary>
- </member>
- <member name="T:ZedGraph.ZedGraphException">
- <summary>
- An exception thrown by ZedGraph. A child class of <see cref="T:System.ApplicationException"/>.
- </summary>
-
- <author> Jerry Vos modified by John Champion</author>
- <version> $Revision: 3.2 $ $Date: 2006-06-24 20:26:44 $ </version>
- </member>
- <member name="M:ZedGraph.ZedGraphException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:ZedGraph.ZedGraphException"/>
- class with serialized data.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/>
- instance that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/>
- instance that contains contextual information about the source or destination.</param>
- </member>
- <member name="M:ZedGraph.ZedGraphException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:System.Exception"/> class with a specified
- error message and a reference to the inner exception that is the cause of this exception.
- </summary>
- <param name="message">The error message that explains the reason for the exception.</param>
- <param name="innerException">The exception that is the cause of the current exception.
- If the innerException parameter is not a null reference, the current exception is raised
- in a catch block that handles the inner exception.</param>
- </member>
- <member name="M:ZedGraph.ZedGraphException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:System.Exception"/> class with a specified error message.
- </summary>
- <param name="message">The error message that explains the reason for the exception.</param>
- </member>
- <member name="M:ZedGraph.ZedGraphException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:System.Exception"/> class.
- </summary>
- </member>
- <member name="T:ZedGraph.XDate">
- <summary>
- This struct encapsulates a date and time value, and handles associated
- calculations and conversions between various formats.
- </summary>
- <remarks>
- This format stored as a double value representing days since a reference date
- (XL date 0.0 is December 30, 1899 at 00:00 hrs).
- Negative values are permissible, and the
- range of valid dates is from noon on January 1st, 4713 B.C. forward. Internally, the
- date calculations are done using Astronomical Julian Day numbers. The Astronomical Julian
- Day number is defined as the number of days since noon on January 1st, 4713 B.C.
- (also referred to as 12:00 on January 1, -4712).
- NOTE: MS Excel actually has an error in the Serial Date calculations because it
- errantly assumes 1900 is a leap year. The XDate calculations do not have this same
- error. Therefore, XDate and Excel Date Serial values are 1 day different up until
- the date value of 60 (in Excel, this is February 29th, 1900, and in XDate, this is
- February 28th, 1900). At a value of 61 (March 1st, 1900) or greater, they agree with
- eachother.
- </remarks>
- <author> John Champion </author>
- <version> $Revision: 3.23 $ $Date: 2007-11-11 06:56:34 $ </version>
- </member>
- <member name="F:ZedGraph.XDate.XLDay1">
- <summary>
- The Astronomical Julian Day number that corresponds to XL Date 0.0
- </summary>
- </member>
- <member name="F:ZedGraph.XDate.JulDayMin">
- <summary>
- The minimum valid Julian Day, which corresponds to January 1st, 4713 B.C.
- </summary>
- </member>
- <member name="F:ZedGraph.XDate.JulDayMax">
- <summary>
- The maximum valid Julian Day, which corresponds to December 31st, 9999 A.D.
- </summary>
- </member>
- <member name="F:ZedGraph.XDate.XLDayMin">
- <summary>
- The minimum valid Excel Day, which corresponds to January 1st, 4713 B.C.
- </summary>
- </member>
- <member name="F:ZedGraph.XDate.XLDayMax">
- <summary>
- The maximum valid Excel Day, which corresponds to December 31st, 9999 A.D.
- </summary>
- </member>
- <member name="F:ZedGraph.XDate.MonthsPerYear">
- <summary>
- The number of months in a year
- </summary>
- </member>
- <member name="F:ZedGraph.XDate.HoursPerDay">
- <summary>
- The number of hours in a day
- </summary>
- </member>
- <member name="F:ZedGraph.XDate.MinutesPerHour">
- <summary>
- The number of minutes in an hour
- </summary>
- </member>
- <member name="F:ZedGraph.XDate.SecondsPerMinute">
- <summary>
- The number of seconds in a minute
- </summary>
- </member>
- <member name="F:ZedGraph.XDate.MinutesPerDay">
- <summary>
- The number of minutes in a day
- </summary>
- </member>
- <member name="F:ZedGraph.XDate.SecondsPerDay">
- <summary>
- The number of seconds in a day
- </summary>
- </member>
- <member name="F:ZedGraph.XDate.MillisecondsPerSecond">
- <summary>
- The number of milliseconds in a second
- </summary>
- </member>
- <member name="F:ZedGraph.XDate.MillisecondsPerDay">
- <summary>
- The number of milliseconds in a day
- </summary>
- </member>
- <member name="F:ZedGraph.XDate.DefaultFormatStr">
- <summary>
- The default format string to be used in <see cref="M:ZedGraph.XDate.ToString"/> when
- no format is provided
- </summary>
- </member>
- <member name="F:ZedGraph.XDate._xlDate">
- <summary>
- The actual date value in MS Excel format. This is the only data field in
- the <see cref="T:ZedGraph.XDate"/> struct.
- </summary>
- </member>
- <member name="M:ZedGraph.XDate.#ctor(System.Double)">
- <summary>
- Construct a date class from an XL date value.
- </summary>
- <param name="xlDate">
- An XL Date value in floating point double format
- </param>
- </member>
- <member name="M:ZedGraph.XDate.#ctor(System.DateTime)">
- <summary>
- Construct a date class from a <see cref="P:ZedGraph.XDate.DateTime"/> struct.
- </summary>
- <param name="dateTime">
- A <see cref="P:ZedGraph.XDate.DateTime"/> struct containing the initial date information.
- </param>
- </member>
- <member name="M:ZedGraph.XDate.#ctor(System.Int32,System.Int32,System.Int32)">
- <summary>
- Construct a date class from a calendar date (year, month, day). Assumes the time
- of day is 00:00 hrs
- </summary>
- <param name="year">An integer value for the year, e.g., 1995.</param>
- <param name="day">An integer value for the day of the month, e.g., 23.
- It is permissible to have day numbers outside of the 1-31 range,
- which will rollover to the previous or next month and year.</param>
- <param name="month">An integer value for the month of the year, e.g.,
- 8 for August. It is permissible to have months outside of the 1-12 range,
- which will rollover to the previous or next year.</param>
- </member>
- <member name="M:ZedGraph.XDate.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
- <summary>
- Construct a date class from a calendar date and time (year, month, day, hour, minute,
- second).
- </summary>
- <param name="year">An integer value for the year, e.g., 1995.</param>
- <param name="day">An integer value for the day of the month, e.g., 23.
- It is permissible to have day numbers outside of the 1-31 range,
- which will rollover to the previous or next month and year.</param>
- <param name="month">An integer value for the month of the year, e.g.,
- 8 for August. It is permissible to have months outside of the 1-12 range,
- which will rollover to the previous or next year.</param>
- <param name="hour">An integer value for the hour of the day, e.g. 15.
- It is permissible to have hour values outside the 0-23 range, which
- will rollover to the previous or next day.</param>
- <param name="minute">An integer value for the minute, e.g. 45.
- It is permissible to have hour values outside the 0-59 range, which
- will rollover to the previous or next hour.</param>
- <param name="second">An integer value for the second, e.g. 35.
- It is permissible to have second values outside the 0-59 range, which
- will rollover to the previous or next minute.</param>
- </member>
- <member name="M:ZedGraph.XDate.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Double)">
- <summary>
- Construct a date class from a calendar date and time (year, month, day, hour, minute,
- second), where seconds is a <see cref="T:System.Double"/> value (allowing fractional seconds).
- </summary>
- <param name="year">An integer value for the year, e.g., 1995.</param>
- <param name="day">An integer value for the day of the month, e.g., 23.
- It is permissible to have day numbers outside of the 1-31 range,
- which will rollover to the previous or next month and year.</param>
- <param name="month">An integer value for the month of the year, e.g.,
- 8 for August. It is permissible to have months outside of the 1-12 range,
- which will rollover to the previous or next year.</param>
- <param name="hour">An integer value for the hour of the day, e.g. 15.
- It is permissible to have hour values outside the 0-23 range, which
- will rollover to the previous or next day.</param>
- <param name="minute">An integer value for the minute, e.g. 45.
- It is permissible to have hour values outside the 0-59 range, which
- will rollover to the previous or next hour.</param>
- <param name="second">A double value for the second, e.g. 35.75.
- It is permissible to have second values outside the 0-59 range, which
- will rollover to the previous or next minute.</param>
- </member>
- <member name="M:ZedGraph.XDate.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
- <summary>
- Construct a date class from a calendar date and time (year, month, day, hour, minute,
- second, millisecond).
- </summary>
- <param name="year">An integer value for the year, e.g., 1995.</param>
- <param name="day">An integer value for the day of the month, e.g., 23.
- It is permissible to have day numbers outside of the 1-31 range,
- which will rollover to the previous or next month and year.</param>
- <param name="month">An integer value for the month of the year, e.g.,
- 8 for August. It is permissible to have months outside of the 1-12 range,
- which will rollover to the previous or next year.</param>
- <param name="hour">An integer value for the hour of the day, e.g. 15.
- It is permissible to have hour values outside the 0-23 range, which
- will rollover to the previous or next day.</param>
- <param name="minute">An integer value for the minute, e.g. 45.
- It is permissible to have hour values outside the 0-59 range, which
- will rollover to the previous or next hour.</param>
- <param name="second">An integer value for the second, e.g. 35.
- It is permissible to have second values outside the 0-59 range, which
- will rollover to the previous or next minute.</param>
- <param name="millisecond">An integer value for the millisecond, e.g. 632.
- It is permissible to have millisecond values outside the 0-999 range, which
- will rollover to the previous or next second.</param>
- </member>
- <member name="M:ZedGraph.XDate.#ctor(ZedGraph.XDate)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The GraphPane object from which to copy</param>
- </member>
- <member name="M:ZedGraph.XDate.CheckValidDate(System.Double)">
- <summary>
- Returns true if the specified date value is in the valid range
- </summary>
- <param name="xlDate">The XL date value to be verified for validity</param>
- <returns>true for a valid date, false otherwise</returns>
- </member>
- <member name="M:ZedGraph.XDate.MakeValidDate(System.Double)">
- <summary>
- Take the specified date, and bound it to the valid date range for the XDate struct.
- </summary>
- <param name="xlDate">The date to be bounded</param>
- <returns>An XLDate value that lies between the minimum and maximum valid date ranges
- (see <see cref="F:ZedGraph.XDate.XLDayMin"/> and <see cref="F:ZedGraph.XDate.XLDayMax"/>)</returns>
- </member>
- <member name="M:ZedGraph.XDate.GetDate(System.Int32@,System.Int32@,System.Int32@)">
- <summary>
- Get the calendar date (year, month, day) corresponding to this instance.
- </summary>
- <param name="year">An integer value for the year, e.g., 1995.</param>
- <param name="day">An integer value for the day of the month, e.g., 23.</param>
- <param name="month">An integer value for the month of the year, e.g.,
- 8 for August.</param>
- </member>
- <member name="M:ZedGraph.XDate.SetDate(System.Int32,System.Int32,System.Int32)">
- <summary>
- Set the calendar date (year, month, day) of this instance.
- </summary>
- <param name="year">An integer value for the year, e.g., 1995.</param>
- <param name="day">An integer value for the day of the month, e.g., 23.</param>
- <param name="month">An integer value for the month of the year, e.g.,
- 8 for August.</param>
- </member>
- <member name="M:ZedGraph.XDate.GetDate(System.Int32@,System.Int32@,System.Int32@,System.Int32@,System.Int32@,System.Int32@)">
- <summary>
- Get the calendar date (year, month, day, hour, minute, second) corresponding
- to this instance.
- </summary>
- <param name="year">An integer value for the year, e.g., 1995.</param>
- <param name="day">An integer value for the day of the month, e.g., 23.</param>
- <param name="month">An integer value for the month of the year, e.g.,
- 8 for August.</param>
- <param name="hour">An integer value for the hour of the day, e.g. 15.</param>
- <param name="minute">An integer value for the minute, e.g. 45.</param>
- <param name="second">An integer value for the second, e.g. 35.</param>
- </member>
- <member name="M:ZedGraph.XDate.SetDate(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
- <summary>
- Set the calendar date (year, month, day, hour, minute, second) of this instance.
- </summary>
- <param name="year">An integer value for the year, e.g., 1995.</param>
- <param name="day">An integer value for the day of the month, e.g., 23.</param>
- <param name="month">An integer value for the month of the year, e.g.,
- 8 for August.</param>
- <param name="hour">An integer value for the hour of the day, e.g. 15.</param>
- <param name="minute">An integer value for the minute, e.g. 45.</param>
- <param name="second">An integer value for the second, e.g. 35.</param>
- </member>
- <member name="M:ZedGraph.XDate.GetDayOfYear">
- <summary>
- Get the day of year value (241.345 means the 241st day of the year)
- corresponding to this instance.
- </summary>
- <returns>The day of the year in floating point double format.</returns>
- </member>
- <member name="M:ZedGraph.XDate.CalendarDateToXLDate(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
- <summary>
- Calculate an XL Date from the specified Calendar date (year, month, day, hour, minute, second),
- first normalizing all input data values.
- </summary>
- <remarks>
- The Calendar date is always based on the Gregorian Calendar. Note that the Gregorian calendar is really
- only valid from October 15, 1582 forward. The countries that adopted the Gregorian calendar
- first did so on October 4, 1582, so that the next day was October 15, 1582. Prior to that time
- the Julian Calendar was used. However, Prior to March 1, 4 AD the treatment of leap years was
- inconsistent, and prior to 45 BC the Julian Calendar did not exist. The <see cref="T:ZedGraph.XDate"/>
- struct projects only Gregorian dates backwards and does not deal with Julian calendar dates at all. The
- <see cref="M:ZedGraph.XDate.ToString(System.Double,System.String)"/> method will just append a "(BC)" notation to the end of any dates
- prior to 1 AD, since the <see cref="P:ZedGraph.XDate.DateTime"/> struct throws an exception when formatting earlier dates.
- </remarks>
- <param name="year">
- The integer year value (e.g., 1994).
- </param>
- <param name="month">
- The integer month value (e.g., 7 for July).
- </param>
- <param name="day">
- The integer day value (e.g., 19 for the 19th day of the month).
- </param>
- <param name="hour">
- The integer hour value (e.g., 14 for 2:00 pm).
- </param>
- <param name="minute">
- The integer minute value (e.g., 35 for 35 minutes past the hour).
- </param>
- <param name="second">
- The integer second value (e.g., 42 for 42 seconds past the minute).
- </param>
- <param name="millisecond">
- The integer millisecond value (e.g., 374 for 374 milliseconds past the second).
- </param>
- <returns>The corresponding XL date, expressed in double floating point format</returns>
- </member>
- <member name="M:ZedGraph.XDate.CalendarDateToXLDate(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
- <summary>
- Calculate an XL Date from the specified Calendar date (year, month, day, hour, minute, second),
- first normalizing all input data values.
- </summary>
- <remarks>
- The Calendar date is always based on the Gregorian Calendar. Note that the Gregorian calendar is really
- only valid from October 15, 1582 forward. The countries that adopted the Gregorian calendar
- first did so on October 4, 1582, so that the next day was October 15, 1582. Prior to that time
- the Julian Calendar was used. However, Prior to March 1, 4 AD the treatment of leap years was
- inconsistent, and prior to 45 BC the Julian Calendar did not exist. The <see cref="T:ZedGraph.XDate"/>
- struct projects only Gregorian dates backwards and does not deal with Julian calendar dates at all. The
- <see cref="M:ZedGraph.XDate.ToString(System.Double,System.String)"/> method will just append a "(BC)" notation to the end of any dates
- prior to 1 AD, since the <see cref="P:ZedGraph.XDate.DateTime"/> struct throws an exception when formatting earlier dates.
- </remarks>
- <param name="year">
- The integer year value (e.g., 1994).
- </param>
- <param name="month">
- The integer month value (e.g., 7 for July).
- </param>
- <param name="day">
- The integer day value (e.g., 19 for the 19th day of the month).
- </param>
- <param name="hour">
- The integer hour value (e.g., 14 for 2:00 pm).
- </param>
- <param name="minute">
- The integer minute value (e.g., 35 for 35 minutes past the hour).
- </param>
- <param name="second">
- The integer second value (e.g., 42 for 42 seconds past the minute).
- </param>
- <returns>The corresponding XL date, expressed in double floating point format</returns>
- </member>
- <member name="M:ZedGraph.XDate.CalendarDateToXLDate(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Double)">
- <summary>
- Calculate an XL Date from the specified Calendar date (year, month, day, hour, minute, second),
- first normalizing all input data values. The seconds value is a double type, allowing fractional
- seconds.
- </summary>
- <remarks>
- The Calendar date is always based on the Gregorian Calendar. Note that the Gregorian calendar is really
- only valid from October 15, 1582 forward. The countries that adopted the Gregorian calendar
- first did so on October 4, 1582, so that the next day was October 15, 1582. Prior to that time
- the Julian Calendar was used. However, Prior to March 1, 4 AD the treatment of leap years was
- inconsistent, and prior to 45 BC the Julian Calendar did not exist. The <see cref="T:ZedGraph.XDate"/>
- struct projects only Gregorian dates backwards and does not deal with Julian calendar dates at all. The
- <see cref="M:ZedGraph.XDate.ToString(System.Double,System.String)"/> method will just append a "(BC)" notation to the end of any dates
- prior to 1 AD, since the <see cref="P:ZedGraph.XDate.DateTime"/> struct throws an exception when formatting earlier dates.
- </remarks>
- <param name="year">
- The integer year value (e.g., 1994).
- </param>
- <param name="month">
- The integer month value (e.g., 7 for July).
- </param>
- <param name="day">
- The integer day value (e.g., 19 for the 19th day of the month).
- </param>
- <param name="hour">
- The integer hour value (e.g., 14 for 2:00 pm).
- </param>
- <param name="minute">
- The integer minute value (e.g., 35 for 35 minutes past the hour).
- </param>
- <param name="second">
- The double second value (e.g., 42.3 for 42.3 seconds past the minute).
- </param>
- <returns>The corresponding XL date, expressed in double floating point format</returns>
- </member>
- <member name="M:ZedGraph.XDate.CalendarDateToJulianDay(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
- <summary>
- Calculate an Astronomical Julian Day number from the specified Calendar date
- (year, month, day, hour, minute, second), first normalizing all input data values
- </summary>
- <param name="year">
- The integer year value (e.g., 1994).
- </param>
- <param name="month">
- The integer month value (e.g., 7 for July).
- </param>
- <param name="day">
- The integer day value (e.g., 19 for the 19th day of the month).
- </param>
- <param name="hour">
- The integer hour value (e.g., 14 for 2:00 pm).
- </param>
- <param name="minute">
- The integer minute value (e.g., 35 for 35 minutes past the hour).
- </param>
- <param name="second">
- The integer second value (e.g., 42 for 42 seconds past the minute).
- </param>
- <returns>The corresponding Astronomical Julian Day number, expressed in double
- floating point format</returns>
- </member>
- <member name="M:ZedGraph.XDate.CalendarDateToJulianDay(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
- <summary>
- Calculate an Astronomical Julian Day number from the specified Calendar date
- (year, month, day, hour, minute, second), first normalizing all input data values
- </summary>
- <param name="year">
- The integer year value (e.g., 1994).
- </param>
- <param name="month">
- The integer month value (e.g., 7 for July).
- </param>
- <param name="day">
- The integer day value (e.g., 19 for the 19th day of the month).
- </param>
- <param name="hour">
- The integer hour value (e.g., 14 for 2:00 pm).
- </param>
- <param name="minute">
- The integer minute value (e.g., 35 for 35 minutes past the hour).
- </param>
- <param name="second">
- The integer second value (e.g., 42 for 42 seconds past the minute).
- </param>
- <param name="millisecond">
- The integer second value (e.g., 325 for 325 milliseconds past the minute).
- </param>
- <returns>The corresponding Astronomical Julian Day number, expressed in double
- floating point format</returns>
- </member>
- <member name="M:ZedGraph.XDate.NormalizeCalendarDate(System.Int32@,System.Int32@,System.Int32@,System.Int32@,System.Int32@,System.Int32@,System.Double@)">
- <summary>
- Normalize a set of Calendar date values (year, month, day, hour, minute, second) to make sure
- that month is between 1 and 12, hour is between 0 and 23, etc.
- </summary>
- <param name="year">
- The integer year value (e.g., 1994).
- </param>
- <param name="month">
- The integer month value (e.g., 7 for July).
- </param>
- <param name="day">
- The integer day value (e.g., 19 for the 19th day of the month).
- </param>
- <param name="hour">
- The integer hour value (e.g., 14 for 2:00 pm).
- </param>
- <param name="minute">
- The integer minute value (e.g., 35 for 35 minutes past the hour).
- </param>
- <param name="second">
- The integer second value (e.g., 42 for 42 seconds past the minute).
- </param>
- <param name="millisecond">
- The double millisecond value (e.g., 325.3 for 325.3 milliseconds past the second).
- </param>
- </member>
- <member name="M:ZedGraph.XDate._CalendarDateToXLDate(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Double)">
- <summary>
- Calculate an XL date from the specified Calendar date (year, month, day, hour, minute, second).
- This is the internal trusted version, where all values are assumed to be legitimate
- ( month is between 1 and 12, minute is between 0 and 59, etc. )
- </summary>
- <param name="year">
- The integer year value (e.g., 1994).
- </param>
- <param name="month">
- The integer month value (e.g., 7 for July).
- </param>
- <param name="day">
- The integer day value (e.g., 19 for the 19th day of the month).
- </param>
- <param name="hour">
- The integer hour value (e.g., 14 for 2:00 pm).
- </param>
- <param name="minute">
- The integer minute value (e.g., 35 for 35 minutes past the hour).
- </param>
- <param name="second">
- The integer second value (e.g., 42 for 42 seconds past the minute).
- </param>
- <param name="millisecond">
- The double millisecond value (e.g., 325.3 for 325.3 milliseconds past the second).
- </param>
- <returns>The corresponding XL date, expressed in double floating point format</returns>
- </member>
- <member name="M:ZedGraph.XDate._CalendarDateToJulianDay(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Double)">
- <summary>
- Calculate an Astronomical Julian Day Number from the specified Calendar date
- (year, month, day, hour, minute, second).
- This is the internal trusted version, where all values are assumed to be legitimate
- ( month is between 1 and 12, minute is between 0 and 59, etc. )
- </summary>
- <param name="year">
- The integer year value (e.g., 1994).
- </param>
- <param name="month">
- The integer month value (e.g., 7 for July).
- </param>
- <param name="day">
- The integer day value (e.g., 19 for the 19th day of the month).
- </param>
- <param name="hour">
- The integer hour value (e.g., 14 for 2:00 pm).
- </param>
- <param name="minute">
- The integer minute value (e.g., 35 for 35 minutes past the hour).
- </param>
- <param name="second">
- The integer second value (e.g., 42 for 42 seconds past the minute).
- </param>
- <param name="millisecond">
- The double millisecond value (e.g., 325.3 for 325.3 milliseconds past the second).
- </param>
- <returns>The corresponding Astronomical Julian Day number, expressed in double
- floating point format</returns>
- </member>
- <member name="M:ZedGraph.XDate.XLDateToCalendarDate(System.Double,System.Int32@,System.Int32@,System.Int32@,System.Int32@,System.Int32@,System.Int32@)">
- <summary>
- Calculate a Calendar date (year, month, day, hour, minute, second) corresponding to
- the specified XL date
- </summary>
- <param name="xlDate">
- The XL date value in floating point double format.
- </param>
- <param name="year">
- The integer year value (e.g., 1994).
- </param>
- <param name="month">
- The integer month value (e.g., 7 for July).
- </param>
- <param name="day">
- The integer day value (e.g., 19 for the 19th day of the month).
- </param>
- <param name="hour">
- The integer hour value (e.g., 14 for 2:00 pm).
- </param>
- <param name="minute">
- The integer minute value (e.g., 35 for 35 minutes past the hour).
- </param>
- <param name="second">
- The integer second value (e.g., 42 for 42 seconds past the minute).
- </param>
- </member>
- <member name="M:ZedGraph.XDate.XLDateToCalendarDate(System.Double,System.Int32@,System.Int32@,System.Int32@,System.Int32@,System.Int32@,System.Int32@,System.Int32@)">
- <summary>
- Calculate a Calendar date (year, month, day, hour, minute, second) corresponding to
- the specified XL date
- </summary>
- <param name="xlDate">
- The XL date value in floating point double format.
- </param>
- <param name="year">
- The integer year value (e.g., 1994).
- </param>
- <param name="month">
- The integer month value (e.g., 7 for July).
- </param>
- <param name="day">
- The integer day value (e.g., 19 for the 19th day of the month).
- </param>
- <param name="hour">
- The integer hour value (e.g., 14 for 2:00 pm).
- </param>
- <param name="minute">
- The integer minute value (e.g., 35 for 35 minutes past the hour).
- </param>
- <param name="second">
- The integer second value (e.g., 42 for 42 seconds past the minute).
- </param>
- <param name="millisecond">
- The integer millisecond value (e.g., 325 for 325 milliseconds past the second).
- </param>
- </member>
- <member name="M:ZedGraph.XDate.XLDateToCalendarDate(System.Double,System.Int32@,System.Int32@,System.Int32@,System.Int32@,System.Int32@,System.Double@)">
- <summary>
- Calculate a Calendar date (year, month, day, hour, minute, second) corresponding to
- the specified XL date
- </summary>
- <param name="xlDate">
- The XL date value in floating point double format.
- </param>
- <param name="year">
- The integer year value (e.g., 1994).
- </param>
- <param name="month">
- The integer month value (e.g., 7 for July).
- </param>
- <param name="day">
- The integer day value (e.g., 19 for the 19th day of the month).
- </param>
- <param name="hour">
- The integer hour value (e.g., 14 for 2:00 pm).
- </param>
- <param name="minute">
- The integer minute value (e.g., 35 for 35 minutes past the hour).
- </param>
- <param name="second">
- The double second value (e.g., 42.3 for 42.3 seconds past the minute).
- </param>
- </member>
- <member name="M:ZedGraph.XDate.JulianDayToCalendarDate(System.Double,System.Int32@,System.Int32@,System.Int32@,System.Int32@,System.Int32@,System.Int32@)">
- <summary>
- Calculate a Calendar date (year, month, day, hour, minute, second) corresponding to
- the Astronomical Julian Day number
- </summary>
- <param name="jDay">
- The Astronomical Julian Day number to be converted
- </param>
- <param name="year">
- The integer year value (e.g., 1994).
- </param>
- <param name="month">
- The integer month value (e.g., 7 for July).
- </param>
- <param name="day">
- The integer day value (e.g., 19 for the 19th day of the month).
- </param>
- <param name="hour">
- The integer hour value (e.g., 14 for 2:00 pm).
- </param>
- <param name="minute">
- The integer minute value (e.g., 35 for 35 minutes past the hour).
- </param>
- <param name="second">
- The integer second value (e.g., 42 for 42 seconds past the minute).
- </param>
- </member>
- <member name="M:ZedGraph.XDate.JulianDayToCalendarDate(System.Double,System.Int32@,System.Int32@,System.Int32@,System.Int32@,System.Int32@,System.Double@)">
- <summary>
- Calculate a Calendar date (year, month, day, hour, minute, second) corresponding to
- the Astronomical Julian Day number
- </summary>
- <param name="jDay">
- The Astronomical Julian Day number to be converted
- </param>
- <param name="year">
- The integer year value (e.g., 1994).
- </param>
- <param name="month">
- The integer month value (e.g., 7 for July).
- </param>
- <param name="day">
- The integer day value (e.g., 19 for the 19th day of the month).
- </param>
- <param name="hour">
- The integer hour value (e.g., 14 for 2:00 pm).
- </param>
- <param name="minute">
- The integer minute value (e.g., 35 for 35 minutes past the hour).
- </param>
- <param name="second">
- The double second value (e.g., 42.3 for 42.3 seconds past the minute).
- </param>
- </member>
- <member name="M:ZedGraph.XDate.JulianDayToCalendarDate(System.Double,System.Int32@,System.Int32@,System.Int32@,System.Int32@,System.Int32@,System.Int32@,System.Double@)">
- <summary>
- Calculate a Calendar date (year, month, day, hour, minute, second) corresponding to
- the Astronomical Julian Day number
- </summary>
- <param name="jDay">
- The Astronomical Julian Day number to be converted
- </param>
- <param name="year">
- The integer year value (e.g., 1994).
- </param>
- <param name="month">
- The integer month value (e.g., 7 for July).
- </param>
- <param name="day">
- The integer day value (e.g., 19 for the 19th day of the month).
- </param>
- <param name="hour">
- The integer hour value (e.g., 14 for 2:00 pm).
- </param>
- <param name="minute">
- The integer minute value (e.g., 35 for 35 minutes past the hour).
- </param>
- <param name="second">
- The integer second value (e.g., 42 for 42 seconds past the minute).
- </param>
- <param name="millisecond">
- The <see cref="T:System.Double"/> millisecond value (e.g., 342.5 for 342.5 milliseconds past
- the second).
- </param>
- </member>
- <member name="M:ZedGraph.XDate.XLDateToJulianDay(System.Double)">
- <summary>
- Calculate an Astronomical Julian Day number corresponding to the specified XL date
- </summary>
- <param name="xlDate">
- The XL date value in floating point double format.
- </param>
- <returns>The corresponding Astronomical Julian Day number, expressed in double
- floating point format</returns>
- </member>
- <member name="M:ZedGraph.XDate.JulianDayToXLDate(System.Double)">
- <summary>
- Calculate an XL Date corresponding to the specified Astronomical Julian Day number
- </summary>
- <param name="jDay">
- The Astronomical Julian Day number in floating point double format.
- </param>
- <returns>The corresponding XL Date, expressed in double
- floating point format</returns>
- </member>
- <member name="M:ZedGraph.XDate.XLDateToDecimalYear(System.Double)">
- <summary>
- Calculate a decimal year value (e.g., 1994.6523) corresponding to the specified XL date
- </summary>
- <param name="xlDate">
- The XL date value in floating point double format.
- </param>
- <returns>The corresponding decimal year value, expressed in double
- floating point format</returns>
- </member>
- <member name="M:ZedGraph.XDate.DecimalYearToXLDate(System.Double)">
- <summary>
- Calculate a decimal year value (e.g., 1994.6523) corresponding to the specified XL date
- </summary>
- <param name="yearDec">
- The decimal year value in floating point double format.
- </param>
- <returns>The corresponding XL Date, expressed in double
- floating point format</returns>
- </member>
- <member name="M:ZedGraph.XDate.XLDateToDayOfYear(System.Double)">
- <summary>
- Calculate a day-of-year value (e.g., 241.543 corresponds to the 241st day of the year)
- corresponding to the specified XL date
- </summary>
- <param name="xlDate">
- The XL date value in floating point double format.
- </param>
- <returns>The corresponding day-of-year (DoY) value, expressed in double
- floating point format</returns>
- </member>
- <member name="M:ZedGraph.XDate.XLDateToDayOfWeek(System.Double)">
- <summary>
- Calculate a day-of-week value (e.g., Sun=0, Mon=1, Tue=2, etc.)
- corresponding to the specified XL date
- </summary>
- <param name="xlDate">
- The XL date value in floating point double format.
- </param>
- <returns>The corresponding day-of-week (DoW) value, expressed in integer format</returns>
- </member>
- <member name="M:ZedGraph.XDate.XLDateToDateTime(System.Double)">
- <summary>
- Convert an XL date format to a .Net DateTime struct
- </summary>
- <param name="xlDate">
- The XL date value in floating point double format.
- </param>
- <returns>The corresponding XL Date, expressed in double
- floating point format</returns>
- <returns>The corresponding date in the form of a .Net DateTime struct</returns>
- </member>
- <member name="M:ZedGraph.XDate.DateTimeToXLDate(System.DateTime)">
- <summary>
- Convert a .Net DateTime struct to an XL Format date
- </summary>
- <param name="dt">
- The date value in the form of a .Net DateTime struct
- </param>
- <returns>The corresponding XL Date, expressed in double
- floating point format</returns>
- </member>
- <member name="M:ZedGraph.XDate.AddMilliseconds(System.Double)">
- <summary>
- Add the specified number of milliseconds (can be fractional) to the current XDate instance.
- </summary>
- <param name="dMilliseconds">
- The incremental number of milliseconds (negative or positive) in floating point double format.
- </param>
- </member>
- <member name="M:ZedGraph.XDate.AddSeconds(System.Double)">
- <summary>
- Add the specified number of seconds (can be fractional) to the current XDate instance.
- </summary>
- <param name="dSeconds">
- The incremental number of seconds (negative or positive) in floating point double format.
- </param>
- </member>
- <member name="M:ZedGraph.XDate.AddMinutes(System.Double)">
- <summary>
- Add the specified number of minutes (can be fractional) to the current XDate instance.
- </summary>
- <param name="dMinutes">
- The incremental number of minutes (negative or positive) in floating point double format.
- </param>
- </member>
- <member name="M:ZedGraph.XDate.AddHours(System.Double)">
- <summary>
- Add the specified number of hours (can be fractional) to the current XDate instance.
- </summary>
- <param name="dHours">
- The incremental number of hours (negative or positive) in floating point double format.
- </param>
- </member>
- <member name="M:ZedGraph.XDate.AddDays(System.Double)">
- <summary>
- Add the specified number of days (can be fractional) to the current XDate instance.
- </summary>
- <param name="dDays">
- The incremental number of days (negative or positive) in floating point double format.
- </param>
- </member>
- <member name="M:ZedGraph.XDate.AddMonths(System.Double)">
- <summary>
- Add the specified number of Months (can be fractional) to the current XDate instance.
- </summary>
- <param name="dMonths">
- The incremental number of months (negative or positive) in floating point double format.
- </param>
- </member>
- <member name="M:ZedGraph.XDate.AddYears(System.Double)">
- <summary>
- Add the specified number of years (can be fractional) to the current XDate instance.
- </summary>
- <param name="dYears">
- The incremental number of years (negative or positive) in floating point double format.
- </param>
- </member>
- <member name="M:ZedGraph.XDate.op_Subtraction(ZedGraph.XDate,ZedGraph.XDate)">
- <summary>
- '-' operator overload. When two XDates are subtracted, the number of days between dates
- is returned.
- </summary>
- <param name="lhs">The left-hand-side of the '-' operator (an XDate class)</param>
- <param name="rhs">The right-hand-side of the '-' operator (an XDate class)</param>
- <returns>The days between dates, expressed as a floating point double</returns>
- </member>
- <member name="M:ZedGraph.XDate.op_Subtraction(ZedGraph.XDate,System.Double)">
- <summary>
- '-' operator overload. When a double value is subtracted from an XDate, the result is a
- new XDate with the number of days subtracted.
- </summary>
- <param name="lhs">The left-hand-side of the '-' operator (an XDate class)</param>
- <param name="rhs">The right-hand-side of the '-' operator (a double value)</param>
- <returns>An XDate with the rhs number of days subtracted</returns>
- </member>
- <member name="M:ZedGraph.XDate.op_Addition(ZedGraph.XDate,System.Double)">
- <summary>
- '+' operator overload. When a double value is added to an XDate, the result is a
- new XDate with the number of days added.
- </summary>
- <param name="lhs">The left-hand-side of the '-' operator (an XDate class)</param>
- <param name="rhs">The right-hand-side of the '+' operator (a double value)</param>
- <returns>An XDate with the rhs number of days added</returns>
- </member>
- <member name="M:ZedGraph.XDate.op_Increment(ZedGraph.XDate)">
- <summary>
- '++' operator overload. Increment the date by one day.
- </summary>
- <param name="xDate">The XDate struct on which to operate</param>
- <returns>An XDate one day later than the specified date</returns>
- </member>
- <member name="M:ZedGraph.XDate.op_Decrement(ZedGraph.XDate)">
- <summary>
- '--' operator overload. Decrement the date by one day.
- </summary>
- <param name="xDate">The XDate struct on which to operate</param>
- <returns>An XDate one day prior to the specified date</returns>
- </member>
- <member name="M:ZedGraph.XDate.op_Implicit(ZedGraph.XDate)~System.Double">
- <summary>
- Implicit conversion from XDate to double (an XL Date).
- </summary>
- <param name="xDate">The XDate struct on which to operate</param>
- <returns>A double floating point value representing the XL Date</returns>
- </member>
- <member name="M:ZedGraph.XDate.op_Implicit(ZedGraph.XDate)~System.Single">
- <summary>
- Implicit conversion from XDate to float (an XL Date).
- </summary>
- <param name="xDate">The XDate struct on which to operate</param>
- <returns>A double floating point value representing the XL Date</returns>
- </member>
- <member name="M:ZedGraph.XDate.op_Implicit(System.Double)~ZedGraph.XDate">
- <summary>
- Implicit conversion from double (an XL Date) to XDate.
- </summary>
- <param name="xlDate">The XDate struct on which to operate</param>
- <returns>An XDate struct representing the specified xlDate value.</returns>
- </member>
- <member name="M:ZedGraph.XDate.op_Implicit(ZedGraph.XDate)~System.DateTime">
- <summary>
- Implicit conversion from XDate to <see cref="P:ZedGraph.XDate.DateTime"/>.
- </summary>
- <param name="xDate">The XDate struct on which to operate</param>
- <returns>A <see cref="P:ZedGraph.XDate.DateTime"/> struct representing the specified xDate value.</returns>
- </member>
- <member name="M:ZedGraph.XDate.op_Implicit(System.DateTime)~ZedGraph.XDate">
- <summary>
- Implicit conversion from <see cref="P:ZedGraph.XDate.DateTime"/> to <see cref="T:ZedGraph.XDate"/>.
- </summary>
- <param name="dt">The <see cref="P:ZedGraph.XDate.DateTime"/> struct on which to operate</param>
- <returns>An <see cref="T:ZedGraph.XDate"/> struct representing the specified DateTime value.</returns>
- </member>
- <member name="M:ZedGraph.XDate.Equals(System.Object)">
- <summary>
- Tests whether <param>obj</param> is either an <see cref="T:ZedGraph.XDate"/> structure or
- a double floating point value that is equal to the same date as this <c>XDate</c>
- struct instance.
- </summary>
- <param name="obj">The object to compare for equality with this XDate instance.
- This object should be either a type XDate or type double.</param>
- <returns>Returns <c>true</c> if <param>obj</param> is the same date as this
- instance; otherwise, <c>false</c></returns>
- </member>
- <member name="M:ZedGraph.XDate.GetHashCode">
- <summary>
- Returns the hash code for this <see cref="T:ZedGraph.XDate"/> structure. In this case, the
- hash code is simply the equivalent hash code for the floating point double date value.
- </summary>
- <returns>An integer representing the hash code for this XDate value</returns>
- </member>
- <member name="M:ZedGraph.XDate.CompareTo(System.Object)">
- <summary>
- Compares one <see cref="T:ZedGraph.XDate"/> object to another.
- </summary>
- <remarks>
- This method will throw an exception if <paramref name="target"/> is not an
- <see cref="T:ZedGraph.XDate"/> object.
- </remarks>
- <param name="target">The second <see cref="T:ZedGraph.XDate"/> object to be compared.</param>
- <returns>zero if <paramref name="target"/> is equal to the current instance,
- -1 if <paramref name="target"/> is less than the current instance, and
- 1 if <paramref name="target"/> is greater than the current instance.</returns>
- </member>
- <member name="M:ZedGraph.XDate.ToString(System.Double)">
- <summary>
- Format this XDate value using the default format string (<see cref="F:ZedGraph.XDate.DefaultFormatStr"/>).
- </summary>
- <remarks>
- The formatting is done using the <see cref="P:ZedGraph.XDate.DateTime"/> <see cref="M:System.DateTime.ToString(System.String)"/>
- method in order to provide full localization capability. The DateTime struct is limited to
- dates from 1 AD onward. However, all calendar dates in <see cref="T:ZedGraph.XDate"/> and <see cref="P:ZedGraph.XDate.DateTime"/>
- are projected Gregorian calendar dates. Since the Gregorian calendar was not implemented
- until October 4, 1582 (or later in some countries), Gregorian dates prior to that time are
- really dates that would have been, had the Gregorian calendar existed. In order to avoid
- throwing an exception, for dates prior to 1 AD, the year will be converted to a positive
- year and the text "(BC)" is appended to the end of the formatted string. Under this mode, the
- year sequence is 2BC, 1BC, 1AD, 2AD, etc. There is no year zero.
- </remarks>
- <param name="xlDate">
- The XL date value to be formatted in floating point double format.
- </param>
- <returns>A string representation of the date</returns>
- </member>
- <member name="M:ZedGraph.XDate.ToString">
- <summary>
- Format this XDate value using the default format string (see cref="DefaultFormatStr"/>).
- </summary>
- <remarks>
- The formatting is done using the <see cref="P:ZedGraph.XDate.DateTime"/>
- <see cref="M:System.DateTime.ToString(System.String)"/>
- method in order to provide full localization capability. The DateTime struct is limited to
- dates from 1 AD onward. However, all calendar dates in <see cref="T:ZedGraph.XDate"/> and
- <see cref="P:ZedGraph.XDate.DateTime"/>
- are projected Gregorian calendar dates. Since the Gregorian calendar was not implemented
- until October 4, 1582 (or later in some countries), Gregorian dates prior to that time are
- really dates that would have been, had the Gregorian calendar existed. In order to avoid
- throwing an exception, for dates prior to 1 AD, the year will be converted to a positive
- year and the text "(BC)" is appended to the end of the formatted string. Under this mode, the
- year sequence is 2BC, 1BC, 1AD, 2AD, etc. There is no year zero.
- </remarks>
- <returns>A string representation of the date</returns>
- </member>
- <member name="M:ZedGraph.XDate.ToString(System.String)">
- <summary>
- Format this XL Date value using the specified format string. The format
- string is specified according to the <see cref="P:ZedGraph.XDate.DateTime"/> class.
- </summary>
- <remarks>
- The formatting is done using the <see cref="P:ZedGraph.XDate.DateTime"/>
- <see cref="M:System.DateTime.ToString(System.String)"/>
- method in order to provide full localization capability. The DateTime struct is limited to
- dates from 1 AD onward. However, all calendar dates in <see cref="T:ZedGraph.XDate"/> and
- <see cref="P:ZedGraph.XDate.DateTime"/>
- are projected Gregorian calendar dates. Since the Gregorian calendar was not implemented
- until October 4, 1582 (or later in some countries), Gregorian dates prior to that time are
- really dates that would have been, had the Gregorian calendar existed. In order to avoid
- throwing an exception, for dates prior to 1 AD, the year will be converted to a positive
- year and the text "(BC)" is appended to the end of the formatted string. Under this mode, the
- year sequence is 2BC, 1BC, 1AD, 2AD, etc. There is no year zero.
- </remarks>
- <param name="fmtStr">
- The formatting string to be used for the date. See
- <see cref="T:System.Globalization.DateTimeFormatInfo"/>
- class for a list of the format types available.</param>
- <returns>A string representation of the date</returns>
- </member>
- <member name="M:ZedGraph.XDate.ToString(System.Double,System.String)">
- <summary>
- Format the specified XL Date value using the specified format string. The format
- string is specified according to the <see cref="P:ZedGraph.XDate.DateTime"/> class.
- </summary>
- <remarks>
- The formatting is done using the <see cref="P:ZedGraph.XDate.DateTime"/>
- <see cref="M:System.DateTime.ToString(System.String)"/>
- method in order to provide full localization capability. The DateTime struct is limited to
- dates from 1 AD onward. However, all calendar dates in <see cref="T:ZedGraph.XDate"/> and
- <see cref="P:ZedGraph.XDate.DateTime"/>
- are projected Gregorian calendar dates. Since the Gregorian calendar was not implemented
- until October 4, 1582 (or later in some countries), Gregorian dates prior to that time are
- really dates that would have been, had the Gregorian calendar existed. In order to avoid
- throwing an exception, for dates prior to 1 AD, the year will be converted to a positive
- year and the text "(BC)" is appended to the end of the formatted string. Under this mode, the
- year sequence is 2BC, 1BC, 1AD, 2AD, etc. There is no year zero.
- </remarks>
- <param name="xlDate">
- The XL date value to be formatted in floating point double format.
- </param>
- <param name="fmtStr">
- The formatting string to be used for the date. See
- <see cref="T:System.Globalization.DateTimeFormatInfo"/>
- for a list of the format types available.</param>
- <returns>A string representation of the date</returns>
- </member>
- <member name="P:ZedGraph.XDate.XLDate">
- <summary>
- Gets or sets the date value for this item in MS Excel format.
- </summary>
- </member>
- <member name="P:ZedGraph.XDate.IsValidDate">
- <summary>
- Returns true if this <see cref="T:ZedGraph.XDate"/> struct is in the valid date range
- </summary>
- </member>
- <member name="P:ZedGraph.XDate.DateTime">
- <summary>
- Gets or sets the date value for this item in .Net DateTime format.
- </summary>
- </member>
- <member name="P:ZedGraph.XDate.JulianDay">
- <summary>
- Gets or sets the date value for this item in Julain day format. This is the
- Astronomical Julian Day number, so a value of 0.0 corresponds to noon GMT on
- January 1st, -4712. Thus, Julian Day number 2,400,000.0 corresponds to
- noon GMT on November 16, 1858.
- </summary>
- </member>
- <member name="P:ZedGraph.XDate.DecimalYear">
- <summary>
- Gets or sets the decimal year number (i.e., 1997.345) corresponding to this item.
- </summary>
- </member>
- <member name="T:ZedGraph.Link">
- <summary>
- A class that maintains hyperlink information for a clickable object on the graph.
- </summary>
-
- <author> John Champion </author>
- <version> $Revision: 3.6 $ $Date: 2007-04-16 00:03:02 $ </version>
- </member>
- <member name="F:ZedGraph.Link.schema">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- <remarks>
- schema started with 10 for ZedGraph version 5
- </remarks>
- </member>
- <member name="F:ZedGraph.Link._title">
- <summary>
- Internal field that stores the title string for this link.
- </summary>
- </member>
- <member name="F:ZedGraph.Link._url">
- <summary>
- Internal field that stores the url string for this link
- </summary>
- </member>
- <member name="F:ZedGraph.Link._target">
- <summary>
- Internal field that stores the target string for this link
- </summary>
- </member>
- <member name="F:ZedGraph.Link._isEnabled">
- <summary>
- Internal field that determines if this link is "live".
- </summary>
- </member>
- <member name="F:ZedGraph.Link.Tag">
- <summary>
- A tag object for use by the user. This can be used to store additional
- information associated with the <see cref="T:ZedGraph.Link"/>. ZedGraph does
- not use this value for any purpose.
- </summary>
- <remarks>
- Note that, if you are going to Serialize ZedGraph data, then any type
- that you store in <see cref="F:ZedGraph.Link.Tag"/> must be a serializable type (or
- it will cause an exception).
- </remarks>
- </member>
- <member name="M:ZedGraph.Link.#ctor">
- <summary>
- Default constructor. Set all properties to string.Empty, or null.
- </summary>
- </member>
- <member name="M:ZedGraph.Link.#ctor(System.String,System.String,System.String)">
- <summary>
- Construct a Link instance from a specified title, url, and target.
- </summary>
- <param name="title">The title for the link (which shows up in the tooltip).</param>
- <param name="url">The URL destination for the link.</param>
- <param name="target">The target for the link (typically "_blank" or "_self").</param>
- </member>
- <member name="M:ZedGraph.Link.#ctor(ZedGraph.Link)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.Link"/> object from which to copy</param>
- </member>
- <member name="M:ZedGraph.Link.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.Link.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.Link.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.Link.MakeCurveItemUrl(ZedGraph.GraphPane,ZedGraph.CurveItem,System.Int32)">
- <summary>
- Create a URL for a <see cref="T:ZedGraph.CurveItem"/> that includes the index of the
- point that was selected.
- </summary>
- <remarks>
- An "index" parameter is added to the <see cref="P:ZedGraph.Link.Url"/> property for this
- link to indicate which point was selected. Further, if the
- X or Y axes that correspond to this <see cref="T:ZedGraph.CurveItem"/> are of
- <see cref="F:ZedGraph.AxisType.Text"/>, then an
- additional parameter will be added containing the text value that
- corresponds to the <paramref name="index"/> of the selected point.
- The <see cref="T:ZedGraph.XAxis"/> text parameter will be labeled "xtext", and
- the <see cref="T:ZedGraph.YAxis"/> text parameter will be labeled "ytext".
- </remarks>
- <param name="index">The zero-based index of the selected point</param>
- <param name="pane">The <see cref="T:ZedGraph.GraphPane"/> of interest</param>
- <param name="curve">The <see cref="T:ZedGraph.CurveItem"/> for which to
- make the url string.</param>
- <returns>A string containing the url with an index parameter added.</returns>
- </member>
- <member name="M:ZedGraph.Link.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.Link.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="P:ZedGraph.Link.Title">
- <summary>
- Gets or sets the title string for this link.
- </summary>
- <remarks>
- For web controls, this title will be shown as a tooltip when the mouse
- hovers over the area of the object that owns this link. Set the value to
- <see cref="F:System.String.Empty"/> to have no title.
- </remarks>
- </member>
- <member name="P:ZedGraph.Link.Url">
- <summary>
- Gets or sets the url string for this link.
- </summary>
- <remarks>
- Set this value to <see cref="F:System.String.Empty"/> if you don't want to have
- a hyperlink associated with the object to which this link belongs.
- </remarks>
- </member>
- <member name="P:ZedGraph.Link.Target">
- <summary>
- Gets or sets the target string for this link.
- </summary>
- <remarks>
- This value should be set to a valid target associated with the "Target"
- property of an html hyperlink. Typically, this would be "_blank" to open
- a new browser window, or "_self" to open in the current browser.
- </remarks>
- </member>
- <member name="P:ZedGraph.Link.IsEnabled">
- <summary>
- Gets or sets a property that determines if this link is active. True to have
- a clickable link, false to ignore the link.
- </summary>
- </member>
- <member name="P:ZedGraph.Link.IsActive">
- <summary>
- Gets a value that indicates if this <see cref="T:ZedGraph.Link"/> is enabled
- (see <see cref="P:ZedGraph.Link.IsEnabled"/>), and that either the
- <see cref="P:ZedGraph.Link.Url"/> or the <see cref="P:ZedGraph.Link.Title"/> is non-null.
- </summary>
- </member>
- <member name="T:ZedGraph.BarItem">
- <summary>
- Encapsulates a bar type that displays vertical or horizontal bars
- </summary>
- <remarks>
- The orientation of the bars depends on the state of
- <see cref="P:ZedGraph.BarSettings.Base"/>, and the bars can be stacked or
- clustered, depending on the state of <see cref="P:ZedGraph.BarSettings.Type"/>
- </remarks>
- <author> John Champion </author>
- <version> $Revision: 3.27 $ $Date: 2007-11-03 04:41:28 $ </version>
- </member>
- <member name="F:ZedGraph.BarItem.schema2">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="F:ZedGraph.BarItem._bar">
- <summary>
- Private field that stores a reference to the <see cref="T:ZedGraph.Bar"/>
- class defined for this <see cref="T:ZedGraph.BarItem"/>. Use the public
- property <see cref="P:ZedGraph.BarItem.Bar"/> to access this value.
- </summary>
- </member>
- <member name="M:ZedGraph.BarItem.IsZIncluded(ZedGraph.GraphPane)">
- <summary>
- Gets a flag indicating if the Z data range should be included in the axis scaling calculations.
- </summary>
- <param name="pane">The parent <see cref="T:ZedGraph.GraphPane"/> of this <see cref="T:ZedGraph.CurveItem"/>.
- </param>
- <value>true if the Z data are included, false otherwise</value>
- </member>
- <member name="M:ZedGraph.BarItem.IsXIndependent(ZedGraph.GraphPane)">
- <summary>
- Gets a flag indicating if the X axis is the independent axis for this <see cref="T:ZedGraph.CurveItem"/>
- </summary>
- <param name="pane">The parent <see cref="T:ZedGraph.GraphPane"/> of this <see cref="T:ZedGraph.CurveItem"/>.
- </param>
- <value>true if the X axis is independent, false otherwise</value>
- </member>
- <member name="M:ZedGraph.BarItem.#ctor(System.String)">
- <summary>
- Create a new <see cref="T:ZedGraph.BarItem"/>, specifying only the legend label for the bar.
- </summary>
- <param name="label">The label that will appear in the legend.</param>
- </member>
- <member name="M:ZedGraph.BarItem.#ctor(System.String,System.Double[],System.Double[],System.Drawing.Color)">
- <summary>
- Create a new <see cref="T:ZedGraph.BarItem"/> using the specified properties.
- </summary>
- <param name="label">The label that will appear in the legend.</param>
- <param name="x">An array of double precision values that define
- the independent (X axis) values for this curve</param>
- <param name="y">An array of double precision values that define
- the dependent (Y axis) values for this curve</param>
- <param name="color">A <see cref="T:System.Drawing.Color"/> value that will be applied to
- the <see cref="P:ZedGraph.Bar.Fill"/> and <see cref="P:ZedGraph.Bar.Border"/> properties.
- </param>
- </member>
- <member name="M:ZedGraph.BarItem.#ctor(System.String,ZedGraph.IPointList,System.Drawing.Color)">
- <summary>
- Create a new <see cref="T:ZedGraph.BarItem"/> using the specified properties.
- </summary>
- <param name="label">The label that will appear in the legend.</param>
- <param name="points">A <see cref="T:ZedGraph.IPointList"/> of double precision value pairs that define
- the X and Y values for this curve</param>
- <param name="color">A <see cref="T:System.Drawing.Color"/> value that will be applied to
- the <see cref="P:ZedGraph.Bar.Fill"/> and <see cref="P:ZedGraph.Bar.Border"/> properties.
- </param>
- </member>
- <member name="M:ZedGraph.BarItem.#ctor(ZedGraph.BarItem)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.BarItem"/> object from which to copy</param>
- </member>
- <member name="M:ZedGraph.BarItem.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.BarItem.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.BarItem.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.BarItem.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.BarItem.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.BarItem.Draw(System.Drawing.Graphics,ZedGraph.GraphPane,System.Int32,System.Single)">
- <summary>
- Do all rendering associated with this <see cref="T:ZedGraph.BarItem"/> to the specified
- <see cref="T:System.Drawing.Graphics"/> device. This method is normally only
- called by the Draw method of the parent <see cref="T:ZedGraph.CurveList"/>
- collection object.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="pos">The ordinal position of the current <see cref="P:ZedGraph.BarItem.Bar"/>
- curve.</param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.BarItem.DrawLegendKey(System.Drawing.Graphics,ZedGraph.GraphPane,System.Drawing.RectangleF,System.Single)">
- <summary>
- Draw a legend key entry for this <see cref="T:ZedGraph.BarItem"/> at the specified location
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="rect">The <see cref="T:System.Drawing.RectangleF"/> struct that specifies the
- location for the legend key</param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.BarItem.CreateBarLabels(ZedGraph.GraphPane,System.Boolean,System.String)">
- <summary>
- Create a <see cref="T:ZedGraph.TextObj"/> for each bar in the <see cref="T:ZedGraph.GraphPane"/>.
- </summary>
- <remarks>
- This method will go through the bars, create a label that corresponds to the bar value,
- and place it on the graph depending on user preferences. This works for horizontal or
- vertical bars in clusters or stacks, but only for <see cref="T:ZedGraph.BarItem"/> types. This method
- does not apply to <see cref="T:ZedGraph.ErrorBarItem"/> or <see cref="T:ZedGraph.HiLowBarItem"/> objects.
- Call this method only after calling <see cref="M:ZedGraph.GraphPane.AxisChange"/>.
- </remarks>
- <param name="pane">The GraphPane in which to place the text labels.</param>
- <param name="isBarCenter">true to center the labels inside the bars, false to
- place the labels just above the top of the bar.</param>
- <param name="valueFormat">The double.ToString string format to use for creating
- the labels.
- </param>
- </member>
- <member name="M:ZedGraph.BarItem.CreateBarLabels(ZedGraph.GraphPane,System.Boolean,System.String,System.String,System.Single,System.Drawing.Color,System.Boolean,System.Boolean,System.Boolean)">
- <summary>
- Create a <see cref="T:ZedGraph.TextObj"/> for each bar in the <see cref="T:ZedGraph.GraphPane"/>.
- </summary>
- <remarks>
- This method will go through the bars, create a label that corresponds to the bar value,
- and place it on the graph depending on user preferences. This works for horizontal or
- vertical bars in clusters or stacks, but only for <see cref="T:ZedGraph.BarItem"/> types. This method
- does not apply to <see cref="T:ZedGraph.ErrorBarItem"/> or <see cref="T:ZedGraph.HiLowBarItem"/> objects.
- Call this method only after calling <see cref="M:ZedGraph.GraphPane.AxisChange"/>.
- </remarks>
- <param name="pane">The GraphPane in which to place the text labels.</param>
- <param name="isBarCenter">true to center the labels inside the bars, false to
- place the labels just above the top of the bar.</param>
- <param name="valueFormat">The double.ToString string format to use for creating
- the labels.
- </param>
- <param name="fontColor">The color in which to draw the labels</param>
- <param name="fontFamily">The string name of the font family to use for the labels</param>
- <param name="fontSize">The floating point size of the font, in scaled points</param>
- <param name="isBold">true for a bold font type, false otherwise</param>
- <param name="isItalic">true for an italic font type, false otherwise</param>
- <param name="isUnderline">true for an underline font type, false otherwise</param>
- </member>
- <member name="M:ZedGraph.BarItem.GetCoords(ZedGraph.GraphPane,System.Int32,System.String@)">
- <summary>
- Determine the coords for the rectangle associated with a specified point for
- this <see cref="T:ZedGraph.CurveItem"/>
- </summary>
- <param name="pane">The <see cref="T:ZedGraph.GraphPane"/> to which this curve belongs</param>
- <param name="i">The index of the point of interest</param>
- <param name="coords">A list of coordinates that represents the "rect" for
- this point (used in an html AREA tag)</param>
- <returns>true if it's a valid point, false otherwise</returns>
- </member>
- <member name="P:ZedGraph.BarItem.Bar">
- <summary>
- Gets a reference to the <see cref="T:ZedGraph.Bar"/> class defined
- for this <see cref="T:ZedGraph.BarItem"/>.
- </summary>
- </member>
- <member name="T:ZedGraph.Bar">
- <summary>
- A class representing all the characteristics of the bar
- segments that make up a curve on the graph.
- </summary>
-
- <author> John Champion </author>
- <version> $Revision: 3.30 $ $Date: 2007-11-03 04:41:28 $ </version>
- </member>
- <member name="F:ZedGraph.Bar.schema">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="F:ZedGraph.Bar._fill">
- <summary>
- Private field that stores the <see cref="T:ZedGraph.Fill"/> data for this
- <see cref="T:ZedGraph.Bar"/>. Use the public property <see cref="P:ZedGraph.Bar.Fill"/> to
- access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.Bar._border">
- <summary>
- Private field that stores the <see cref="P:ZedGraph.Bar.Border"/> class that defines the
- properties of the border around this <see cref="T:ZedGraph.BarItem"/>. Use the public
- property <see cref="P:ZedGraph.Bar.Border"/> to access this value.
- </summary>
- </member>
- <member name="M:ZedGraph.Bar.#ctor">
- <summary>
- Default constructor that sets all <see cref="T:ZedGraph.Bar"/> properties to default
- values as defined in the <see cref="T:ZedGraph.Bar.Default"/> class.
- </summary>
- </member>
- <member name="M:ZedGraph.Bar.#ctor(System.Drawing.Color)">
- <summary>
- Default constructor that sets the
- <see cref="T:System.Drawing.Color"/> as specified, and the remaining
- <see cref="T:ZedGraph.Bar"/> properties to default
- values as defined in the <see cref="T:ZedGraph.Bar.Default"/> class.
- The specified color is only applied to the
- <see cref="P:ZedGraph.Fill.Color"/>, and the <see cref="P:ZedGraph.LineBase.Color"/>
- will be defaulted.
- </summary>
- <param name="color">A <see cref="T:System.Drawing.Color"/> value indicating
- the <see cref="P:ZedGraph.Fill.Color"/>
- of the Bar.
- </param>
- </member>
- <member name="M:ZedGraph.Bar.#ctor(ZedGraph.Bar)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The Bar object from which to copy</param>
- </member>
- <member name="M:ZedGraph.Bar.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.Bar.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.Bar.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.Bar.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.Bar.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.Bar.Draw(System.Drawing.Graphics,ZedGraph.GraphPane,System.Single,System.Single,System.Single,System.Single,System.Single,System.Boolean,System.Boolean,ZedGraph.PointPair)">
- <summary>
- Draw the <see cref="T:ZedGraph.Bar"/> to the specified <see cref="T:System.Drawing.Graphics"/> device
- at the specified location. This routine draws a single bar.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="left">The x position of the left side of the bar in
- pixel units</param>
- <param name="right">The x position of the right side of the bar in
- pixel units</param>
- <param name="top">The y position of the top of the bar in
- pixel units</param>
- <param name="bottom">The y position of the bottom of the bar in
- pixel units</param>
- <param name="scaleFactor">
- The scaling factor for the features of the graph based on the <see cref="P:ZedGraph.PaneBase.BaseDimension"/>. This
- scaling factor is calculated by the <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method. The scale factor
- represents a linear multiple to be applied to font sizes, symbol sizes, etc.
- </param>
- <param name="fullFrame">true to draw the bottom portion of the border around the
- bar (this is for legend entries)</param>
- <param name="dataValue">The data value to be used for a value-based
- color gradient. This is only applicable for <see cref="F:ZedGraph.FillType.GradientByX"/>,
- <see cref="F:ZedGraph.FillType.GradientByY"/> or <see cref="F:ZedGraph.FillType.GradientByZ"/>.</param>
- <param name="isSelected">Indicates that the <see cref="T:ZedGraph.Bar"/> should be drawn
- with attributes from the <see cref="T:ZedGraph.Selection"/> class.
- </param>
- </member>
- <member name="M:ZedGraph.Bar.Draw(System.Drawing.Graphics,ZedGraph.GraphPane,System.Drawing.RectangleF,System.Single,System.Boolean,System.Boolean,ZedGraph.PointPair)">
- <summary>
- Draw the <see cref="T:ZedGraph.Bar"/> to the specified <see cref="T:System.Drawing.Graphics"/> device
- at the specified location. This routine draws a single bar.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="rect">The rectangle (pixels) to contain the bar</param>
- <param name="scaleFactor">
- The scaling factor for the features of the graph based on the <see cref="P:ZedGraph.PaneBase.BaseDimension"/>. This
- scaling factor is calculated by the <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method. The scale factor
- represents a linear multiple to be applied to font sizes, symbol sizes, etc.
- </param>
- <param name="fullFrame">true to draw the bottom portion of the border around the
- bar (this is for legend entries)</param>
- <param name="dataValue">The data value to be used for a value-based
- color gradient. This is only applicable for <see cref="F:ZedGraph.FillType.GradientByX"/>,
- <see cref="F:ZedGraph.FillType.GradientByY"/> or <see cref="F:ZedGraph.FillType.GradientByZ"/>.</param>
- <param name="isSelected">Indicates that the <see cref="T:ZedGraph.Bar"/> should be drawn
- with attributes from the <see cref="T:ZedGraph.Selection"/> class.
- </param>
- </member>
- <member name="M:ZedGraph.Bar.DrawBars(System.Drawing.Graphics,ZedGraph.GraphPane,ZedGraph.CurveItem,ZedGraph.Axis,ZedGraph.Axis,System.Single,System.Int32,System.Single)">
- <summary>
- Draw the this <see cref="T:ZedGraph.Bar"/> to the specified <see cref="T:System.Drawing.Graphics"/>
- device as a bar at each defined point. This method
- is normally only called by the <see cref="M:ZedGraph.BarItem.Draw(System.Drawing.Graphics,ZedGraph.GraphPane,System.Int32,System.Single)"/> method of the
- <see cref="T:ZedGraph.BarItem"/> object
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="curve">A <see cref="T:ZedGraph.CurveItem"/> object representing the
- <see cref="T:ZedGraph.Bar"/>'s to be drawn.</param>
- <param name="baseAxis">The <see cref="T:ZedGraph.Axis"/> class instance that defines the base (independent)
- axis for the <see cref="T:ZedGraph.Bar"/></param>
- <param name="valueAxis">The <see cref="T:ZedGraph.Axis"/> class instance that defines the value (dependent)
- axis for the <see cref="T:ZedGraph.Bar"/></param>
- <param name="barWidth">
- The width of each bar, in pixels.
- </param>
- <param name="pos">
- The ordinal position of the this bar series (0=first bar, 1=second bar, etc.)
- in the cluster of bars.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.Bar.DrawSingleBar(System.Drawing.Graphics,ZedGraph.GraphPane,ZedGraph.CurveItem,ZedGraph.Axis,ZedGraph.Axis,System.Int32,System.Int32,System.Single,System.Single)">
- <summary>
- Draw the specified single bar (an individual "point") of this series to the specified
- <see cref="T:System.Drawing.Graphics"/> device. This method is not as efficient as
- <see cref="M:ZedGraph.Bar.DrawBars(System.Drawing.Graphics,ZedGraph.GraphPane,ZedGraph.CurveItem,ZedGraph.Axis,ZedGraph.Axis,System.Single,System.Int32,System.Single)"/>, which draws the bars for all points. It is intended to be used
- only for <see cref="F:ZedGraph.BarType.SortedOverlay"/>, which requires special handling of each bar.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="curve">A <see cref="T:ZedGraph.CurveItem"/> object representing the
- <see cref="T:ZedGraph.Bar"/>'s to be drawn.</param>
- <param name="baseAxis">The <see cref="T:ZedGraph.Axis"/> class instance that defines the base (independent)
- axis for the <see cref="T:ZedGraph.Bar"/></param>
- <param name="valueAxis">The <see cref="T:ZedGraph.Axis"/> class instance that defines the value (dependent)
- axis for the <see cref="T:ZedGraph.Bar"/></param>
- <param name="pos">
- The ordinal position of the this bar series (0=first bar, 1=second bar, etc.)
- in the cluster of bars.
- </param>
- <param name="index">
- The zero-based index number for the single bar to be drawn.
- </param>
- <param name="barWidth">
- The width of each bar, in pixels.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.Bar.DrawSingleBar(System.Drawing.Graphics,ZedGraph.GraphPane,ZedGraph.CurveItem,System.Int32,System.Int32,ZedGraph.Axis,ZedGraph.Axis,System.Single,System.Single)">
- <summary>
- Protected internal routine that draws the specified single bar (an individual "point")
- of this series to the specified <see cref="T:System.Drawing.Graphics"/> device.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="curve">A <see cref="T:ZedGraph.CurveItem"/> object representing the
- <see cref="T:ZedGraph.Bar"/>'s to be drawn.</param>
- <param name="index">
- The zero-based index number for the single bar to be drawn.
- </param>
- <param name="pos">
- The ordinal position of the this bar series (0=first bar, 1=second bar, etc.)
- in the cluster of bars.
- </param>
- <param name="baseAxis">The <see cref="T:ZedGraph.Axis"/> class instance that defines the base (independent)
- axis for the <see cref="T:ZedGraph.Bar"/></param>
- <param name="valueAxis">The <see cref="T:ZedGraph.Axis"/> class instance that defines the value (dependent)
- axis for the <see cref="T:ZedGraph.Bar"/></param>
- <param name="barWidth">
- The width of each bar, in pixels.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="P:ZedGraph.Bar.Border">
- <summary>
- The <see cref="P:ZedGraph.Bar.Border"/> object used to draw the border around the <see cref="T:ZedGraph.Bar"/>.
- </summary>
- <seealso cref="F:ZedGraph.Bar.Default.IsBorderVisible"/>
- <seealso cref="F:ZedGraph.Bar.Default.BorderWidth"/>
- <seealso cref="F:ZedGraph.Bar.Default.BorderColor"/>
- </member>
- <member name="P:ZedGraph.Bar.Fill">
- <summary>
- Gets or sets the <see cref="T:ZedGraph.Fill"/> data for this
- <see cref="T:ZedGraph.Bar"/>.
- </summary>
- </member>
- <member name="T:ZedGraph.Bar.Default">
- <summary>
- A simple struct that defines the
- default property values for the <see cref="T:ZedGraph.Bar"/> class.
- </summary>
- </member>
- <member name="F:ZedGraph.Bar.Default.BorderWidth">
- <summary>
- The default pen width to be used for drawing the border around the bars
- (<see cref="P:ZedGraph.LineBase.Width"/> property). Units are points.
- </summary>
- </member>
- <member name="F:ZedGraph.Bar.Default.FillType">
- <summary>
- The default fill mode for bars (<see cref="P:ZedGraph.Fill.Type"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.Bar.Default.IsBorderVisible">
- <summary>
- The default border mode for bars (<see cref="P:ZedGraph.LineBase.IsVisible"/> property).
- true to display frames around bars, false otherwise
- </summary>
- </member>
- <member name="F:ZedGraph.Bar.Default.BorderColor">
- <summary>
- The default color for drawing frames around bars
- (<see cref="P:ZedGraph.LineBase.Color"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.Bar.Default.FillColor">
- <summary>
- The default color for filling in the bars
- (<see cref="P:ZedGraph.Fill.Color"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.Bar.Default.FillBrush">
- <summary>
- The default custom brush for filling in the bars
- (<see cref="P:ZedGraph.Fill.Brush"/> property).
- </summary>
- </member>
- <member name="T:ZedGraph.Y2Axis">
- <summary>
- <see cref="T:ZedGraph.Y2Axis"/> inherits from <see cref="T:ZedGraph.Axis"/>, and defines the
- special characteristics of a vertical axis, specifically located on
- the right side of the <see cref="P:ZedGraph.Chart.Rect"/> of the <see cref="T:ZedGraph.GraphPane"/>
- object
- </summary>
-
- <author> John Champion </author>
- <version> $Revision: 3.16 $ $Date: 2007-04-16 00:03:05 $ </version>
- </member>
- <member name="F:ZedGraph.Y2Axis.schema2">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="M:ZedGraph.Y2Axis.#ctor">
- <summary>
- Default constructor that sets all <see cref="T:ZedGraph.Y2Axis"/> properties to
- default values as defined in the <see cref="T:ZedGraph.Y2Axis.Default"/> class
- </summary>
- </member>
- <member name="M:ZedGraph.Y2Axis.#ctor(System.String)">
- <summary>
- Default constructor that sets all <see cref="T:ZedGraph.Y2Axis"/> properties to
- default values as defined in the <see cref="T:ZedGraph.Y2Axis.Default"/> class, except
- for the axis title
- </summary>
- <param name="title">The <see cref="P:ZedGraph.Axis.Title"/> for this axis</param>
- </member>
- <member name="M:ZedGraph.Y2Axis.#ctor(ZedGraph.Y2Axis)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The Y2Axis object from which to copy</param>
- </member>
- <member name="M:ZedGraph.Y2Axis.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.Y2Axis.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.Y2Axis.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.Y2Axis.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.Y2Axis.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.Y2Axis.SetTransformMatrix(System.Drawing.Graphics,ZedGraph.GraphPane,System.Single)">
- <summary>
- Setup the Transform Matrix to handle drawing of this <see cref="T:ZedGraph.Y2Axis"/>
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.Y2Axis.IsPrimary(ZedGraph.GraphPane)">
- <summary>
- Determines if this <see cref="T:ZedGraph.Axis"/> object is a "primary" one.
- </summary>
- <remarks>
- The primary axes are the <see cref="T:ZedGraph.XAxis"/> (always), the first
- <see cref="T:ZedGraph.YAxis"/> in the <see cref="P:ZedGraph.GraphPane.YAxisList"/>
- (<see cref="P:ZedGraph.CurveItem.YAxisIndex"/> = 0), and the first
- <see cref="T:ZedGraph.Y2Axis"/> in the <see cref="P:ZedGraph.GraphPane.Y2AxisList"/>
- (<see cref="P:ZedGraph.CurveItem.YAxisIndex"/> = 0). Note that
- <see cref="P:ZedGraph.GraphPane.YAxis"/> and <see cref="P:ZedGraph.GraphPane.Y2Axis"/>
- always reference the primary axes.
- </remarks>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <returns>true for a primary <see cref="T:ZedGraph.Axis"/>, false otherwise</returns>
- </member>
- <member name="M:ZedGraph.Y2Axis.CalcCrossShift(ZedGraph.GraphPane)">
- <summary>
- Calculate the "shift" size, in pixels, in order to shift the axis from its default
- location to the value specified by <see cref="P:ZedGraph.Axis.Cross"/>.
- </summary>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <returns>The shift amount measured in pixels</returns>
- </member>
- <member name="M:ZedGraph.Y2Axis.GetCrossAxis(ZedGraph.GraphPane)">
- <summary>
- Gets the "Cross" axis that corresponds to this axis.
- </summary>
- <remarks>
- The cross axis is the axis which determines the of this Axis when the
- <see cref="P:ZedGraph.Axis.Cross">Axis.Cross</see> property is used. The
- cross axis for any <see cref="T:ZedGraph.XAxis"/> or <see cref="T:ZedGraph.X2Axis"/>
- is always the primary <see cref="T:ZedGraph.YAxis"/>, and
- the cross axis for any <see cref="T:ZedGraph.YAxis"/> or <see cref="T:ZedGraph.Y2Axis"/> is
- always the primary <see cref="T:ZedGraph.XAxis"/>.
- </remarks>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- </member>
- <member name="T:ZedGraph.Y2Axis.Default">
- <summary>
- A simple subclass of the <see cref="T:ZedGraph.Y2Axis.Default"/> class that defines the
- default property values for the <see cref="T:ZedGraph.Y2Axis"/> class.
- </summary>
- </member>
- <member name="F:ZedGraph.Y2Axis.Default.IsVisible">
- <summary>
- The default display mode for the <see cref="T:ZedGraph.Y2Axis"/>
- (<see cref="P:ZedGraph.Axis.IsVisible"/> property). true to display the scale
- values, title, tic marks, false to hide the axis entirely.
- </summary>
- </member>
- <member name="F:ZedGraph.Y2Axis.Default.IsZeroLine">
- <summary>
- Determines if a line will be drawn at the zero value for the
- <see cref="T:ZedGraph.Y2Axis"/>, that is, a line that
- divides the negative values from positive values.
- <seealso cref="P:ZedGraph.MajorGrid.IsZeroLine"/>.
- </summary>
- </member>
- <member name="T:ZedGraph.XAxis">
- <summary>
- <see cref="T:ZedGraph.XAxis"/> inherits from <see cref="T:ZedGraph.Axis"/>, and defines the
- special characteristics of a horizontal axis, specifically located at
- the bottom of the <see cref="P:ZedGraph.Chart.Rect"/> of the <see cref="T:ZedGraph.GraphPane"/>
- object
- </summary>
-
- <author> John Champion </author>
- <version> $Revision: 3.16 $ $Date: 2007-04-16 00:03:02 $ </version>
- </member>
- <member name="F:ZedGraph.XAxis.schema2">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="M:ZedGraph.XAxis.#ctor">
- <summary>
- Default constructor that sets all <see cref="T:ZedGraph.XAxis"/> properties to
- default values as defined in the <see cref="T:ZedGraph.XAxis.Default"/> class
- </summary>
- </member>
- <member name="M:ZedGraph.XAxis.#ctor(System.String)">
- <summary>
- Default constructor that sets all <see cref="T:ZedGraph.XAxis"/> properties to
- default values as defined in the <see cref="T:ZedGraph.XAxis.Default"/> class, except
- for the axis title
- </summary>
- <param name="title">The <see cref="P:ZedGraph.Axis.Title"/> for this axis</param>
- </member>
- <member name="M:ZedGraph.XAxis.#ctor(ZedGraph.XAxis)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The XAxis object from which to copy</param>
- </member>
- <member name="M:ZedGraph.XAxis.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.XAxis.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.XAxis.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.XAxis.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.XAxis.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.XAxis.SetTransformMatrix(System.Drawing.Graphics,ZedGraph.GraphPane,System.Single)">
- <summary>
- Setup the Transform Matrix to handle drawing of this <see cref="T:ZedGraph.XAxis"/>
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.XAxis.IsPrimary(ZedGraph.GraphPane)">
- <summary>
- Determines if this <see cref="T:ZedGraph.Axis"/> object is a "primary" one.
- </summary>
- <remarks>
- The primary axes are the <see cref="T:ZedGraph.XAxis"/> (always), the first
- <see cref="T:ZedGraph.YAxis"/> in the <see cref="P:ZedGraph.GraphPane.YAxisList"/>
- (<see cref="P:ZedGraph.CurveItem.YAxisIndex"/> = 0), and the first
- <see cref="T:ZedGraph.Y2Axis"/> in the <see cref="P:ZedGraph.GraphPane.Y2AxisList"/>
- (<see cref="P:ZedGraph.CurveItem.YAxisIndex"/> = 0). Note that
- <see cref="P:ZedGraph.GraphPane.YAxis"/> and <see cref="P:ZedGraph.GraphPane.Y2Axis"/>
- always reference the primary axes.
- </remarks>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <returns>true for a primary <see cref="T:ZedGraph.Axis"/> (for the <see cref="T:ZedGraph.XAxis"/>,
- this is always true), false otherwise</returns>
- </member>
- <member name="M:ZedGraph.XAxis.CalcCrossShift(ZedGraph.GraphPane)">
- <summary>
- Calculate the "shift" size, in pixels, in order to shift the axis from its default
- location to the value specified by <see cref="P:ZedGraph.Axis.Cross"/>.
- </summary>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <returns>The shift amount measured in pixels</returns>
- </member>
- <member name="M:ZedGraph.XAxis.GetCrossAxis(ZedGraph.GraphPane)">
- <summary>
- Gets the "Cross" axis that corresponds to this axis.
- </summary>
- <remarks>
- The cross axis is the axis which determines the of this Axis when the
- <see cref="P:ZedGraph.Axis.Cross">Axis.Cross</see> property is used. The
- cross axis for any <see cref="T:ZedGraph.XAxis"/> or <see cref="T:ZedGraph.X2Axis"/>
- is always the primary <see cref="T:ZedGraph.YAxis"/>, and
- the cross axis for any <see cref="T:ZedGraph.YAxis"/> or <see cref="T:ZedGraph.Y2Axis"/> is
- always the primary <see cref="T:ZedGraph.XAxis"/>.
- </remarks>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- </member>
- <member name="T:ZedGraph.XAxis.Default">
- <summary>
- A simple struct that defines the
- default property values for the <see cref="T:ZedGraph.XAxis"/> class.
- </summary>
- </member>
- <member name="F:ZedGraph.XAxis.Default.IsVisible">
- <summary>
- The default display mode for the <see cref="T:ZedGraph.XAxis"/>
- (<see cref="P:ZedGraph.Axis.IsVisible"/> property). true to display the scale
- values, title, tic marks, false to hide the axis entirely.
- </summary>
- </member>
- <member name="F:ZedGraph.XAxis.Default.IsZeroLine">
- <summary>
- Determines if a line will be drawn at the zero value for the
- <see cref="T:ZedGraph.XAxis"/>, that is, a line that
- divides the negative values from positive values.
- <seealso cref="P:ZedGraph.MajorGrid.IsZeroLine"/>.
- </summary>
- </member>
- <member name="T:ZedGraph.RollingPointPairList">
- <summary>
- A class that provides a rolling list of <see cref="T:ZedGraph.PointPair"/> objects.
- This is essentially a
- first-in-first-out (FIFO) queue with a fixed capacity which allows 'rolling'
- (or oscilloscope like) graphs to be be animated without having the overhead of an
- ever-growing ArrayList.
-
- The queue is constructed with a fixed capacity and new points can be enqueued. When the
- capacity is reached the oldest (first in) PointPair is overwritten. However, when
- accessing via <see cref="T:ZedGraph.IPointList"/>, the <see cref="T:ZedGraph.PointPair"/> objects are
- seen in the order in which they were enqeued.
-
- RollingPointPairList supports data editing through the <see cref="T:ZedGraph.IPointListEdit"/>
- interface.
-
- <author>Colin Green with mods by John Champion</author>
- <version> $Date: 2007-11-05 04:33:26 $ </version>
- </summary>
- </member>
- <member name="F:ZedGraph.RollingPointPairList.schema">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="F:ZedGraph.RollingPointPairList._mBuffer">
- <summary>
- An array of PointPair objects that acts as the underlying buffer.
- </summary>
- </member>
- <member name="F:ZedGraph.RollingPointPairList._headIdx">
- <summary>
- The index of the previously enqueued item. -1 if buffer is empty.
- </summary>
- </member>
- <member name="F:ZedGraph.RollingPointPairList._tailIdx">
- <summary>
- The index of the next item to be dequeued. -1 if buffer is empty.
- </summary>
- </member>
- <member name="M:ZedGraph.RollingPointPairList.#ctor(System.Int32)">
- <summary>
- Constructs an empty buffer with the specified capacity.
- </summary>
- <param name="capacity">Number of elements in the rolling list. This number
- cannot be changed once the RollingPointPairList is constructed.</param>
- </member>
- <member name="M:ZedGraph.RollingPointPairList.#ctor(System.Int32,System.Boolean)">
- <summary>
- Constructs an empty buffer with the specified capacity. Pre-allocates space
- for all PointPair's in the list if <paramref name="preLoad"/> is true.
- </summary>
- <param name="capacity">Number of elements in the rolling list. This number
- cannot be changed once the RollingPointPairList is constructed.</param>
- <param name="preLoad">true to pre-allocate all PointPair instances in
- the list, false otherwise. Note that in order to be memory efficient,
- the <see cref="M:ZedGraph.RollingPointPairList.Add(System.Double,System.Double,System.Double)"/> method should be used to add
- data. Avoid the <see cref="M:ZedGraph.RollingPointPairList.Add(ZedGraph.PointPair)"/> method.
- </param>
- <seealso cref="M:ZedGraph.RollingPointPairList.Add(System.Double,System.Double,System.Double)"/>
- </member>
- <member name="M:ZedGraph.RollingPointPairList.#ctor(ZedGraph.IPointList)">
- <summary>
- Constructs a buffer with a copy of the items within the provided
- <see cref="T:ZedGraph.IPointList"/>.
- The <see cref="P:ZedGraph.RollingPointPairList.Capacity"/> is set to the length of the provided list.
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.IPointList"/> to be copied.</param>
- </member>
- <member name="M:ZedGraph.RollingPointPairList.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.RollingPointPairList.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.RollingPointPairList.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.RollingPointPairList.Clear">
- <summary>
- Clear the buffer of all <see cref="T:ZedGraph.PointPair"/> objects.
- Note that the <see cref="P:ZedGraph.RollingPointPairList.Capacity"/> remains unchanged.
- </summary>
- </member>
- <member name="M:ZedGraph.RollingPointPairList.GetNextIndex">
- <summary>
- Calculate that the next index in the buffer that should receive a new data point.
- Note that this method actually advances the buffer, so a datapoint should be
- added at _mBuffer[_headIdx].
- </summary>
- <returns>The index position of the new head element</returns>
- </member>
- <member name="M:ZedGraph.RollingPointPairList.Add(ZedGraph.PointPair)">
- <summary>
- Add a <see cref="T:ZedGraph.PointPair"/> onto the head of the queue,
- overwriting old values if the buffer is full.
- </summary>
- <param name="item">The <see cref="T:ZedGraph.PointPair"/> to be added.</param>
- </member>
- <member name="M:ZedGraph.RollingPointPairList.Add(ZedGraph.IPointList)">
- <summary>
- Add an <see cref="T:ZedGraph.IPointList"/> object to the head of the queue.
- </summary>
- <param name="pointList">A reference to the <see cref="T:ZedGraph.IPointList"/> object to
- be added</param>
- </member>
- <member name="M:ZedGraph.RollingPointPairList.Remove">
- <summary>
- Remove an old item from the tail of the queue.
- </summary>
- <returns>The removed item. Throws an <see cref="T:System.InvalidOperationException"/>
- if the buffer was empty.
- Check the buffer's length (<see cref="P:ZedGraph.RollingPointPairList.Count"/>) or the <see cref="P:ZedGraph.RollingPointPairList.IsEmpty"/>
- property to avoid exceptions.</returns>
- </member>
- <member name="M:ZedGraph.RollingPointPairList.RemoveAt(System.Int32)">
- <summary>
- Remove the <see cref="T:ZedGraph.PointPair"/> at the specified index
- </summary>
- <remarks>
- All items in the queue that lie after <paramref name="index"/> will
- be shifted back by one, and the queue will be one item shorter.
- </remarks>
- <param name="index">The ordinal position of the item to be removed.
- Throws an <see cref="T:System.ArgumentOutOfRangeException"/> if index is less than
- zero or greater than or equal to <see cref="P:ZedGraph.RollingPointPairList.Count"/>
- </param>
- </member>
- <member name="M:ZedGraph.RollingPointPairList.RemoveRange(System.Int32,System.Int32)">
- <summary>
- Remove a range of <see cref="T:ZedGraph.PointPair"/> objects starting at the specified index
- </summary>
- <remarks>
- All items in the queue that lie after <paramref name="index"/> will
- be shifted back, and the queue will be <paramref name="count"/> items shorter.
- </remarks>
- <param name="index">The ordinal position of the item to be removed.
- Throws an <see cref="T:System.ArgumentOutOfRangeException"/> if index is less than
- zero or greater than or equal to <see cref="P:ZedGraph.RollingPointPairList.Count"/>
- </param>
- <param name="count">The number of items to be removed. Throws an
- <see cref="T:System.ArgumentOutOfRangeException"/> if <paramref name="count"/> is less than zero
- or greater than the total available items in the queue</param>
- </member>
- <member name="M:ZedGraph.RollingPointPairList.Pop">
- <summary>
- Pop an item off the head of the queue.
- </summary>
- <returns>The popped item. Throws an exception if the buffer was empty.</returns>
- </member>
- <member name="M:ZedGraph.RollingPointPairList.Peek">
- <summary>
- Peek at the <see cref="T:ZedGraph.PointPair"/> item at the head of the queue.
- </summary>
- <returns>The <see cref="T:ZedGraph.PointPair"/> item at the head of the queue.
- Throws an <see cref="T:System.InvalidOperationException"/> if the buffer was empty.
- </returns>
- </member>
- <member name="M:ZedGraph.RollingPointPairList.Add(System.Double,System.Double,System.Double,System.Object)">
- <summary>
- Add a set of values onto the head of the queue,
- overwriting old values if the buffer is full.
- </summary>
- <remarks>
- This method is much more efficient that the <see cref="M:ZedGraph.RollingPointPairList.Add(ZedGraph.PointPair)">Add(PointPair)</see>
- method, since it does not require that a new PointPair instance be provided.
- If the buffer already contains a <see cref="T:ZedGraph.PointPair"/> at the head position,
- then the x, y, z, and tag values will be copied into the existing PointPair.
- Otherwise, a new PointPair instance must be created.
- In this way, each PointPair position in the rolling list will only be allocated one time.
- To truly be memory efficient, the <see cref="M:ZedGraph.RollingPointPairList.Remove"/>, <see cref="M:ZedGraph.RollingPointPairList.RemoveAt(System.Int32)"/>,
- and <see cref="M:ZedGraph.RollingPointPairList.Pop"/> methods should be avoided. Also, the <paramref name="tag"/> property
- for this method should be null, since it is a reference type.
- </remarks>
- <param name="x">The X value</param>
- <param name="y">The Y value</param>
- <param name="z">The Z value</param>
- <param name="tag">The Tag value for the PointPair</param>
- </member>
- <member name="M:ZedGraph.RollingPointPairList.Add(System.Double,System.Double)">
- <summary>
- Add a set of values onto the head of the queue,
- overwriting old values if the buffer is full.
- </summary>
- <remarks>
- This method is much more efficient that the <see cref="M:ZedGraph.RollingPointPairList.Add(ZedGraph.PointPair)">Add(PointPair)</see>
- method, since it does not require that a new PointPair instance be provided.
- If the buffer already contains a <see cref="T:ZedGraph.PointPair"/> at the head position,
- then the x, y, z, and tag values will be copied into the existing PointPair.
- Otherwise, a new PointPair instance must be created.
- In this way, each PointPair position in the rolling list will only be allocated one time.
- To truly be memory efficient, the <see cref="M:ZedGraph.RollingPointPairList.Remove"/>, <see cref="M:ZedGraph.RollingPointPairList.RemoveAt(System.Int32)"/>,
- and <see cref="M:ZedGraph.RollingPointPairList.Pop"/> methods should be avoided.
- </remarks>
- <param name="x">The X value</param>
- <param name="y">The Y value</param>
- </member>
- <member name="M:ZedGraph.RollingPointPairList.Add(System.Double,System.Double,System.Object)">
- <summary>
- Add a set of values onto the head of the queue,
- overwriting old values if the buffer is full.
- </summary>
- <remarks>
- This method is much more efficient that the <see cref="M:ZedGraph.RollingPointPairList.Add(ZedGraph.PointPair)">Add(PointPair)</see>
- method, since it does not require that a new PointPair instance be provided.
- If the buffer already contains a <see cref="T:ZedGraph.PointPair"/> at the head position,
- then the x, y, z, and tag values will be copied into the existing PointPair.
- Otherwise, a new PointPair instance must be created.
- In this way, each PointPair position in the rolling list will only be allocated one time.
- To truly be memory efficient, the <see cref="M:ZedGraph.RollingPointPairList.Remove"/>, <see cref="M:ZedGraph.RollingPointPairList.RemoveAt(System.Int32)"/>,
- and <see cref="M:ZedGraph.RollingPointPairList.Pop"/> methods should be avoided. Also, the <paramref name="tag"/> property
- for this method should be null, since it is a reference type.
- </remarks>
- <param name="x">The X value</param>
- <param name="y">The Y value</param>
- <param name="tag">The Tag value for the PointPair</param>
- </member>
- <member name="M:ZedGraph.RollingPointPairList.Add(System.Double,System.Double,System.Double)">
- <summary>
- Add a set of values onto the head of the queue,
- overwriting old values if the buffer is full.
- </summary>
- <remarks>
- This method is much more efficient that the <see cref="M:ZedGraph.RollingPointPairList.Add(ZedGraph.PointPair)">Add(PointPair)</see>
- method, since it does not require that a new PointPair instance be provided.
- If the buffer already contains a <see cref="T:ZedGraph.PointPair"/> at the head position,
- then the x, y, z, and tag values will be copied into the existing PointPair.
- Otherwise, a new PointPair instance must be created.
- In this way, each PointPair position in the rolling list will only be allocated one time.
- To truly be memory efficient, the <see cref="M:ZedGraph.RollingPointPairList.Remove"/>, <see cref="M:ZedGraph.RollingPointPairList.RemoveAt(System.Int32)"/>,
- and <see cref="M:ZedGraph.RollingPointPairList.Pop"/> methods should be avoided.
- </remarks>
- <param name="x">The X value</param>
- <param name="y">The Y value</param>
- <param name="z">The Z value</param>
- </member>
- <member name="M:ZedGraph.RollingPointPairList.Add(System.Double[],System.Double[])">
- <summary>
- Add a set of points to the <see cref="T:ZedGraph.RollingPointPairList"/>
- from two arrays of type double.
- If either array is null, then a set of ordinal values is automatically
- generated in its place (see <see cref="F:ZedGraph.AxisType.Ordinal"/>).
- If the arrays are of different size, then the larger array prevails and the
- smaller array is padded with <see cref="F:ZedGraph.PointPairBase.Missing"/> values.
- </summary>
- <param name="x">A double[] array of X values</param>
- <param name="y">A double[] array of Y values</param>
- </member>
- <member name="M:ZedGraph.RollingPointPairList.Add(System.Double[],System.Double[],System.Double[])">
- <summary>
- Add a set of points to the <see cref="T:ZedGraph.RollingPointPairList"/> from
- three arrays of type double.
- If the X or Y array is null, then a set of ordinal values is automatically
- generated in its place (see <see cref="F:ZedGraph.AxisType.Ordinal"/>.
- If the <see paramref="z"/> value
- is null, then it is set to zero.
- If the arrays are of different size, then the larger array prevails and the
- smaller array is padded with <see cref="F:ZedGraph.PointPairBase.Missing"/> values.
- </summary>
- <param name="x">A double[] array of X values</param>
- <param name="y">A double[] array of Y values</param>
- <param name="z">A double[] array of Z values</param>
- </member>
- <member name="M:ZedGraph.RollingPointPairList.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.RollingPointPairList.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="P:ZedGraph.RollingPointPairList.Capacity">
- <summary>
- Gets the capacity of the rolling buffer.
- </summary>
- </member>
- <member name="P:ZedGraph.RollingPointPairList.Count">
- <summary>
- Gets the count of items within the rolling buffer. Note that this may be less than
- the capacity.
- </summary>
- </member>
- <member name="P:ZedGraph.RollingPointPairList.IsEmpty">
- <summary>
- Gets a bolean that indicates if the buffer is empty.
- Alternatively you can test Count==0.
- </summary>
- </member>
- <member name="P:ZedGraph.RollingPointPairList.Item(System.Int32)">
- <summary>
- Gets or sets the <see cref="T:ZedGraph.PointPair"/> at the specified index in the buffer.
- </summary>
- <remarks>
- Index must be within the current size of the buffer, e.g., the set
- method will not expand the buffer even if <see cref="P:ZedGraph.RollingPointPairList.Capacity"/> is available
- </remarks>
- </member>
- <member name="T:ZedGraph.PaneList">
- <summary>
- A collection class containing a list of <see cref="T:ZedGraph.GraphPane"/> objects.
- </summary>
-
- <author>John Champion</author>
- <version> $Revision: 3.6 $ $Date: 2006-06-24 20:26:43 $ </version>
- </member>
- <member name="F:ZedGraph.PaneList.schema">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="M:ZedGraph.PaneList.#ctor">
- <summary>
- Default constructor for the collection class.
- </summary>
- </member>
- <member name="M:ZedGraph.PaneList.#ctor(ZedGraph.PaneList)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.PaneList"/> object from which to copy</param>
- </member>
- <member name="M:ZedGraph.PaneList.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.PaneList.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.PaneList.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.PaneList.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.PaneList.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.PaneList.IndexOf(System.String)">
- <summary>
- Return the zero-based position index of the
- <see cref="T:ZedGraph.GraphPane"/> with the specified <see cref="P:ZedGraph.PaneBase.Title"/>.
- </summary>
- <remarks>The comparison of titles is not case sensitive, but it must include
- all characters including punctuation, spaces, etc.</remarks>
- <param name="title">The <see cref="T:System.String"/> label that is in the
- <see cref="P:ZedGraph.PaneBase.Title"/> attribute of the item to be found.
- </param>
- <returns>The zero-based index of the specified <see cref="T:ZedGraph.GraphPane"/>,
- or -1 if the <see cref="P:ZedGraph.PaneBase.Title"/> was not found in the list</returns>
- <seealso cref="M:ZedGraph.PaneList.IndexOfTag(System.String)"/>
- </member>
- <member name="M:ZedGraph.PaneList.IndexOfTag(System.String)">
- <summary>
- Return the zero-based position index of the
- <see cref="T:ZedGraph.GraphPane"/> with the specified <see cref="P:ZedGraph.PaneBase.Tag"/>.
- </summary>
- <remarks>In order for this method to work, the <see cref="P:ZedGraph.PaneBase.Tag"/>
- property must be of type <see cref="T:System.String"/>.</remarks>
- <param name="tagStr">The <see cref="T:System.String"/> tag that is in the
- <see cref="P:ZedGraph.PaneBase.Tag"/> attribute of the item to be found.
- </param>
- <returns>The zero-based index of the specified <see cref="T:ZedGraph.GraphPane"/>,
- or -1 if the <see cref="P:ZedGraph.PaneBase.Tag"/> string is not in the list</returns>
- </member>
- <member name="P:ZedGraph.PaneList.Item(System.String)">
- <summary>
- Indexer to access the specified <see cref="T:ZedGraph.GraphPane"/> object by
- its <see cref="P:ZedGraph.PaneBase.Title"/> string.
- </summary>
- <param name="title">The string title of the
- <see cref="T:ZedGraph.GraphPane"/> object to be accessed.</param>
- <value>A <see cref="T:ZedGraph.GraphPane"/> object reference.</value>
- </member>
- <member name="T:ZedGraph.LineObj">
- <summary>
- A class that represents a line segment object on the graph. A list of
- GraphObj objects is maintained by the <see cref="T:ZedGraph.GraphObjList"/> collection class.
- </summary>
- <remarks>
- This should not be confused with the <see cref="T:ZedGraph.LineItem"/> class, which represents
- a set of points plotted together as a "curve". The <see cref="T:ZedGraph.LineObj"/> class is
- a single line segment, drawn as a "decoration" on the chart.</remarks>
-
- <author> John Champion </author>
- <version> $Revision: 3.4 $ $Date: 2007-01-25 07:56:09 $ </version>
- </member>
- <member name="F:ZedGraph.LineObj.schema2">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="F:ZedGraph.LineObj._line">
- <summary>
- protected field that maintains the attributes of the line using an
- instance of the <see cref="T:ZedGraph.LineBase"/> class.
- </summary>
- </member>
- <member name="M:ZedGraph.LineObj.#ctor(System.Drawing.Color,System.Double,System.Double,System.Double,System.Double)">
- <overloads>Constructors for the <see cref="T:ZedGraph.LineObj"/> object</overloads>
- <summary>
- A constructor that allows the position, color, and size of the
- <see cref="T:ZedGraph.LineObj"/> to be pre-specified.
- </summary>
- <param name="color">An arbitrary <see cref="T:System.Drawing.Color"/> specification
- for the arrow</param>
- <param name="x1">The x position of the starting point that defines the
- line. The units of this position are specified by the
- <see cref="P:ZedGraph.Location.CoordinateFrame"/> property.</param>
- <param name="y1">The y position of the starting point that defines the
- line. The units of this position are specified by the
- <see cref="P:ZedGraph.Location.CoordinateFrame"/> property.</param>
- <param name="x2">The x position of the ending point that defines the
- line. The units of this position are specified by the
- <see cref="P:ZedGraph.Location.CoordinateFrame"/> property.</param>
- <param name="y2">The y position of the ending point that defines the
- line. The units of this position are specified by the
- <see cref="P:ZedGraph.Location.CoordinateFrame"/> property.</param>
- </member>
- <member name="M:ZedGraph.LineObj.#ctor(System.Double,System.Double,System.Double,System.Double)">
- <summary>
- A constructor that allows only the position of the
- line to be pre-specified. All other properties are set to
- default values
- </summary>
- <param name="x1">The x position of the starting point that defines the
- <see cref="T:ZedGraph.LineObj"/>. The units of this position are specified by the
- <see cref="P:ZedGraph.Location.CoordinateFrame"/> property.</param>
- <param name="y1">The y position of the starting point that defines the
- <see cref="T:ZedGraph.LineObj"/>. The units of this position are specified by the
- <see cref="P:ZedGraph.Location.CoordinateFrame"/> property.</param>
- <param name="x2">The x position of the ending point that defines the
- <see cref="T:ZedGraph.LineObj"/>. The units of this position are specified by the
- <see cref="P:ZedGraph.Location.CoordinateFrame"/> property.</param>
- <param name="y2">The y position of the ending point that defines the
- <see cref="T:ZedGraph.LineObj"/>. The units of this position are specified by the
- <see cref="P:ZedGraph.Location.CoordinateFrame"/> property.</param>
- </member>
- <member name="M:ZedGraph.LineObj.#ctor">
- <summary>
- Default constructor -- places the <see cref="T:ZedGraph.LineObj"/> at location
- (0,0) to (1,1). All other values are defaulted.
- </summary>
- </member>
- <member name="M:ZedGraph.LineObj.#ctor(ZedGraph.LineObj)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.LineObj"/> object from which to copy</param>
- </member>
- <member name="M:ZedGraph.LineObj.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.LineObj.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.LineObj.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.LineObj.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.LineObj.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.LineObj.Draw(System.Drawing.Graphics,ZedGraph.PaneBase,System.Single)">
- <summary>
- Render this object to the specified <see cref="T:System.Drawing.Graphics"/> device.
- </summary>
- <remarks>
- This method is normally only called by the Draw method
- of the parent <see cref="T:ZedGraph.GraphObjList"/> collection object.
- </remarks>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.PaneBase"/> object that is the parent or
- owner of this object.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.LineObj.PointInBox(System.Drawing.PointF,ZedGraph.PaneBase,System.Drawing.Graphics,System.Single)">
- <summary>
- Determine if the specified screen point lies inside the bounding box of this
- <see cref="T:ZedGraph.LineObj"/>.
- </summary>
- <remarks>The bounding box is calculated assuming a distance
- of <see cref="F:ZedGraph.GraphPane.Default.NearestTol"/> pixels around the arrow segment.
- </remarks>
- <param name="pt">The screen point, in pixels</param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.PaneBase"/> object that is the parent or
- owner of this object.
- </param>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <returns>true if the point lies in the bounding box, false otherwise</returns>
- </member>
- <member name="M:ZedGraph.LineObj.GetCoords(ZedGraph.PaneBase,System.Drawing.Graphics,System.Single,System.String@,System.String@)">
- <summary>
- Determines the shape type and Coords values for this GraphObj
- </summary>
- </member>
- <member name="P:ZedGraph.LineObj.Line">
- <summary>
- A <see cref="T:ZedGraph.LineBase"/> class that contains the attributes for drawing this
- <see cref="T:ZedGraph.LineObj"/>.
- </summary>
- </member>
- <member name="T:ZedGraph.ErrorBar">
- <summary>
- This class handles the drawing of the curve <see cref="T:ZedGraph.ErrorBar"/> objects.
- The Error Bars are the vertical lines with a symbol at each end.
- </summary>
- <remarks>To draw "I-Beam" bars, the symbol type defaults to
- <see cref="F:ZedGraph.SymbolType.HDash"/>, which is just a horizontal line.
- If <see cref="T:ZedGraph.BarBase"/> is Y-oriented, then the symbol type should be
- set to <see cref="F:ZedGraph.SymbolType.VDash"/> to get the same effect.
- </remarks>
-
- <author> John Champion </author>
- <version> $Revision: 3.21 $ $Date: 2007-08-10 16:22:54 $ </version>
- </member>
- <member name="F:ZedGraph.ErrorBar.schema">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="F:ZedGraph.ErrorBar._isVisible">
- <summary>
- Private field that stores the visibility of this
- <see cref="T:ZedGraph.ErrorBar"/>. Use the public
- property <see cref="P:ZedGraph.ErrorBar.IsVisible"/> to access this value. If this value is
- false, the symbols will not be shown.
- </summary>
- </member>
- <member name="F:ZedGraph.ErrorBar._color">
- <summary>
- Private field that stores the error bar color. Use the public
- property <see cref="P:ZedGraph.ErrorBar.Color"/> to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.ErrorBar._penWidth">
- <summary>
- Private field that stores the pen width for this error bar. Use the public
- property <see cref="P:ZedGraph.ErrorBar.PenWidth"/> to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.ErrorBar._symbol">
- <summary>
- private field that contains the symbol element that will be drawn
- at the top and bottom of the error bar. Use the public property
- <see cref="P:ZedGraph.ErrorBar.Symbol"/> to access this value.
- </summary>
- </member>
- <member name="M:ZedGraph.ErrorBar.#ctor">
- <summary>
- Default constructor that sets all <see cref="T:ZedGraph.ErrorBar"/> properties to
- default values as defined in the <see cref="T:ZedGraph.ErrorBar.Default"/> class.
- </summary>
- </member>
- <member name="M:ZedGraph.ErrorBar.#ctor(System.Drawing.Color)">
- <summary>
- Default constructor that sets the
- <see cref="P:ZedGraph.ErrorBar.Color"/> as specified, and the remaining
- <see cref="T:ZedGraph.ErrorBar"/> properties to default
- values as defined in the <see cref="T:ZedGraph.ErrorBar.Default"/> class.
- </summary>
- <param name="color">A <see cref="P:ZedGraph.ErrorBar.Color"/> value indicating
- the color of the symbol
- </param>
- </member>
- <member name="M:ZedGraph.ErrorBar.#ctor(ZedGraph.ErrorBar)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.ErrorBar"/> object from which to copy</param>
- </member>
- <member name="M:ZedGraph.ErrorBar.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.ErrorBar.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.ErrorBar.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.ErrorBar.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.ErrorBar.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.ErrorBar.Draw(System.Drawing.Graphics,ZedGraph.GraphPane,System.Boolean,System.Single,System.Single,System.Single,System.Single,System.Drawing.Pen,System.Boolean,ZedGraph.PointPair)">
- <summary>
- Draw the <see cref="T:ZedGraph.ErrorBar"/> to the specified <see cref="T:System.Drawing.Graphics"/>
- device at the specified location.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="isXBase">boolean value that indicates if the "base" axis for this
- <see cref="T:ZedGraph.ErrorBar"/> is the X axis. True for an <see cref="T:ZedGraph.XAxis"/> base,
- false for a <see cref="T:ZedGraph.YAxis"/> or <see cref="T:ZedGraph.Y2Axis"/> base.</param>
- <param name="pixBase">The independent axis position of the center of the error bar in
- pixel units</param>
- <param name="pixValue">The dependent axis position of the top of the error bar in
- pixel units</param>
- <param name="pixLowValue">The dependent axis position of the bottom of the error bar in
- pixel units</param>
- <param name="scaleFactor">
- The scaling factor for the features of the graph based on the <see cref="P:ZedGraph.PaneBase.BaseDimension"/>. This
- scaling factor is calculated by the <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method. The scale factor
- represents a linear multiple to be applied to font sizes, symbol sizes, etc.</param>
- <param name="pen">A pen with attributes of <see cref="P:ZedGraph.ErrorBar.Color"/> and
- <see cref="P:ZedGraph.ErrorBar.PenWidth"/> for this <see cref="T:ZedGraph.ErrorBar"/></param>
- <param name="dataValue">The data value to be used for a value-based
- color gradient. This is only applicable for <see cref="F:ZedGraph.FillType.GradientByX"/>,
- <see cref="F:ZedGraph.FillType.GradientByY"/> or <see cref="F:ZedGraph.FillType.GradientByZ"/>.</param>
- <param name="isSelected">Indicates that the <see cref="T:ZedGraph.ErrorBar"/> should be drawn
- with attributes from the <see cref="T:ZedGraph.Selection"/> class.
- </param>
- </member>
- <member name="M:ZedGraph.ErrorBar.Draw(System.Drawing.Graphics,ZedGraph.GraphPane,ZedGraph.ErrorBarItem,ZedGraph.Axis,ZedGraph.Axis,System.Single)">
- <summary>
- Draw all the <see cref="T:ZedGraph.ErrorBar"/>'s to the specified <see cref="T:System.Drawing.Graphics"/>
- device as a an error bar at each defined point.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="curve">A <see cref="T:ZedGraph.CurveItem"/> object representing the
- <see cref="T:ZedGraph.Bar"/>'s to be drawn.</param>
- <param name="baseAxis">The <see cref="T:ZedGraph.Axis"/> class instance that defines the base (independent)
- axis for the <see cref="T:ZedGraph.Bar"/></param>
- <param name="valueAxis">The <see cref="T:ZedGraph.Axis"/> class instance that defines the value (dependent)
- axis for the <see cref="T:ZedGraph.Bar"/></param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="P:ZedGraph.ErrorBar.IsVisible">
- <summary>
- Gets or sets a property that shows or hides the <see cref="T:ZedGraph.ErrorBar"/>.
- </summary>
- <value>true to show the error bar, false to hide it</value>
- <seealso cref="F:ZedGraph.ErrorBar.Default.IsVisible"/>
- </member>
- <member name="P:ZedGraph.ErrorBar.Color">
- <summary>
- Gets or sets the <see cref="T:System.Drawing.Color"/> data for this
- <see cref="T:ZedGraph.ErrorBar"/>.
- </summary>
- <remarks>This property only controls the color of
- the vertical line. The symbol color is controlled separately in
- the <see cref="P:ZedGraph.ErrorBar.Symbol"/> property.
- </remarks>
- </member>
- <member name="P:ZedGraph.ErrorBar.PenWidth">
- <summary>
- The pen width to be used for drawing error bars
- Units are points.
- </summary>
- <remarks>This property only controls the pen width for the
- vertical line. The pen width for the symbol outline is
- controlled separately by the <see cref="P:ZedGraph.ErrorBar.Symbol"/> property.
- </remarks>
- </member>
- <member name="P:ZedGraph.ErrorBar.Symbol">
- <summary>
- Contains the symbol element that will be drawn
- at the top and bottom of the error bar.
- </summary>
- </member>
- <member name="T:ZedGraph.ErrorBar.Default">
- <summary>
- A simple struct that defines the
- default property values for the <see cref="T:ZedGraph.ErrorBar"/> class.
- </summary>
- </member>
- <member name="F:ZedGraph.ErrorBar.Default.Size">
- <summary>
- The default size for curve symbols
- (<see cref="P:ZedGraph.Symbol.Size"/> property),
- in units of points.
- </summary>
- </member>
- <member name="F:ZedGraph.ErrorBar.Default.PenWidth">
- <summary>
- The default pen width to be used for drawing error bars
- (<see cref="P:ZedGraph.ErrorBar.PenWidth"/> property). Units are points.
- </summary>
- </member>
- <member name="F:ZedGraph.ErrorBar.Default.IsVisible">
- <summary>
- The default display mode for symbols (<see cref="P:ZedGraph.ErrorBar.IsVisible"/> property).
- true to display symbols, false to hide them.
- </summary>
- </member>
- <member name="F:ZedGraph.ErrorBar.Default.Color">
- <summary>
- The default color for drawing error bars (<see cref="P:ZedGraph.ErrorBar.Color"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.ErrorBar.Default.Type">
- <summary>
- The default symbol for drawing at the top and bottom of the
- error bar (see <see cref="P:ZedGraph.ErrorBar.Symbol"/>).
- </summary>
- </member>
- <member name="T:ZedGraph.EllipseObj">
- <summary>
- A class that represents a bordered and/or filled ellipse object on
- the graph. A list of EllipseObj objects is maintained by the
- <see cref="T:ZedGraph.GraphObjList"/> collection class. The ellipse is defined
- as the ellipse that would be contained by the rectangular box as
- defined by the <see cref="T:ZedGraph.Location"/> property.
- </summary>
-
- <author> John Champion </author>
- <version> $Revision: 3.3 $ $Date: 2007-01-25 07:56:08 $ </version>
- </member>
- <member name="T:ZedGraph.BoxObj">
- <summary>
- A class that represents a bordered and/or filled box (rectangle) object on
- the graph. A list of
- BoxObj objects is maintained by the <see cref="T:ZedGraph.GraphObjList"/> collection class.
- </summary>
-
- <author> John Champion </author>
- <version> $Revision: 3.3 $ $Date: 2007-01-25 07:56:08 $ </version>
- </member>
- <member name="F:ZedGraph.BoxObj.schema2">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="F:ZedGraph.BoxObj._fill">
- <summary>
- Private field that stores the <see cref="T:ZedGraph.Fill"/> data for this
- <see cref="T:ZedGraph.BoxObj"/>. Use the public property <see cref="P:ZedGraph.BoxObj.Fill"/> to
- access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.BoxObj._border">
- <summary>
- Private field that determines the properties of the border around this
- <see cref="T:ZedGraph.BoxObj"/>
- Use the public property <see cref="P:ZedGraph.BoxObj.Border"/> to access this value.
- </summary>
- </member>
- <member name="M:ZedGraph.BoxObj.#ctor(System.Double,System.Double,System.Double,System.Double,System.Drawing.Color,System.Drawing.Color)">
- <overloads>Constructors for the <see cref="T:ZedGraph.BoxObj"/> object</overloads>
- <summary>
- A constructor that allows the position, border color, and solid fill color
- of the <see cref="T:ZedGraph.BoxObj"/> to be pre-specified.
- </summary>
- <param name="borderColor">An arbitrary <see cref="T:System.Drawing.Color"/> specification
- for the box border</param>
- <param name="fillColor">An arbitrary <see cref="T:System.Drawing.Color"/> specification
- for the box fill (will be a solid color fill)</param>
- <param name="x">The x location for this <see cref="T:ZedGraph.BoxObj"/>. This will be in units determined by
- <see cref="P:ZedGraph.Location.CoordinateFrame"/>.</param>
- <param name="y">The y location for this <see cref="T:ZedGraph.BoxObj"/>. This will be in units determined by
- <see cref="P:ZedGraph.Location.CoordinateFrame"/>.</param>
- <param name="width">The width of this <see cref="T:ZedGraph.BoxObj"/>. This will be in units determined by
- <see cref="P:ZedGraph.Location.CoordinateFrame"/>.</param>
- <param name="height">The height of this <see cref="T:ZedGraph.BoxObj"/>. This will be in units determined by
- <see cref="P:ZedGraph.Location.CoordinateFrame"/>.</param>
- </member>
- <member name="M:ZedGraph.BoxObj.#ctor(System.Double,System.Double,System.Double,System.Double)">
- <summary>
- A constructor that allows the position
- of the <see cref="T:ZedGraph.BoxObj"/> to be pre-specified. Other properties are defaulted.
- </summary>
- <param name="x">The x location for this <see cref="T:ZedGraph.BoxObj"/>. This will be in units determined by
- <see cref="P:ZedGraph.Location.CoordinateFrame"/>.</param>
- <param name="y">The y location for this <see cref="T:ZedGraph.BoxObj"/>. This will be in units determined by
- <see cref="P:ZedGraph.Location.CoordinateFrame"/>.</param>
- <param name="width">The width of this <see cref="T:ZedGraph.BoxObj"/>. This will be in units determined by
- <see cref="P:ZedGraph.Location.CoordinateFrame"/>.</param>
- <param name="height">The height of this <see cref="T:ZedGraph.BoxObj"/>. This will be in units determined by
- <see cref="P:ZedGraph.Location.CoordinateFrame"/>.</param>
- </member>
- <member name="M:ZedGraph.BoxObj.#ctor">
- <summary>
- A default constructor that creates a <see cref="T:ZedGraph.BoxObj"/> using a location of (0,0),
- and a width,height of (1,1). Other properties are defaulted.
- </summary>
- </member>
- <member name="M:ZedGraph.BoxObj.#ctor(System.Double,System.Double,System.Double,System.Double,System.Drawing.Color,System.Drawing.Color,System.Drawing.Color)">
- <summary>
- A constructor that allows the position, border color, and two-color
- gradient fill colors
- of the <see cref="T:ZedGraph.BoxObj"/> to be pre-specified.
- </summary>
- <param name="borderColor">An arbitrary <see cref="T:System.Drawing.Color"/> specification
- for the box border</param>
- <param name="fillColor1">An arbitrary <see cref="T:System.Drawing.Color"/> specification
- for the start of the box gradient fill</param>
- <param name="fillColor2">An arbitrary <see cref="T:System.Drawing.Color"/> specification
- for the end of the box gradient fill</param>
- <param name="x">The x location for this <see cref="T:ZedGraph.BoxObj"/>. This will be in units determined by
- <see cref="P:ZedGraph.Location.CoordinateFrame"/>.</param>
- <param name="y">The y location for this <see cref="T:ZedGraph.BoxObj"/>. This will be in units determined by
- <see cref="P:ZedGraph.Location.CoordinateFrame"/>.</param>
- <param name="width">The width of this <see cref="T:ZedGraph.BoxObj"/>. This will be in units determined by
- <see cref="P:ZedGraph.Location.CoordinateFrame"/>.</param>
- <param name="height">The height of this <see cref="T:ZedGraph.BoxObj"/>. This will be in units determined by
- <see cref="P:ZedGraph.Location.CoordinateFrame"/>.</param>
- </member>
- <member name="M:ZedGraph.BoxObj.#ctor(ZedGraph.BoxObj)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.BoxObj"/> object from which to copy</param>
- </member>
- <member name="M:ZedGraph.BoxObj.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.BoxObj.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.BoxObj.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.BoxObj.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.BoxObj.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.BoxObj.Draw(System.Drawing.Graphics,ZedGraph.PaneBase,System.Single)">
- <summary>
- Render this object to the specified <see cref="T:System.Drawing.Graphics"/> device.
- </summary>
- <remarks>
- This method is normally only called by the Draw method
- of the parent <see cref="T:ZedGraph.GraphObjList"/> collection object.
- </remarks>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.PaneBase"/> object that is the parent or
- owner of this object.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.BoxObj.PointInBox(System.Drawing.PointF,ZedGraph.PaneBase,System.Drawing.Graphics,System.Single)">
- <summary>
- Determine if the specified screen point lies inside the bounding box of this
- <see cref="T:ZedGraph.BoxObj"/>.
- </summary>
- <param name="pt">The screen point, in pixels</param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.PaneBase"/> object that is the parent or
- owner of this object.
- </param>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <returns>true if the point lies in the bounding box, false otherwise</returns>
- </member>
- <member name="M:ZedGraph.BoxObj.GetCoords(ZedGraph.PaneBase,System.Drawing.Graphics,System.Single,System.String@,System.String@)">
- <summary>
- Determines the shape type and Coords values for this GraphObj
- </summary>
- </member>
- <member name="P:ZedGraph.BoxObj.Fill">
- <summary>
- Gets or sets the <see cref="T:ZedGraph.Fill"/> data for this
- <see cref="T:ZedGraph.BoxObj"/>.
- </summary>
- </member>
- <member name="P:ZedGraph.BoxObj.Border">
- <summary>
- Gets or sets the <see cref="T:ZedGraph.Border"/> object, which
- determines the properties of the border around this
- <see cref="T:ZedGraph.BoxObj"/>
- </summary>
- </member>
- <member name="T:ZedGraph.BoxObj.Default">
- <summary>
- A simple struct that defines the
- default property values for the <see cref="T:ZedGraph.ArrowObj"/> class.
- </summary>
- </member>
- <member name="F:ZedGraph.BoxObj.Default.PenWidth">
- <summary>
- The default pen width used for the <see cref="T:ZedGraph.BoxObj"/> border
- (<see cref="P:ZedGraph.LineBase.Width"/> property). Units are points (1/72 inch).
- </summary>
- </member>
- <member name="F:ZedGraph.BoxObj.Default.BorderColor">
- <summary>
- The default color used for the <see cref="T:ZedGraph.BoxObj"/> border
- (<see cref="P:ZedGraph.LineBase.Color"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.BoxObj.Default.FillColor">
- <summary>
- The default color used for the <see cref="T:ZedGraph.BoxObj"/> fill
- (<see cref="P:ZedGraph.Fill.Color"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.EllipseObj.schema3">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="M:ZedGraph.EllipseObj.#ctor(System.Double,System.Double,System.Double,System.Double)">
- <overloads>Constructors for the <see cref="T:ZedGraph.EllipseObj"/> object</overloads>
- <summary>
- A constructor that allows the position and size
- of the <see cref="T:ZedGraph.EllipseObj"/> to be pre-specified. Other properties are defaulted.
- </summary>
- <param name="x">The x location for this <see cref="T:ZedGraph.BoxObj"/>. This will be in units determined by
- <see cref="P:ZedGraph.Location.CoordinateFrame"/>.</param>
- <param name="y">The y location for this <see cref="T:ZedGraph.BoxObj"/>. This will be in units determined by
- <see cref="P:ZedGraph.Location.CoordinateFrame"/>.</param>
- <param name="width">The width of this <see cref="T:ZedGraph.BoxObj"/>. This will be in units determined by
- <see cref="P:ZedGraph.Location.CoordinateFrame"/>.</param>
- <param name="height">The height of this <see cref="T:ZedGraph.BoxObj"/>. This will be in units determined by
- <see cref="P:ZedGraph.Location.CoordinateFrame"/>.</param>
- </member>
- <member name="M:ZedGraph.EllipseObj.#ctor">
- <summary>
- A default constructor that places the <see cref="T:ZedGraph.EllipseObj"/> at location (0,0),
- with width/height of (1,1). Other properties are defaulted.
- </summary>
- </member>
- <member name="M:ZedGraph.EllipseObj.#ctor(System.Double,System.Double,System.Double,System.Double,System.Drawing.Color,System.Drawing.Color)">
- <summary>
- A constructor that allows the position, border color, and solid fill color
- of the <see cref="T:ZedGraph.EllipseObj"/> to be pre-specified.
- </summary>
- <param name="borderColor">An arbitrary <see cref="T:System.Drawing.Color"/> specification
- for the ellipse border</param>
- <param name="fillColor">An arbitrary <see cref="T:System.Drawing.Color"/> specification
- for the ellipse fill (will be a solid color fill)</param>
- <param name="x">The x location for this <see cref="T:ZedGraph.BoxObj"/>. This will be in units determined by
- <see cref="P:ZedGraph.Location.CoordinateFrame"/>.</param>
- <param name="y">The y location for this <see cref="T:ZedGraph.BoxObj"/>. This will be in units determined by
- <see cref="P:ZedGraph.Location.CoordinateFrame"/>.</param>
- <param name="width">The width of this <see cref="T:ZedGraph.BoxObj"/>. This will be in units determined by
- <see cref="P:ZedGraph.Location.CoordinateFrame"/>.</param>
- <param name="height">The height of this <see cref="T:ZedGraph.BoxObj"/>. This will be in units determined by
- <see cref="P:ZedGraph.Location.CoordinateFrame"/>.</param>
- </member>
- <member name="M:ZedGraph.EllipseObj.#ctor(System.Double,System.Double,System.Double,System.Double,System.Drawing.Color,System.Drawing.Color,System.Drawing.Color)">
- <summary>
- A constructor that allows the position, border color, and two-color
- gradient fill colors
- of the <see cref="T:ZedGraph.EllipseObj"/> to be pre-specified.
- </summary>
- <param name="borderColor">An arbitrary <see cref="T:System.Drawing.Color"/> specification
- for the ellipse border</param>
- <param name="fillColor1">An arbitrary <see cref="T:System.Drawing.Color"/> specification
- for the start of the ellipse gradient fill</param>
- <param name="fillColor2">An arbitrary <see cref="T:System.Drawing.Color"/> specification
- for the end of the ellipse gradient fill</param>
- <param name="x">The x location for this <see cref="T:ZedGraph.BoxObj"/>. This will be in units determined by
- <see cref="P:ZedGraph.Location.CoordinateFrame"/>.</param>
- <param name="y">The y location for this <see cref="T:ZedGraph.BoxObj"/>. This will be in units determined by
- <see cref="P:ZedGraph.Location.CoordinateFrame"/>.</param>
- <param name="width">The width of this <see cref="T:ZedGraph.BoxObj"/>. This will be in units determined by
- <see cref="P:ZedGraph.Location.CoordinateFrame"/>.</param>
- <param name="height">The height of this <see cref="T:ZedGraph.BoxObj"/>. This will be in units determined by
- <see cref="P:ZedGraph.Location.CoordinateFrame"/>.</param>
- </member>
- <member name="M:ZedGraph.EllipseObj.#ctor(ZedGraph.BoxObj)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.EllipseObj"/> object from
- which to copy</param>
- </member>
- <member name="M:ZedGraph.EllipseObj.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.EllipseObj.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.EllipseObj.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.EllipseObj.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.EllipseObj.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.EllipseObj.Draw(System.Drawing.Graphics,ZedGraph.PaneBase,System.Single)">
- <summary>
- Render this object to the specified <see cref="T:System.Drawing.Graphics"/> device.
- </summary>
- <remarks>
- This method is normally only called by the Draw method
- of the parent <see cref="T:ZedGraph.GraphObjList"/> collection object.
- </remarks>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.PaneBase"/> object that is the parent or
- owner of this object.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.EllipseObj.PointInBox(System.Drawing.PointF,ZedGraph.PaneBase,System.Drawing.Graphics,System.Single)">
- <summary>
- Determine if the specified screen point lies inside the bounding box of this
- <see cref="T:ZedGraph.BoxObj"/>.
- </summary>
- <param name="pt">The screen point, in pixels</param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.PaneBase"/> object that is the parent or
- owner of this object.
- </param>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <returns>true if the point lies in the bounding box, false otherwise</returns>
- </member>
- <member name="T:ZedGraph.BarSettings">
- <summary>
- Class that handles the global settings for bar charts
- </summary>
-
- <author> John Champion </author>
- <version> $Revision: 3.6 $ $Date: 2007-12-30 23:27:39 $ </version>
- </member>
- <member name="F:ZedGraph.BarSettings.schema">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="F:ZedGraph.BarSettings._minClusterGap">
- <summary>Private field that determines the size of the gap between bar clusters
- for bar charts. This gap is expressed as a fraction of the bar size (1.0 means
- leave a 1-barwidth gap between clusters).
- Use the public property <see cref="P:ZedGraph.BarSettings.MinClusterGap"/> to access this value. </summary>
- </member>
- <member name="F:ZedGraph.BarSettings._minBarGap">
- <summary>Private field that determines the size of the gap between individual bars
- within a bar cluster for bar charts. This gap is expressed as a fraction of the
- bar size (1.0 means leave a 1-barwidth gap between each bar).
- Use the public property <see cref="P:ZedGraph.BarSettings.MinBarGap"/> to access this value. </summary>
- </member>
- <member name="F:ZedGraph.BarSettings._base">
- <summary>Private field that determines the base axis from which <see cref="T:ZedGraph.Bar"/>
- graphs will be displayed. The base axis is the axis from which the bars grow with
- increasing value. The value is of the enumeration type <see cref="T:ZedGraph.BarBase"/>.
- To access this value, use the public property <see cref="P:ZedGraph.BarSettings.Base"/>.
- </summary>
- <seealso cref="F:ZedGraph.BarSettings.Default.Base"/>
- </member>
- <member name="F:ZedGraph.BarSettings._type">
- <summary>Private field that determines how the <see cref="T:ZedGraph.BarItem"/>
- graphs will be displayed. See the <see cref="T:ZedGraph.BarType"/> enum
- for the individual types available.
- To access this value, use the public property <see cref="P:ZedGraph.BarSettings.Type"/>.
- </summary>
- <seealso cref="F:ZedGraph.BarSettings.Default.Type"/>
- </member>
- <member name="F:ZedGraph.BarSettings._clusterScaleWidth">
- <summary>Private field that determines the width of a bar cluster (for bar charts)
- in user scale units. Normally, this value is 1.0 because bar charts are typically
- <see cref="F:ZedGraph.AxisType.Ordinal"/> or <see cref="F:ZedGraph.AxisType.Text"/>, and the bars are
- defined at ordinal values (1.0 scale units apart). For <see cref="F:ZedGraph.AxisType.Linear"/>
- or other scale types, you can use this value to scale the bars to an arbitrary
- user scale. Use the public property <see cref="P:ZedGraph.BarSettings.ClusterScaleWidth"/> to access this
- value. </summary>
- </member>
- <member name="F:ZedGraph.BarSettings._clusterScaleWidthAuto">
- <summary>
- Private field that determines if the <see cref="P:ZedGraph.BarSettings.ClusterScaleWidth"/> will be
- calculated automatically. Use the public property <see cref="P:ZedGraph.BarSettings.ClusterScaleWidthAuto"/>
- to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.BarSettings._ownerPane">
- <summary>
- private field that stores the owner GraphPane that contains this BarSettings instance.
- </summary>
- </member>
- <member name="M:ZedGraph.BarSettings.#ctor(ZedGraph.GraphPane)">
- <summary>
- Constructor to build a <see cref="T:ZedGraph.BarSettings"/> instance from the defaults.
- </summary>
- </member>
- <member name="M:ZedGraph.BarSettings.#ctor(ZedGraph.BarSettings,ZedGraph.GraphPane)">
- <summary>
- Copy constructor
- </summary>
- <param name="rhs">the <see cref="T:ZedGraph.BarSettings"/> instance to be copied.</param>
- <param name="parentPane">The <see cref="T:ZedGraph.GraphPane"/> that will be the
- parent of this new BarSettings object.</param>
- </member>
- <member name="M:ZedGraph.BarSettings.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <remarks>
- You MUST set the _ownerPane property after deserializing a BarSettings object.
- </remarks>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the
- serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains
- the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.BarSettings.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.BarSettings.CalcClusterScaleWidth">
- <summary>
- Calculate the width of an individual bar cluster on a <see cref="T:ZedGraph.BarItem"/> graph.
- This value only applies to bar graphs plotted on non-ordinal X axis
- types (<see cref="P:ZedGraph.Scale.IsAnyOrdinal"/> is false).
- </summary>
- <remarks>
- This value can be calculated automatically if <see cref="P:ZedGraph.BarSettings.ClusterScaleWidthAuto"/>
- is set to true. In this case, ClusterScaleWidth will be calculated if
- <see cref="P:ZedGraph.BarSettings.Base"/> refers to an <see cref="T:ZedGraph.Axis"/> of a non-ordinal type
- (<see cref="P:ZedGraph.Scale.IsAnyOrdinal"/> is false). The ClusterScaleWidth is calculated
- from the minimum difference found between any two points on the <see cref="P:ZedGraph.BarSettings.Base"/>
- <see cref="T:ZedGraph.Axis"/> for any <see cref="T:ZedGraph.BarItem"/> in the
- <see cref="P:ZedGraph.GraphPane.CurveList"/>. The ClusterScaleWidth is set automatically
- each time <see cref="M:ZedGraph.GraphPane.AxisChange"/> is called.
- </remarks>
- <seealso cref="F:ZedGraph.BarSettings.Default.ClusterScaleWidth"/>
- <seealso cref="P:ZedGraph.BarSettings.ClusterScaleWidthAuto"/>
- <seealso cref="P:ZedGraph.BarSettings.MinBarGap"/>
- <seealso cref="P:ZedGraph.BarSettings.MinClusterGap"/>
- </member>
- <member name="M:ZedGraph.BarSettings.GetMinStepSize(ZedGraph.IPointList,ZedGraph.Axis)">
- <summary>
- Determine the minimum increment between individual points to be used for
- calculating a bar size that fits without overlapping
- </summary>
- <param name="list">The <see cref="T:ZedGraph.IPointList"/> list of points for the bar
- of interest</param>
- <param name="baseAxis">The base axis for the bar</param>
- <returns>The minimum increment between bars along the base axis</returns>
- </member>
- <member name="M:ZedGraph.BarSettings.GetClusterWidth">
- <summary>
- Determine the width, in screen pixel units, of each bar cluster including
- the cluster gaps and bar gaps.
- </summary>
- <remarks>This method calls the <see cref="M:ZedGraph.Scale.GetClusterWidth(ZedGraph.GraphPane)"/>
- method for the base <see cref="T:ZedGraph.Axis"/> for <see cref="T:ZedGraph.Bar"/> graphs
- (the base <see cref="T:ZedGraph.Axis"/> is assigned by the <see cref="P:ZedGraph.BarSettings.Base"/>
- property).
- </remarks>
- <seealso cref="T:ZedGraph.BarBase"/>
- <seealso cref="T:ZedGraph.BarSettings"/>
- <seealso cref="M:ZedGraph.Scale.GetClusterWidth(ZedGraph.GraphPane)"/>
- <seealso cref="P:ZedGraph.BarSettings.Type"/>
- <returns>The width of each bar cluster, in pixel units</returns>
- </member>
- <member name="M:ZedGraph.BarSettings.BarBaseAxis">
- <summary>
- Determine the <see cref="T:ZedGraph.Axis"/> from which the <see cref="T:ZedGraph.Bar"/> charts are based.
- </summary>
- <seealso cref="T:ZedGraph.BarBase"/>
- <seealso cref="T:ZedGraph.BarSettings"/>
- <seealso cref="P:ZedGraph.BarSettings.Base"/>
- <seealso cref="M:ZedGraph.Scale.GetClusterWidth(ZedGraph.GraphPane)"/>
- <returns>The <see cref="T:ZedGraph.Axis"/> class for the axis from which the bars are based</returns>
- </member>
- <member name="P:ZedGraph.BarSettings.MinClusterGap">
- <summary>
- The minimum space between <see cref="T:ZedGraph.Bar"/> clusters, expressed as a
- fraction of the bar size.
- </summary>
- <seealso cref="F:ZedGraph.BarSettings.Default.MinClusterGap"/>
- <seealso cref="P:ZedGraph.BarSettings.MinBarGap"/>
- <seealso cref="P:ZedGraph.BarSettings.ClusterScaleWidth"/>
- </member>
- <member name="P:ZedGraph.BarSettings.MinBarGap">
- <summary>
- The minimum space between individual <see cref="T:ZedGraph.Bar">Bars</see>
- within a cluster, expressed as a
- fraction of the bar size.
- </summary>
- <seealso cref="F:ZedGraph.BarSettings.Default.MinBarGap"/>
- <seealso cref="P:ZedGraph.BarSettings.MinClusterGap"/>
- <seealso cref="P:ZedGraph.BarSettings.ClusterScaleWidth"/>
- </member>
- <member name="P:ZedGraph.BarSettings.Base">
- <summary>Determines the base axis from which <see cref="T:ZedGraph.Bar"/>
- graphs will be displayed.
- </summary>
- <remarks>The base axis is the axis from which the bars grow with
- increasing value. The value is of the enumeration type <see cref="T:ZedGraph.BarBase"/>.
- </remarks>
- <seealso cref="F:ZedGraph.BarSettings.Default.Base"/>
- </member>
- <member name="P:ZedGraph.BarSettings.Type">
- <summary>Determines how the <see cref="T:ZedGraph.BarItem"/>
- graphs will be displayed. See the <see cref="T:ZedGraph.BarType"/> enum
- for the individual types available.
- </summary>
- <seealso cref="F:ZedGraph.BarSettings.Default.Type"/>
- </member>
- <member name="P:ZedGraph.BarSettings.ClusterScaleWidth">
- <summary>
- The width of an individual bar cluster on a <see cref="T:ZedGraph.Bar"/> graph.
- This value only applies to bar graphs plotted on non-ordinal X axis
- types (<see cref="F:ZedGraph.AxisType.Linear"/>, <see cref="F:ZedGraph.AxisType.Log"/>, and
- <see cref="F:ZedGraph.AxisType.Date"/>.
- </summary>
- <remarks>
- This value can be calculated automatically if <see cref="P:ZedGraph.BarSettings.ClusterScaleWidthAuto"/>
- is set to true. In this case, ClusterScaleWidth will be calculated if
- <see cref="P:ZedGraph.BarSettings.Base"/> refers to an <see cref="T:ZedGraph.Axis"/> of a non-ordinal type
- (<see cref="P:ZedGraph.Scale.IsAnyOrdinal"/> is false). The ClusterScaleWidth is calculated
- from the minimum difference found between any two points on the <see cref="P:ZedGraph.BarSettings.Base"/>
- <see cref="T:ZedGraph.Axis"/> for any <see cref="T:ZedGraph.BarItem"/> in the
- <see cref="P:ZedGraph.GraphPane.CurveList"/>. The ClusterScaleWidth is set automatically
- each time <see cref="M:ZedGraph.GraphPane.AxisChange"/> is called. Calculations are
- done by the <see cref="M:ZedGraph.BarSettings.CalcClusterScaleWidth"/> method.
- </remarks>
- <seealso cref="F:ZedGraph.BarSettings.Default.ClusterScaleWidth"/>
- <seealso cref="P:ZedGraph.BarSettings.ClusterScaleWidthAuto"/>
- <seealso cref="P:ZedGraph.BarSettings.MinBarGap"/>
- <seealso cref="P:ZedGraph.BarSettings.MinClusterGap"/>
- </member>
- <member name="P:ZedGraph.BarSettings.ClusterScaleWidthAuto">
- <summary>
- Gets or sets a property that determines if the <see cref="P:ZedGraph.BarSettings.ClusterScaleWidth"/> will be
- calculated automatically.
- </summary>
- <remarks>true for the <see cref="P:ZedGraph.BarSettings.ClusterScaleWidth"/> to be calculated
- automatically based on the available data, false otherwise. This value will
- be set to false automatically if the <see cref="P:ZedGraph.BarSettings.ClusterScaleWidth"/> value
- is changed by the user.
- </remarks>
- <seealso cref="F:ZedGraph.BarSettings.Default.ClusterScaleWidthAuto"/>
- <seealso cref="P:ZedGraph.BarSettings.ClusterScaleWidth"/>
- </member>
- <member name="T:ZedGraph.BarSettings.Default">
- <summary>
- A simple struct that defines the
- default property values for the <see cref="T:ZedGraph.BarSettings"/> class.
- </summary>
- </member>
- <member name="F:ZedGraph.BarSettings.Default.MinClusterGap">
- <summary>
- The default dimension gap between clusters of bars on a
- <see cref="T:ZedGraph.Bar"/> graph.
- This dimension is expressed in terms of the normal bar width.
- </summary>
- <seealso cref="F:ZedGraph.BarSettings.Default.MinBarGap"/>
- <seealso cref="P:ZedGraph.BarSettings.MinClusterGap"/>
- </member>
- <member name="F:ZedGraph.BarSettings.Default.MinBarGap">
- <summary>
- The default dimension gap between each individual bar within a bar cluster
- on a <see cref="T:ZedGraph.Bar"/> graph.
- This dimension is expressed in terms of the normal bar width.
- </summary>
- <seealso cref="F:ZedGraph.BarSettings.Default.MinClusterGap"/>
- <seealso cref="P:ZedGraph.BarSettings.MinBarGap"/>
- </member>
- <member name="F:ZedGraph.BarSettings.Default.Base">
- <summary>The default value for the <see cref="P:ZedGraph.BarSettings.Base"/>, which determines the base
- <see cref="T:ZedGraph.Axis"/> from which the <see cref="T:ZedGraph.Bar"/> graphs will be displayed.
- </summary>
- <seealso cref="P:ZedGraph.BarSettings.Base"/>
- </member>
- <member name="F:ZedGraph.BarSettings.Default.Type">
- <summary>The default value for the <see cref="P:ZedGraph.BarSettings.Type"/> property, which
- determines if the bars are drawn overlapping eachother in a "stacked" format,
- or side-by-side in a "cluster" format. See the <see cref="T:ZedGraph.BarType"/>
- for more information.
- </summary>
- <seealso cref="P:ZedGraph.BarSettings.Type"/>
- </member>
- <member name="F:ZedGraph.BarSettings.Default.ClusterScaleWidth">
- <summary>
- The default width of a bar cluster
- on a <see cref="T:ZedGraph.Bar"/> graph. This value only applies to
- <see cref="T:ZedGraph.Bar"/> graphs, and only when the
- <see cref="P:ZedGraph.Axis.Type"/> is <see cref="F:ZedGraph.AxisType.Linear"/>,
- <see cref="F:ZedGraph.AxisType.Log"/> or <see cref="F:ZedGraph.AxisType.Date"/>.
- This dimension is expressed in terms of X scale user units.
- </summary>
- <seealso cref="F:ZedGraph.BarSettings.Default.MinClusterGap"/>
- <seealso cref="P:ZedGraph.BarSettings.MinBarGap"/>
- </member>
- <member name="F:ZedGraph.BarSettings.Default.ClusterScaleWidthAuto">
- <summary>
- The default value for <see cref="P:ZedGraph.BarSettings.ClusterScaleWidthAuto"/>.
- </summary>
- </member>
- <member name="T:ZedGraph.AxisLabel">
- <summary>
- Class that handles the data associated with text title and its associated font
- properties. Inherits from <see cref="T:ZedGraph.Label"/>, and adds <see cref="P:ZedGraph.AxisLabel.IsOmitMag"/>
- and <see cref="P:ZedGraph.AxisLabel.IsTitleAtCross"/> properties, which are specifically associated with
- the <see cref="T:ZedGraph.Axis"/> <see cref="P:ZedGraph.Axis.Title"/>.
- </summary>
-
- <author> John Champion </author>
- <version> $Revision: 3.1 $ $Date: 2006-06-24 20:26:44 $ </version>
- </member>
- <member name="F:ZedGraph.AxisLabel.schema3">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="M:ZedGraph.AxisLabel.#ctor(System.String,System.String,System.Single,System.Drawing.Color,System.Boolean,System.Boolean,System.Boolean)">
- <summary>
- Constructor to build an <see cref="T:ZedGraph.AxisLabel"/> from the text and the
- associated font properties.
- </summary>
- <param name="text">The <see cref="T:System.String"/> representing the text to be
- displayed</param>
- <param name="fontFamily">The <see cref="T:System.String"/> font family name</param>
- <param name="fontSize">The size of the font in points and scaled according
- to the <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> logic.</param>
- <param name="color">The <see cref="T:System.Drawing.Color"/> instance representing the color
- of the font</param>
- <param name="isBold">true for a bold font face</param>
- <param name="isItalic">true for an italic font face</param>
- <param name="isUnderline">true for an underline font face</param>
- </member>
- <member name="M:ZedGraph.AxisLabel.#ctor(ZedGraph.AxisLabel)">
- <summary>
- Copy constructor
- </summary>
- <param name="rhs">the <see cref="T:ZedGraph.AxisLabel"/> instance to be copied.</param>
- </member>
- <member name="M:ZedGraph.AxisLabel.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.AxisLabel.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.AxisLabel.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.AxisLabel.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.AxisLabel.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="P:ZedGraph.AxisLabel.IsOmitMag">
- <summary>
- Gets or sets the property that controls whether or not the magnitude factor (power of 10) for
- this scale will be included in the label.
- </summary>
- <remarks>
- For large scale values, a "magnitude" value (power of 10) is automatically
- used for scaling the graph. This magnitude value is automatically appended
- to the end of the Axis <see cref="P:ZedGraph.Axis.Title"/> (e.g., "(10^4)") to indicate
- that a magnitude is in use. This property controls whether or not the
- magnitude is included in the title. Note that it only affects the axis
- title; a magnitude value may still be used even if it is not shown in the title.
- </remarks>
- <value>true to show the magnitude value, false to hide it</value>
- <seealso cref="P:ZedGraph.Axis.Title"/>
- <seealso cref="P:ZedGraph.Scale.Mag"/>
- <seealso cref="P:ZedGraph.Scale.Format"/>
- </member>
- <member name="P:ZedGraph.AxisLabel.IsTitleAtCross">
- <summary>
- Gets or sets a value that determines whether the Axis title is located at the
- <see cref="P:ZedGraph.Axis.Cross"/>
- value or at the normal position (outside the <see cref="P:ZedGraph.Chart.Rect"/>).
- </summary>
- <remarks>
- This value only applies if <see cref="P:ZedGraph.Axis.CrossAuto"/> is false.
- </remarks>
- </member>
- <member name="T:ZedGraph.PolyObj">
- <summary>
- A class that represents a bordered and/or filled polygon object on
- the graph. A list of <see cref="T:ZedGraph.PolyObj"/> objects is maintained by
- the <see cref="T:ZedGraph.GraphObjList"/> collection class.
- </summary>
-
- <author> John Champion </author>
- <version> $Revision: 3.4 $ $Date: 2007-01-25 07:56:09 $ </version>
- </member>
- <member name="F:ZedGraph.PolyObj.schema3">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="F:ZedGraph.PolyObj._isClosedFigure">
- <summary>
- private value that determines if the polygon will be automatically closed.
- true to close the figure, false to leave it "open." Use the public property
- <see cref="P:ZedGraph.PolyObj.IsClosedFigure"/> to access this value.
- </summary>
- </member>
- <member name="M:ZedGraph.PolyObj.#ctor(ZedGraph.PointD[],System.Drawing.Color,System.Drawing.Color)">
- <overloads>Constructors for the <see cref="T:ZedGraph.PolyObj"/> object</overloads>
- <summary>
- A constructor that allows the position, border color, and solid fill color
- of the <see cref="T:ZedGraph.PolyObj"/> to be pre-specified.
- </summary>
- <param name="borderColor">An arbitrary <see cref="T:System.Drawing.Color"/> specification
- for the box border</param>
- <param name="fillColor">An arbitrary <see cref="T:System.Drawing.Color"/> specification
- for the box fill (will be a solid color fill)</param>
- <param name="points">The <see cref="T:ZedGraph.PointD"/> array that defines
- the polygon. This will be in units determined by
- <see cref="P:ZedGraph.Location.CoordinateFrame"/>.
- </param>
- </member>
- <member name="M:ZedGraph.PolyObj.#ctor(ZedGraph.PointD[])">
- <summary>
- A constructor that allows the position
- of the <see cref="T:ZedGraph.PolyObj"/> to be pre-specified. Other properties are defaulted.
- </summary>
- <param name="points">The <see cref="T:ZedGraph.PointD"/> array that defines
- the polygon. This will be in units determined by
- <see cref="P:ZedGraph.Location.CoordinateFrame"/>.
- </param>
- </member>
- <member name="M:ZedGraph.PolyObj.#ctor">
- <summary>
- A default constructor that creates a <see cref="T:ZedGraph.PolyObj"/> from an empty
- <see cref="T:ZedGraph.PointD"/> array. Other properties are defaulted.
- </summary>
- </member>
- <member name="M:ZedGraph.PolyObj.#ctor(ZedGraph.PointD[],System.Drawing.Color,System.Drawing.Color,System.Drawing.Color)">
- <summary>
- A constructor that allows the position, border color, and two-color
- gradient fill colors
- of the <see cref="T:ZedGraph.PolyObj"/> to be pre-specified.
- </summary>
- <param name="borderColor">An arbitrary <see cref="T:System.Drawing.Color"/> specification
- for the box border</param>
- <param name="fillColor1">An arbitrary <see cref="T:System.Drawing.Color"/> specification
- for the start of the box gradient fill</param>
- <param name="fillColor2">An arbitrary <see cref="T:System.Drawing.Color"/> specification
- for the end of the box gradient fill</param>
- <param name="points">The <see cref="T:ZedGraph.PointD"/> array that defines
- the polygon. This will be in units determined by
- <see cref="P:ZedGraph.Location.CoordinateFrame"/>.
- </param>
- </member>
- <member name="M:ZedGraph.PolyObj.#ctor(ZedGraph.PolyObj)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.PolyObj"/> object from which to copy</param>
- </member>
- <member name="M:ZedGraph.PolyObj.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.PolyObj.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.PolyObj.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.PolyObj.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.PolyObj.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.PolyObj.Draw(System.Drawing.Graphics,ZedGraph.PaneBase,System.Single)">
- <summary>
- Render this object to the specified <see cref="T:System.Drawing.Graphics"/> device.
- </summary>
- <remarks>
- This method is normally only called by the Draw method
- of the parent <see cref="T:ZedGraph.GraphObjList"/> collection object.
- </remarks>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.PaneBase"/> object that is the parent or
- owner of this object.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.PolyObj.PointInBox(System.Drawing.PointF,ZedGraph.PaneBase,System.Drawing.Graphics,System.Single)">
- <summary>
- Determine if the specified screen point lies inside the bounding box of this
- <see cref="T:ZedGraph.PolyObj"/>.
- </summary>
- <param name="pt">The screen point, in pixels</param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.PaneBase"/> object that is the parent or
- owner of this object.
- </param>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <returns>true if the point lies in the bounding box, false otherwise</returns>
- </member>
- <member name="P:ZedGraph.PolyObj.Points">
- <summary>
- Gets or sets the <see cref="T:ZedGraph.PointD"/> array that defines
- the polygon. This will be in units determined by
- <see cref="P:ZedGraph.Location.CoordinateFrame"/>.
- </summary>
- </member>
- <member name="P:ZedGraph.PolyObj.IsClosedFigure">
- <summary>
- Gets or sets a value that determines if the polygon will be automatically closed.
- true to close the figure, false to leave it "open."
- </summary>
- <remarks>
- This boolean determines whether or not the CloseFigure() method will be called
- to fully close the path of the polygon. This value defaults to true, and for any
- closed figure it should fine. If you want to draw a line that does not close into
- a shape, then you should set this value to false. For a figure that is naturally
- closed (e.g., the first point of the polygon is the same as the last point),
- leaving this value set to false may result in minor pixel artifacts due to
- rounding.
- </remarks>
- </member>
- <member name="T:ZedGraph.LinearScale">
- <summary>
- The LinearScale class inherits from the <see cref="T:ZedGraph.Scale"/> class, and implements
- the features specific to <see cref="F:ZedGraph.AxisType.Linear"/>.
- </summary>
- <remarks>
- LinearScale is the normal, default cartesian axis.
- </remarks>
-
- <author> John Champion </author>
- <version> $Revision: 1.10 $ $Date: 2007-04-16 00:03:02 $ </version>
- </member>
- <member name="F:ZedGraph.LinearScale.schema2">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="M:ZedGraph.LinearScale.#ctor(ZedGraph.Axis)">
- <summary>
- Default constructor that defines the owner <see cref="T:ZedGraph.Axis"/>
- (containing object) for this new object.
- </summary>
- <param name="owner">The owner, or containing object, of this instance</param>
- </member>
- <member name="M:ZedGraph.LinearScale.#ctor(ZedGraph.Scale,ZedGraph.Axis)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.LinearScale"/> object from which to copy</param>
- <param name="owner">The <see cref="T:ZedGraph.Axis"/> object that will own the
- new instance of <see cref="T:ZedGraph.LinearScale"/></param>
- </member>
- <member name="M:ZedGraph.LinearScale.Clone(ZedGraph.Axis)">
- <summary>
- Create a new clone of the current item, with a new owner assignment
- </summary>
- <param name="owner">The new <see cref="T:ZedGraph.Axis"/> instance that will be
- the owner of the new Scale</param>
- <returns>A new <see cref="T:ZedGraph.Scale"/> clone.</returns>
- </member>
- <member name="M:ZedGraph.LinearScale.PickScale(ZedGraph.GraphPane,System.Drawing.Graphics,System.Single)">
- <summary>
- Select a reasonable linear axis scale given a range of data values.
- </summary>
- <remarks>
- This method only applies to <see cref="F:ZedGraph.AxisType.Linear"/> type axes, and it
- is called by the general <see cref="M:ZedGraph.Scale.PickScale(ZedGraph.GraphPane,System.Drawing.Graphics,System.Single)"/> method. The scale range is chosen
- based on increments of 1, 2, or 5 (because they are even divisors of 10). This
- method honors the <see cref="P:ZedGraph.Scale.MinAuto"/>, <see cref="P:ZedGraph.Scale.MaxAuto"/>,
- and <see cref="P:ZedGraph.Scale.MajorStepAuto"/> autorange settings.
- In the event that any of the autorange settings are false, the
- corresponding <see cref="P:ZedGraph.Scale.Min"/>, <see cref="P:ZedGraph.Scale.Max"/>, or <see cref="P:ZedGraph.Scale.MajorStep"/>
- setting is explicitly honored, and the remaining autorange settings (if any) will
- be calculated to accomodate the non-autoranged values. The basic defaults for
- scale selection are defined using <see cref="F:ZedGraph.Scale.Default.ZeroLever"/>,
- <see cref="F:ZedGraph.Scale.Default.TargetXSteps"/>, and <see cref="F:ZedGraph.Scale.Default.TargetYSteps"/>
- from the <see cref="T:ZedGraph.Scale.Default"/> default class.
- <para>On Exit:</para>
- <para><see cref="P:ZedGraph.Scale.Min"/> is set to scale minimum (if <see cref="P:ZedGraph.Scale.MinAuto"/> = true)</para>
- <para><see cref="P:ZedGraph.Scale.Max"/> is set to scale maximum (if <see cref="P:ZedGraph.Scale.MaxAuto"/> = true)</para>
- <para><see cref="P:ZedGraph.Scale.MajorStep"/> is set to scale step size (if <see cref="P:ZedGraph.Scale.MajorStepAuto"/> = true)</para>
- <para><see cref="P:ZedGraph.Scale.MinorStep"/> is set to scale minor step size (if <see cref="P:ZedGraph.Scale.MinorStepAuto"/> = true)</para>
- <para><see cref="P:ZedGraph.Scale.Mag"/> is set to a magnitude multiplier according to the data</para>
- <para><see cref="P:ZedGraph.Scale.Format"/> is set to the display format for the values (this controls the
- number of decimal places, whether there are thousands separators, currency types, etc.)</para>
- </remarks>
- <param name="pane">A reference to the <see cref="T:ZedGraph.GraphPane"/> object
- associated with this <see cref="T:ZedGraph.Axis"/></param>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <seealso cref="M:ZedGraph.LinearScale.PickScale(ZedGraph.GraphPane,System.Drawing.Graphics,System.Single)"/>
- <seealso cref="F:ZedGraph.AxisType.Linear"/>
- </member>
- <member name="M:ZedGraph.LinearScale.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.LinearScale.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="P:ZedGraph.LinearScale.Type">
- <summary>
- Return the <see cref="T:ZedGraph.AxisType"/> for this <see cref="T:ZedGraph.Scale"/>, which is
- <see cref="F:ZedGraph.AxisType.Linear"/>.
- </summary>
- </member>
- <member name="T:ZedGraph.ImageObj">
- <summary>
- A class that represents an image object on the graph. A list of
- <see cref="T:ZedGraph.GraphObj"/> objects is maintained by the <see cref="T:ZedGraph.GraphObjList"/>
- collection class.
- </summary>
-
- <author> John Champion </author>
- <version> $Revision: 3.2 $ $Date: 2006-09-09 17:32:01 $ </version>
- </member>
- <member name="F:ZedGraph.ImageObj.schema2">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="F:ZedGraph.ImageObj._image">
- <summary>
- Private field that stores the image. Use the public property <see cref="P:ZedGraph.ImageObj.Image"/>
- to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.ImageObj._isScaled">
- <summary>
- Private field that determines if the image will be scaled to the output rectangle.
- </summary>
- <value>true to scale the image, false to draw the image unscaled, but clipped
- to the destination rectangle</value>
- </member>
- <member name="M:ZedGraph.ImageObj.#ctor">
- <overloads>Constructors for the <see cref="T:ZedGraph.ImageObj"/> object</overloads>
- <summary>
- A default constructor that places a null <see cref="T:System.Drawing.Image"/> at a
- default <see cref="T:System.Drawing.RectangleF"/> of (0,0,1,1)
- </summary>
- </member>
- <member name="M:ZedGraph.ImageObj.#ctor(System.Drawing.Image,System.Drawing.RectangleF)">
- <summary>
- A constructor that allows the <see cref="T:System.Drawing.Image"/> and
- <see cref="T:System.Drawing.RectangleF"/> location for the
- <see cref="T:ZedGraph.ImageObj"/> to be pre-specified.
- </summary>
- <param name="image">A <see cref="T:System.Drawing.Image"/> class that defines
- the image</param>
- <param name="rect">A <see cref="T:System.Drawing.RectangleF"/> struct that defines the
- image location, specifed in units based on the
- <see cref="P:ZedGraph.Location.CoordinateFrame"/> property.</param>
- </member>
- <member name="M:ZedGraph.ImageObj.#ctor(System.Drawing.Image,System.Drawing.RectangleF,ZedGraph.CoordType,ZedGraph.AlignH,ZedGraph.AlignV)">
- <overloads>Constructors for the <see cref="T:ZedGraph.ImageObj"/> object</overloads>
- <summary>
- A constructor that allows the <see cref="T:System.Drawing.Image"/> and
- <see cref="T:System.Drawing.RectangleF"/> location for the
- <see cref="T:ZedGraph.ImageObj"/> to be pre-specified.
- </summary>
- <param name="image">A <see cref="T:System.Drawing.Image"/> class that defines
- the image</param>
- <param name="rect">A <see cref="T:System.Drawing.RectangleF"/> struct that defines the
- image location, specifed in units based on the
- <see cref="P:ZedGraph.Location.CoordinateFrame"/> property.</param>
- <param name="coordType">The <see cref="T:ZedGraph.CoordType"/> enum value that
- indicates what type of coordinate system the x and y parameters are
- referenced to.</param>
- <param name="alignH">The <see cref="T:ZedGraph.AlignH"/> enum that specifies
- the horizontal alignment of the object with respect to the (x,y) location</param>
- <param name="alignV">The <see cref="T:ZedGraph.AlignV"/> enum that specifies
- the vertical alignment of the object with respect to the (x,y) location</param>
- </member>
- <member name="M:ZedGraph.ImageObj.#ctor(System.Drawing.Image,System.Double,System.Double,System.Double,System.Double)">
- <overloads>Constructors for the <see cref="T:ZedGraph.ImageObj"/> object</overloads>
- <summary>
- A constructor that allows the <see cref="T:System.Drawing.Image"/> and
- individual <see cref="T:System.Single"/> coordinate locations for the
- <see cref="T:ZedGraph.ImageObj"/> to be pre-specified.
- </summary>
- <param name="image">A <see cref="T:System.Drawing.Image"/> class that defines
- the image</param>
- <param name="left">The position of the left side of the rectangle that defines the
- <see cref="T:ZedGraph.ImageObj"/> location. The units of this position are specified by the
- <see cref="P:ZedGraph.Location.CoordinateFrame"/> property.</param>
- <param name="top">The position of the top side of the rectangle that defines the
- <see cref="T:ZedGraph.ImageObj"/> location. The units of this position are specified by the
- <see cref="P:ZedGraph.Location.CoordinateFrame"/> property.</param>
- <param name="width">The width of the rectangle that defines the
- <see cref="T:ZedGraph.ImageObj"/> location. The units of this position are specified by the
- <see cref="P:ZedGraph.Location.CoordinateFrame"/> property.</param>
- <param name="height">The height of the rectangle that defines the
- <see cref="T:ZedGraph.ImageObj"/> location. The units of this position are specified by the
- <see cref="P:ZedGraph.Location.CoordinateFrame"/> property.</param>
- </member>
- <member name="M:ZedGraph.ImageObj.#ctor(ZedGraph.ImageObj)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.ImageObj"/> object from which to copy</param>
- </member>
- <member name="M:ZedGraph.ImageObj.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.ImageObj.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.ImageObj.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.ImageObj.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.ImageObj.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.ImageObj.Draw(System.Drawing.Graphics,ZedGraph.PaneBase,System.Single)">
- <summary>
- Render this object to the specified <see cref="T:System.Drawing.Graphics"/> device
- This method is normally only called by the Draw method
- of the parent <see cref="T:ZedGraph.GraphObjList"/> collection object.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.PaneBase"/> object that is the parent or
- owner of this object.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.ImageObj.PointInBox(System.Drawing.PointF,ZedGraph.PaneBase,System.Drawing.Graphics,System.Single)">
- <summary>
- Determine if the specified screen point lies inside the bounding box of this
- <see cref="T:ZedGraph.ArrowObj"/>. The bounding box is calculated assuming a distance
- of <see cref="F:ZedGraph.GraphPane.Default.NearestTol"/> pixels around the arrow segment.
- </summary>
- <param name="pt">The screen point, in pixels</param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.PaneBase"/> object that is the parent or
- owner of this object.
- </param>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <returns>true if the point lies in the bounding box, false otherwise</returns>
- </member>
- <member name="M:ZedGraph.ImageObj.GetCoords(ZedGraph.PaneBase,System.Drawing.Graphics,System.Single,System.String@,System.String@)">
- <summary>
- Determines the shape type and Coords values for this GraphObj
- </summary>
- </member>
- <member name="P:ZedGraph.ImageObj.Image">
- <summary>
- The <see cref="T:System.Drawing.Image"/> object.
- </summary>
- <value> A <see cref="T:System.Drawing.Image"/> class reference. </value>
- </member>
- <member name="P:ZedGraph.ImageObj.IsScaled">
- <summary>
- Gets or sets a property that determines if the image will be scaled to the
- output rectangle (see <see cref="T:ZedGraph.Location"/>).
- </summary>
- <value>true to scale the image, false to draw the image unscaled, but clipped
- to the destination rectangle</value>
- </member>
- <member name="T:ZedGraph.ImageObj.Default">
- <summary>
- A simple struct that defines the
- default property values for the <see cref="T:ZedGraph.ImageObj"/> class.
- </summary>
- </member>
- <member name="F:ZedGraph.ImageObj.Default.IsScaled">
- <summary>
- Default value for the <see cref="T:ZedGraph.ImageObj"/>
- <see cref="P:ZedGraph.ImageObj.IsScaled"/> property.
- </summary>
- </member>
- <member name="T:ZedGraph.GraphPane">
- <summary>
- Class <see cref="T:ZedGraph.GraphPane"/> encapsulates the graph pane, which is all display elements
- associated with an individual graph.
- </summary>
- <remarks>This class is the outside "wrapper"
- for the ZedGraph classes, and provides the interface to access the attributes
- of the graph. You can have multiple graphs in the same document or form,
- just instantiate multiple GraphPane's.
- </remarks>
-
- <author> John Champion modified by Jerry Vos </author>
- <version> $Revision: 3.81 $ $Date: 2007-09-30 07:44:11 $ </version>
- </member>
- <member name="F:ZedGraph.GraphPane.schema2">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="F:ZedGraph.GraphPane._xAxis">
- <summary>Private field instance of the <see cref="T:ZedGraph.XAxis"/> class. Use the
- public property <see cref="P:ZedGraph.GraphPane.XAxis"/> to access this class.</summary>
- </member>
- <member name="F:ZedGraph.GraphPane._x2Axis">
- <summary>Private field instance of the <see cref="T:ZedGraph.XAxis"/> class. Use the
- public property <see cref="P:ZedGraph.GraphPane.X2Axis"/> to access this class.</summary>
- </member>
- <member name="F:ZedGraph.GraphPane._yAxisList">
- <summary>Private field instance of the <see cref="T:ZedGraph.YAxisList"/> class. Use the
- public property <see cref="P:ZedGraph.GraphPane.YAxisList"/> to access this class.</summary>
- </member>
- <member name="F:ZedGraph.GraphPane._y2AxisList">
- <summary>Private field instance of the <see cref="T:ZedGraph.Y2AxisList"/> class. Use the
- public property <see cref="P:ZedGraph.GraphPane.Y2AxisList"/> to access this class.</summary>
- </member>
- <member name="F:ZedGraph.GraphPane._curveList">
- <summary>Private field instance of the <see cref="T:ZedGraph.CurveList"/> class. Use the
- public property <see cref="P:ZedGraph.GraphPane.CurveList"/> to access this class.</summary>
- </member>
- <member name="F:ZedGraph.GraphPane._zoomStack">
- <summary>
- private value that contains a <see cref="T:ZedGraph.ZoomStateStack"/>, which stores prior
- <see cref="T:ZedGraph.ZoomState"/> objects containing scale range information. This enables
- zooming and panning functionality for the <see cref="T:ZedGraph.ZedGraphControl"/>.
- </summary>
- </member>
- <member name="F:ZedGraph.GraphPane._isIgnoreInitial">
- <summary>Private field that determines whether or not initial zero values will
- be included or excluded when determining the Y or Y2 axis scale range.
- Use the public property <see cref="P:ZedGraph.GraphPane.IsIgnoreInitial"/> to access
- this value. </summary>
- </member>
- <member name="F:ZedGraph.GraphPane._isIgnoreMissing">
- <summary>Private field that determines whether or not initial
- <see cref="F:ZedGraph.PointPairBase.Missing"/> values will cause the line segments of
- a curve to be discontinuous. If this field is true, then the curves
- will be plotted as continuous lines as if the Missing values did not
- exist.
- Use the public property <see cref="P:ZedGraph.GraphPane.IsIgnoreMissing"/> to access
- this value. </summary>
- </member>
- <member name="F:ZedGraph.GraphPane._isBoundedRanges">
- <summary> private field that determines if the auto-scaled axis ranges will subset the
- data points based on any manually set scale range values. Use the public property
- <see cref="P:ZedGraph.GraphPane.IsBoundedRanges"/> to access this value.</summary>
- <remarks>The bounds provide a means to subset the data. For example, if all the axes are set to
- autoscale, then the full range of data are used. But, if the XAxis.Min and XAxis.Max values
- are manually set, then the Y data range will reflect the Y values within the bounds of
- XAxis.Min and XAxis.Max.</remarks>
- </member>
- <member name="F:ZedGraph.GraphPane._isAlignGrids">
- <summary>
- private field that determines if ZedGraph should modify the scale ranges for the Y and Y2
- axes such that the number of steps, and therefore the grid lines, line up. Use the
- public property <see cref="P:ZedGraph.GraphPane.IsAlignGrids"/> to acccess this value.
- </summary>
- </member>
- <member name="F:ZedGraph.GraphPane._lineType">
- <summary>Private field that determines how the <see cref="T:ZedGraph.LineItem"/>
- graphs will be displayed. See the <see cref="T:ZedGraph.LineType"/> enum
- for the individual types available.
- To access this value, use the public property <see cref="P:ZedGraph.GraphPane.LineType"/>.
- </summary>
- <seealso cref="F:ZedGraph.GraphPane.Default.LineType"/>
- </member>
- <member name="M:ZedGraph.GraphPane.#ctor">
- <summary>
- Default Constructor. Sets the <see cref="P:ZedGraph.PaneBase.Rect"/> to (0, 0, 500, 375), and
- sets the <see cref="P:ZedGraph.PaneBase.Title"/> and <see cref="P:ZedGraph.Axis.Title"/> values to empty
- strings.
- </summary>
- </member>
- <member name="M:ZedGraph.GraphPane.#ctor(System.Drawing.RectangleF,System.String,System.String,System.String)">
- <summary>
- Constructor for the <see cref="T:ZedGraph.GraphPane"/> object. This routine will
- initialize all member variables and classes, setting appropriate default
- values as defined in the <see cref="T:ZedGraph.GraphPane.Default"/> class.
- </summary>
- <param name="rect"> A rectangular screen area where the graph is to be displayed.
- This area can be any size, and can be resize at any time using the
- <see cref="P:ZedGraph.PaneBase.Rect"/> property.
- </param>
- <param name="title">The <see cref="P:ZedGraph.PaneBase.Title"/> for this <see cref="T:ZedGraph.GraphPane"/></param>
- <param name="xTitle">The <see cref="P:ZedGraph.Axis.Title"/> for the <see cref="P:ZedGraph.GraphPane.XAxis"/></param>
- <param name="yTitle">The <see cref="P:ZedGraph.Axis.Title"/> for the <see cref="P:ZedGraph.GraphPane.YAxis"/></param>
- </member>
- <member name="M:ZedGraph.GraphPane.#ctor(ZedGraph.GraphPane)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The GraphPane object from which to copy</param>
- </member>
- <member name="M:ZedGraph.GraphPane.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.GraphPane.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.GraphPane.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.GraphPane.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.GraphPane.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.GraphPane.AxisChange">
- <summary>
- AxisChange causes the axes scale ranges to be recalculated based on the current data range.
- </summary>
- <remarks>
- There is no obligation to call AxisChange() for manually scaled axes. AxisChange() is only
- intended to handle auto scaling operations. Call this function anytime you change, add, or
- remove curve data to insure that the scale range of the axes are appropriate for the data range.
- This method calculates
- a scale minimum, maximum, and step size for each axis based on the current curve data.
- Only the axis attributes (min, max, step) that are set to auto-range
- (<see cref="P:ZedGraph.Scale.MinAuto"/>, <see cref="P:ZedGraph.Scale.MaxAuto"/>, <see cref="P:ZedGraph.Scale.MajorStepAuto"/>)
- will be modified. You must call <see cref="M:System.Windows.Forms.Control.Invalidate"/> after calling
- AxisChange to make sure the display gets updated.<br/>
- This overload of AxisChange just uses the default Graphics instance for the screen.
- If you have a Graphics instance available from your Windows Form, you should use
- the <see cref="M:ZedGraph.GraphPane.AxisChange(System.Drawing.Graphics)"/> overload instead.
- </remarks>
- </member>
- <member name="M:ZedGraph.GraphPane.AxisChange(System.Drawing.Graphics)">
- <summary>
- AxisChange causes the axes scale ranges to be recalculated based on the current data range.
- </summary>
- <remarks>
- There is no obligation to call AxisChange() for manually scaled axes. AxisChange() is only
- intended to handle auto scaling operations. Call this function anytime you change, add, or
- remove curve data to insure that the scale range of the axes are appropriate for the data range.
- This method calculates
- a scale minimum, maximum, and step size for each axis based on the current curve data.
- Only the axis attributes (min, max, step) that are set to auto-range
- (<see cref="P:ZedGraph.Scale.MinAuto"/>, <see cref="P:ZedGraph.Scale.MaxAuto"/>, <see cref="P:ZedGraph.Scale.MajorStepAuto"/>)
- will be modified. You must call
- <see cref="M:System.Windows.Forms.Control.Invalidate"/> after calling AxisChange to make sure the display gets updated.
- </remarks>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- </member>
- <member name="M:ZedGraph.GraphPane.Draw(System.Drawing.Graphics)">
- <summary>
- Draw all elements in the <see cref="T:ZedGraph.GraphPane"/> to the specified graphics device.
- </summary>
- <remarks>This method
- should be part of the Paint() update process. Calling this routine will redraw all
- features of the graph. No preparation is required other than an instantiated
- <see cref="T:ZedGraph.GraphPane"/> object.
- </remarks>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- </member>
- <member name="M:ZedGraph.GraphPane.CalcChartRect(System.Drawing.Graphics)">
- <summary>
- Calculate the <see cref="P:ZedGraph.Chart.Rect"/> based on the <see cref="P:ZedGraph.PaneBase.Rect"/>.
- </summary>
- <remarks>The ChartRect
- is the plot area bounded by the axes, and the rect is the total area as
- specified by the client application.
- </remarks>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <returns>The calculated chart rect, in pixel coordinates.</returns>
- </member>
- <member name="M:ZedGraph.GraphPane.CalcChartRect(System.Drawing.Graphics,System.Single)">
- <summary>
- Calculate the <see cref="P:ZedGraph.Chart.Rect"/> based on the <see cref="P:ZedGraph.PaneBase.Rect"/>.
- </summary>
- <remarks>The ChartRect
- is the plot area bounded by the axes, and the rect is the total area as
- specified by the client application.
- </remarks>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="scaleFactor">
- The scaling factor for the features of the graph based on the <see cref="P:ZedGraph.PaneBase.BaseDimension"/>. This
- scaling factor is calculated by the <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method. The scale factor
- represents a linear multiple to be applied to font sizes, symbol sizes, etc.
- </param>
- <returns>The calculated chart rect, in pixel coordinates.</returns>
- </member>
- <member name="M:ZedGraph.GraphPane.SetMinSpaceBuffer(System.Drawing.Graphics,System.Single,System.Boolean)">
- <summary>
- This method will set the <see cref="P:ZedGraph.Axis.MinSpace"/> property for all three axes;
- <see cref="P:ZedGraph.GraphPane.XAxis"/>, <see cref="P:ZedGraph.GraphPane.YAxis"/>, and <see cref="P:ZedGraph.GraphPane.Y2Axis"/>.
- </summary>
- <remarks>The <see cref="P:ZedGraph.Axis.MinSpace"/>
- is calculated using the currently required space multiplied by a fraction
- (<paramref>bufferFraction</paramref>).
- The currently required space is calculated using <see cref="M:ZedGraph.Axis.CalcSpace(System.Drawing.Graphics,ZedGraph.GraphPane,System.Single,System.Single@)"/>, and is
- based on current data ranges, font sizes, etc. The "space" is actually the amount of space
- required to fit the tic marks, scale labels, and axis title.
- The calculation is done by calling the <see cref="M:ZedGraph.Axis.SetMinSpaceBuffer(System.Drawing.Graphics,ZedGraph.GraphPane,System.Single,System.Boolean)"/> method for
- each <see cref="T:ZedGraph.Axis"/>.
- </remarks>
- <param name="g">A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.</param>
- <param name="bufferFraction">The amount of space to allocate for the axis, expressed
- as a fraction of the currently required space. For example, a value of 1.2 would
- allow for 20% extra above the currently required space.</param>
- <param name="isGrowOnly">If true, then this method will only modify the <see cref="P:ZedGraph.Axis.MinSpace"/>
- property if the calculated result is more than the current value.</param>
- </member>
- <member name="M:ZedGraph.GraphPane.AddCurve(System.String,System.Double[],System.Double[],System.Drawing.Color)">
- <summary>
- Add a curve (<see cref="T:ZedGraph.CurveItem"/> object) to the plot with
- the given data points (double arrays) and properties.
- This is simplified way to add curves without knowledge of the
- <see cref="P:ZedGraph.GraphPane.CurveList"/> class. An alternative is to use
- the <see cref="T:ZedGraph.CurveList"/> Add() method.
- </summary>
- <param name="label">The text label (string) for the curve that will be
- used as a <see cref="T:ZedGraph.Legend"/> entry.</param>
- <param name="x">An array of double precision X values (the
- independent values) that define the curve.</param>
- <param name="y">An array of double precision Y values (the
- dependent values) that define the curve.</param>
- <param name="color">The color to used for the curve line,
- symbols, etc.</param>
- <returns>A <see cref="T:ZedGraph.CurveItem"/> class for the newly created curve.
- This can then be used to access all of the curve properties that
- are not defined as arguments to the
- <see cref="M:ZedGraph.GraphPane.AddCurve(System.String,System.Double[],System.Double[],System.Drawing.Color)"/> method.</returns>
- </member>
- <member name="M:ZedGraph.GraphPane.AddCurve(System.String,ZedGraph.IPointList,System.Drawing.Color)">
- <summary>
- Add a curve (<see cref="T:ZedGraph.CurveItem"/> object) to the plot with
- the given data points (<see cref="T:ZedGraph.IPointList"/>) and properties.
- This is simplified way to add curves without knowledge of the
- <see cref="P:ZedGraph.GraphPane.CurveList"/> class. An alternative is to use
- the <see cref="T:ZedGraph.CurveList"/> Add() method.
- </summary>
- <param name="label">The text label (string) for the curve that will be
- used as a <see cref="T:ZedGraph.Legend"/> entry.</param>
- <param name="points">A <see cref="T:ZedGraph.IPointList"/> of double precision value pairs that define
- the X and Y values for this curve</param>
- <param name="color">The color to used for the curve line,
- symbols, etc.</param>
- <returns>A <see cref="T:ZedGraph.CurveItem"/> class for the newly created curve.
- This can then be used to access all of the curve properties that
- are not defined as arguments to the
- <see cref="M:ZedGraph.GraphPane.AddCurve(System.String,ZedGraph.IPointList,System.Drawing.Color)"/> method.</returns>
- </member>
- <member name="M:ZedGraph.GraphPane.AddCurve(System.String,System.Double[],System.Double[],System.Drawing.Color,ZedGraph.SymbolType)">
- <summary>
- Add a curve (<see cref="T:ZedGraph.CurveItem"/> object) to the plot with
- the given data points (double arrays) and properties.
- This is simplified way to add curves without knowledge of the
- <see cref="P:ZedGraph.GraphPane.CurveList"/> class. An alternative is to use
- the <see cref="T:ZedGraph.CurveList"/> Add() method.
- </summary>
- <param name="label">The text label (string) for the curve that will be
- used as a <see cref="T:ZedGraph.Legend"/> entry.</param>
- <param name="x">An array of double precision X values (the
- independent values) that define the curve.</param>
- <param name="y">An array of double precision Y values (the
- dependent values) that define the curve.</param>
- <param name="color">The color to used for the curve line,
- symbols, etc.</param>
- <param name="symbolType">A symbol type (<see cref="T:ZedGraph.SymbolType"/>)
- that will be used for this curve.</param>
- <returns>A <see cref="T:ZedGraph.CurveItem"/> class for the newly created curve.
- This can then be used to access all of the curve properties that
- are not defined as arguments to the
- <see cref="M:ZedGraph.GraphPane.AddCurve(System.String,System.Double[],System.Double[],System.Drawing.Color,ZedGraph.SymbolType)"/> method.</returns>
- </member>
- <member name="M:ZedGraph.GraphPane.AddCurve(System.String,ZedGraph.IPointList,System.Drawing.Color,ZedGraph.SymbolType)">
- <summary>
- Add a curve (<see cref="T:ZedGraph.CurveItem"/> object) to the plot with
- the given data points (<see cref="T:ZedGraph.IPointList"/>) and properties.
- This is simplified way to add curves without knowledge of the
- <see cref="P:ZedGraph.GraphPane.CurveList"/> class. An alternative is to use
- the <see cref="T:ZedGraph.CurveList"/> Add() method.
- </summary>
- <param name="label">The text label (string) for the curve that will be
- used as a <see cref="T:ZedGraph.Legend"/> entry.</param>
- <param name="points">A <see cref="T:ZedGraph.IPointList"/> of double precision value pairs that define
- the X and Y values for this curve</param>
- <param name="color">The color to used for the curve line,
- symbols, etc.</param>
- <param name="symbolType">A symbol type (<see cref="T:ZedGraph.SymbolType"/>)
- that will be used for this curve.</param>
- <returns>A <see cref="T:ZedGraph.CurveItem"/> class for the newly created curve.
- This can then be used to access all of the curve properties that
- are not defined as arguments to the
- <see cref="M:ZedGraph.GraphPane.AddCurve(System.String,ZedGraph.IPointList,System.Drawing.Color,ZedGraph.SymbolType)"/> method.</returns>
- </member>
- <member name="M:ZedGraph.GraphPane.AddStick(System.String,System.Double[],System.Double[],System.Drawing.Color)">
- <summary>
- Add a stick graph (<see cref="T:ZedGraph.StickItem"/> object) to the plot with
- the given data points (double arrays) and properties.
- This is simplified way to add curves without knowledge of the
- <see cref="P:ZedGraph.GraphPane.CurveList"/> class. An alternative is to use
- the <see cref="T:ZedGraph.CurveList"/> Add() method.
- </summary>
- <param name="label">The text label (string) for the curve that will be
- used as a <see cref="T:ZedGraph.Legend"/> entry.</param>
- <param name="x">An array of double precision X values (the
- independent values) that define the curve.</param>
- <param name="y">An array of double precision Y values (the
- dependent values) that define the curve.</param>
- <param name="color">The color to used for the curve line,
- symbols, etc.</param>
- <returns>A <see cref="T:ZedGraph.StickItem"/> class for the newly created curve.
- This can then be used to access all of the curve properties that
- are not defined as arguments to the
- <see cref="M:ZedGraph.GraphPane.AddStick(System.String,System.Double[],System.Double[],System.Drawing.Color)"/> method.</returns>
- </member>
- <member name="M:ZedGraph.GraphPane.AddStick(System.String,ZedGraph.IPointList,System.Drawing.Color)">
- <summary>
- Add a stick graph (<see cref="T:ZedGraph.StickItem"/> object) to the plot with
- the given data points (<see cref="T:ZedGraph.IPointList"/>) and properties.
- This is simplified way to add curves without knowledge of the
- <see cref="P:ZedGraph.GraphPane.CurveList"/> class. An alternative is to use
- the <see cref="T:ZedGraph.CurveList"/> Add() method.
- </summary>
- <param name="label">The text label (string) for the curve that will be
- used as a <see cref="T:ZedGraph.Legend"/> entry.</param>
- <param name="points">A <see cref="T:ZedGraph.IPointList"/> of double precision value pairs that define
- the X and Y values for this curve</param>
- <param name="color">The color to used for the curve line,
- symbols, etc.</param>
- <returns>A <see cref="T:ZedGraph.CurveItem"/> class for the newly created curve.
- This can then be used to access all of the curve properties that
- are not defined as arguments to the
- <see cref="M:ZedGraph.GraphPane.AddStick(System.String,ZedGraph.IPointList,System.Drawing.Color)"/> method.</returns>
- </member>
- <member name="M:ZedGraph.GraphPane.AddOHLCBar(System.String,ZedGraph.IPointList,System.Drawing.Color)">
- <summary>
- Add a candlestick graph (<see cref="T:ZedGraph.OHLCBarItem"/> object) to the plot with
- the given data points (<see cref="T:ZedGraph.IPointList"/>) and properties.
- </summary>
- <remarks>
- This is simplified way to add curves without knowledge of the
- <see cref="P:ZedGraph.GraphPane.CurveList"/> class. An alternative is to use
- the <see cref="T:ZedGraph.CurveList"/> Add() method.
- Note that the <see cref="T:ZedGraph.IPointList"/>
- should contain <see cref="T:ZedGraph.StockPt"/> objects instead of <see cref="T:ZedGraph.PointPair"/>
- objects in order to contain all the data values required for this curve type.
- </remarks>
- <param name="label">The text label (string) for the curve that will be
- used as a <see cref="T:ZedGraph.Legend"/> entry.</param>
- <param name="points">A <see cref="T:ZedGraph.IPointList"/> of double precision value pairs that define
- the X and Y values for this curve</param>
- <param name="color">The color to used for the curve line,
- symbols, etc.</param>
- <returns>A <see cref="T:ZedGraph.CurveItem"/> class for the newly created curve.
- This can then be used to access all of the curve properties that
- are not defined as arguments to the
- <see cref="M:ZedGraph.GraphPane.AddOHLCBar(System.String,ZedGraph.IPointList,System.Drawing.Color)"/> method.</returns>
- </member>
- <member name="M:ZedGraph.GraphPane.AddJapaneseCandleStick(System.String,ZedGraph.IPointList)">
- <summary>
- Add a japanesecandlestick graph (<see cref="T:ZedGraph.JapaneseCandleStickItem"/> object) to the plot with
- the given data points (<see cref="T:ZedGraph.IPointList"/>) and properties.
- </summary>
- <remarks>
- This is simplified way to add curves without knowledge of the
- <see cref="P:ZedGraph.GraphPane.CurveList"/> class. An alternative is to use
- the <see cref="T:ZedGraph.CurveList"/> Add() method.
- Note that the <see cref="T:ZedGraph.IPointList"/>
- should contain <see cref="T:ZedGraph.StockPt"/> objects instead of <see cref="T:ZedGraph.PointPair"/>
- objects in order to contain all the data values required for this curve type.
- </remarks>
- <param name="label">The text label (string) for the curve that will be
- used as a <see cref="T:ZedGraph.Legend"/> entry.</param>
- <param name="points">A <see cref="T:ZedGraph.IPointList"/> of double precision value pairs that define
- the X and Y values for this curve</param>
- <returns>A <see cref="T:ZedGraph.CurveItem"/> class for the newly created curve.
- This can then be used to access all of the curve properties that
- are not defined as arguments to the
- <see cref="M:ZedGraph.GraphPane.AddJapaneseCandleStick(System.String,ZedGraph.IPointList)"/> method.</returns>
- </member>
- <member name="M:ZedGraph.GraphPane.AddErrorBar(System.String,System.Double[],System.Double[],System.Double[],System.Drawing.Color)">
- <summary>
- Add an error bar set (<see cref="T:ZedGraph.ErrorBarItem"/> object) to the plot with
- the given data points (<see cref="T:ZedGraph.IPointList"/>) and properties.
- This is simplified way to add curves without knowledge of the
- <see cref="P:ZedGraph.GraphPane.CurveList"/> class. An alternative is to use
- the <see cref="T:ZedGraph.CurveList"/> Add() method.
- </summary>
- <param name="label">The text label (string) for the curve that will be
- used as a <see cref="T:ZedGraph.Legend"/> entry.</param>
- <param name="x">An array of double precision X values (the
- independent values) that define the curve.</param>
- <param name="y">An array of double precision Y values (the
- dependent values) that define the curve.</param>
- <param name="baseValue">An array of double precision values that define the
- base value (the bottom) of the bars for this curve.
- </param>
- <param name="color">The color to used for the curve line,
- symbols, etc.</param>
- <returns>An <see cref="T:ZedGraph.ErrorBarItem"/> class for the newly created curve.
- This can then be used to access all of the curve properties that
- are not defined as arguments to the
- <see cref="M:ZedGraph.GraphPane.AddErrorBar(System.String,ZedGraph.IPointList,System.Drawing.Color)"/> method.</returns>
- </member>
- <member name="M:ZedGraph.GraphPane.AddErrorBar(System.String,ZedGraph.IPointList,System.Drawing.Color)">
- <summary>
- Add an error bar set (<see cref="T:ZedGraph.ErrorBarItem"/> object) to the plot with
- the given data points (<see cref="T:ZedGraph.IPointList"/>) and properties.
- This is simplified way to add curves without knowledge of the
- <see cref="P:ZedGraph.GraphPane.CurveList"/> class. An alternative is to use
- the <see cref="T:ZedGraph.CurveList"/> Add() method.
- </summary>
- <param name="label">The text label (string) for the curve that will be
- used as a <see cref="T:ZedGraph.Legend"/> entry.</param>
- <param name="points">A <see cref="T:ZedGraph.IPointList"/> of double precision value pairs that define
- the X and Y values for this curve</param>
- <param name="color">The color to used for the curve line,
- symbols, etc.</param>
- <returns>An <see cref="T:ZedGraph.ErrorBarItem"/> class for the newly created curve.
- This can then be used to access all of the curve properties that
- are not defined as arguments to the
- <see cref="M:ZedGraph.GraphPane.AddErrorBar(System.String,ZedGraph.IPointList,System.Drawing.Color)"/> method.</returns>
- </member>
- <member name="M:ZedGraph.GraphPane.AddBar(System.String,ZedGraph.IPointList,System.Drawing.Color)">
- <summary>
- Add a bar type curve (<see cref="T:ZedGraph.CurveItem"/> object) to the plot with
- the given data points (<see cref="T:ZedGraph.IPointList"/>) and properties.
- This is simplified way to add curves without knowledge of the
- <see cref="P:ZedGraph.GraphPane.CurveList"/> class. An alternative is to use
- the <see cref="T:ZedGraph.CurveList"/> Add() method.
- </summary>
- <param name="label">The text label (string) for the curve that will be
- used as a <see cref="T:ZedGraph.Legend"/> entry.</param>
- <param name="points">A <see cref="T:ZedGraph.IPointList"/> of double precision value pairs that define
- the X and Y values for this curve</param>
- <param name="color">The color to used to fill the bars</param>
- <returns>A <see cref="T:ZedGraph.CurveItem"/> class for the newly created bar curve.
- This can then be used to access all of the curve properties that
- are not defined as arguments to the
- <see cref="M:ZedGraph.GraphPane.AddBar(System.String,ZedGraph.IPointList,System.Drawing.Color)"/> method.</returns>
- </member>
- <member name="M:ZedGraph.GraphPane.AddBar(System.String,System.Double[],System.Double[],System.Drawing.Color)">
- <summary>
- Add a bar type curve (<see cref="T:ZedGraph.CurveItem"/> object) to the plot with
- the given data points (double arrays) and properties.
- This is simplified way to add curves without knowledge of the
- <see cref="P:ZedGraph.GraphPane.CurveList"/> class. An alternative is to use
- the <see cref="T:ZedGraph.CurveList"/> Add() method.
- </summary>
- <param name="label">The text label (string) for the curve that will be
- used as a <see cref="T:ZedGraph.Legend"/> entry.</param>
- <param name="x">An array of double precision X values (the
- independent values) that define the curve.</param>
- <param name="y">An array of double precision Y values (the
- dependent values) that define the curve.</param>
- <param name="color">The color to used for the bars</param>
- <returns>A <see cref="T:ZedGraph.CurveItem"/> class for the newly created bar curve.
- This can then be used to access all of the curve properties that
- are not defined as arguments to the
- <see cref="M:ZedGraph.GraphPane.AddBar(System.String,System.Double[],System.Double[],System.Drawing.Color)"/> method.</returns>
- </member>
- <member name="M:ZedGraph.GraphPane.AddHiLowBar(System.String,System.Double[],System.Double[],System.Double[],System.Drawing.Color)">
- <summary>
- Add a "High-Low" bar type curve (<see cref="T:ZedGraph.HiLowBarItem"/> object) to the plot with
- the given data points (double arrays) and properties.
- This is simplified way to add curves without knowledge of the
- <see cref="P:ZedGraph.GraphPane.CurveList"/> class. An alternative is to use
- the <see cref="T:ZedGraph.CurveList"/> Add() method.
- </summary>
- <param name="label">The text label (string) for the curve that will be
- used as a <see cref="T:ZedGraph.Legend"/> entry.</param>
- <param name="x">An array of double precision X values (the
- independent values) that define the curve.</param>
- <param name="y">An array of double precision Y values (the
- dependent values) that define the curve.</param>
- <param name="baseVal">An array of double precision values that define the
- base value (the bottom) of the bars for this curve.
- </param>
- <param name="color">The color to used for the bars</param>
- <returns>A <see cref="T:ZedGraph.HiLowBarItem"/> class for the newly created bar curve.
- This can then be used to access all of the curve properties that
- are not defined as arguments to the
- <see cref="M:ZedGraph.GraphPane.AddHiLowBar(System.String,System.Double[],System.Double[],System.Double[],System.Drawing.Color)"/> method.</returns>
- </member>
- <member name="M:ZedGraph.GraphPane.AddHiLowBar(System.String,ZedGraph.IPointList,System.Drawing.Color)">
- <summary>
- Add a hi-low bar type curve (<see cref="T:ZedGraph.CurveItem"/> object) to the plot with
- the given data points (<see cref="T:ZedGraph.IPointList"/>) and properties.
- This is simplified way to add curves without knowledge of the
- <see cref="P:ZedGraph.GraphPane.CurveList"/> class. An alternative is to use
- the <see cref="T:ZedGraph.CurveList"/> Add() method.
- </summary>
- <param name="label">The text label (string) for the curve that will be
- used as a <see cref="T:ZedGraph.Legend"/> entry.</param>
- <param name="points">A <see cref="T:ZedGraph.IPointList"/> of double precision value Trio's that define
- the X, Y, and lower dependent values for this curve</param>
- <param name="color">The color to used to fill the bars</param>
- <returns>A <see cref="T:ZedGraph.HiLowBarItem"/> class for the newly created bar curve.
- This can then be used to access all of the curve properties that
- are not defined as arguments to the
- <see cref="M:ZedGraph.GraphPane.AddHiLowBar(System.String,ZedGraph.IPointList,System.Drawing.Color)"/> method.</returns>
- </member>
- <member name="M:ZedGraph.GraphPane.AddPieSlice(System.Double,System.Drawing.Color,System.Double,System.String)">
- <summary>
- Add a <see cref="T:ZedGraph.PieItem"/> to the display.
- </summary>
- <param name="value">The value associated with this <see cref="T:ZedGraph.PieItem"/>item.</param>
- <param name="color">The display color for this <see cref="T:ZedGraph.PieItem"/>item.</param>
- <param name="displacement">The amount this <see cref="T:ZedGraph.PieItem"/>item will be
- displaced from the center of the <see cref="T:ZedGraph.PieItem"/>.</param>
- <param name="label">Text label for this <see cref="T:ZedGraph.PieItem"/></param>
- <returns>a reference to the <see cref="T:ZedGraph.PieItem"/> constructed</returns>
- </member>
- <member name="M:ZedGraph.GraphPane.AddPieSlice(System.Double,System.Drawing.Color,System.Drawing.Color,System.Single,System.Double,System.String)">
- <summary>
- Add a <see cref="T:ZedGraph.PieItem"/> to the display, providing a gradient fill for the pie color.
- </summary>
- <param name="value">The value associated with this <see cref="T:ZedGraph.PieItem"/> instance.</param>
- <param name="color1">The starting display color for the gradient <see cref="T:ZedGraph.Fill"/> for this
- <see cref="T:ZedGraph.PieItem"/> instance.</param>
- <param name="color2">The ending display color for the gradient <see cref="T:ZedGraph.Fill"/> for this
- <see cref="T:ZedGraph.PieItem"/> instance.</param>
- <param name="fillAngle">The angle for the gradient <see cref="T:ZedGraph.Fill"/>.</param>
- <param name="displacement">The amount this <see cref="T:ZedGraph.PieItem"/> instance will be
- displaced from the center point.</param>
- <param name="label">Text label for this <see cref="T:ZedGraph.PieItem"/> instance.</param>
- </member>
- <member name="M:ZedGraph.GraphPane.AddPieSlices(System.Double[],System.String[])">
- <summary>
- Creates all the <see cref="T:ZedGraph.PieItem"/>s for a single Pie Chart.
- </summary>
- <param name="values">double array containing all <see cref="P:ZedGraph.PieItem.Value"/>s
- for a single PieChart.
- </param>
- <param name="labels"> string array containing all <see cref="P:ZedGraph.CurveItem.Label"/>s
- for a single PieChart.
- </param>
- <returns>an array containing references to all <see cref="T:ZedGraph.PieItem"/>s comprising
- the Pie Chart.</returns>
- </member>
- <member name="M:ZedGraph.GraphPane.GeneralTransform(System.Drawing.PointF,ZedGraph.CoordType)">
- <summary>
- Transform a data point from the specified coordinate type
- (<see cref="T:ZedGraph.CoordType"/>) to screen coordinates (pixels).
- </summary>
- <remarks>This method implicitly assumes that <see cref="P:ZedGraph.Chart.Rect"/>
- has already been calculated via <see cref="M:ZedGraph.GraphPane.AxisChange"/> or
- <see cref="M:ZedGraph.GraphPane.Draw(System.Drawing.Graphics)"/> methods, or the <see cref="P:ZedGraph.Chart.Rect"/> is
- set manually (see <see cref="P:ZedGraph.Chart.IsRectAuto"/>).</remarks>
- <param name="ptF">The X,Y pair that defines the point in user
- coordinates.</param>
- <param name="coord">A <see cref="T:ZedGraph.CoordType"/> type that defines the
- coordinate system in which the X,Y pair is defined.</param>
- <returns>A point in screen coordinates that corresponds to the
- specified user point.</returns>
- </member>
- <member name="M:ZedGraph.GraphPane.GeneralTransform(System.Double,System.Double,ZedGraph.CoordType)">
- <summary>
- Transform a data point from the specified coordinate type
- (<see cref="T:ZedGraph.CoordType"/>) to screen coordinates (pixels).
- </summary>
- <remarks>This method implicitly assumes that <see cref="P:ZedGraph.Chart.Rect"/>
- has already been calculated via <see cref="M:ZedGraph.GraphPane.AxisChange"/> or
- <see cref="M:ZedGraph.GraphPane.Draw(System.Drawing.Graphics)"/> methods, or the <see cref="P:ZedGraph.Chart.Rect"/> is
- set manually (see <see cref="P:ZedGraph.Chart.IsRectAuto"/>).
- Note that this method is more accurate than the <see cref="M:ZedGraph.GraphPane.GeneralTransform(System.Drawing.PointF,ZedGraph.CoordType)"/>
- overload, since it uses double types. This would typically only be significant for
- <see cref="F:ZedGraph.AxisType.Date"/> coordinates.
- </remarks>
- <param name="x">The x coordinate that defines the location in user space</param>
- <param name="y">The y coordinate that defines the location in user space</param>
- <param name="coord">A <see cref="T:ZedGraph.CoordType"/> type that defines the
- coordinate system in which the X,Y pair is defined.</param>
- <returns>A point in screen coordinates that corresponds to the
- specified user point.</returns>
- </member>
- <member name="M:ZedGraph.GraphPane.ReverseTransform(System.Drawing.PointF,System.Double@,System.Double@)">
- <summary>
- Return the user scale values that correspond to the specified screen
- coordinate position (pixels). This overload assumes the default
- <see cref="P:ZedGraph.GraphPane.XAxis"/> and <see cref="P:ZedGraph.GraphPane.YAxis"/>.
- </summary>
- <remarks>This method implicitly assumes that <see cref="P:ZedGraph.Chart.Rect"/>
- has already been calculated via <see cref="M:ZedGraph.GraphPane.AxisChange"/> or
- <see cref="M:ZedGraph.GraphPane.Draw(System.Drawing.Graphics)"/> methods, or the <see cref="P:ZedGraph.Chart.Rect"/> is
- set manually (see <see cref="P:ZedGraph.Chart.IsRectAuto"/>).</remarks>
- <param name="ptF">The X,Y pair that defines the screen coordinate
- point of interest</param>
- <param name="x">The resultant value in user coordinates from the
- <see cref="P:ZedGraph.GraphPane.XAxis"/></param>
- <param name="y">The resultant value in user coordinates from the
- primary <see cref="P:ZedGraph.GraphPane.YAxis"/></param>
- </member>
- <member name="M:ZedGraph.GraphPane.ReverseTransform(System.Drawing.PointF,System.Double@,System.Double@,System.Double@,System.Double@)">
- <summary>
- Return the user scale values that correspond to the specified screen
- coordinate position (pixels).
- </summary>
- <remarks>This method implicitly assumes that <see cref="P:ZedGraph.Chart.Rect"/>
- has already been calculated via <see cref="M:ZedGraph.GraphPane.AxisChange"/> or
- <see cref="M:ZedGraph.GraphPane.Draw(System.Drawing.Graphics)"/> methods, or the <see cref="P:ZedGraph.Chart.Rect"/> is
- set manually (see <see cref="P:ZedGraph.Chart.IsRectAuto"/>).</remarks>
- <param name="ptF">The X,Y pair that defines the screen coordinate
- point of interest</param>
- <param name="x">The resultant value in user coordinates from the
- <see cref="P:ZedGraph.GraphPane.XAxis"/></param>
- <param name="x2">The resultant value in user coordinates from the
- <see cref="P:ZedGraph.GraphPane.X2Axis"/></param>
- <param name="y">The resultant value in user coordinates from the
- primary <see cref="P:ZedGraph.GraphPane.YAxis"/></param>
- <param name="y2">The resultant value in user coordinates from the
- primary <see cref="P:ZedGraph.GraphPane.Y2Axis"/></param>
- </member>
- <member name="M:ZedGraph.GraphPane.ReverseTransform(System.Drawing.PointF,System.Boolean,System.Boolean,System.Int32,System.Double@,System.Double@)">
- <summary>
- Return the user scale values that correspond to the specified screen
- coordinate position (pixels).
- </summary>
- <remarks>This method implicitly assumes that <see cref="P:ZedGraph.Chart.Rect"/>
- has already been calculated via <see cref="M:ZedGraph.GraphPane.AxisChange"/> or
- <see cref="M:ZedGraph.GraphPane.Draw(System.Drawing.Graphics)"/> methods, or the <see cref="P:ZedGraph.Chart.Rect"/> is
- set manually (see <see cref="P:ZedGraph.Chart.IsRectAuto"/>).</remarks>
- <param name="ptF">The X,Y pair that defines the screen coordinate
- point of interest</param>
- <param name="isX2Axis">true to return data that corresponds to an
- <see cref="P:ZedGraph.GraphPane.X2Axis"/>, false for an <see cref="P:ZedGraph.GraphPane.XAxis"/>.</param>
- <param name="isY2Axis">true to return data that corresponds to a
- <see cref="P:ZedGraph.GraphPane.Y2Axis"/>, false for a <see cref="P:ZedGraph.GraphPane.YAxis"/>.</param>
- <param name="yAxisIndex">The ordinal index of the Y or Y2 axis from which
- to return data (see <seealso cref="P:ZedGraph.GraphPane.YAxisList"/>, <seealso cref="P:ZedGraph.GraphPane.Y2AxisList"/>)
- </param>
- <param name="x">The resultant value in user coordinates from the
- <see cref="P:ZedGraph.GraphPane.XAxis"/></param>
- <param name="y">The resultant value in user coordinates from the
- primary <see cref="P:ZedGraph.GraphPane.YAxis"/></param>
- </member>
- <member name="M:ZedGraph.GraphPane.ReverseTransform(System.Drawing.PointF,System.Double@,System.Double@,System.Double[]@,System.Double[]@)">
- <summary>
- Return the user scale values that correspond to the specified screen
- coordinate position (pixels) for all y axes.
- </summary>
- <remarks>This method implicitly assumes that <see cref="P:ZedGraph.Chart.Rect"/>
- has already been calculated via <see cref="M:ZedGraph.GraphPane.AxisChange"/> or
- <see cref="M:ZedGraph.GraphPane.Draw(System.Drawing.Graphics)"/> methods, or the <see cref="P:ZedGraph.Chart.Rect"/> is
- set manually (see <see cref="P:ZedGraph.Chart.IsRectAuto"/>).</remarks>
- <param name="ptF">The X,Y pair that defines the screen coordinate
- point of interest</param>
- <param name="x">The resultant value in user coordinates from the
- <see cref="P:ZedGraph.GraphPane.XAxis"/></param>
- <param name="x2">The resultant value in user coordinates from the
- <see cref="P:ZedGraph.GraphPane.X2Axis"/></param>
- <param name="y">An array of resultant values in user coordinates from the
- list of <see cref="P:ZedGraph.GraphPane.YAxis"/> instances. This method allocates the
- array for you, according to the number of <see cref="P:ZedGraph.GraphPane.YAxis"/> objects
- in the list.</param>
- <param name="y2">An array of resultant values in user coordinates from the
- list of <see cref="P:ZedGraph.GraphPane.Y2Axis"/> instances. This method allocates the
- array for you, according to the number of <see cref="P:ZedGraph.GraphPane.Y2Axis"/> objects
- in the list.</param>
- </member>
- <member name="M:ZedGraph.GraphPane.AddYAxis(System.String)">
- <summary>
- Add a secondary <see cref="P:ZedGraph.GraphPane.YAxis"/> (left side) to the list of axes
- in the Graph.
- </summary>
- <remarks>
- Note that the primary <see cref="P:ZedGraph.GraphPane.YAxis"/> is always included by default.
- This method turns off the <see cref="T:ZedGraph.MajorTic"/> and <see cref="T:ZedGraph.MinorTic"/>
- <see cref="P:ZedGraph.MinorTic.IsOpposite"/> and <see cref="P:ZedGraph.MinorTic.IsInside"/>
- properties by default.
- </remarks>
- <param name="title">The title for the <see cref="P:ZedGraph.GraphPane.YAxis"/>.</param>
- <returns>the ordinal position (index) in the <see cref="P:ZedGraph.GraphPane.YAxisList"/>.</returns>
- </member>
- <member name="M:ZedGraph.GraphPane.AddY2Axis(System.String)">
- <summary>
- Add a secondary <see cref="P:ZedGraph.GraphPane.Y2Axis"/> (right side) to the list of axes
- in the Graph.
- </summary>
- <remarks>
- Note that the primary <see cref="P:ZedGraph.GraphPane.Y2Axis"/> is always included by default.
- This method turns off the <see cref="T:ZedGraph.MajorTic"/> and <see cref="T:ZedGraph.MinorTic"/>
- <see cref="P:ZedGraph.MinorTic.IsOpposite"/> and <see cref="P:ZedGraph.MinorTic.IsInside"/>
- properties by default.
- </remarks>
- <param name="title">The title for the <see cref="P:ZedGraph.GraphPane.Y2Axis"/>.</param>
- <returns>the ordinal position (index) in the <see cref="P:ZedGraph.GraphPane.Y2AxisList"/>.</returns>
- </member>
- <member name="M:ZedGraph.GraphPane.FindNearestObject(System.Drawing.PointF,System.Drawing.Graphics,System.Object@,System.Int32@)">
- <summary>
- Find the object that lies closest to the specified mouse (screen) point.
- </summary>
- <remarks>
- This method will search through all of the graph objects, such as
- <see cref="T:ZedGraph.Axis"/>, <see cref="T:ZedGraph.Legend"/>, <see cref="P:ZedGraph.PaneBase.Title"/>,
- <see cref="T:ZedGraph.GraphObj"/>, and <see cref="T:ZedGraph.CurveItem"/>.
- If the mouse point is within the bounding box of the items (or in the case
- of <see cref="T:ZedGraph.ArrowObj"/> and <see cref="T:ZedGraph.CurveItem"/>, within
- <see cref="F:ZedGraph.GraphPane.Default.NearestTol"/> pixels), then the object will be returned.
- You must check the type of the object to determine what object was
- selected (for example, "if ( object is Legend ) ..."). The
- <see paramref="index"/> parameter returns the index number of the item
- within the selected object (such as the point number within a
- <see cref="T:ZedGraph.CurveItem"/> object.
- </remarks>
- <param name="mousePt">The screen point, in pixel coordinates.</param>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="nearestObj">A reference to the nearest object to the
- specified screen point. This can be any of <see cref="T:ZedGraph.Axis"/>,
- <see cref="T:ZedGraph.Legend"/>, <see cref="P:ZedGraph.PaneBase.Title"/>,
- <see cref="T:ZedGraph.TextObj"/>, <see cref="T:ZedGraph.ArrowObj"/>, or <see cref="T:ZedGraph.CurveItem"/>.
- Note: If the pane title is selected, then the <see cref="T:ZedGraph.GraphPane"/> object
- will be returned.
- </param>
- <param name="index">The index number of the item within the selected object
- (where applicable). For example, for a <see cref="T:ZedGraph.CurveItem"/> object,
- <see paramref="index"/> will be the index number of the nearest data point,
- accessible via <see cref="P:ZedGraph.CurveItem.Points">CurveItem.Points[index]</see>.
- index will be -1 if no data points are available.</param>
- <returns>true if an object was found, false otherwise.</returns>
- <seealso cref="M:ZedGraph.GraphPane.FindNearestObject(System.Drawing.PointF,System.Drawing.Graphics,System.Object@,System.Int32@)"/>
- </member>
- <member name="M:ZedGraph.GraphPane.FindNearestPoint(System.Drawing.PointF,ZedGraph.CurveItem,ZedGraph.CurveItem@,System.Int32@)">
- <summary>
- Find the data point that lies closest to the specified mouse (screen)
- point for the specified curve.
- </summary>
- <remarks>
- This method will search only through the points for the specified
- curve to determine which point is
- nearest the mouse point. It will only consider points that are within
- <see cref="F:ZedGraph.GraphPane.Default.NearestTol"/> pixels of the screen point.
- </remarks>
- <param name="mousePt">The screen point, in pixel coordinates.</param>
- <param name="nearestCurve">A reference to the <see cref="T:ZedGraph.CurveItem"/>
- instance that contains the closest point. nearestCurve will be null if
- no data points are available.</param>
- <param name="targetCurve">A <see cref="T:ZedGraph.CurveItem"/> object containing
- the data points to be searched.</param>
- <param name="iNearest">The index number of the closest point. The
- actual data vpoint will then be <see cref="P:ZedGraph.CurveItem.Points">CurveItem.Points[iNearest]</see>
- . iNearest will
- be -1 if no data points are available.</param>
- <returns>true if a point was found and that point lies within
- <see cref="F:ZedGraph.GraphPane.Default.NearestTol"/> pixels
- of the screen point, false otherwise.</returns>
- </member>
- <member name="M:ZedGraph.GraphPane.FindNearestPoint(System.Drawing.PointF,ZedGraph.CurveItem@,System.Int32@)">
- <summary>
- Find the data point that lies closest to the specified mouse (screen)
- point.
- </summary>
- <remarks>
- This method will search through all curves in
- <see cref="P:ZedGraph.GraphPane.CurveList"/> to find which point is
- nearest. It will only consider points that are within
- <see cref="F:ZedGraph.GraphPane.Default.NearestTol"/> pixels of the screen point.
- </remarks>
- <param name="mousePt">The screen point, in pixel coordinates.</param>
- <param name="nearestCurve">A reference to the <see cref="T:ZedGraph.CurveItem"/>
- instance that contains the closest point. nearestCurve will be null if
- no data points are available.</param>
- <param name="iNearest">The index number of the closest point. The
- actual data vpoint will then be <see cref="P:ZedGraph.CurveItem.Points">CurveItem.Points[iNearest]</see>
- . iNearest will
- be -1 if no data points are available.</param>
- <returns>true if a point was found and that point lies within
- <see cref="F:ZedGraph.GraphPane.Default.NearestTol"/> pixels
- of the screen point, false otherwise.</returns>
- </member>
- <member name="M:ZedGraph.GraphPane.FindNearestPoint(System.Drawing.PointF,ZedGraph.CurveList,ZedGraph.CurveItem@,System.Int32@)">
- <summary>
- Find the data point that lies closest to the specified mouse (screen)
- point.
- </summary>
- <remarks>
- This method will search through the specified list of curves to find which point is
- nearest. It will only consider points that are within
- <see cref="F:ZedGraph.GraphPane.Default.NearestTol"/> pixels of the screen point, and it will
- only consider <see cref="T:ZedGraph.CurveItem"/>'s that are in
- <paramref name="targetCurveList"/>.
- </remarks>
- <param name="mousePt">The screen point, in pixel coordinates.</param>
- <param name="targetCurveList">A <see cref="P:ZedGraph.GraphPane.CurveList"/> object containing
- a subset of <see cref="T:ZedGraph.CurveItem"/>'s to be searched.</param>
- <param name="nearestCurve">A reference to the <see cref="T:ZedGraph.CurveItem"/>
- instance that contains the closest point. nearestCurve will be null if
- no data points are available.</param>
- <param name="iNearest">The index number of the closest point. The
- actual data vpoint will then be <see cref="P:ZedGraph.CurveItem.Points">CurveItem.Points[iNearest]</see>
- . iNearest will
- be -1 if no data points are available.</param>
- <returns>true if a point was found and that point lies within
- <see cref="F:ZedGraph.GraphPane.Default.NearestTol"/> pixels
- of the screen point, false otherwise.</returns>
- </member>
- <member name="M:ZedGraph.GraphPane.FindLinkableObject(System.Drawing.PointF,System.Drawing.Graphics,System.Single,System.Object@,ZedGraph.Link@,System.Int32@)">
- <summary>
- Search through the <see cref="T:ZedGraph.GraphObjList"/> and <see cref="P:ZedGraph.GraphPane.CurveList"/> for
- items that contain active <see cref="T:ZedGraph.Link"/> objects.
- </summary>
- <param name="mousePt">The mouse location where the click occurred</param>
- <param name="g">An appropriate <see cref="T:System.Drawing.Graphics"/> instance</param>
- <param name="scaleFactor">The current scaling factor for drawing operations.</param>
- <param name="source">The clickable object that was found. Typically a type of
- <see cref="T:ZedGraph.GraphObj"/> or a type of <see cref="T:ZedGraph.CurveItem"/>.</param>
- <param name="link">The <see cref="T:ZedGraph.Link"/> instance that is contained within
- the <see paramref="source"/> object.</param>
- <param name="index">An index value, indicating which point was clicked for
- <see cref="T:ZedGraph.CurveItem"/> type objects.</param>
- <returns>returns true if a clickable link was found under the
- <see paramref="mousePt"/>, or false otherwise.
- </returns>
- </member>
- <member name="M:ZedGraph.GraphPane.FindContainedObjects(System.Drawing.RectangleF,System.Drawing.Graphics,ZedGraph.CurveList@)">
- <summary>
- Find any objects that exist within the specified (screen) rectangle.
- This method will search through all of the graph objects, such as
- <see cref="T:ZedGraph.Axis"/>, <see cref="T:ZedGraph.Legend"/>, <see cref="P:ZedGraph.PaneBase.Title"/>,
- <see cref="T:ZedGraph.GraphObj"/>, and <see cref="T:ZedGraph.CurveItem"/>.
- and see if the objects' bounding boxes are within the specified (screen) rectangle
- This method returns true if any are found.
- </summary>
- </member>
- <member name="E:ZedGraph.GraphPane.AxisChangeEvent">
- <summary>
- Subscribe to this event to be notified when <see cref="M:ZedGraph.GraphPane.AxisChange"/> is called.
- </summary>
- </member>
- <member name="P:ZedGraph.GraphPane.CurveList">
- <summary>
- Gets or sets the list of <see cref="T:ZedGraph.CurveItem"/> items for this <see cref="T:ZedGraph.GraphPane"/>
- </summary>
- <value>A reference to a <see cref="P:ZedGraph.GraphPane.CurveList"/> collection object</value>
- </member>
- <member name="P:ZedGraph.GraphPane.XAxis">
- <summary>
- Accesses the <see cref="P:ZedGraph.GraphPane.XAxis"/> for this graph
- </summary>
- <value>A reference to a <see cref="P:ZedGraph.GraphPane.XAxis"/> object</value>
- </member>
- <member name="P:ZedGraph.GraphPane.X2Axis">
- <summary>
- Accesses the <see cref="P:ZedGraph.GraphPane.X2Axis"/> for this graph
- </summary>
- <value>A reference to a <see cref="P:ZedGraph.GraphPane.X2Axis"/> object</value>
- </member>
- <member name="P:ZedGraph.GraphPane.YAxis">
- <summary>
- Accesses the primary <see cref="P:ZedGraph.GraphPane.YAxis"/> for this graph
- </summary>
- <value>A reference to a <see cref="P:ZedGraph.GraphPane.YAxis"/> object</value>
- <seealso cref="P:ZedGraph.GraphPane.YAxisList"/>
- <seealso cref="P:ZedGraph.GraphPane.Y2AxisList"/>
- </member>
- <member name="P:ZedGraph.GraphPane.Y2Axis">
- <summary>
- Accesses the primary <see cref="P:ZedGraph.GraphPane.Y2Axis"/> for this graph
- </summary>
- <value>A reference to a <see cref="P:ZedGraph.GraphPane.Y2Axis"/> object</value>
- <seealso cref="P:ZedGraph.GraphPane.YAxisList"/>
- <seealso cref="P:ZedGraph.GraphPane.Y2AxisList"/>
- </member>
- <member name="P:ZedGraph.GraphPane.YAxisList">
- <summary>
- Gets the collection of Y axes that belong to this <see cref="T:ZedGraph.GraphPane"/>.
- </summary>
- </member>
- <member name="P:ZedGraph.GraphPane.Y2AxisList">
- <summary>
- Gets the collection of Y2 axes that belong to this <see cref="T:ZedGraph.GraphPane"/>.
- </summary>
- </member>
- <member name="P:ZedGraph.GraphPane.Chart">
- <summary>
- Gets the <see cref="P:ZedGraph.GraphPane.Chart"/> instance for this <see cref="T:ZedGraph.GraphPane"/>.
- </summary>
- </member>
- <member name="P:ZedGraph.GraphPane.BarSettings">
- <summary>
- Gets the <see cref="P:ZedGraph.GraphPane.BarSettings"/> instance for this <see cref="T:ZedGraph.GraphPane"/>,
- which stores the global properties for bar type charts.
- </summary>
- </member>
- <member name="P:ZedGraph.GraphPane.IsIgnoreInitial">
- <summary>
- Gets or sets a boolean value that affects the data range that is considered
- for the automatic scale ranging.
- </summary>
- <remarks>If true, then initial data points where the Y value
- is zero are not included when automatically determining the scale <see cref="P:ZedGraph.Scale.Min"/>,
- <see cref="P:ZedGraph.Scale.Max"/>, and <see cref="P:ZedGraph.Scale.MajorStep"/> size.
- All data after the first non-zero Y value are included.
- </remarks>
- <seealso cref="F:ZedGraph.GraphPane.Default.IsIgnoreInitial"/>
- </member>
- <member name="P:ZedGraph.GraphPane.IsBoundedRanges">
- <summary> Gets or sets a boolean value that determines if the auto-scaled axis ranges will
- subset the data points based on any manually set scale range values.</summary>
- <remarks>The bounds provide a means to subset the data. For example, if all the axes are set to
- autoscale, then the full range of data are used. But, if the XAxis.Min and XAxis.Max values
- are manually set, then the Y data range will reflect the Y values within the bounds of
- XAxis.Min and XAxis.Max. Set to true to subset the data, or false to always include
- all data points when calculating scale ranges.</remarks>
- </member>
- <member name="P:ZedGraph.GraphPane.IsIgnoreMissing">
- <summary>Gets or sets a value that determines whether or not initial
- <see cref="F:ZedGraph.PointPairBase.Missing"/> values will cause the line segments of
- a curve to be discontinuous.
- </summary>
- <remarks>If this field is true, then the curves
- will be plotted as continuous lines as if the Missing values did not exist.
- Use the public property <see cref="P:ZedGraph.GraphPane.IsIgnoreMissing"/> to access
- this value. </remarks>
- </member>
- <member name="P:ZedGraph.GraphPane.IsAlignGrids">
- <summary>
- Gets or sets a value that determines if ZedGraph should modify the scale ranges
- for the Y and Y2 axes such that the number of major steps, and therefore the
- major grid lines, line up.
- </summary>
- <remarks>
- This property affects the way that <see cref="M:ZedGraph.GraphPane.AxisChange"/> selects the scale
- ranges for the Y and Y2 axes. It applies to the scale ranges of all Y and Y2 axes,
- but only if the <see cref="P:ZedGraph.Scale.MaxAuto"/> is set to true.<br/>
- </remarks>
- </member>
- <member name="P:ZedGraph.GraphPane.LineType">
- <summary>Determines how the <see cref="T:ZedGraph.LineItem"/>
- graphs will be displayed. See the <see cref="T:ZedGraph.LineType"/> enum
- for the individual types available.
- </summary>
- <seealso cref="F:ZedGraph.GraphPane.Default.LineType"/>
- </member>
- <member name="P:ZedGraph.GraphPane.IsZoomed">
- <summary>
- Gets a value that indicates whether or not the <see cref="T:ZedGraph.ZoomStateStack"/> for
- this <see cref="T:ZedGraph.GraphPane"/> is empty. Note that this value is only used for
- the <see cref="T:ZedGraph.ZedGraphControl"/>.
- </summary>
- </member>
- <member name="P:ZedGraph.GraphPane.ZoomStack">
- <summary>
- Gets a reference to the <see cref="T:ZedGraph.ZoomStateStack"/> for this <see cref="T:ZedGraph.GraphPane"/>.
- </summary>
- </member>
- <member name="T:ZedGraph.GraphPane.AxisChangeEventHandler">
- <summary>
- A delegate to provide notification through the <see cref="E:ZedGraph.GraphPane.AxisChangeEvent"/>
- when <see cref="M:ZedGraph.GraphPane.AxisChange"/> is called.
- </summary>
- <param name="pane">The <see cref="T:ZedGraph.GraphPane"/> for which AxisChange() has
- been called.</param>
- <seealso cref="E:ZedGraph.GraphPane.AxisChangeEvent"/>
- </member>
- <member name="T:ZedGraph.GraphPane.Default">
- <summary>
- A simple struct that defines the
- default property values for the <see cref="T:ZedGraph.GraphPane"/> class.
- </summary>
- </member>
- <member name="F:ZedGraph.GraphPane.Default.IsIgnoreInitial">
- <summary>
- The default settings for the <see cref="T:ZedGraph.Axis"/> scale ignore initial
- zero values option (<see cref="P:ZedGraph.GraphPane.IsIgnoreInitial"/> property).
- true to have the auto-scale-range code ignore the initial data points
- until the first non-zero Y value, false otherwise.
- </summary>
- </member>
- <member name="F:ZedGraph.GraphPane.Default.IsBoundedRanges">
- <summary>
- The default settings for the <see cref="T:ZedGraph.Axis"/> scale bounded ranges option
- (<see cref="P:ZedGraph.GraphPane.IsBoundedRanges"/> property).
- true to have the auto-scale-range code subset the data according to any
- manually set scale values, false otherwise.
- </summary>
- </member>
- <member name="F:ZedGraph.GraphPane.Default.LineType">
- <summary>The default value for the <see cref="P:ZedGraph.GraphPane.LineType"/> property, which
- determines if the lines are drawn in normal or "stacked" mode. See the
- <see cref="T:ZedGraph.LineType"/> for more information.
- </summary>
- <seealso cref="P:ZedGraph.GraphPane.LineType"/>
- </member>
- <member name="F:ZedGraph.GraphPane.Default.ClusterScaleWidth">
- <summary>
- The default width of a bar cluster
- on a <see cref="T:ZedGraph.Bar"/> graph. This value only applies to
- <see cref="T:ZedGraph.Bar"/> graphs, and only when the
- <see cref="P:ZedGraph.Axis.Type"/> is <see cref="F:ZedGraph.AxisType.Linear"/>,
- <see cref="F:ZedGraph.AxisType.Log"/> or <see cref="F:ZedGraph.AxisType.Date"/>.
- This dimension is expressed in terms of X scale user units.
- </summary>
- <seealso cref="F:ZedGraph.BarSettings.Default.MinClusterGap"/>
- <seealso cref="P:ZedGraph.BarSettings.MinBarGap"/>
- </member>
- <member name="F:ZedGraph.GraphPane.Default.NearestTol">
- <summary>
- The tolerance that is applied to the
- <see cref="M:ZedGraph.GraphPane.FindNearestPoint(System.Drawing.PointF,ZedGraph.CurveItem@,System.Int32@)"/> routine.
- If a given curve point is within this many pixels of the mousePt, the curve
- point is considered to be close enough for selection as a nearest point
- candidate.
- </summary>
- </member>
- <member name="T:ZedGraph.PointD">
- <summary>
- Simple struct that stores X and Y coordinates as doubles.
- </summary>
-
- <author> John Champion </author>
- <version> $Revision: 3.1 $ $Date: 2006-06-24 20:26:44 $ </version>
- </member>
- <member name="F:ZedGraph.PointD.X">
- <summary>
- The X coordinate
- </summary>
- </member>
- <member name="F:ZedGraph.PointD.Y">
- <summary>
- The Y coordinate
- </summary>
- </member>
- <member name="M:ZedGraph.PointD.#ctor(System.Double,System.Double)">
- <summary>
- Construct a <see cref="T:ZedGraph.PointD"/> object from two double values.
- </summary>
- <param name="x">The X coordinate</param>
- <param name="y">The Y coordinate</param>
- </member>
- <member name="T:ZedGraph.MajorGrid">
- <summary>
- Class that handles the data associated with the major grid lines on the chart.
- Inherits from <see cref="T:ZedGraph.MinorGrid"/>.
- </summary>
-
- <author> John Champion </author>
- <version> $Revision: 3.1 $ $Date: 2006-06-24 20:26:44 $ </version>
- </member>
- <member name="F:ZedGraph.MajorGrid.schema2">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="M:ZedGraph.MajorGrid.#ctor">
- <summary>
- Default constructor
- </summary>
- </member>
- <member name="M:ZedGraph.MajorGrid.#ctor(ZedGraph.MajorGrid)">
- <summary>
- Copy constructor
- </summary>
- <param name="rhs">The source <see cref="T:ZedGraph.MajorGrid"/> to be copied.</param>
- </member>
- <member name="M:ZedGraph.MajorGrid.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.MajorGrid.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.MajorGrid.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.MajorGrid.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.MajorGrid.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="P:ZedGraph.MajorGrid.IsZeroLine">
- <summary>
- Gets or sets a boolean value that determines if a line will be drawn at the
- zero value for the axis.
- </summary>
- <remarks>
- The zero line is a line that divides the negative values from the positive values.
- The default is set according to
- <see cref="F:ZedGraph.XAxis.Default.IsZeroLine"/>, <see cref="F:ZedGraph.YAxis.Default.IsZeroLine"/>,
- <see cref="F:ZedGraph.Y2Axis.Default.IsZeroLine"/>,
- </remarks>
- <value>true to show the zero line, false otherwise</value>
- </member>
- <member name="T:ZedGraph.MajorGrid.Default">
- <summary>
- A simple struct that defines the
- default property values for the <see cref="T:ZedGraph.MajorGrid"/> class.
- </summary>
- </member>
- <member name="F:ZedGraph.MajorGrid.Default.DashOn">
- <summary>
- The default "dash on" size for drawing the <see cref="T:ZedGraph.Axis"/> grid
- (<see cref="P:ZedGraph.MinorGrid.DashOn"/> property). Units are in points (1/72 inch).
- </summary>
- </member>
- <member name="F:ZedGraph.MajorGrid.Default.DashOff">
- <summary>
- The default "dash off" size for drawing the <see cref="T:ZedGraph.Axis"/> grid
- (<see cref="P:ZedGraph.MinorGrid.DashOff"/> property). Units are in points (1/72 inch).
- </summary>
- </member>
- <member name="F:ZedGraph.MajorGrid.Default.PenWidth">
- <summary>
- The default pen width for drawing the <see cref="T:ZedGraph.Axis"/> grid
- (<see cref="P:ZedGraph.MinorGrid.PenWidth"/> property). Units are in points (1/72 inch).
- </summary>
- </member>
- <member name="F:ZedGraph.MajorGrid.Default.Color">
- <summary>
- The default color for the <see cref="T:ZedGraph.Axis"/> grid lines
- (<see cref="P:ZedGraph.MinorGrid.Color"/> property). This color only affects the
- grid lines.
- </summary>
- </member>
- <member name="F:ZedGraph.MajorGrid.Default.IsVisible">
- <summary>
- The default display mode for the <see cref="T:ZedGraph.Axis"/> grid lines
- (<see cref="P:ZedGraph.MinorGrid.IsVisible"/> property). true
- to show the grid lines, false to hide them.
- </summary>
- </member>
- <member name="F:ZedGraph.MajorGrid.Default.IsZeroLine">
- <summary>
- The default boolean value that determines if a line will be drawn at the
- zero value for the axis.
- </summary>
- <remarks>
- The zero line is a line that divides the negative values from the positive values.
- The default is set according to
- <see cref="F:ZedGraph.XAxis.Default.IsZeroLine"/>, <see cref="F:ZedGraph.YAxis.Default.IsZeroLine"/>,
- <see cref="F:ZedGraph.Y2Axis.Default.IsZeroLine"/>,
- </remarks>
- <value>true to show the zero line, false otherwise</value>
- </member>
- <member name="T:ZedGraph.GasGaugeNeedle">
- <summary>
- A class representing a needle on the GasGuage chart
- <see cref="T:ZedGraph.GasGaugeNeedle"/>s.
- </summary>
- <author> Jay Mistry </author>
- <version> $Revision: 1.2 $ $Date: 2007-08-11 14:37:47 $ </version>
- </member>
- <member name="F:ZedGraph.GasGaugeNeedle.schema2">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="F:ZedGraph.GasGaugeNeedle._needleValue">
- <summary>
- Value of this needle
- </summary>
- </member>
- <member name="F:ZedGraph.GasGaugeNeedle._needleWidth">
- <summary>
- Width of the line being drawn
- </summary>
- </member>
- <member name="F:ZedGraph.GasGaugeNeedle._color">
- <summary>
- Color of the needle line
- </summary>
- </member>
- <member name="F:ZedGraph.GasGaugeNeedle._sweepAngle">
- <summary>
- Internally calculated angle that places this needle relative to the MinValue and
- MaxValue of 180 degree GasGuage
- </summary>
- </member>
- <member name="F:ZedGraph.GasGaugeNeedle._fill">
- <summary>
- Private field that stores the <see cref="T:ZedGraph.Fill"/> data for this
- <see cref="T:ZedGraph.GasGaugeNeedle"/>. Use the public property <see cref="P:ZedGraph.GasGaugeNeedle.Fill"/> to
- access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.GasGaugeNeedle._labelDetail">
- <summary>
- A <see cref="T:ZedGraph.TextObj"/> which will customize the label display of this
- <see cref="T:ZedGraph.GasGaugeNeedle"/>
- </summary>
- </member>
- <member name="F:ZedGraph.GasGaugeNeedle._border">
- <summary>
- Private field that stores the <see cref="P:ZedGraph.GasGaugeNeedle.Border"/> class that defines the
- properties of the border around this <see cref="T:ZedGraph.GasGaugeNeedle"/>. Use the public
- property <see cref="P:ZedGraph.GasGaugeNeedle.Border"/> to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.GasGaugeNeedle._boundingRectangle">
- <summary>
- The bounding rectangle for this <see cref="T:ZedGraph.GasGaugeNeedle"/>.
- </summary>
- </member>
- <member name="F:ZedGraph.GasGaugeNeedle._slicePath">
- <summary>
- Private field to hold the GraphicsPath of this <see cref="T:ZedGraph.GasGaugeNeedle"/> to be
- used for 'hit testing'.
- </summary>
- </member>
- <member name="M:ZedGraph.GasGaugeNeedle.#ctor(System.String,System.Double,System.Drawing.Color)">
- <summary>
- Create a new <see cref="T:ZedGraph.GasGaugeNeedle"/>
- </summary>
- <param name="label">The value associated with this <see cref="T:ZedGraph.GasGaugeNeedle"/>
- instance.</param>
- <param name="color">The display color for this <see cref="T:ZedGraph.GasGaugeNeedle"/>
- instance.</param>
- <param name="val">The value of this <see cref="T:ZedGraph.GasGaugeNeedle"/>.</param>
- </member>
- <member name="M:ZedGraph.GasGaugeNeedle.#ctor(ZedGraph.GasGaugeNeedle)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="ggn">The <see cref="T:ZedGraph.GasGaugeNeedle"/> object from which to copy</param>
- </member>
- <member name="M:ZedGraph.GasGaugeNeedle.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.GasGaugeNeedle.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.GasGaugeNeedle.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.GasGaugeNeedle.IsZIncluded(ZedGraph.GraphPane)">
- <summary>
- Gets a flag indicating if the Z data range should be included in the axis scaling calculations.
- </summary>
- <param name="pane">The parent <see cref="T:ZedGraph.GraphPane"/> of this <see cref="T:ZedGraph.CurveItem"/>.
- </param>
- <value>true if the Z data are included, false otherwise</value>
- </member>
- <member name="M:ZedGraph.GasGaugeNeedle.IsXIndependent(ZedGraph.GraphPane)">
- <summary>
- Gets a flag indicating if the X axis is the independent axis for this <see cref="T:ZedGraph.CurveItem"/>
- </summary>
- <param name="pane">The parent <see cref="T:ZedGraph.GraphPane"/> of this <see cref="T:ZedGraph.CurveItem"/>.
- </param>
- <value>true if the X axis is independent, false otherwise</value>
- </member>
- <member name="M:ZedGraph.GasGaugeNeedle.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.GasGaugeNeedle.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.GasGaugeNeedle.Draw(System.Drawing.Graphics,ZedGraph.GraphPane,System.Int32,System.Single)">
- <summary>
- Do all rendering associated with this <see cref="T:ZedGraph.GasGaugeNeedle"/> item to the specified
- <see cref="T:System.Drawing.Graphics"/> device. This method is normally only
- called by the Draw method of the parent <see cref="T:ZedGraph.CurveList"/>
- collection object.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="pos">Not used for rendering GasGaugeNeedle</param>
- <param name="scaleFactor">Not used for rendering GasGaugeNeedle</param>
- </member>
- <member name="M:ZedGraph.GasGaugeNeedle.DrawLegendKey(System.Drawing.Graphics,ZedGraph.GraphPane,System.Drawing.RectangleF,System.Single)">
- <summary>
- Render the label for this <see cref="T:ZedGraph.GasGaugeNeedle"/>.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="rect">Bounding rectangle for this <see cref="T:ZedGraph.GasGaugeNeedle"/>.</param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.GasGaugeNeedle.GetCoords(ZedGraph.GraphPane,System.Int32,System.String@)">
- <summary>
- Determine the coords for the rectangle associated with a specified point for
- this <see cref="T:ZedGraph.CurveItem"/>
- </summary>
- <param name="pane">The <see cref="T:ZedGraph.GraphPane"/> to which this curve belongs</param>
- <param name="i">The index of the point of interest</param>
- <param name="coords">A list of coordinates that represents the "rect" for
- this point (used in an html AREA tag)</param>
- <returns>true if it's a valid point, false otherwise</returns>
- </member>
- <member name="M:ZedGraph.GasGaugeNeedle.CalculateGasGaugeParameters(ZedGraph.GraphPane)">
- <summary>
- Calculate the values needed to properly display this <see cref="T:ZedGraph.GasGaugeNeedle"/>.
- </summary>
- <param name="pane">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- </member>
- <member name="M:ZedGraph.GasGaugeNeedle.CalcRectangle(System.Drawing.Graphics,ZedGraph.GraphPane,System.Single,System.Drawing.RectangleF)">
- <summary>
- Calculate the <see cref="T:System.Drawing.RectangleF"/> that will be used to define the bounding rectangle of
- the GasGaugeNeedle.
- </summary>
- <remarks>This rectangle always lies inside of the <see cref="P:ZedGraph.Chart.Rect"/>, and it is
- normally a square so that the pie itself is not oval-shaped.</remarks>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <param name="chartRect">The <see cref="T:System.Drawing.RectangleF"/> (normally the <see cref="P:ZedGraph.Chart.Rect"/>)
- that bounds this pie.</param>
- <returns></returns>
- </member>
- <member name="P:ZedGraph.GasGaugeNeedle.NeedleWidth">
- <summary>
- Gets or Sets the NeedleWidth of this <see cref="T:ZedGraph.GasGaugeNeedle"/>
- </summary>
- </member>
- <member name="P:ZedGraph.GasGaugeNeedle.Border">
- <summary>
- Gets or Sets the Border of this <see cref="T:ZedGraph.GasGaugeNeedle"/>
- </summary>
- </member>
- <member name="P:ZedGraph.GasGaugeNeedle.SlicePath">
- <summary>
- Gets or Sets the SlicePath of this <see cref="T:ZedGraph.GasGaugeNeedle"/>
- </summary>
- </member>
- <member name="P:ZedGraph.GasGaugeNeedle.LabelDetail">
- <summary>
- Gets or Sets the LableDetail of this <see cref="T:ZedGraph.GasGaugeNeedle"/>
- </summary>
- </member>
- <member name="P:ZedGraph.GasGaugeNeedle.NeedleColor">
- <summary>
- Gets or Sets the NeedelColor of this <see cref="T:ZedGraph.GasGaugeNeedle"/>
- </summary>
- </member>
- <member name="P:ZedGraph.GasGaugeNeedle.Fill">
- <summary>
- Gets or Sets the Fill of this <see cref="T:ZedGraph.GasGaugeNeedle"/>
- </summary>
- </member>
- <member name="P:ZedGraph.GasGaugeNeedle.SweepAngle">
- <summary>
- Private property that Gets or Sets the SweepAngle of this <see cref="T:ZedGraph.GasGaugeNeedle"/>
- </summary>
- </member>
- <member name="P:ZedGraph.GasGaugeNeedle.NeedleValue">
- <summary>
- Gets or Sets the NeedleValue of this <see cref="T:ZedGraph.GasGaugeNeedle"/>
- </summary>
- </member>
- <member name="T:ZedGraph.GasGaugeNeedle.Default">
- <summary>
- Specify the default property values for the <see cref="T:ZedGraph.GasGaugeNeedle"/> class.
- </summary>
- </member>
- <member name="F:ZedGraph.GasGaugeNeedle.Default.NeedleWidth">
- <summary>
- The default width of the gas gauge needle. Units are points, scaled according
- to <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/>
- </summary>
- </member>
- <member name="F:ZedGraph.GasGaugeNeedle.Default.BorderWidth">
- <summary>
- The default pen width to be used for drawing the border around the GasGaugeNeedle
- (<see cref="P:ZedGraph.LineBase.Width"/> property). Units are points.
- </summary>
- </member>
- <member name="F:ZedGraph.GasGaugeNeedle.Default.IsBorderVisible">
- <summary>
- The default border mode for GasGaugeNeedle (<see cref="P:ZedGraph.LineBase.IsVisible"/>
- property).
- true to display frame around GasGaugeNeedle, false otherwise
- </summary>
- </member>
- <member name="F:ZedGraph.GasGaugeNeedle.Default.BorderColor">
- <summary>
- The default color for drawing frames around GasGaugeNeedle
- (<see cref="P:ZedGraph.LineBase.Color"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.GasGaugeNeedle.Default.FillType">
- <summary>
- The default fill type for filling the GasGaugeNeedle.
- </summary>
- </member>
- <member name="F:ZedGraph.GasGaugeNeedle.Default.FillColor">
- <summary>
- The default color for filling in the GasGaugeNeedle
- (<see cref="P:ZedGraph.Fill.Color"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.GasGaugeNeedle.Default.FillBrush">
- <summary>
- The default custom brush for filling in the GasGaugeNeedle.
- (<see cref="P:ZedGraph.Fill.Brush"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.GasGaugeNeedle.Default.isVisible">
- <summary>
- Default value for controlling <see cref="T:ZedGraph.GasGaugeNeedle"/> display.
- </summary>
- </member>
- <member name="F:ZedGraph.GasGaugeNeedle.Default.FontSize">
- <summary>
- The default font size for <see cref="P:ZedGraph.GasGaugeNeedle.LabelDetail"/> entries
- (<see cref="P:ZedGraph.FontSpec.Size"/> property). Units are
- in points (1/72 inch).
- </summary>
- </member>
- <member name="T:ZedGraph.DataSourcePointList">
- <summary>
-
- </summary>
- <seealso cref="T:ZedGraph.IPointList"/>
- <seealso cref="T:ZedGraph.IPointListEdit"/>
-
- <author>John Champion</author>
- <version> $Revision: 3.7 $ $Date: 2007-11-05 04:33:26 $ </version>
- </member>
- <member name="M:ZedGraph.DataSourcePointList.#ctor">
- <summary>
- Default Constructor
- </summary>
- </member>
- <member name="M:ZedGraph.DataSourcePointList.#ctor(ZedGraph.DataSourcePointList)">
- <summary>
- Constructor to initialize the DataSourcePointList from an
- existing <see cref="T:ZedGraph.DataSourcePointList"/>
- </summary>
- </member>
- <member name="M:ZedGraph.DataSourcePointList.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.DataSourcePointList.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.DataSourcePointList.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.DataSourcePointList.GetDouble(System.Object,System.String,System.Int32)">
- <summary>
- Extract a double value from the specified table row or data object with the
- specified column name.
- </summary>
- <param name="row">The data object from which to extract the value</param>
- <param name="dataMember">The property name or column name of the value
- to be extracted</param>
- <param name="index">The zero-based index of the point to be extracted.
- </param>
- </member>
- <member name="M:ZedGraph.DataSourcePointList.GetObject(System.Object,System.String)">
- <summary>
- Extract an object from the specified table row or data object with the
- specified column name.
- </summary>
- <param name="row">The data object from which to extract the object</param>
- <param name="dataMember">The property name or column name of the object
- to be extracted</param>
- </member>
- <member name="P:ZedGraph.DataSourcePointList.Item(System.Int32)">
- <summary>
- Indexer to access the specified <see cref="T:ZedGraph.PointPair"/> object by
- its ordinal position in the list.
- </summary>
- <param name="index">The ordinal position (zero-based) of the
- <see cref="T:ZedGraph.PointPair"/> object to be accessed.</param>
- <value>A <see cref="T:ZedGraph.PointPair"/> object reference.</value>
- </member>
- <member name="P:ZedGraph.DataSourcePointList.Count">
- <summary>
- gets the number of points available in the list
- </summary>
- </member>
- <member name="P:ZedGraph.DataSourcePointList.BindingSource">
- <summary>
- The <see cref="P:ZedGraph.DataSourcePointList.BindingSource"/> object from which to get the bound data
- </summary>
- <remarks>
- Typically, you set the <see cref="P:System.Windows.Forms.BindingSource.DataSource"/>
- property to a reference to your database, table or list object. The
- <see cref="P:System.Windows.Forms.BindingSource.DataMember"/> property would be set
- to the name of the datatable within the
- <see cref="P:System.Windows.Forms.BindingSource.DataSource"/>,
- if applicable.</remarks>
- </member>
- <member name="P:ZedGraph.DataSourcePointList.DataSource">
- <summary>
- The table or list object from which to extract the data values.
- </summary>
- <remarks>
- This property is just an alias for
- <see cref="P:System.Windows.Forms.BindingSource.DataSource"/>.
- </remarks>
- </member>
- <member name="P:ZedGraph.DataSourcePointList.XDataMember">
- <summary>
- The <see cref="T:System.String"/> name of the property or column from which to obtain the
- X data values for the chart.
- </summary>
- <remarks>Set this to null leave the X data values set to <see cref="F:ZedGraph.PointPairBase.Missing"/>
- </remarks>
- </member>
- <member name="P:ZedGraph.DataSourcePointList.YDataMember">
- <summary>
- The <see cref="T:System.String"/> name of the property or column from which to obtain the
- Y data values for the chart.
- </summary>
- <remarks>Set this to null leave the Y data values set to <see cref="F:ZedGraph.PointPairBase.Missing"/>
- </remarks>
- </member>
- <member name="P:ZedGraph.DataSourcePointList.ZDataMember">
- <summary>
- The <see cref="T:System.String"/> name of the property or column from which to obtain the
- Z data values for the chart.
- </summary>
- <remarks>Set this to null leave the Z data values set to <see cref="F:ZedGraph.PointPairBase.Missing"/>
- </remarks>
- </member>
- <member name="P:ZedGraph.DataSourcePointList.TagDataMember">
- <summary>
- The <see cref="T:System.String"/> name of the property or column from which to obtain the
- tag values for the chart.
- </summary>
- <remarks>Set this to null leave the tag values set to null. If this references string
- data, then the tags may be used as tooltips using the
- <see cref="P:ZedGraph.ZedGraphControl.IsShowPointValues"/> option.
- </remarks>
- </member>
- <member name="T:ZedGraph.TextScale">
- <summary>
- The TextScale class inherits from the <see cref="T:ZedGraph.Scale"/> class, and implements
- the features specific to <see cref="F:ZedGraph.AxisType.Text"/>.
- </summary>
- <remarks>
- TextScale is an ordinal axis with user-defined text labels. An ordinal axis means that
- all data points are evenly spaced at integral values, and the actual coordinate values
- for points corresponding to that axis are ignored. That is, if the X axis is an
- ordinal type, then all X values associated with the curves are ignored.
- </remarks>
-
- <author> John Champion </author>
- <version> $Revision: 1.8 $ $Date: 2006-08-25 05:19:09 $ </version>
- </member>
- <member name="F:ZedGraph.TextScale.schema2">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="M:ZedGraph.TextScale.#ctor(ZedGraph.Scale,ZedGraph.Axis)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.TextScale"/> object from which to copy</param>
- <param name="owner">The <see cref="T:ZedGraph.Axis"/> object that will own the
- new instance of <see cref="T:ZedGraph.TextScale"/></param>
- </member>
- <member name="M:ZedGraph.TextScale.Clone(ZedGraph.Axis)">
- <summary>
- Create a new clone of the current item, with a new owner assignment
- </summary>
- <param name="owner">The new <see cref="T:ZedGraph.Axis"/> instance that will be
- the owner of the new Scale</param>
- <returns>A new <see cref="T:ZedGraph.Scale"/> clone.</returns>
- </member>
- <member name="M:ZedGraph.TextScale.CalcMinorStart(System.Double)">
- <summary>
- Internal routine to determine the ordinals of the first minor tic mark
- </summary>
- <param name="baseVal">
- The value of the first major tic for the axis.
- </param>
- <returns>
- The ordinal position of the first minor tic, relative to the first major tic.
- This value can be negative (e.g., -3 means the first minor tic is 3 minor step
- increments before the first major tic.
- </returns>
- </member>
- <member name="M:ZedGraph.TextScale.CalcBaseTic">
- <summary>
- Determine the value for the first major tic.
- </summary>
- <remarks>
- This is done by finding the first possible value that is an integral multiple of
- the step size, taking into account the date/time units if appropriate.
- This method properly accounts for <see cref="P:ZedGraph.Scale.IsLog"/>, <see cref="P:ZedGraph.Scale.IsText"/>,
- and other axis format settings.
- </remarks>
- <returns>
- First major tic value (floating point double).
- </returns>
- </member>
- <member name="M:ZedGraph.TextScale.CalcNumTics">
- <summary>
- Internal routine to determine the ordinals of the first and last major axis label.
- </summary>
- <returns>
- This is the total number of major tics for this axis.
- </returns>
- </member>
- <member name="M:ZedGraph.TextScale.PickScale(ZedGraph.GraphPane,System.Drawing.Graphics,System.Single)">
- <summary>
- Select a reasonable text axis scale given a range of data values.
- </summary>
- <remarks>
- This method only applies to <see cref="F:ZedGraph.AxisType.Text"/> type axes, and it
- is called by the general <see cref="M:ZedGraph.TextScale.PickScale(ZedGraph.GraphPane,System.Drawing.Graphics,System.Single)"/> method. This is an ordinal
- type, such that the labeled values start at 1.0 and increment by 1.0 for
- each successive label. The maximum number of labels on the graph is
- determined by <see cref="F:ZedGraph.Scale.Default.MaxTextLabels"/>. If necessary, this method will
- set the <see cref="P:ZedGraph.Scale.MajorStep"/> value to greater than 1.0 in order to keep the total
- labels displayed below <see cref="F:ZedGraph.Scale.Default.MaxTextLabels"/>. For example, a
- <see cref="P:ZedGraph.Scale.MajorStep"/> size of 2.0 would only display every other label on the
- axis. The <see cref="P:ZedGraph.Scale.MajorStep"/> value calculated by this routine is always
- an integral value. This
- method honors the <see cref="P:ZedGraph.Scale.MinAuto"/>, <see cref="P:ZedGraph.Scale.MaxAuto"/>,
- and <see cref="P:ZedGraph.Scale.MajorStepAuto"/> autorange settings.
- In the event that any of the autorange settings are false, the
- corresponding <see cref="P:ZedGraph.Scale.Min"/>, <see cref="P:ZedGraph.Scale.Max"/>, or <see cref="P:ZedGraph.Scale.MajorStep"/>
- setting is explicitly honored, and the remaining autorange settings (if any) will
- be calculated to accomodate the non-autoranged values.
- <para>On Exit:</para>
- <para><see cref="P:ZedGraph.Scale.Min"/> is set to scale minimum (if <see cref="P:ZedGraph.Scale.MinAuto"/> = true)</para>
- <para><see cref="P:ZedGraph.Scale.Max"/> is set to scale maximum (if <see cref="P:ZedGraph.Scale.MaxAuto"/> = true)</para>
- <para><see cref="P:ZedGraph.Scale.MajorStep"/> is set to scale step size (if <see cref="P:ZedGraph.Scale.MajorStepAuto"/> = true)</para>
- <para><see cref="P:ZedGraph.Scale.MinorStep"/> is set to scale minor step size (if <see cref="P:ZedGraph.Scale.MinorStepAuto"/> = true)</para>
- <para><see cref="P:ZedGraph.Scale.Mag"/> is set to a magnitude multiplier according to the data</para>
- <para><see cref="P:ZedGraph.Scale.Format"/> is set to the display format for the values (this controls the
- number of decimal places, whether there are thousands separators, currency types, etc.)</para>
- </remarks>
- <param name="pane">A reference to the <see cref="T:ZedGraph.GraphPane"/> object
- associated with this <see cref="T:ZedGraph.Axis"/></param>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <seealso cref="M:ZedGraph.TextScale.PickScale(ZedGraph.GraphPane,System.Drawing.Graphics,System.Single)"/>
- <seealso cref="F:ZedGraph.AxisType.Text"/>
- </member>
- <member name="M:ZedGraph.TextScale.MakeLabel(ZedGraph.GraphPane,System.Int32,System.Double)">
- <summary>
- Make a value label for an <see cref="F:ZedGraph.AxisType.Text"/> <see cref="T:ZedGraph.Axis"/>.
- </summary>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="index">
- The zero-based, ordinal index of the label to be generated. For example, a value of 2 would
- cause the third value label on the axis to be generated.
- </param>
- <param name="dVal">
- The numeric value associated with the label. This value is ignored for log (<see cref="P:ZedGraph.Scale.IsLog"/>)
- and text (<see cref="P:ZedGraph.Scale.IsText"/>) type axes.
- </param>
- <returns>The resulting value label as a <see cref="T:System.String"/></returns>
- </member>
- <member name="M:ZedGraph.TextScale.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.TextScale.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="T:ZedGraph.Symbol">
- <summary>
- This class handles the drawing of the curve <see cref="T:ZedGraph.Symbol"/> objects.
- The symbols are the small shapes that appear over each defined point
- along the curve.
- </summary>
-
- <author> John Champion </author>
- <version> $Revision: 3.37 $ $Date: 2007-09-19 06:41:56 $ </version>
- </member>
- <member name="F:ZedGraph.Symbol.schema">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="F:ZedGraph.Symbol._size">
- <summary>
- Private field that stores the size of this
- <see cref="T:ZedGraph.Symbol"/> in points (1/72 inch). Use the public
- property <see cref="P:ZedGraph.Symbol.Size"/> to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.Symbol._type">
- <summary>
- Private field that stores the <see cref="T:ZedGraph.SymbolType"/> for this
- <see cref="T:ZedGraph.Symbol"/>. Use the public
- property <see cref="P:ZedGraph.Symbol.Type"/> to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.Symbol._isAntiAlias">
- <summary>
- private field that determines if the symbols are drawn using
- Anti-Aliasing capabilities from the <see cref="T:System.Drawing.Graphics"/> class.
- Use the public property <see cref="P:ZedGraph.Symbol.IsAntiAlias"/> to access
- this value.
- </summary>
- </member>
- <member name="F:ZedGraph.Symbol._isVisible">
- <summary>
- Private field that stores the visibility of this
- <see cref="T:ZedGraph.Symbol"/>. Use the public
- property <see cref="P:ZedGraph.Symbol.IsVisible"/> to access this value. If this value is
- false, the symbols will not be shown (but the <see cref="T:ZedGraph.Line"/> may
- still be shown).
- </summary>
- </member>
- <member name="F:ZedGraph.Symbol._fill">
- <summary>
- Private field that stores the <see cref="T:ZedGraph.Fill"/> data for this
- <see cref="T:ZedGraph.Symbol"/>. Use the public property <see cref="P:ZedGraph.Symbol.Fill"/> to
- access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.Symbol._border">
- <summary>
- Private field that stores the <see cref="T:ZedGraph.Border"/> data for this
- <see cref="T:ZedGraph.Symbol"/>. Use the public property <see cref="P:ZedGraph.Symbol.Border"/> to
- access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.Symbol._userSymbol">
- <summary>
- Private field that stores the user defined <see cref="T:System.Drawing.Drawing2D.GraphicsPath"/> data for this
- <see cref="T:ZedGraph.Symbol"/>. Use the public property <see cref="P:ZedGraph.Symbol.UserSymbol"/> to
- access this value.
- </summary>
- </member>
- <member name="M:ZedGraph.Symbol.#ctor">
- <summary>
- Default constructor that sets all <see cref="T:ZedGraph.Symbol"/> properties to default
- values as defined in the <see cref="T:ZedGraph.Symbol.Default"/> class.
- </summary>
- </member>
- <member name="M:ZedGraph.Symbol.#ctor(ZedGraph.SymbolType,System.Drawing.Color)">
- <summary>
- Default constructor that sets the <see cref="T:ZedGraph.SymbolType"/> and
- <see cref="T:System.Drawing.Color"/> as specified, and the remaining
- <see cref="T:ZedGraph.Symbol"/> properties to default
- values as defined in the <see cref="T:ZedGraph.Symbol.Default"/> class.
- </summary>
- <param name="type">A <see cref="T:ZedGraph.SymbolType"/> enum value
- indicating the shape of the symbol</param>
- <param name="color">A <see cref="T:System.Drawing.Color"/> value indicating
- the color of the symbol
- </param>
- </member>
- <member name="M:ZedGraph.Symbol.#ctor(ZedGraph.Symbol)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The Symbol object from which to copy</param>
- </member>
- <member name="M:ZedGraph.Symbol.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.Symbol.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.Symbol.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.Symbol.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.Symbol.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.Symbol.DrawSymbol(System.Drawing.Graphics,System.Int32,System.Int32,System.Drawing.Drawing2D.GraphicsPath,System.Drawing.Pen,System.Drawing.Brush)">
- <summary>
- Draw the <see cref="T:ZedGraph.Symbol"/> to the specified <see cref="T:System.Drawing.Graphics"/> device
- at the specified location. This routine draws a single symbol.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="x">The x position of the center of the symbol in
- pixel units</param>
- <param name="y">The y position of the center of the symbol in
- pixel units</param>
- <param name="path">A <see cref="T:System.Drawing.Drawing2D.GraphicsPath"/> previously constructed by
- <see cref="M:ZedGraph.Symbol.MakePath(System.Drawing.Graphics,System.Single)"/> for this symbol</param>
- <param name="pen">A <see cref="T:System.Drawing.Pen"/> class representing the standard pen for this symbol</param>
- <param name="brush">A <see cref="T:System.Drawing.Brush"/> class representing a default solid brush for this symbol
- If this symbol uses a <see cref="T:System.Drawing.Drawing2D.LinearGradientBrush"/>, it will be created on the fly for
- each point, since it has to be scaled to the individual point coordinates.</param>
- </member>
- <member name="M:ZedGraph.Symbol.DrawSymbol(System.Drawing.Graphics,ZedGraph.GraphPane,System.Int32,System.Int32,System.Single,System.Boolean,ZedGraph.PointPair)">
- <summary>
- Draw the <see cref="T:ZedGraph.Symbol"/> to the specified <see cref="T:System.Drawing.Graphics"/> device
- at the specified location. This routine draws a single symbol.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="x">The x position of the center of the symbol in
- pixel units</param>
- <param name="y">The y position of the center of the symbol in
- pixel units</param>
- <param name="scaleFactor">
- The scaling factor for the features of the graph based on the <see cref="P:ZedGraph.PaneBase.BaseDimension"/>. This
- scaling factor is calculated by the <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method. The scale factor
- represents a linear multiple to be applied to font sizes, symbol sizes, etc.
- </param>
- <param name="dataValue">The data value to be used for a value-based
- color gradient. This is only applicable for <see cref="F:ZedGraph.FillType.GradientByX"/>,
- <see cref="F:ZedGraph.FillType.GradientByY"/> or <see cref="F:ZedGraph.FillType.GradientByZ"/>.</param>
- <param name="isSelected">Indicates that the <see cref="T:ZedGraph.Symbol"/> should be drawn
- with attributes from the <see cref="T:ZedGraph.Selection"/> class.
- </param>
- </member>
- <member name="M:ZedGraph.Symbol.MakePath(System.Drawing.Graphics,System.Single)">
- <summary>
- Create a <see cref="T:System.Drawing.Drawing2D.GraphicsPath"/> struct for the current symbol based on the
- specified scaleFactor and assuming the symbol will be centered at position 0,0.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="scaleFactor">
- The scaling factor for the features of the graph based on the <see cref="P:ZedGraph.PaneBase.BaseDimension"/>. This
- scaling factor is calculated by the <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method. The scale factor
- represents a linear multiple to be applied to font sizes, symbol sizes, etc.</param>
- <returns>Returns the <see cref="T:System.Drawing.Drawing2D.GraphicsPath"/> for the current symbol</returns>
- </member>
- <member name="M:ZedGraph.Symbol.Draw(System.Drawing.Graphics,ZedGraph.GraphPane,ZedGraph.LineItem,System.Single,System.Boolean)">
- <summary>
- Draw this <see cref="T:ZedGraph.CurveItem"/> to the specified <see cref="T:System.Drawing.Graphics"/>
- device as a symbol at each defined point. The routine
- only draws the symbols; the lines are draw by the
- <see cref="M:ZedGraph.Line.DrawCurve(System.Drawing.Graphics,ZedGraph.GraphPane,ZedGraph.CurveItem,System.Single)"/> method. This method
- is normally only called by the Draw method of the
- <see cref="T:ZedGraph.CurveItem"/> object
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="curve">A <see cref="T:ZedGraph.LineItem"/> representing this
- curve.</param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <param name="isSelected">Indicates that the <see cref="T:ZedGraph.Symbol"/> should be drawn
- with attributes from the <see cref="T:ZedGraph.Selection"/> class.
- </param>
- </member>
- <member name="P:ZedGraph.Symbol.Size">
- <summary>
- Gets or sets the size of the <see cref="T:ZedGraph.Symbol"/>
- </summary>
- <value>Size in points (1/72 inch)</value>
- <seealso cref="F:ZedGraph.Symbol.Default.Size"/>
- </member>
- <member name="P:ZedGraph.Symbol.Type">
- <summary>
- Gets or sets the type (shape) of the <see cref="T:ZedGraph.Symbol"/>
- </summary>
- <value>A <see cref="T:ZedGraph.SymbolType"/> enum value indicating the shape</value>
- <seealso cref="F:ZedGraph.Symbol.Default.Type"/>
- </member>
- <member name="P:ZedGraph.Symbol.IsAntiAlias">
- <summary>
- Gets or sets a value that determines if the symbols are drawn using
- Anti-Aliasing capabilities from the <see cref="T:System.Drawing.Graphics"/> class.
- </summary>
- <remarks>
- If this value is set to true, then the <see cref="P:System.Drawing.Graphics.SmoothingMode"/>
- property will be set to <see cref="F:System.Drawing.Drawing2D.SmoothingMode.HighQuality"/> only while
- this <see cref="T:ZedGraph.Symbol"/> is drawn. A value of false will leave the value of
- <see cref="P:System.Drawing.Graphics.SmoothingMode"/> unchanged.
- </remarks>
- </member>
- <member name="P:ZedGraph.Symbol.IsVisible">
- <summary>
- Gets or sets a property that shows or hides the <see cref="T:ZedGraph.Symbol"/>.
- </summary>
- <value>true to show the symbol, false to hide it</value>
- <seealso cref="F:ZedGraph.Symbol.Default.IsVisible"/>
- </member>
- <member name="P:ZedGraph.Symbol.Fill">
- <summary>
- Gets or sets the <see cref="T:ZedGraph.Fill"/> data for this
- <see cref="T:ZedGraph.Symbol"/>.
- </summary>
- </member>
- <member name="P:ZedGraph.Symbol.Border">
- <summary>
- Gets or sets the <see cref="T:ZedGraph.Border"/> data for this
- <see cref="T:ZedGraph.Symbol"/>, which controls the border outline of the symbol.
- </summary>
- </member>
- <member name="P:ZedGraph.Symbol.UserSymbol">
- <summary>
- Gets or sets the <see cref="T:System.Drawing.Drawing2D.GraphicsPath"/> data for this
- <see cref="T:ZedGraph.Symbol"/>, describing the user-defined symbol type.
- </summary>
- <remarks>
- This value only applies if <see cref="P:ZedGraph.Symbol.Type">Symbol.Type</see>
- is <see cref="F:ZedGraph.SymbolType.UserDefined">SymbolType.UserDefined</see>
- </remarks>
- </member>
- <member name="T:ZedGraph.Symbol.Default">
- <summary>
- A simple struct that defines the
- default property values for the <see cref="T:ZedGraph.Symbol"/> class.
- </summary>
- </member>
- <member name="F:ZedGraph.Symbol.Default.Size">
- <summary>
- The default size for curve symbols (<see cref="P:ZedGraph.Symbol.Size"/> property),
- in units of points.
- </summary>
- </member>
- <member name="F:ZedGraph.Symbol.Default.PenWidth">
- <summary>
- The default pen width to be used for drawing curve symbols
- (<see cref="P:ZedGraph.LineBase.Width"/> property). Units are points.
- </summary>
- </member>
- <member name="F:ZedGraph.Symbol.Default.FillColor">
- <summary>
- The default color for filling in this <see cref="T:ZedGraph.Symbol"/>
- (<see cref="P:ZedGraph.Fill.Color"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.Symbol.Default.FillBrush">
- <summary>
- The default custom brush for filling in this <see cref="T:ZedGraph.Symbol"/>
- (<see cref="P:ZedGraph.Fill.Brush"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.Symbol.Default.FillType">
- <summary>
- The default fill mode for the curve (<see cref="P:ZedGraph.Fill.Type"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.Symbol.Default.Type">
- <summary>
- The default symbol type for curves (<see cref="P:ZedGraph.Symbol.Type"/> property).
- This is defined as a <see cref="T:ZedGraph.SymbolType"/> enumeration.
- </summary>
- </member>
- <member name="F:ZedGraph.Symbol.Default.IsAntiAlias">
- <summary>
- The default value for the <see cref="P:ZedGraph.Symbol.IsAntiAlias"/>
- property.
- </summary>
- </member>
- <member name="F:ZedGraph.Symbol.Default.IsVisible">
- <summary>
- The default display mode for symbols (<see cref="P:ZedGraph.Symbol.IsVisible"/> property).
- true to display symbols, false to hide them.
- </summary>
- </member>
- <member name="F:ZedGraph.Symbol.Default.IsBorderVisible">
- <summary>
- The default for drawing frames around symbols (<see cref="P:ZedGraph.LineBase.IsVisible"/> property).
- true to display symbol frames, false to hide them.
- </summary>
- </member>
- <member name="F:ZedGraph.Symbol.Default.BorderColor">
- <summary>
- The default color for drawing symbols (<see cref="P:ZedGraph.LineBase.Color"/> property).
- </summary>
- </member>
- <member name="T:ZedGraph.ScrollRangeList">
- <summary>
- A collection class containing a list of <see cref="T:ZedGraph.ScrollRange"/> objects.
- </summary>
-
- <author>John Champion</author>
- <version> $Revision: 3.3 $ $Date: 2006-06-24 20:26:43 $ </version>
- </member>
- <member name="M:ZedGraph.ScrollRangeList.#ctor">
- <summary>
- Default constructor for the collection class.
- </summary>
- </member>
- <member name="M:ZedGraph.ScrollRangeList.#ctor(ZedGraph.ScrollRangeList)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.ScrollRangeList"/> object from which to copy</param>
- </member>
- <member name="M:ZedGraph.ScrollRangeList.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.ScrollRangeList.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.ScrollRangeList.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="P:ZedGraph.ScrollRangeList.Item(System.Int32)">
- <summary>
- Indexer to access the specified <see cref="T:ZedGraph.ScrollRange"/> object by
- its ordinal position in the list.
- </summary>
- <param name="index">The ordinal position (zero-based) of the
- <see cref="T:ZedGraph.ScrollRange"/> object to be accessed.</param>
- <value>A <see cref="T:ZedGraph.ScrollRange"/> object instance</value>
- </member>
- <member name="T:ZedGraph.ScrollRange">
- <summary>
- A simple struct to store minimum and maximum <see cref="T:System.Double"/> type
- values for the scroll range
- </summary>
- </member>
- <member name="M:ZedGraph.ScrollRange.#ctor(System.Double,System.Double,System.Boolean)">
- <summary>
- Construct a <see cref="T:ZedGraph.ScrollRange"/> object given the specified data values.
- </summary>
- <param name="min">The minimum axis value limit for the scroll bar</param>
- <param name="max">The maximum axis value limit for the scroll bar</param>
- <param name="isScrollable">true to make this item scrollable, false otherwise</param>
- </member>
- <member name="M:ZedGraph.ScrollRange.#ctor(System.Boolean)">
- <summary>
- Sets the scroll range to default values of zero, and sets the <see cref="P:ZedGraph.ScrollRange.IsScrollable"/>
- property as specified.
- </summary>
- <param name="isScrollable">true to make this item scrollable, false otherwise</param>
- </member>
- <member name="M:ZedGraph.ScrollRange.#ctor(ZedGraph.ScrollRange)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.ScrollRange"/> object from which to copy</param>
- </member>
- <member name="P:ZedGraph.ScrollRange.IsScrollable">
- <summary>
- Gets or sets a property that determines if the <see cref="T:ZedGraph.Axis"/> corresponding to
- this <see cref="T:ZedGraph.ScrollRange"/> object can be scrolled.
- </summary>
- </member>
- <member name="P:ZedGraph.ScrollRange.Min">
- <summary>
- The minimum axis value limit for the scroll bar.
- </summary>
- </member>
- <member name="P:ZedGraph.ScrollRange.Max">
- <summary>
- The maximum axis value limit for the scroll bar.
- </summary>
- </member>
- <member name="T:ZedGraph.SampleType">
- <summary>
- enumeration used to indicate which type of data will be plotted.
- </summary>
- </member>
- <member name="F:ZedGraph.SampleType.Time">
- <summary>
- Designates the "Time" property will be used
- </summary>
- </member>
- <member name="F:ZedGraph.SampleType.Position">
- <summary>
- Designates the "Position" property will be used
- </summary>
- </member>
- <member name="F:ZedGraph.SampleType.VelocityInst">
- <summary>
- Designates the Instantaneous Velocity property will be used
- </summary>
- </member>
- <member name="F:ZedGraph.SampleType.TimeDiff">
- <summary>
- Designates the "Time since start" property will be used
- </summary>
- </member>
- <member name="F:ZedGraph.SampleType.VelocityAvg">
- <summary>
- Designates the Average Velocity property will be used
- </summary>
- </member>
- <member name="T:ZedGraph.Sample">
- <summary>
- A simple storage class to maintain an individual sampling of data
- </summary>
- </member>
- <member name="P:ZedGraph.Sample.Time">
- <summary>
- The time of the sample
- </summary>
- </member>
- <member name="P:ZedGraph.Sample.Position">
- <summary>
- The position at sample time
- </summary>
- </member>
- <member name="P:ZedGraph.Sample.Velocity">
- <summary>
- The instantaneous velocity at sample time
- </summary>
- </member>
- <member name="T:ZedGraph.SamplePointList">
- <summary>
- A collection class to maintain a set of samples
- </summary>
- </member>
- <member name="F:ZedGraph.SamplePointList.XType">
- <summary>
- Determines what data type gets plotted for the X values
- </summary>
- </member>
- <member name="F:ZedGraph.SamplePointList.YType">
- <summary>
- Determines what data type gets plotted for the Y values
- </summary>
- </member>
- <member name="M:ZedGraph.SamplePointList.GetValue(ZedGraph.Sample,ZedGraph.SampleType)">
- <summary>
- Get the specified data type from the specified sample
- </summary>
- <param name="sample">The sample instance of interest</param>
- <param name="type">The data type to be extracted from the sample</param>
- <returns>A double value representing the requested data</returns>
- </member>
- <member name="M:ZedGraph.SamplePointList.Add(ZedGraph.Sample)">
- <summary>
- Append a sample to the collection
- </summary>
- <param name="sample">The sample to append</param>
- <returns>The ordinal position at which the sample was added</returns>
- </member>
- <member name="M:ZedGraph.SamplePointList.Clone">
- <summary>
- typesafe clone method
- </summary>
- <returns>A new cloned SamplePointList. This returns a copy of the structure,
- but it does not duplicate the data (it just keeps a reference to the original)
- </returns>
- </member>
- <member name="M:ZedGraph.SamplePointList.#ctor">
- <summary>
- default constructor
- </summary>
- </member>
- <member name="M:ZedGraph.SamplePointList.#ctor(ZedGraph.SamplePointList)">
- <summary>
- copy constructor -- this returns a copy of the structure,
- but it does not duplicate the data (it just keeps a reference to the original)
- </summary>
- <param name="rhs">The SamplePointList to be copied</param>
- </member>
- <member name="P:ZedGraph.SamplePointList.Item(System.Int32)">
- <summary>
- Indexer: get the Sample instance at the specified ordinal position in the list
- </summary>
- <param name="index">The ordinal position in the list of samples</param>
- <returns>Returns a <see cref="T:ZedGraph.PointPair"/> instance containing the
- data specified by <see cref="F:ZedGraph.SamplePointList.XType"/> and <see cref="F:ZedGraph.SamplePointList.YType"/>
- </returns>
- </member>
- <member name="P:ZedGraph.SamplePointList.Count">
- <summary>
- Gets the number of samples in the collection
- </summary>
- </member>
- <member name="T:ZedGraph.PerfDataType">
- <summary>
- An enum used to specify the X or Y data type of interest -- see
- <see cref="F:ZedGraph.SampleMultiPointList.XData"/> and <see cref="F:ZedGraph.SampleMultiPointList.YData"/>.
- </summary>
- </member>
- <member name="F:ZedGraph.PerfDataType.Time">
- <summary>
- The time (seconds) at which these data are measured
- </summary>
- </member>
- <member name="F:ZedGraph.PerfDataType.Distance">
- <summary>
- The distance traveled, meters
- </summary>
- </member>
- <member name="F:ZedGraph.PerfDataType.Velocity">
- <summary>
- The instantaneous velocity, meters per second
- </summary>
- </member>
- <member name="F:ZedGraph.PerfDataType.Acceleration">
- <summary>
- The instantaneous acceleration, meters per second squared
- </summary>
- </member>
- <member name="T:ZedGraph.PerformanceData">
- <summary>
- Sample data structure containing a variety of data values, in this case the values
- are related in that they correspond to the same time value.
- </summary>
- </member>
- <member name="F:ZedGraph.PerformanceData.time">
- <summary>
- The time (seconds) at which these data are measured
- </summary>
- </member>
- <member name="F:ZedGraph.PerformanceData.distance">
- <summary>
- The distance traveled, meters
- </summary>
- </member>
- <member name="F:ZedGraph.PerformanceData.velocity">
- <summary>
- The instantaneous velocity, meters per second
- </summary>
- </member>
- <member name="F:ZedGraph.PerformanceData.acceleration">
- <summary>
- The instantaneous acceleration, meters per second squared
- </summary>
- </member>
- <member name="M:ZedGraph.PerformanceData.#ctor(System.Double,System.Double,System.Double,System.Double)">
- <summary>
- Constructor that specifies each data value in the PerformanceData struct
- </summary>
- <param name="time">The time (seconds) at which these data are measured</param>
- <param name="distance">The distance traveled, meters</param>
- <param name="velocity">The instantaneous velocity, meters per second</param>
- <param name="acceleration">The instantaneous acceleration, meters per second squared</param>
- </member>
- <member name="P:ZedGraph.PerformanceData.Item(ZedGraph.PerfDataType)">
- <summary>
- Gets or sets the data value as specified by the <see cref="T:ZedGraph.PerfDataType"/> enum
- </summary>
- <param name="type">The required data value type</param>
- </member>
- <member name="T:ZedGraph.SampleMultiPointList">
- <summary>
- A sample class that holds an internal collection, and implements the
- <see cref="T:ZedGraph.IPointList"/> interface so that it can be used by ZedGraph as curve data.
- </summary>
- <remarks>
- This particular class efficiently implements the data storage so that the class
- can be cloned without duplicating the data points. For example, you can create
- a <see cref="T:ZedGraph.SampleMultiPointList"/>, populate it with values, and set
- <see cref="F:ZedGraph.SampleMultiPointList.XData"/> = <see cref="F:ZedGraph.PerfDataType.Time"/> and
- <see cref="F:ZedGraph.SampleMultiPointList.YData"/> = <see cref="F:ZedGraph.PerfDataType.Distance"/>.
- You can then clone this <see cref="T:ZedGraph.SampleMultiPointList"/> to a new one, and set
- <see cref="F:ZedGraph.SampleMultiPointList.YData"/> = <see cref="F:ZedGraph.PerfDataType.Velocity"/>.
- Each of these <see cref="T:ZedGraph.SampleMultiPointList"/>'s can then be used as an
- <see cref="M:ZedGraph.GraphPane.AddCurve(System.String,ZedGraph.IPointList,System.Drawing.Color)"/> argument,
- thereby plotting a distance vs time curve and a velocity vs time curve. There
- will still be only one copy of the data in memory.
- </remarks>
- </member>
- <member name="F:ZedGraph.SampleMultiPointList.DataCollection">
- <summary>
- This is where the data are stored. Duplicating the <see cref="T:ZedGraph.SampleMultiPointList"/>
- copies the reference to this <see cref="T:System.Collections.ArrayList"/>, but does not actually duplicate
- the data.
- </summary>
- </member>
- <member name="F:ZedGraph.SampleMultiPointList.XData">
- <summary>
- Determines what X data will be returned by the indexer of this list.
- </summary>
- </member>
- <member name="F:ZedGraph.SampleMultiPointList.YData">
- <summary>
- Determines what Y data will be returned by the indexer of this list.
- </summary>
- </member>
- <member name="M:ZedGraph.SampleMultiPointList.#ctor">
- <summary>
- Default constructor
- </summary>
- </member>
- <member name="M:ZedGraph.SampleMultiPointList.#ctor(ZedGraph.SampleMultiPointList)">
- <summary>
- The Copy Constructor. This method does NOT duplicate the data, it merely makes
- another "Window" into the same collection. You can make multiple copies and
- set the <see cref="F:ZedGraph.SampleMultiPointList.XData"/> and/or <see cref="F:ZedGraph.SampleMultiPointList.YData"/> properties to different
- values to plot different data, while maintaining only one copy of the original values.
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.SampleMultiPointList"/> from which to copy</param>
- </member>
- <member name="M:ZedGraph.SampleMultiPointList.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.SampleMultiPointList.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.SampleMultiPointList.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.SampleMultiPointList.Add(ZedGraph.PerformanceData)">
- <summary>
- Adds the specified <see cref="T:ZedGraph.PerformanceData"/> struct to the end of the collection.
- </summary>
- <param name="perfData">A <see cref="T:ZedGraph.PerformanceData"/> struct to be added</param>
- <returns>The ordinal position in the collection where the values were added</returns>
- </member>
- <member name="M:ZedGraph.SampleMultiPointList.RemoveAt(System.Int32)">
- <summary>
- Remove the <see cref="T:ZedGraph.PerformanceData"/> struct from the list at the specified
- ordinal location.
- </summary>
- <param name="index">The ordinal location of the <see cref="T:ZedGraph.PerformanceData"/>
- struct to be removed</param>
- </member>
- <member name="M:ZedGraph.SampleMultiPointList.Insert(System.Int32,ZedGraph.PerformanceData)">
- <summary>
- Insert the specified <see cref="T:ZedGraph.PerformanceData"/> struct into the list at
- the specified ordinal location.
- </summary>
- <param name="index">The ordinal location at which to insert</param>
- <param name="perfData">The <see cref="T:ZedGraph.PerformanceData"/> struct to be inserted</param>
- </member>
- <member name="P:ZedGraph.SampleMultiPointList.Item(System.Int32)">
- <summary>
- Indexer to access the data. This gets the appropriate data and converts to
- the <see cref="T:ZedGraph.PointPair"/> struct that is compatible with ZedGraph. The
- actual data returned depends on the values of <see cref="F:ZedGraph.SampleMultiPointList.XData"/> and
- <see cref="F:ZedGraph.SampleMultiPointList.YData"/>.
- </summary>
- <param name="index">The ordinal position of the desired point in the list</param>
- <returns>A <see cref="T:ZedGraph.PointPair"/> corresponding to the specified ordinal data position</returns>
- </member>
- <member name="P:ZedGraph.SampleMultiPointList.Count">
- <summary>
- Gets the number of data points in the collection
- </summary>
- </member>
- <member name="T:ZedGraph.PointPairCV">
- <summary>
- A simple instance that stores a data point (X, Y, Z). This differs from a regular
- <see cref="T:ZedGraph.PointPair"/> in that it maps the <see cref="P:ZedGraph.PointPairCV.ColorValue"/> property
- to an independent value. That is, <see cref="P:ZedGraph.PointPairCV.ColorValue"/> and
- <see cref="F:ZedGraph.PointPair.Z"/> are not related (as they are in the
- <see cref="T:ZedGraph.PointPair"/>).
- </summary>
- </member>
- <member name="F:ZedGraph.PointPairCV.schema3">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="F:ZedGraph.PointPairCV._colorValue">
- <summary>
- This is a user value that can be anything. It is used to provide special
- property-based coloration to the graph elements.
- </summary>
- </member>
- <member name="M:ZedGraph.PointPairCV.#ctor(System.Double,System.Double,System.Double)">
- <summary>
- Creates a point pair with the specified X, Y, and base value.
- </summary>
- <param name="x">This pair's x coordinate.</param>
- <param name="y">This pair's y coordinate.</param>
- <param name="z">This pair's z or lower dependent coordinate.</param>
- </member>
- <member name="M:ZedGraph.PointPairCV.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.PointPairCV.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="P:ZedGraph.PointPairCV.ColorValue">
- <summary>
- The ColorValue property. This is used with the
- <see cref="F:ZedGraph.FillType.GradientByColorValue"/> option.
- </summary>
- </member>
- <member name="T:ZedGraph.Border">
- <summary>
- A class that encapsulates Border (frame) properties for an object. The <see cref="T:ZedGraph.Border"/> class
- is used in a variety of ZedGraph objects to handle the drawing of the Border around the object.
- </summary>
-
- <author> John Champion </author>
- <version> $Revision: 3.18 $ $Date: 2007-03-17 18:43:44 $ </version>
- </member>
- <member name="F:ZedGraph.Border.schema">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="F:ZedGraph.Border._inflateFactor">
- <summary>
- Private field that stores the amount of inflation to be done on the rectangle
- before rendering. This allows the border to be inset or outset relative to
- the actual rectangle area. Use the public property <see cref="P:ZedGraph.Border.InflateFactor"/>
- to access this value.
- </summary>
- </member>
- <member name="M:ZedGraph.Border.#ctor">
- <summary>
- The default constructor. Initialized to default values.
- </summary>
- </member>
- <member name="M:ZedGraph.Border.#ctor(System.Boolean,System.Drawing.Color,System.Single)">
- <summary>
- Constructor that specifies the visibility, color and penWidth of the Border.
- </summary>
- <param name="isVisible">Determines whether or not the Border will be drawn.</param>
- <param name="color">The color of the Border</param>
- <param name="width">The width, in points (1/72 inch), for the Border.</param>
- </member>
- <member name="M:ZedGraph.Border.#ctor(System.Drawing.Color,System.Single)">
- <summary>
- Constructor that specifies the color and penWidth of the Border.
- </summary>
- <param name="color">The color of the Border</param>
- <param name="width">The width, in points (1/72 inch), for the Border.</param>
- </member>
- <member name="M:ZedGraph.Border.#ctor(ZedGraph.Border)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The Border object from which to copy</param>
- </member>
- <member name="M:ZedGraph.Border.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.Border.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.Border.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.Border.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.Border.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.Border.Draw(System.Drawing.Graphics,ZedGraph.PaneBase,System.Single,System.Drawing.RectangleF)">
- <summary>
- Draw the specified Border (<see cref="T:System.Drawing.RectangleF"/>) using the properties of
- this <see cref="T:ZedGraph.Border"/> object.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.PaneBase"/> object that is the parent or
- owner of this object.
- </param>
- <param name="scaleFactor">
- The scaling factor for the features of the graph based on the <see cref="P:ZedGraph.PaneBase.BaseDimension"/>. This
- scaling factor is calculated by the <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method. The scale factor
- represents a linear multiple to be applied to font sizes, symbol sizes, etc.
- </param>
- <param name="rect">A <see cref="T:System.Drawing.RectangleF"/> struct to be drawn.</param>
- </member>
- <member name="P:ZedGraph.Border.InflateFactor">
- <summary>
- Gets or sets the amount of inflation to be done on the rectangle
- before rendering.
- </summary>
- <remarks>This allows the border to be inset or outset relative to
- the actual rectangle area.
- </remarks>
- </member>
- <member name="T:ZedGraph.Border.Default">
- <summary>
- A simple struct that defines the
- default property values for the <see cref="T:ZedGraph.Fill"/> class.
- </summary>
- </member>
- <member name="F:ZedGraph.Border.Default.InflateFactor">
- <summary>
- The default value for <see cref="P:ZedGraph.Border.InflateFactor"/>, in units of points (1/72 inch).
- </summary>
- <seealso cref="P:ZedGraph.Border.InflateFactor"/>
- </member>
- <member name="T:ZedGraph.X2Axis">
- <summary>
- <see cref="T:ZedGraph.X2Axis"/> inherits from <see cref="T:ZedGraph.Axis"/>, and defines the
- special characteristics of a horizontal axis, specifically located at
- the top of the <see cref="P:ZedGraph.Chart.Rect"/> of the <see cref="T:ZedGraph.GraphPane"/>
- object
- </summary>
-
- <author> John Champion </author>
- <version> $Revision: 3.1 $ $Date: 2007-04-16 00:03:07 $ </version>
- </member>
- <member name="F:ZedGraph.X2Axis.schema2">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="M:ZedGraph.X2Axis.#ctor">
- <summary>
- Default constructor that sets all <see cref="T:ZedGraph.X2Axis"/> properties to
- default values as defined in the <see cref="T:ZedGraph.X2Axis.Default"/> class
- </summary>
- </member>
- <member name="M:ZedGraph.X2Axis.#ctor(System.String)">
- <summary>
- Default constructor that sets all <see cref="T:ZedGraph.X2Axis"/> properties to
- default values as defined in the <see cref="T:ZedGraph.X2Axis.Default"/> class, except
- for the axis title
- </summary>
- <param name="title">The <see cref="P:ZedGraph.Axis.Title"/> for this axis</param>
- </member>
- <member name="M:ZedGraph.X2Axis.#ctor(ZedGraph.X2Axis)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The X2Axis object from which to copy</param>
- </member>
- <member name="M:ZedGraph.X2Axis.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.X2Axis.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.X2Axis.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.X2Axis.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.X2Axis.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.X2Axis.SetTransformMatrix(System.Drawing.Graphics,ZedGraph.GraphPane,System.Single)">
- <summary>
- Setup the Transform Matrix to handle drawing of this <see cref="T:ZedGraph.X2Axis"/>
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.X2Axis.IsPrimary(ZedGraph.GraphPane)">
- <summary>
- Determines if this <see cref="T:ZedGraph.Axis"/> object is a "primary" one.
- </summary>
- <remarks>
- The primary axes are the <see cref="T:ZedGraph.XAxis"/> (always),
- the <see cref="T:ZedGraph.X2Axis"/> (always), the first
- <see cref="T:ZedGraph.YAxis"/> in the <see cref="P:ZedGraph.GraphPane.YAxisList"/>
- (<see cref="P:ZedGraph.CurveItem.YAxisIndex"/> = 0), and the first
- <see cref="T:ZedGraph.Y2Axis"/> in the <see cref="P:ZedGraph.GraphPane.Y2AxisList"/>
- (<see cref="P:ZedGraph.CurveItem.YAxisIndex"/> = 0). Note that
- <see cref="P:ZedGraph.GraphPane.YAxis"/> and <see cref="P:ZedGraph.GraphPane.Y2Axis"/>
- always reference the primary axes.
- </remarks>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <returns>true for a primary <see cref="T:ZedGraph.Axis"/> (for the <see cref="T:ZedGraph.X2Axis"/>,
- this is always true), false otherwise</returns>
- </member>
- <member name="M:ZedGraph.X2Axis.CalcCrossShift(ZedGraph.GraphPane)">
- <summary>
- Calculate the "shift" size, in pixels, in order to shift the axis from its default
- location to the value specified by <see cref="P:ZedGraph.Axis.Cross"/>.
- </summary>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <returns>The shift amount measured in pixels</returns>
- </member>
- <member name="M:ZedGraph.X2Axis.GetCrossAxis(ZedGraph.GraphPane)">
- <summary>
- Gets the "Cross" axis that corresponds to this axis.
- </summary>
- <remarks>
- The cross axis is the axis which determines the of this Axis when the
- <see cref="P:ZedGraph.Axis.Cross">Axis.Cross</see> property is used. The
- cross axis for any <see cref="T:ZedGraph.XAxis"/> or <see cref="T:ZedGraph.X2Axis"/>
- is always the primary <see cref="T:ZedGraph.YAxis"/>, and
- the cross axis for any <see cref="T:ZedGraph.YAxis"/> or <see cref="T:ZedGraph.Y2Axis"/> is
- always the primary <see cref="T:ZedGraph.XAxis"/>.
- </remarks>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- </member>
- <member name="T:ZedGraph.X2Axis.Default">
- <summary>
- A simple struct that defines the
- default property values for the <see cref="T:ZedGraph.X2Axis"/> class.
- </summary>
- </member>
- <member name="F:ZedGraph.X2Axis.Default.IsVisible">
- <summary>
- The default display mode for the <see cref="T:ZedGraph.X2Axis"/>
- (<see cref="P:ZedGraph.Axis.IsVisible"/> property). true to display the scale
- values, title, tic marks, false to hide the axis entirely.
- </summary>
- </member>
- <member name="F:ZedGraph.X2Axis.Default.IsZeroLine">
- <summary>
- Determines if a line will be drawn at the zero value for the
- <see cref="T:ZedGraph.X2Axis"/>, that is, a line that
- divides the negative values from positive values.
- <seealso cref="P:ZedGraph.MajorGrid.IsZeroLine"/>.
- </summary>
- </member>
- <member name="T:ZedGraph.OrdinalScale">
- <summary>
- The OrdinalScale class inherits from the <see cref="T:ZedGraph.Scale"/> class, and implements
- the features specific to <see cref="F:ZedGraph.AxisType.Ordinal"/>.
- </summary>
- <remarks>
- OrdinalScale is an ordinal axis with tic labels generated at integral values. An ordinal axis means that
- all data points are evenly spaced at integral values, and the actual coordinate values
- for points corresponding to that axis are ignored. That is, if the X axis is an
- ordinal type, then all X values associated with the curves are ignored.
- </remarks>
-
- <author> John Champion </author>
- <version> $Revision: 1.8 $ $Date: 2007-04-16 00:03:02 $ </version>
- </member>
- <member name="F:ZedGraph.OrdinalScale.schema2">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="M:ZedGraph.OrdinalScale.#ctor(ZedGraph.Axis)">
- <summary>
- Default constructor that defines the owner <see cref="T:ZedGraph.Axis"/>
- (containing object) for this new object.
- </summary>
- <param name="owner">The owner, or containing object, of this instance</param>
- </member>
- <member name="M:ZedGraph.OrdinalScale.#ctor(ZedGraph.Scale,ZedGraph.Axis)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.OrdinalScale"/> object from which to copy</param>
- <param name="owner">The <see cref="T:ZedGraph.Axis"/> object that will own the
- new instance of <see cref="T:ZedGraph.OrdinalScale"/></param>
- </member>
- <member name="M:ZedGraph.OrdinalScale.Clone(ZedGraph.Axis)">
- <summary>
- Create a new clone of the current item, with a new owner assignment
- </summary>
- <param name="owner">The new <see cref="T:ZedGraph.Axis"/> instance that will be
- the owner of the new Scale</param>
- <returns>A new <see cref="T:ZedGraph.Scale"/> clone.</returns>
- </member>
- <member name="M:ZedGraph.OrdinalScale.PickScale(ZedGraph.GraphPane,System.Drawing.Graphics,System.Single)">
- <summary>
- Select a reasonable ordinal axis scale given a range of data values.
- </summary>
- <remarks>
- This method only applies to <see cref="F:ZedGraph.AxisType.Ordinal"/> type axes, and it
- is called by the general <see cref="M:ZedGraph.Scale.PickScale(ZedGraph.GraphPane,System.Drawing.Graphics,System.Single)"/> method. The scale range is chosen
- based on increments of 1, 2, or 5 (because they are even divisors of 10).
- Being an ordinal axis type, the <see cref="P:ZedGraph.Scale.MajorStep"/> value will always be integral. This
- method honors the <see cref="P:ZedGraph.Scale.MinAuto"/>, <see cref="P:ZedGraph.Scale.MaxAuto"/>,
- and <see cref="P:ZedGraph.Scale.MajorStepAuto"/> autorange settings.
- In the event that any of the autorange settings are false, the
- corresponding <see cref="P:ZedGraph.Scale.Min"/>, <see cref="P:ZedGraph.Scale.Max"/>, or <see cref="P:ZedGraph.Scale.MajorStep"/>
- setting is explicitly honored, and the remaining autorange settings (if any) will
- be calculated to accomodate the non-autoranged values. The basic defaults for
- scale selection are defined using <see cref="F:ZedGraph.Scale.Default.ZeroLever"/>,
- <see cref="F:ZedGraph.Scale.Default.TargetXSteps"/>, and <see cref="F:ZedGraph.Scale.Default.TargetYSteps"/>
- from the <see cref="T:ZedGraph.Scale.Default"/> default class.
- <para>On Exit:</para>
- <para><see cref="P:ZedGraph.Scale.Min"/> is set to scale minimum (if <see cref="P:ZedGraph.Scale.MinAuto"/> = true)</para>
- <para><see cref="P:ZedGraph.Scale.Max"/> is set to scale maximum (if <see cref="P:ZedGraph.Scale.MaxAuto"/> = true)</para>
- <para><see cref="P:ZedGraph.Scale.MajorStep"/> is set to scale step size (if <see cref="P:ZedGraph.Scale.MajorStepAuto"/> = true)</para>
- <para><see cref="P:ZedGraph.Scale.MinorStep"/> is set to scale minor step size (if <see cref="P:ZedGraph.Scale.MinorStepAuto"/> = true)</para>
- <para><see cref="P:ZedGraph.Scale.Mag"/> is set to a magnitude multiplier according to the data</para>
- <para><see cref="P:ZedGraph.Scale.Format"/> is set to the display format for the values (this controls the
- number of decimal places, whether there are thousands separators, currency types, etc.)</para>
- </remarks>
- <param name="pane">A reference to the <see cref="T:ZedGraph.GraphPane"/> object
- associated with this <see cref="T:ZedGraph.Axis"/></param>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <seealso cref="F:ZedGraph.AxisType.Ordinal"/>
- </member>
- <member name="M:ZedGraph.OrdinalScale.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.OrdinalScale.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="P:ZedGraph.OrdinalScale.Type">
- <summary>
- Return the <see cref="T:ZedGraph.AxisType"/> for this <see cref="T:ZedGraph.Scale"/>, which is
- <see cref="F:ZedGraph.AxisType.Ordinal"/>.
- </summary>
- </member>
- <member name="T:ZedGraph.DataPoint">
- <summary>
- A simple storage struct to maintain an individual sampling of data. This only
- contains two data values in order to reduce to memory load for large datasets.
- (e.g., no Tag or Z property)
- </summary>
- </member>
- <member name="F:ZedGraph.DataPoint.X">
- <summary>
- The X value for the point, stored as a double type.
- </summary>
- </member>
- <member name="F:ZedGraph.DataPoint.Y">
- <summary>
- The Y value for the point, stored as a double type.
- </summary>
- </member>
- <member name="T:ZedGraph.NoDupePointList">
- <summary>
- A collection class to maintain a set of samples.
- </summary>
- <remarks>This type, intended for very
- large datasets, will reduce the number of points displayed by eliminating
- individual points that overlay (at the same pixel location) on the graph.
- Note that this type probably does not make sense for line plots, but is intended
- primarily for scatter plots.
- </remarks>
-
- <author> John Champion </author>
- <version> $Revision: 3.5 $ $Date: 2007-06-02 06:56:03 $ </version>
- </member>
- <member name="F:ZedGraph.NoDupePointList._isFiltered">
- <summary>
- Protected field that stores a value indicating whether or not the data have been filtered.
- If the data have not been filtered, then <see cref="P:ZedGraph.NoDupePointList.Count"/> will be equal to
- <see cref="P:ZedGraph.NoDupePointList.TotalCount"/>. Use the public property <see cref="P:ZedGraph.NoDupePointList.IsFiltered"/> to
- access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.NoDupePointList._filteredCount">
- <summary>
- Protected field that stores the number of data points after filtering (e.g.,
- <see cref="M:ZedGraph.NoDupePointList.FilterData(ZedGraph.GraphPane,ZedGraph.Axis,ZedGraph.Axis)"/> has been called). The <see cref="P:ZedGraph.NoDupePointList.Count"/> property
- returns the total count for an unfiltered dataset, or <see cref="F:ZedGraph.NoDupePointList._filteredCount"/>
- for a dataset that has been filtered.
- </summary>
- </member>
- <member name="F:ZedGraph.NoDupePointList._visibleIndicies">
- <summary>
- Protected array of indices for all the points that are currently visible. This only
- applies if <see cref="P:ZedGraph.NoDupePointList.IsFiltered"/> is true.
- </summary>
- </member>
- <member name="F:ZedGraph.NoDupePointList._filterMode">
- <summary>
- Protected field that stores a value that determines how close a point must be to a prior
- neighbor in order to be filtered out. Use the public property <see cref="P:ZedGraph.NoDupePointList.FilterMode"/>
- to access this value.
- </summary>
- </member>
- <member name="M:ZedGraph.NoDupePointList.Add(ZedGraph.PointPair)">
- <summary>
- Append a data point to the collection
- </summary>
- <param name="pt">The <see cref="T:ZedGraph.PointPair"/> value to append</param>
- </member>
- <member name="M:ZedGraph.NoDupePointList.Add(System.Double,System.Double)">
- <summary>
- Append a point to the collection
- </summary>
- <param name="x">The x value of the point to append</param>
- <param name="y">The y value of the point to append</param>
- </member>
- <member name="M:ZedGraph.NoDupePointList.Clone">
- <summary>
- typesafe clone method
- </summary>
- <returns>A new cloned NoDupePointList. This returns a copy of the structure,
- but it does not duplicate the data (it just keeps a reference to the original)
- </returns>
- </member>
- <member name="M:ZedGraph.NoDupePointList.#ctor">
- <summary>
- default constructor
- </summary>
- </member>
- <member name="M:ZedGraph.NoDupePointList.#ctor(ZedGraph.NoDupePointList)">
- <summary>
- copy constructor -- this returns a copy of the structure,
- but it does not duplicate the data (it just keeps a reference to the original)
- </summary>
- <param name="rhs">The NoDupePointList to be copied</param>
- </member>
- <member name="M:ZedGraph.NoDupePointList.GetDataPointAt(System.Int32)">
- <summary>
- Protected method to access the internal DataPoint collection, without any
- translation to a PointPair.
- </summary>
- <param name="index">The ordinal position of the DataPoint of interest</param>
- </member>
- <member name="M:ZedGraph.NoDupePointList.ClearFilter">
- <summary>
- Clears any filtering previously done by a call to <see cref="M:ZedGraph.NoDupePointList.FilterData(ZedGraph.GraphPane,ZedGraph.Axis,ZedGraph.Axis)"/>.
- After calling this method, all data points will be visible, and
- <see cref="P:ZedGraph.NoDupePointList.Count"/> will be equal to <see cref="P:ZedGraph.NoDupePointList.TotalCount"/>.
- </summary>
- </member>
- <member name="M:ZedGraph.NoDupePointList.FilterData(ZedGraph.GraphPane,ZedGraph.Axis,ZedGraph.Axis)">
- <summary>
- Go through the collection, and hide (filter out) any points that fall on the
- same pixel location as a previously included point.
- </summary>
- <remarks>
- This method does not delete any points, it just temporarily hides them until
- the next call to <see cref="M:ZedGraph.NoDupePointList.FilterData(ZedGraph.GraphPane,ZedGraph.Axis,ZedGraph.Axis)"/> or <see cref="M:ZedGraph.NoDupePointList.ClearFilter"/>.
- You should call <see cref="M:ZedGraph.NoDupePointList.FilterData(ZedGraph.GraphPane,ZedGraph.Axis,ZedGraph.Axis)"/> once your collection of points has
- been constructed. You may need to call <see cref="M:ZedGraph.NoDupePointList.FilterData(ZedGraph.GraphPane,ZedGraph.Axis,ZedGraph.Axis)"/> again if
- you add points, or if the chart rect changes size (by resizing, printing,
- image save, etc.), or if the scale range changes.
- You must call <see cref="M:ZedGraph.GraphPane.AxisChange"/> before calling
- this method so that the <see cref="P:ZedGraph.Chart.Rect">GraphPane.Chart.Rect</see>
- and the scale ranges are valid. This method is not valid for
- ordinal axes (but ordinal axes don't make sense for very large datasets
- anyway).
- </remarks>
- <param name="pane">The <see cref="T:ZedGraph.GraphPane"/> into which the data
- will be plotted. </param>
- <param name="yAxis">The <see cref="T:ZedGraph.Axis"/> class to be used in the Y direction
- for plotting these data. This can be a <see cref="T:ZedGraph.YAxis"/> or a
- <see cref="T:ZedGraph.Y2Axis"/>, and can be a primary or secondary axis (if multiple Y or Y2
- axes are being used).
- </param>
- <param name="xAxis">The <see cref="T:ZedGraph.Axis"/> class to be used in the X direction
- for plotting these data. This can be an <see cref="T:ZedGraph.XAxis"/> or a
- <see cref="T:ZedGraph.X2Axis"/>.
- </param>
- </member>
- <member name="P:ZedGraph.NoDupePointList.FilterMode">
- <summary>
- Gets or sets a value that determines how close a point must be to a prior
- neighbor in order to be filtered out.
- </summary>
- <remarks>
- A value of 0 indicates that subsequent
- points must coincide exactly at the same pixel location. A value of 1 or more
- indicates that number of pixels distance from a prior point that will cause
- a new point to be filtered out. For example, a value of 2 means that, once
- a particular pixel location is taken, any subsequent point that lies within 2
- pixels of that location will be filtered out.
- </remarks>
- </member>
- <member name="P:ZedGraph.NoDupePointList.IsFiltered">
- <summary>
- Gets a value indicating whether or not the data have been filtered. If the data
- have not been filtered, then <see cref="P:ZedGraph.NoDupePointList.Count"/> will be equal to
- <see cref="P:ZedGraph.NoDupePointList.TotalCount"/>.
- </summary>
- </member>
- <member name="P:ZedGraph.NoDupePointList.Item(System.Int32)">
- <summary>
- Indexer: get the DataPoint instance at the specified ordinal position in the list
- </summary>
- <remarks>
- This method will throw an exception if the index is out of range. This can happen
- if the index is less than the number of filtered values, or if data points are
- removed from a filtered dataset with updating the filter (by calling
- <see cref="M:ZedGraph.NoDupePointList.FilterData(ZedGraph.GraphPane,ZedGraph.Axis,ZedGraph.Axis)"/>).
- </remarks>
- <param name="index">The ordinal position in the list of points</param>
- <returns>Returns a <see cref="T:ZedGraph.PointPair"/> instance. The <see cref="F:ZedGraph.PointPair.Z"/>
- and <see cref="F:ZedGraph.PointPair.Tag"/> properties will be defaulted to
- <see cref="F:ZedGraph.PointPairBase.Missing"/> and null, respectively.
- </returns>
- </member>
- <member name="P:ZedGraph.NoDupePointList.Count">
- <summary>
- Gets the number of active samples in the collection. This is the number of
- samples that are non-duplicates. See the <see cref="P:ZedGraph.NoDupePointList.TotalCount"/> property
- to get the total number of samples in the list.
- </summary>
- </member>
- <member name="P:ZedGraph.NoDupePointList.TotalCount">
- <summary>
- Gets the total number of samples in the collection. See the <see cref="P:ZedGraph.NoDupePointList.Count"/>
- property to get the number of active (non-duplicate) samples in the list.
- </summary>
- </member>
- <member name="T:ZedGraph.Margin">
- <summary>
- Class that handles that stores the margin properties for the GraphPane
- </summary>
-
- <author> John Champion </author>
- <version> $Revision: 3.1 $ $Date: 2006-06-24 20:26:44 $ </version>
- </member>
- <member name="F:ZedGraph.Margin.schema">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="F:ZedGraph.Margin._left">
- <summary>
- Private fields that store the size of the margin around the edge of the pane which will be
- kept blank. Use the public properties <see cref="P:ZedGraph.Margin.Left"/>, <see cref="P:ZedGraph.Margin.Right"/>,
- <see cref="P:ZedGraph.Margin.Top"/>, <see cref="P:ZedGraph.Margin.Bottom"/> to access these values.
- </summary>
- <value>Units are points (1/72 inch)</value>
- </member>
- <member name="F:ZedGraph.Margin._right">
- <summary>
- Private fields that store the size of the margin around the edge of the pane which will be
- kept blank. Use the public properties <see cref="P:ZedGraph.Margin.Left"/>, <see cref="P:ZedGraph.Margin.Right"/>,
- <see cref="P:ZedGraph.Margin.Top"/>, <see cref="P:ZedGraph.Margin.Bottom"/> to access these values.
- </summary>
- <value>Units are points (1/72 inch)</value>
- </member>
- <member name="F:ZedGraph.Margin._top">
- <summary>
- Private fields that store the size of the margin around the edge of the pane which will be
- kept blank. Use the public properties <see cref="P:ZedGraph.Margin.Left"/>, <see cref="P:ZedGraph.Margin.Right"/>,
- <see cref="P:ZedGraph.Margin.Top"/>, <see cref="P:ZedGraph.Margin.Bottom"/> to access these values.
- </summary>
- <value>Units are points (1/72 inch)</value>
- </member>
- <member name="F:ZedGraph.Margin._bottom">
- <summary>
- Private fields that store the size of the margin around the edge of the pane which will be
- kept blank. Use the public properties <see cref="P:ZedGraph.Margin.Left"/>, <see cref="P:ZedGraph.Margin.Right"/>,
- <see cref="P:ZedGraph.Margin.Top"/>, <see cref="P:ZedGraph.Margin.Bottom"/> to access these values.
- </summary>
- <value>Units are points (1/72 inch)</value>
- </member>
- <member name="M:ZedGraph.Margin.#ctor">
- <summary>
- Constructor to build a <see cref="T:ZedGraph.Margin"/> from the default values.
- </summary>
- </member>
- <member name="M:ZedGraph.Margin.#ctor(ZedGraph.Margin)">
- <summary>
- Copy constructor
- </summary>
- <param name="rhs">the <see cref="T:ZedGraph.Margin"/> instance to be copied.</param>
- </member>
- <member name="M:ZedGraph.Margin.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.Margin.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.Margin.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.Margin.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.Margin.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="P:ZedGraph.Margin.Left">
- <summary>
- Gets or sets a float value that determines the margin area between the left edge of the
- <see cref="P:ZedGraph.PaneBase.Rect"/> rectangle and the features of the graph.
- </summary>
- <value>This value is in units of points (1/72 inch), and is scaled
- linearly with the graph size.</value>
- <seealso cref="F:ZedGraph.Margin.Default.Left"/>
- <seealso cref="P:ZedGraph.PaneBase.IsFontsScaled"/>
- <seealso cref="P:ZedGraph.Margin.Right"/>
- <seealso cref="P:ZedGraph.Margin.Top"/>
- <seealso cref="P:ZedGraph.Margin.Bottom"/>
- </member>
- <member name="P:ZedGraph.Margin.Right">
- <summary>
- Gets or sets a float value that determines the margin area between the right edge of the
- <see cref="P:ZedGraph.PaneBase.Rect"/> rectangle and the features of the graph.
- </summary>
- <value>This value is in units of points (1/72 inch), and is scaled
- linearly with the graph size.</value>
- <seealso cref="F:ZedGraph.Margin.Default.Right"/>
- <seealso cref="P:ZedGraph.PaneBase.IsFontsScaled"/>
- <seealso cref="P:ZedGraph.Margin.Left"/>
- <seealso cref="P:ZedGraph.Margin.Top"/>
- <seealso cref="P:ZedGraph.Margin.Bottom"/>
- </member>
- <member name="P:ZedGraph.Margin.Top">
- <summary>
- Gets or sets a float value that determines the margin area between the top edge of the
- <see cref="P:ZedGraph.PaneBase.Rect"/> rectangle and the features of the graph.
- </summary>
- <value>This value is in units of points (1/72 inch), and is scaled
- linearly with the graph size.</value>
- <seealso cref="F:ZedGraph.Margin.Default.Top"/>
- <seealso cref="P:ZedGraph.PaneBase.IsFontsScaled"/>
- <seealso cref="P:ZedGraph.Margin.Left"/>
- <seealso cref="P:ZedGraph.Margin.Right"/>
- <seealso cref="P:ZedGraph.Margin.Bottom"/>
- </member>
- <member name="P:ZedGraph.Margin.Bottom">
- <summary>
- Gets or sets a float value that determines the margin area between the bottom edge of the
- <see cref="P:ZedGraph.PaneBase.Rect"/> rectangle and the features of the graph.
- </summary>
- <value>This value is in units of points (1/72 inch), and is scaled
- linearly with the graph size.</value>
- <seealso cref="F:ZedGraph.Margin.Default.Bottom"/>
- <seealso cref="P:ZedGraph.PaneBase.IsFontsScaled"/>
- <seealso cref="P:ZedGraph.Margin.Left"/>
- <seealso cref="P:ZedGraph.Margin.Right"/>
- <seealso cref="P:ZedGraph.Margin.Top"/>
- </member>
- <member name="P:ZedGraph.Margin.All">
- <summary>
- Concurrently sets all outer margin values to a single value.
- </summary>
- <value>This value is in units of points (1/72 inch), and is scaled
- linearly with the graph size.</value>
- <seealso cref="P:ZedGraph.PaneBase.IsFontsScaled"/>
- <seealso cref="P:ZedGraph.Margin.Bottom"/>
- <seealso cref="P:ZedGraph.Margin.Left"/>
- <seealso cref="P:ZedGraph.Margin.Right"/>
- <seealso cref="P:ZedGraph.Margin.Top"/>
- </member>
- <member name="T:ZedGraph.Margin.Default">
- <summary>
- A simple struct that defines the default property values for the <see cref="T:ZedGraph.Margin"/> class.
- </summary>
- </member>
- <member name="F:ZedGraph.Margin.Default.Left">
- <summary>
- The default value for the <see cref="P:ZedGraph.Margin.Left"/> property, which is
- the size of the space on the left side of the <see cref="P:ZedGraph.PaneBase.Rect"/>.
- </summary>
- <value>Units are points (1/72 inch)</value>
- </member>
- <member name="F:ZedGraph.Margin.Default.Right">
- <summary>
- The default value for the <see cref="P:ZedGraph.Margin.Right"/> property, which is
- the size of the space on the right side of the <see cref="P:ZedGraph.PaneBase.Rect"/>.
- </summary>
- <value>Units are points (1/72 inch)</value>
- </member>
- <member name="F:ZedGraph.Margin.Default.Top">
- <summary>
- The default value for the <see cref="P:ZedGraph.Margin.Top"/> property, which is
- the size of the space on the top side of the <see cref="P:ZedGraph.PaneBase.Rect"/>.
- </summary>
- <value>Units are points (1/72 inch)</value>
- </member>
- <member name="F:ZedGraph.Margin.Default.Bottom">
- <summary>
- The default value for the <see cref="P:ZedGraph.Margin.Bottom"/> property, which is
- the size of the space on the bottom side of the <see cref="P:ZedGraph.PaneBase.Rect"/>.
- </summary>
- <value>Units are points (1/72 inch)</value>
- </member>
- <member name="T:ZedGraph.FilteredPointList">
- <summary>
- An example of an <see cref="T:ZedGraph.IPointList"/> implementation that stores large datasets, and
- selectively filters the output data depending on the displayed range.
- </summary>
- <remarks>
- This class will refilter the data points each time <see cref="M:ZedGraph.FilteredPointList.SetBounds(System.Double,System.Double,System.Int32)"/> is called. The
- data are filtered down to <see cref="P:ZedGraph.FilteredPointList.MaxPts"/> points, within the data bounds of
- a minimum and maximum data range. The data are filtered by simply skipping
- points to achieve the desired total number of points. Input arrays are assumed to be
- monotonically increasing in X, and evenly spaced in X.
- </remarks>
- <seealso cref="T:ZedGraph.PointPairList"/>
- <seealso cref="T:ZedGraph.BasicArrayPointList"/>
- <seealso cref="T:ZedGraph.IPointList"/>
- <seealso cref="T:ZedGraph.IPointListEdit"/>
-
- <author> John Champion with mods by Christophe Holmes</author>
- <version> $Revision: 1.11 $ $Date: 2007-11-29 02:15:39 $ </version>
- </member>
- <member name="F:ZedGraph.FilteredPointList._x">
- <summary>
- Instance of an array of x values
- </summary>
- </member>
- <member name="F:ZedGraph.FilteredPointList._y">
- <summary>
- Instance of an array of x values
- </summary>
- </member>
- <member name="F:ZedGraph.FilteredPointList._maxPts">
- <summary>
- This is the maximum number of points that you want to see in the filtered dataset
- </summary>
- </member>
- <member name="F:ZedGraph.FilteredPointList._minBoundIndex">
- <summary>
- The index of the xMinBound above
- </summary>
- </member>
- <member name="F:ZedGraph.FilteredPointList._maxBoundIndex">
- <summary>
- The index of the xMaxBound above
- </summary>
- </member>
- <member name="M:ZedGraph.FilteredPointList.#ctor(System.Double[],System.Double[])">
- <summary>
- Constructor to initialize the PointPairList from two arrays of
- type double.
- </summary>
- </member>
- <member name="M:ZedGraph.FilteredPointList.#ctor(ZedGraph.FilteredPointList)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The FilteredPointList from which to copy</param>
- </member>
- <member name="M:ZedGraph.FilteredPointList.Clone">
- <summary>
- Deep-copy clone routine
- </summary>
- <returns>A new, independent copy of the FilteredPointList</returns>
- </member>
- <member name="M:ZedGraph.FilteredPointList.SetBounds(System.Double,System.Double,System.Int32)">
- <summary>
- Set the data bounds to the specified minimum, maximum, and point count. Use values of
- min=double.MinValue and max=double.MaxValue to get the full range of data. Use maxPts=-1
- to not limit the number of points. Call this method anytime the zoom range is changed.
- </summary>
- <param name="min">The lower bound for the X data of interest</param>
- <param name="max">The upper bound for the X data of interest</param>
- <param name="maxPts">The maximum number of points allowed to be
- output by the filter</param>
- </member>
- <member name="P:ZedGraph.FilteredPointList.Item(System.Int32)">
- <summary>
- Indexer to access the specified <see cref="T:ZedGraph.PointPair"/> object by
- its ordinal position in the list.
- </summary>
- <remarks>
- Returns <see cref="F:ZedGraph.PointPairBase.Missing"/> for any value of <see paramref="index"/>
- that is outside of its corresponding array bounds.
- </remarks>
- <param name="index">The ordinal position (zero-based) of the
- <see cref="T:ZedGraph.PointPair"/> object to be accessed.</param>
- <value>A <see cref="T:ZedGraph.PointPair"/> object reference.</value>
- </member>
- <member name="P:ZedGraph.FilteredPointList.Count">
- <summary>
- Returns the number of points according to the current state of the filter.
- </summary>
- </member>
- <member name="P:ZedGraph.FilteredPointList.MaxPts">
- <summary>
- Gets the desired number of filtered points to output. You can set this value by
- calling <see cref="M:ZedGraph.FilteredPointList.SetBounds(System.Double,System.Double,System.Int32)"/>.
- </summary>
- </member>
- <member name="T:ZedGraph.ExponentScale">
- <summary>
- The ExponentScale class inherits from the <see cref="T:ZedGraph.Scale"/> class, and implements
- the features specific to <see cref="F:ZedGraph.AxisType.Exponent"/>.
- </summary>
- <remarks>
- ExponentScale is a non-linear axis in which the values are scaled using an exponential function
- with the <see cref="P:ZedGraph.Scale.Exponent"/> property.
- </remarks>
-
- <author> John Champion with contributions by jackply </author>
- <version> $Revision: 1.8 $ $Date: 2007-04-16 00:03:01 $ </version>
- </member>
- <member name="F:ZedGraph.ExponentScale.schema2">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="M:ZedGraph.ExponentScale.#ctor(ZedGraph.Axis)">
- <summary>
- Default constructor that defines the owner <see cref="T:ZedGraph.Axis"/>
- (containing object) for this new object.
- </summary>
- <param name="owner">The owner, or containing object, of this instance</param>
- </member>
- <member name="M:ZedGraph.ExponentScale.#ctor(ZedGraph.Scale,ZedGraph.Axis)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.ExponentScale"/> object from which to copy</param>
- <param name="owner">The <see cref="T:ZedGraph.Axis"/> object that will own the
- new instance of <see cref="T:ZedGraph.ExponentScale"/></param>
- </member>
- <member name="M:ZedGraph.ExponentScale.Clone(ZedGraph.Axis)">
- <summary>
- Create a new clone of the current item, with a new owner assignment
- </summary>
- <param name="owner">The new <see cref="T:ZedGraph.Axis"/> instance that will be
- the owner of the new Scale</param>
- <returns>A new <see cref="T:ZedGraph.Scale"/> clone.</returns>
- </member>
- <member name="M:ZedGraph.ExponentScale.SetupScaleData(ZedGraph.GraphPane,ZedGraph.Axis)">
- <summary>
- Setup some temporary transform values in preparation for rendering the <see cref="T:ZedGraph.Axis"/>.
- </summary>
- <remarks>
- This method is typically called by the parent <see cref="T:ZedGraph.GraphPane"/>
- object as part of the <see cref="M:ZedGraph.GraphPane.Draw(System.Drawing.Graphics)"/> method. It is also
- called by <see cref="M:ZedGraph.GraphPane.GeneralTransform(System.Double,System.Double,ZedGraph.CoordType)"/> and
- <see cref="M:ZedGraph.GraphPane.ReverseTransform(System.Drawing.PointF,System.Double@,System.Double@)"/>
- methods to setup for coordinate transformations.
- </remarks>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="axis">
- The parent <see cref="T:ZedGraph.Axis"/> for this <see cref="T:ZedGraph.Scale"/>
- </param>
- </member>
- <member name="M:ZedGraph.ExponentScale.Linearize(System.Double)">
- <summary>
- Convert a value to its linear equivalent for this type of scale.
- </summary>
- <remarks>
- The default behavior is to just return the value unchanged. However,
- for <see cref="F:ZedGraph.AxisType.Log"/> and <see cref="F:ZedGraph.AxisType.Exponent"/>,
- it returns the log or power equivalent.
- </remarks>
- <param name="val">The value to be converted</param>
- </member>
- <member name="M:ZedGraph.ExponentScale.DeLinearize(System.Double)">
- <summary>
- Convert a value from its linear equivalent to its actual scale value
- for this type of scale.
- </summary>
- <remarks>
- The default behavior is to just return the value unchanged. However,
- for <see cref="F:ZedGraph.AxisType.Log"/> and <see cref="F:ZedGraph.AxisType.Exponent"/>,
- it returns the anti-log or inverse-power equivalent.
- </remarks>
- <param name="val">The value to be converted</param>
- </member>
- <member name="M:ZedGraph.ExponentScale.CalcMajorTicValue(System.Double,System.Double)">
- <summary>
- Determine the value for any major tic.
- </summary>
- <remarks>
- This method properly accounts for <see cref="P:ZedGraph.Scale.IsLog"/>, <see cref="P:ZedGraph.Scale.IsText"/>,
- and other axis format settings.
- </remarks>
- <param name="baseVal">
- The value of the first major tic (floating point double)
- </param>
- <param name="tic">
- The major tic number (0 = first major tic). For log scales, this is the actual power of 10.
- </param>
- <returns>
- The specified major tic value (floating point double).
- </returns>
- </member>
- <member name="M:ZedGraph.ExponentScale.CalcMinorTicValue(System.Double,System.Int32)">
- <summary>
- Determine the value for any minor tic.
- </summary>
- <remarks>
- This method properly accounts for <see cref="P:ZedGraph.Scale.IsLog"/>, <see cref="P:ZedGraph.Scale.IsText"/>,
- and other axis format settings.
- </remarks>
- <param name="baseVal">
- The value of the first major tic (floating point double). This tic value is the base
- reference for all tics (including minor ones).
- </param>
- <param name="iTic">
- The major tic number (0 = first major tic). For log scales, this is the actual power of 10.
- </param>
- <returns>
- The specified minor tic value (floating point double).
- </returns>
- </member>
- <member name="M:ZedGraph.ExponentScale.CalcMinorStart(System.Double)">
- <summary>
- Internal routine to determine the ordinals of the first minor tic mark
- </summary>
- <param name="baseVal">
- The value of the first major tic for the axis.
- </param>
- <returns>
- The ordinal position of the first minor tic, relative to the first major tic.
- This value can be negative (e.g., -3 means the first minor tic is 3 minor step
- increments before the first major tic.
- </returns>
- </member>
- <member name="M:ZedGraph.ExponentScale.PickScale(ZedGraph.GraphPane,System.Drawing.Graphics,System.Single)">
- <summary>
- Select a reasonable exponential axis scale given a range of data values.
- </summary>
- <remarks>
- This method only applies to <see cref="F:ZedGraph.AxisType.Exponent"/> type axes, and it
- is called by the general <see cref="M:ZedGraph.Scale.PickScale(ZedGraph.GraphPane,System.Drawing.Graphics,System.Single)"/> method. The exponential scale
- relies on the <see cref="P:ZedGraph.Scale.Exponent"/> property to set the scaling exponent. This
- method honors the <see cref="P:ZedGraph.Scale.MinAuto"/>, <see cref="P:ZedGraph.Scale.MaxAuto"/>,
- and <see cref="P:ZedGraph.Scale.MajorStepAuto"/> autorange settings.
- In the event that any of the autorange settings are false, the
- corresponding <see cref="P:ZedGraph.Scale.Min"/>, <see cref="P:ZedGraph.Scale.Max"/>, or <see cref="P:ZedGraph.Scale.MajorStep"/>
- setting is explicitly honored, and the remaining autorange settings (if any) will
- be calculated to accomodate the non-autoranged values. For log axes, the MinorStep
- value is not used.
- <para>On Exit:</para>
- <para><see cref="P:ZedGraph.Scale.Min"/> is set to scale minimum (if <see cref="P:ZedGraph.Scale.MinAuto"/> = true)</para>
- <para><see cref="P:ZedGraph.Scale.Max"/> is set to scale maximum (if <see cref="P:ZedGraph.Scale.MaxAuto"/> = true)</para>
- <para><see cref="P:ZedGraph.Scale.MajorStep"/> is set to scale step size (if <see cref="P:ZedGraph.Scale.MajorStepAuto"/> = true)</para>
- <para><see cref="P:ZedGraph.Scale.Mag"/> is set to a magnitude multiplier according to the data</para>
- <para><see cref="P:ZedGraph.Scale.Format"/> is set to the display format for the values (this controls the
- number of decimal places, whether there are thousands separators, currency types, etc.)</para>
- </remarks>
- <seealso cref="M:ZedGraph.Scale.PickScale(ZedGraph.GraphPane,System.Drawing.Graphics,System.Single)"/>
- <seealso cref="F:ZedGraph.AxisType.Exponent"/>
- </member>
- <member name="M:ZedGraph.ExponentScale.MakeLabel(ZedGraph.GraphPane,System.Int32,System.Double)">
- <summary>
- Make a value label for an <see cref="F:ZedGraph.AxisType.Exponent"/> <see cref="T:ZedGraph.Axis"/>.
- </summary>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="index">
- The zero-based, ordinal index of the label to be generated. For example, a value of 2 would
- cause the third value label on the axis to be generated.
- </param>
- <param name="dVal">
- The numeric value associated with the label. This value is ignored for log (<see cref="P:ZedGraph.Scale.IsLog"/>)
- and text (<see cref="P:ZedGraph.Scale.IsText"/>) type axes.
- </param>
- <returns>The resulting value label as a <see cref="T:System.String"/></returns>
- </member>
- <member name="M:ZedGraph.ExponentScale.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.ExponentScale.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="T:ZedGraph.HiLowBarItem">
- <summary>
- Encapsulates an "High-Low" Bar curve type that displays a bar in which both
- the bottom and the top of the bar are set by data valuesfrom the
- <see cref="T:ZedGraph.PointPair"/> struct.
- </summary>
- <remarks>The <see cref="T:ZedGraph.HiLowBarItem"/> type is intended for displaying
- bars that cover a band of data, such as a confidence interval, "waterfall"
- chart, etc. The position of each bar is set
- according to the <see cref="T:ZedGraph.PointPair"/> values. The independent axis
- is assigned with <see cref="P:ZedGraph.BarSettings.Base"/>, and is a
- <see cref="T:ZedGraph.BarBase"/> enum type. If <see cref="P:ZedGraph.BarSettings.Base"/>
- is set to <see cref="F:ZedGraph.BarBase.Y"/> or <see cref="F:ZedGraph.BarBase.Y2"/>, then
- the bars will actually be horizontal, since the X axis becomes the
- value axis and the Y or Y2 axis becomes the independent axis.</remarks>
- <author> John Champion </author>
- <version> $Revision: 3.18 $ $Date: 2007-11-03 04:41:28 $ </version>
- </member>
- <member name="F:ZedGraph.HiLowBarItem.schema3">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="M:ZedGraph.HiLowBarItem.#ctor(System.String,System.Double[],System.Double[],System.Double[],System.Drawing.Color)">
- <summary>
- Create a new <see cref="T:ZedGraph.HiLowBarItem"/> using the specified properties.
- </summary>
- <param name="label">The label that will appear in the legend.</param>
- <param name="x">An array of double precision values that define
- the independent (X axis) values for this curve</param>
- <param name="y">An array of double precision values that define
- the dependent (Y axis) values for this curve</param>
- <param name="baseVal">An array of double precision values that define the
- base value (the bottom) of the bars for this curve.
- </param>
- <param name="color">A <see cref="T:System.Drawing.Color"/> value that will be applied to
- the <see cref="P:ZedGraph.Bar.Fill"/> and <see cref="P:ZedGraph.Bar.Border"/> properties.
- </param>
- </member>
- <member name="M:ZedGraph.HiLowBarItem.#ctor(System.String,ZedGraph.IPointList,System.Drawing.Color)">
- <summary>
- Create a new <see cref="T:ZedGraph.HiLowBarItem"/> using the specified properties.
- </summary>
- <param name="label">The label that will appear in the legend.</param>
- <param name="points">A <see cref="T:ZedGraph.IPointList"/> of double precision value trio's that define
- the X, Y, and lower dependent values for this curve</param>
- <param name="color">A <see cref="T:System.Drawing.Color"/> value that will be applied to
- the <see cref="P:ZedGraph.Bar.Fill"/> and <see cref="P:ZedGraph.Bar.Border"/> properties.
- </param>
- </member>
- <member name="M:ZedGraph.HiLowBarItem.#ctor(ZedGraph.HiLowBarItem)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.HiLowBarItem"/> object from which to copy</param>
- </member>
- <member name="M:ZedGraph.HiLowBarItem.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.HiLowBarItem.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.HiLowBarItem.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.HiLowBarItem.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.HiLowBarItem.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="T:ZedGraph.ZoomStateStack">
- <summary>
- A LIFO stack of prior <see cref="T:ZedGraph.ZoomState"/> objects, used to allow zooming out to prior
- states (of scale range settings).
- </summary>
- <author> John Champion </author>
- <version> $Revision: 3.1 $ $Date: 2006-06-24 20:26:44 $ </version>
- </member>
- <member name="M:ZedGraph.ZoomStateStack.#ctor">
- <summary>
- Default Constructor
- </summary>
- </member>
- <member name="M:ZedGraph.ZoomStateStack.#ctor(ZedGraph.ZoomStateStack)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.ZoomStateStack"/> object from which to copy</param>
- </member>
- <member name="M:ZedGraph.ZoomStateStack.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.ZoomStateStack.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.ZoomStateStack.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.ZoomStateStack.Push(ZedGraph.GraphPane,ZedGraph.ZoomState.StateType)">
- <summary>
- Add the scale range information from the specified <see cref="T:ZedGraph.GraphPane"/> object as a
- new <see cref="T:ZedGraph.ZoomState"/> entry on the stack.
- </summary>
- <param name="pane">The <see cref="T:ZedGraph.GraphPane"/> object from which the scale range
- information should be copied.</param>
- <param name="type">A <see cref="T:ZedGraph.ZoomState.StateType"/> enumeration that indicates whether this
- state is the result of a zoom or pan operation.</param>
- <returns>The resultant <see cref="T:ZedGraph.ZoomState"/> object that was pushed on the stack.</returns>
- </member>
- <member name="M:ZedGraph.ZoomStateStack.Push(ZedGraph.ZoomState)">
- <summary>
- Add the scale range information from the specified <see cref="T:ZedGraph.ZoomState"/> object as a
- new <see cref="T:ZedGraph.ZoomState"/> entry on the stack.
- </summary>
- <param name="state">The <see cref="T:ZedGraph.ZoomState"/> object to be placed on the stack.</param>
- <returns>The <see cref="T:ZedGraph.ZoomState"/> object (same as the <see paramref="state"/>
- parameter).</returns>
- </member>
- <member name="M:ZedGraph.ZoomStateStack.Pop(ZedGraph.GraphPane)">
- <summary>
- Pop a <see cref="T:ZedGraph.ZoomState"/> entry from the top of the stack, and apply the properties
- to the specified <see cref="T:ZedGraph.GraphPane"/> object.
- </summary>
- <param name="pane">The <see cref="T:ZedGraph.GraphPane"/> object to which the scale range
- information should be copied.</param>
- <returns>The <see cref="T:ZedGraph.ZoomState"/> object that was "popped" from the stack and applied
- to the specified <see cref="T:ZedGraph.GraphPane"/>. null if no <see cref="T:ZedGraph.ZoomState"/> was
- available (the stack was empty).</returns>
- </member>
- <member name="M:ZedGraph.ZoomStateStack.PopAll(ZedGraph.GraphPane)">
- <summary>
- Pop the <see cref="T:ZedGraph.ZoomState"/> entry from the bottom of the stack, and apply the properties
- to the specified <see cref="T:ZedGraph.GraphPane"/> object. Clear the stack completely.
- </summary>
- <param name="pane">The <see cref="T:ZedGraph.GraphPane"/> object to which the scale range
- information should be copied.</param>
- <returns>The <see cref="T:ZedGraph.ZoomState"/> object at the bottom of the stack that was applied
- to the specified <see cref="T:ZedGraph.GraphPane"/>. null if no <see cref="T:ZedGraph.ZoomState"/> was
- available (the stack was empty).</returns>
- </member>
- <member name="P:ZedGraph.ZoomStateStack.IsEmpty">
- <summary>
- Public readonly property that indicates if the stack is empty
- </summary>
- <value>true for an empty stack, false otherwise</value>
- </member>
- <member name="P:ZedGraph.ZoomStateStack.Top">
- <summary>
- Gets a reference to the <see cref="T:ZedGraph.ZoomState"/> object at the top of the stack,
- without actually removing it from the stack.
- </summary>
- <value>A <see cref="T:ZedGraph.ZoomState"/> object reference, or null if the stack is empty.</value>
- </member>
- <member name="T:ZedGraph.TextObj">
- <summary>
- A class that represents a text object on the graph. A list of
- <see cref="T:ZedGraph.GraphObj"/> objects is maintained by the
- <see cref="T:ZedGraph.GraphObjList"/> collection class.
- </summary>
-
- <author> John Champion </author>
- <version> $Revision: 3.4 $ $Date: 2007-01-25 07:56:09 $ </version>
- </member>
- <member name="F:ZedGraph.TextObj.schema2">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="F:ZedGraph.TextObj._text">
- <summary> Private field to store the actual text string for this
- <see cref="T:ZedGraph.TextObj"/>. Use the public property <see cref="P:ZedGraph.TextObj.Text"/>
- to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.TextObj._fontSpec">
- <summary>
- Private field to store the <see cref="P:ZedGraph.TextObj.FontSpec"/> class used to render
- this <see cref="T:ZedGraph.TextObj"/>. Use the public property <see cref="P:ZedGraph.TextObj.FontSpec"/>
- to access this class.
- </summary>
- </member>
- <member name="F:ZedGraph.TextObj._layoutArea">
- <summary>
- Private field holding the SizeF into which this <see cref="T:ZedGraph.TextObj"/>
- should be rendered. Use the public property <see cref="P:ZedGraph.TextObj.LayoutArea"/>
- to access this value.
- </summary>
- </member>
- <member name="M:ZedGraph.TextObj.#ctor(System.String,System.Double,System.Double)">
- <summary>
- Constructor that sets all <see cref="T:ZedGraph.TextObj"/> properties to default
- values as defined in the <see cref="T:ZedGraph.TextObj.Default"/> class.
- </summary>
- <param name="text">The text to be displayed.</param>
- <param name="x">The x position of the text. The units
- of this position are specified by the
- <see cref="P:ZedGraph.Location.CoordinateFrame"/> property. The text will be
- aligned to this position based on the <see cref="T:ZedGraph.AlignH"/>
- property.</param>
- <param name="y">The y position of the text. The units
- of this position are specified by the
- <see cref="P:ZedGraph.Location.CoordinateFrame"/> property. The text will be
- aligned to this position based on the
- <see cref="T:ZedGraph.AlignV"/> property.</param>
- </member>
- <member name="M:ZedGraph.TextObj.#ctor(System.String,System.Double,System.Double,ZedGraph.CoordType)">
- <summary>
- Constructor that sets all <see cref="T:ZedGraph.TextObj"/> properties to default
- values as defined in the <see cref="T:ZedGraph.TextObj.Default"/> class.
- </summary>
- <param name="text">The text to be displayed.</param>
- <param name="x">The x position of the text. The units
- of this position are specified by the
- <see cref="P:ZedGraph.Location.CoordinateFrame"/> property. The text will be
- aligned to this position based on the <see cref="T:ZedGraph.AlignH"/>
- property.</param>
- <param name="y">The y position of the text. The units
- of this position are specified by the
- <see cref="P:ZedGraph.Location.CoordinateFrame"/> property. The text will be
- aligned to this position based on the
- <see cref="T:ZedGraph.AlignV"/> property.</param>
- <param name="coordType">The <see cref="T:ZedGraph.CoordType"/> enum value that
- indicates what type of coordinate system the x and y parameters are
- referenced to.</param>
- </member>
- <member name="M:ZedGraph.TextObj.#ctor(System.String,System.Double,System.Double,ZedGraph.CoordType,ZedGraph.AlignH,ZedGraph.AlignV)">
- <summary>
- Constructor that sets all <see cref="T:ZedGraph.TextObj"/> properties to default
- values as defined in the <see cref="T:ZedGraph.TextObj.Default"/> class.
- </summary>
- <param name="text">The text to be displayed.</param>
- <param name="x">The x position of the text. The units
- of this position are specified by the
- <see cref="P:ZedGraph.Location.CoordinateFrame"/> property. The text will be
- aligned to this position based on the <see cref="T:ZedGraph.AlignH"/>
- property.</param>
- <param name="y">The y position of the text. The units
- of this position are specified by the
- <see cref="P:ZedGraph.Location.CoordinateFrame"/> property. The text will be
- aligned to this position based on the
- <see cref="T:ZedGraph.AlignV"/> property.</param>
- <param name="coordType">The <see cref="T:ZedGraph.CoordType"/> enum value that
- indicates what type of coordinate system the x and y parameters are
- referenced to.</param>
- <param name="alignH">The <see cref="T:ZedGraph.AlignH"/> enum that specifies
- the horizontal alignment of the object with respect to the (x,y) location</param>
- <param name="alignV">The <see cref="T:ZedGraph.AlignV"/> enum that specifies
- the vertical alignment of the object with respect to the (x,y) location</param>
- </member>
- <member name="M:ZedGraph.TextObj.#ctor">
- <summary>
- Parameterless constructor that initializes a new <see cref="T:ZedGraph.TextObj"/>.
- </summary>
- </member>
- <member name="M:ZedGraph.TextObj.#ctor(ZedGraph.TextObj)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.TextObj"/> object from which to copy</param>
- </member>
- <member name="M:ZedGraph.TextObj.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.TextObj.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.TextObj.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.TextObj.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.TextObj.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.TextObj.Draw(System.Drawing.Graphics,ZedGraph.PaneBase,System.Single)">
- <summary>
- Render this <see cref="T:ZedGraph.TextObj"/> object to the specified <see cref="T:System.Drawing.Graphics"/> device
- This method is normally only called by the Draw method
- of the parent <see cref="T:ZedGraph.GraphObjList"/> collection object.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.PaneBase"/> object that is the parent or
- owner of this object.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.TextObj.PointInBox(System.Drawing.PointF,ZedGraph.PaneBase,System.Drawing.Graphics,System.Single)">
- <summary>
- Determine if the specified screen point lies inside the bounding box of this
- <see cref="T:ZedGraph.TextObj"/>. This method takes into account rotation and alignment
- parameters of the text, as specified in the <see cref="P:ZedGraph.TextObj.FontSpec"/>.
- </summary>
- <param name="pt">The screen point, in pixels</param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.PaneBase"/> object that is the parent or
- owner of this object.
- </param>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <returns>true if the point lies in the bounding box, false otherwise</returns>
- </member>
- <member name="M:ZedGraph.TextObj.GetCoords(ZedGraph.PaneBase,System.Drawing.Graphics,System.Single,System.String@,System.String@)">
- <summary>
- Determines the shape type and Coords values for this GraphObj
- </summary>
- </member>
- <member name="P:ZedGraph.TextObj.LayoutArea">
- <summary>
-
- </summary>
- </member>
- <member name="P:ZedGraph.TextObj.Text">
- <summary>
- The <see cref="T:ZedGraph.TextObj"/> to be displayed. This text can be multi-line by
- including newline ('\n') characters between the lines.
- </summary>
- </member>
- <member name="P:ZedGraph.TextObj.FontSpec">
- <summary>
- Gets a reference to the <see cref="P:ZedGraph.TextObj.FontSpec"/> class used to render
- this <see cref="T:ZedGraph.TextObj"/>
- </summary>
- <seealso cref="F:ZedGraph.TextObj.Default.FontColor"/>
- <seealso cref="F:ZedGraph.TextObj.Default.FontBold"/>
- <seealso cref="F:ZedGraph.TextObj.Default.FontItalic"/>
- <seealso cref="F:ZedGraph.TextObj.Default.FontUnderline"/>
- <seealso cref="F:ZedGraph.TextObj.Default.FontFamily"/>
- <seealso cref="F:ZedGraph.TextObj.Default.FontSize"/>
- </member>
- <member name="T:ZedGraph.TextObj.Default">
- <summary>
- A simple struct that defines the
- default property values for the <see cref="T:ZedGraph.TextObj"/> class.
- </summary>
- </member>
- <member name="F:ZedGraph.TextObj.Default.FontFamily">
- <summary>
- The default font family for the <see cref="T:ZedGraph.TextObj"/> text
- (<see cref="P:ZedGraph.FontSpec.Family"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.TextObj.Default.FontSize">
- <summary>
- The default font size for the <see cref="T:ZedGraph.TextObj"/> text
- (<see cref="P:ZedGraph.FontSpec.Size"/> property). Units are
- in points (1/72 inch).
- </summary>
- </member>
- <member name="F:ZedGraph.TextObj.Default.FontColor">
- <summary>
- The default font color for the <see cref="T:ZedGraph.TextObj"/> text
- (<see cref="P:ZedGraph.FontSpec.FontColor"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.TextObj.Default.FontBold">
- <summary>
- The default font bold mode for the <see cref="T:ZedGraph.TextObj"/> text
- (<see cref="P:ZedGraph.FontSpec.IsBold"/> property). true
- for a bold typeface, false otherwise.
- </summary>
- </member>
- <member name="F:ZedGraph.TextObj.Default.FontUnderline">
- <summary>
- The default font underline mode for the <see cref="T:ZedGraph.TextObj"/> text
- (<see cref="P:ZedGraph.FontSpec.IsUnderline"/> property). true
- for an underlined typeface, false otherwise.
- </summary>
- </member>
- <member name="F:ZedGraph.TextObj.Default.FontItalic">
- <summary>
- The default font italic mode for the <see cref="T:ZedGraph.TextObj"/> text
- (<see cref="P:ZedGraph.FontSpec.IsItalic"/> property). true
- for an italic typeface, false otherwise.
- </summary>
- </member>
- <member name="T:ZedGraph.Line">
- <summary>
- A class representing all the characteristics of the Line
- segments that make up a curve on the graph.
- </summary>
-
- <author> John Champion </author>
- <version> $Revision: 3.50 $ $Date: 2007-12-30 23:27:39 $ </version>
- </member>
- <member name="F:ZedGraph.Line.schema">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="F:ZedGraph.Line._isSmooth">
- <summary>
- Private field that stores the smoothing flag for this
- <see cref="T:ZedGraph.Line"/>. Use the public
- property <see cref="P:ZedGraph.Line.IsSmooth"/> to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.Line._smoothTension">
- <summary>
- Private field that stores the smoothing tension
- for this <see cref="T:ZedGraph.Line"/>. Use the public property
- <see cref="P:ZedGraph.Line.SmoothTension"/> to access this value.
- </summary>
- <value>A floating point value indicating the level of smoothing.
- 0.0F for no smoothing, 1.0F for lots of smoothing, >1.0 for odd
- smoothing.</value>
- <seealso cref="P:ZedGraph.Line.IsSmooth"/>
- <seealso cref="F:ZedGraph.Line.Default.IsSmooth"/>
- <seealso cref="F:ZedGraph.Line.Default.SmoothTension"/>
- </member>
- <member name="F:ZedGraph.Line._stepType">
- <summary>
- Private field that stores the <see cref="T:ZedGraph.StepType"/> for this
- <see cref="T:ZedGraph.CurveItem"/>. Use the public
- property <see cref="P:ZedGraph.Line.StepType"/> to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.Line._fill">
- <summary>
- Private field that stores the <see cref="T:ZedGraph.Fill"/> data for this
- <see cref="T:ZedGraph.Line"/>. Use the public property <see cref="P:ZedGraph.Line.Fill"/> to
- access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.Line._isOptimizedDraw">
- <summary>
- Private field that determines if this <see cref="T:ZedGraph.Line"/> will be drawn with
- optimizations enabled. Use the public
- property <see cref="P:ZedGraph.Line.IsOptimizedDraw"/> to access this value.
- </summary>
- </member>
- <member name="M:ZedGraph.Line.#ctor">
- <summary>
- Default constructor that sets all <see cref="T:ZedGraph.Line"/> properties to default
- values as defined in the <see cref="T:ZedGraph.Line.Default"/> class.
- </summary>
- </member>
- <member name="M:ZedGraph.Line.#ctor(System.Drawing.Color)">
- <summary>
- Constructor that sets the color property to the specified value, and sets
- the remaining <see cref="T:ZedGraph.Line"/> properties to default
- values as defined in the <see cref="T:ZedGraph.Line.Default"/> class.
- </summary>
- <param name="color">The color to assign to this new Line object</param>
- </member>
- <member name="M:ZedGraph.Line.#ctor(ZedGraph.Line)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The Line object from which to copy</param>
- </member>
- <member name="M:ZedGraph.Line.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.Line.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.Line.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.Line.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.Line.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.Line.Draw(System.Drawing.Graphics,ZedGraph.GraphPane,ZedGraph.CurveItem,System.Single)">
- <summary>
- Do all rendering associated with this <see cref="T:ZedGraph.Line"/> to the specified
- <see cref="T:System.Drawing.Graphics"/> device. This method is normally only
- called by the Draw method of the parent <see cref="T:ZedGraph.LineItem"/> object.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="curve">A <see cref="T:ZedGraph.LineItem"/> representing this
- curve.</param>
- </member>
- <member name="M:ZedGraph.Line.DrawSegment(System.Drawing.Graphics,ZedGraph.GraphPane,System.Single,System.Single,System.Single,System.Single,System.Single)">
- <summary>
- Render a single <see cref="T:ZedGraph.Line"/> segment to the specified
- <see cref="T:System.Drawing.Graphics"/> device.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <param name="x1">The x position of the starting point that defines the
- line segment in screen pixel units</param>
- <param name="y1">The y position of the starting point that defines the
- line segment in screen pixel units</param>
- <param name="x2">The x position of the ending point that defines the
- line segment in screen pixel units</param>
- <param name="y2">The y position of the ending point that defines the
- line segment in screen pixel units</param>
- </member>
- <member name="M:ZedGraph.Line.DrawSticks(System.Drawing.Graphics,ZedGraph.GraphPane,ZedGraph.CurveItem,System.Single)">
- <summary>
- Render the <see cref="T:ZedGraph.Line"/>'s as vertical sticks (from a <see cref="T:ZedGraph.StickItem"/>) to
- the specified <see cref="T:System.Drawing.Graphics"/> device.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="curve">A <see cref="T:ZedGraph.CurveItem"/> representing this
- curve.</param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.Line.DrawSmoothFilledCurve(System.Drawing.Graphics,ZedGraph.GraphPane,ZedGraph.CurveItem,System.Single)">
- <summary>
- Draw the this <see cref="T:ZedGraph.CurveItem"/> to the specified <see cref="T:System.Drawing.Graphics"/>
- device using the specified smoothing property (<see cref="P:ZedGraph.Line.SmoothTension"/>).
- The routine draws the line segments and the area fill (if any, see <see cref="T:ZedGraph.FillType"/>;
- the symbols are drawn by the <see cref="M:ZedGraph.Symbol.Draw(System.Drawing.Graphics,ZedGraph.GraphPane,ZedGraph.LineItem,System.Single,System.Boolean)"/> method. This method
- is normally only called by the Draw method of the
- <see cref="T:ZedGraph.CurveItem"/> object. Note that the <see cref="P:ZedGraph.Line.StepType"/> property
- is ignored for smooth lines (e.g., when <see cref="P:ZedGraph.Line.IsSmooth"/> is true).
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="curve">A <see cref="T:ZedGraph.LineItem"/> representing this
- curve.</param>
- </member>
- <member name="M:ZedGraph.Line.DrawCurve(System.Drawing.Graphics,ZedGraph.GraphPane,ZedGraph.CurveItem,System.Single)">
- <summary>
- Draw the this <see cref="T:ZedGraph.CurveItem"/> to the specified <see cref="T:System.Drawing.Graphics"/>
- device. The format (stair-step or line) of the curve is
- defined by the <see cref="P:ZedGraph.Line.StepType"/> property. The routine
- only draws the line segments; the symbols are drawn by the
- <see cref="M:ZedGraph.Symbol.Draw(System.Drawing.Graphics,ZedGraph.GraphPane,ZedGraph.LineItem,System.Single,System.Boolean)"/> method. This method
- is normally only called by the Draw method of the
- <see cref="T:ZedGraph.CurveItem"/> object
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="curve">A <see cref="T:ZedGraph.LineItem"/> representing this
- curve.</param>
- </member>
- <member name="M:ZedGraph.Line.DrawCurveOriginal(System.Drawing.Graphics,ZedGraph.GraphPane,ZedGraph.CurveItem,System.Single)">
- <summary>
- Draw the this <see cref="T:ZedGraph.CurveItem"/> to the specified <see cref="T:System.Drawing.Graphics"/>
- device. The format (stair-step or line) of the curve is
- defined by the <see cref="P:ZedGraph.Line.StepType"/> property. The routine
- only draws the line segments; the symbols are drawn by the
- <see cref="M:ZedGraph.Symbol.Draw(System.Drawing.Graphics,ZedGraph.GraphPane,ZedGraph.LineItem,System.Single,System.Boolean)"/> method. This method
- is normally only called by the Draw method of the
- <see cref="T:ZedGraph.CurveItem"/> object
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="curve">A <see cref="T:ZedGraph.LineItem"/> representing this
- curve.</param>
- </member>
- <member name="M:ZedGraph.Line.InterpolatePoint(System.Drawing.Graphics,ZedGraph.GraphPane,ZedGraph.CurveItem,ZedGraph.PointPair,System.Single,System.Drawing.Pen,System.Single,System.Single,System.Single,System.Single)">
- <summary>
- This method just handles the case where one or more of the coordinates are outrageous,
- or GDI+ threw an exception. This method attempts to correct the outrageous coordinates by
- interpolating them to a point (along the original line) that lies at the edge of the ChartRect
- so that GDI+ will handle it properly. GDI+ will throw an exception, or just plot the data
- incorrectly if the coordinates are too large (empirically, this appears to be when the
- coordinate value is greater than 5,000,000 or less than -5,000,000). Although you typically
- would not see coordinates like this, if you repeatedly zoom in on a ZedGraphControl, eventually
- all your points will be way outside the bounds of the plot.
- </summary>
- </member>
- <member name="M:ZedGraph.Line.BuildPointsArray(ZedGraph.GraphPane,ZedGraph.CurveItem,System.Drawing.PointF[]@,System.Int32@)">
- <summary>
- Build an array of <see cref="T:System.Drawing.PointF"/> values (pixel coordinates) that represents
- the current curve. Note that this drawing routine ignores <see cref="F:ZedGraph.PointPairBase.Missing"/>
- values, but it does not "break" the line to indicate values are missing.
- </summary>
- <param name="pane">A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.</param>
- <param name="curve">A <see cref="T:ZedGraph.LineItem"/> representing this
- curve.</param>
- <param name="arrPoints">An array of <see cref="T:System.Drawing.PointF"/> values in pixel
- coordinates representing the current curve.</param>
- <param name="count">The number of points contained in the "arrPoints"
- parameter.</param>
- <returns>true for a successful points array build, false for data problems</returns>
- </member>
- <member name="M:ZedGraph.Line.BuildLowPointsArray(ZedGraph.GraphPane,ZedGraph.CurveItem,System.Drawing.PointF[]@,System.Int32@)">
- <summary>
- Build an array of <see cref="T:System.Drawing.PointF"/> values (pixel coordinates) that represents
- the low values for the current curve.
- </summary>
- <remarks>Note that this drawing routine ignores <see cref="F:ZedGraph.PointPairBase.Missing"/>
- values, but it does not "break" the line to indicate values are missing.
- </remarks>
- <param name="pane">A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.</param>
- <param name="curve">A <see cref="T:ZedGraph.LineItem"/> representing this
- curve.</param>
- <param name="arrPoints">An array of <see cref="T:System.Drawing.PointF"/> values in pixel
- coordinates representing the current curve.</param>
- <param name="count">The number of points contained in the "arrPoints"
- parameter.</param>
- <returns>true for a successful points array build, false for data problems</returns>
- </member>
- <member name="M:ZedGraph.Line.CloseCurve(ZedGraph.GraphPane,ZedGraph.CurveItem,System.Drawing.PointF[],System.Int32,System.Double,System.Drawing.Drawing2D.GraphicsPath)">
- <summary>
- Close off a <see cref="T:System.Drawing.Drawing2D.GraphicsPath"/> that defines a curve
- </summary>
- <param name="pane">A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.</param>
- <param name="curve">A <see cref="T:ZedGraph.LineItem"/> representing this
- curve.</param>
- <param name="arrPoints">An array of <see cref="T:System.Drawing.PointF"/> values in screen pixel
- coordinates representing the current curve.</param>
- <param name="count">The number of points contained in the "arrPoints"
- parameter.</param>
- <param name="yMin">The Y axis value location where the X axis crosses.</param>
- <param name="path">The <see cref="T:System.Drawing.Drawing2D.GraphicsPath"/> class that represents the curve.</param>
- </member>
- <member name="P:ZedGraph.Line.IsSmooth">
- <summary>
- Gets or sets a property that determines if this <see cref="T:ZedGraph.Line"/>
- will be drawn smooth. The "smoothness" is controlled by
- the <see cref="P:ZedGraph.Line.SmoothTension"/> property.
- </summary>
- <value>true to smooth the line, false to just connect the dots
- with linear segments</value>
- <seealso cref="P:ZedGraph.Line.SmoothTension"/>
- <seealso cref="F:ZedGraph.Line.Default.IsSmooth"/>
- <seealso cref="F:ZedGraph.Line.Default.SmoothTension"/>
- </member>
- <member name="P:ZedGraph.Line.SmoothTension">
- <summary>
- Gets or sets a property that determines the smoothing tension
- for this <see cref="T:ZedGraph.Line"/>. This property is only used if
- <see cref="P:ZedGraph.Line.IsSmooth"/> is true. A tension value 0.0 will just
- draw ordinary line segments like an unsmoothed line. A tension
- value of 1.0 will be smooth. Values greater than 1.0 will generally
- give odd results.
- </summary>
- <value>A floating point value indicating the level of smoothing.
- 0.0F for no smoothing, 1.0F for lots of smoothing, >1.0 for odd
- smoothing.</value>
- <seealso cref="P:ZedGraph.Line.IsSmooth"/>
- <seealso cref="F:ZedGraph.Line.Default.IsSmooth"/>
- <seealso cref="F:ZedGraph.Line.Default.SmoothTension"/>
- </member>
- <member name="P:ZedGraph.Line.StepType">
- <summary>
- Determines if the <see cref="T:ZedGraph.CurveItem"/> will be drawn by directly connecting the
- points from the <see cref="P:ZedGraph.CurveItem.Points"/> data collection,
- or if the curve will be a "stair-step" in which the points are
- connected by a series of horizontal and vertical lines that
- represent discrete, constant values. Note that the values can
- be forward oriented <c>ForwardStep</c> (<see cref="T:ZedGraph.StepType"/>) or
- rearward oriented <c>RearwardStep</c>.
- That is, the points are defined at the beginning or end
- of the constant value for which they apply, respectively.
- The <see cref="P:ZedGraph.Line.StepType"/> property is ignored for lines
- that have <see cref="P:ZedGraph.Line.IsSmooth"/> set to true.
- </summary>
- <value><see cref="T:ZedGraph.StepType"/> enum value</value>
- <seealso cref="F:ZedGraph.Line.Default.StepType"/>
- </member>
- <member name="P:ZedGraph.Line.Fill">
- <summary>
- Gets or sets the <see cref="T:ZedGraph.Fill"/> data for this
- <see cref="T:ZedGraph.Line"/>.
- </summary>
- </member>
- <member name="P:ZedGraph.Line.IsOptimizedDraw">
- <summary>
- Gets or sets a boolean value that determines if this <see cref="T:ZedGraph.Line"/> will be drawn with
- optimizations enabled.
- </summary>
- <remarks>
- Normally, the optimizations can be used without a problem, especially if the data
- are sorted. The optimizations are particularly helpful with very large datasets.
- However, if the data are very discontinuous (for example, a curve that doubles back
- on itself), then the optimizations can cause drawing artifacts in the form of
- missing line segments. The default option for this mode is false, so you must
- explicitly enable it for each <see cref="P:ZedGraph.LineItem.Line">LineItem.Line</see>.
- Also note that, even if the optimizations are enabled explicitly, no actual
- optimization will be done for datasets of less than 1000 points.
- </remarks>
- </member>
- <member name="T:ZedGraph.Line.Default">
- <summary>
- A simple struct that defines the
- default property values for the <see cref="T:ZedGraph.Line"/> class.
- </summary>
- </member>
- <member name="F:ZedGraph.Line.Default.Color">
- <summary>
- The default color for curves (line segments connecting the points).
- This is the default value for the <see cref="P:ZedGraph.LineBase.Color"/> property.
- </summary>
- </member>
- <member name="F:ZedGraph.Line.Default.FillColor">
- <summary>
- The default color for filling in the area under the curve
- (<see cref="P:ZedGraph.Fill.Color"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.Line.Default.FillBrush">
- <summary>
- The default custom brush for filling in the area under the curve
- (<see cref="P:ZedGraph.Fill.Brush"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.Line.Default.FillType">
- <summary>
- The default fill mode for the curve (<see cref="P:ZedGraph.Fill.Type"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.Line.Default.IsSmooth">
- <summary>
- The default value for the <see cref="P:ZedGraph.Line.IsSmooth"/>
- property.
- </summary>
- </member>
- <member name="F:ZedGraph.Line.Default.SmoothTension">
- <summary>
- The default value for the <see cref="P:ZedGraph.Line.SmoothTension"/> property.
- </summary>
- </member>
- <member name="F:ZedGraph.Line.Default.IsOptimizedDraw">
- <summary>
- The default value for the <see cref="P:ZedGraph.Line.IsOptimizedDraw"/> property.
- </summary>
- </member>
- <member name="F:ZedGraph.Line.Default.StepType">
- <summary>
- Default value for the curve type property
- (<see cref="P:ZedGraph.Line.StepType"/>). This determines if the curve
- will be drawn by directly connecting the points from the
- <see cref="P:ZedGraph.CurveItem.Points"/> data collection,
- or if the curve will be a "stair-step" in which the points are
- connected by a series of horizontal and vertical lines that
- represent discrete, staticant values. Note that the values can
- be forward oriented <code>ForwardStep</code> (<see cref="F:ZedGraph.Line.Default.StepType"/>) or
- rearward oriented <code>RearwardStep</code>.
- That is, the points are defined at the beginning or end
- of the staticant value for which they apply, respectively.
- </summary>
- <value><see cref="F:ZedGraph.Line.Default.StepType"/> enum value</value>
- </member>
- <member name="T:ZedGraph.ArrowObj">
- <summary>
- A class that represents a graphic arrow or line object on the graph. A list of
- ArrowObj objects is maintained by the <see cref="T:ZedGraph.GraphObjList"/> collection class.
- </summary>
-
- <author> John Champion </author>
- <version> $Revision: 3.4 $ $Date: 2007-01-25 07:56:08 $ </version>
- </member>
- <member name="F:ZedGraph.ArrowObj.schema3">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="F:ZedGraph.ArrowObj._size">
- <summary>
- Private field that stores the arrowhead size, measured in points.
- Use the public property <see cref="P:ZedGraph.ArrowObj.Size"/> to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.ArrowObj._isArrowHead">
- <summary>
- Private boolean field that stores the arrowhead state.
- Use the public property <see cref="P:ZedGraph.ArrowObj.IsArrowHead"/> to access this value.
- </summary>
- <value> true if an arrowhead is to be drawn, false otherwise </value>
- </member>
- <member name="M:ZedGraph.ArrowObj.#ctor(System.Drawing.Color,System.Single,System.Double,System.Double,System.Double,System.Double)">
- <overloads>Constructors for the <see cref="T:ZedGraph.ArrowObj"/> object</overloads>
- <summary>
- A constructor that allows the position, color, and size of the
- <see cref="T:ZedGraph.ArrowObj"/> to be pre-specified.
- </summary>
- <param name="color">An arbitrary <see cref="T:System.Drawing.Color"/> specification
- for the arrow</param>
- <param name="size">The size of the arrowhead, measured in points.</param>
- <param name="x1">The x position of the starting point that defines the
- arrow. The units of this position are specified by the
- <see cref="P:ZedGraph.Location.CoordinateFrame"/> property.</param>
- <param name="y1">The y position of the starting point that defines the
- arrow. The units of this position are specified by the
- <see cref="P:ZedGraph.Location.CoordinateFrame"/> property.</param>
- <param name="x2">The x position of the ending point that defines the
- arrow. The units of this position are specified by the
- <see cref="P:ZedGraph.Location.CoordinateFrame"/> property.</param>
- <param name="y2">The y position of the ending point that defines the
- arrow. The units of this position are specified by the
- <see cref="P:ZedGraph.Location.CoordinateFrame"/> property.</param>
- </member>
- <member name="M:ZedGraph.ArrowObj.#ctor(System.Double,System.Double,System.Double,System.Double)">
- <summary>
- A constructor that allows only the position of the
- arrow to be pre-specified. All other properties are set to
- default values
- </summary>
- <param name="x1">The x position of the starting point that defines the
- <see cref="T:ZedGraph.ArrowObj"/>. The units of this position are specified by the
- <see cref="P:ZedGraph.Location.CoordinateFrame"/> property.</param>
- <param name="y1">The y position of the starting point that defines the
- <see cref="T:ZedGraph.ArrowObj"/>. The units of this position are specified by the
- <see cref="P:ZedGraph.Location.CoordinateFrame"/> property.</param>
- <param name="x2">The x position of the ending point that defines the
- <see cref="T:ZedGraph.ArrowObj"/>. The units of this position are specified by the
- <see cref="P:ZedGraph.Location.CoordinateFrame"/> property.</param>
- <param name="y2">The y position of the ending point that defines the
- <see cref="T:ZedGraph.ArrowObj"/>. The units of this position are specified by the
- <see cref="P:ZedGraph.Location.CoordinateFrame"/> property.</param>
- </member>
- <member name="M:ZedGraph.ArrowObj.#ctor">
- <summary>
- Default constructor -- places the <see cref="T:ZedGraph.ArrowObj"/> at location
- (0,0) to (1,1). All other values are defaulted.
- </summary>
- </member>
- <member name="M:ZedGraph.ArrowObj.#ctor(ZedGraph.ArrowObj)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.ArrowObj"/> object from which to copy</param>
- </member>
- <member name="M:ZedGraph.ArrowObj.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.ArrowObj.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.ArrowObj.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.ArrowObj.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.ArrowObj.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.ArrowObj.Draw(System.Drawing.Graphics,ZedGraph.PaneBase,System.Single)">
- <summary>
- Render this object to the specified <see cref="T:System.Drawing.Graphics"/> device.
- </summary>
- <remarks>
- This method is normally only called by the Draw method
- of the parent <see cref="T:ZedGraph.GraphObjList"/> collection object.
- </remarks>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.PaneBase"/> object that is the parent or
- owner of this object.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="P:ZedGraph.ArrowObj.Size">
- <summary>
- The size of the arrowhead.
- </summary>
- <remarks>The display of the arrowhead can be
- enabled or disabled with the <see cref="P:ZedGraph.ArrowObj.IsArrowHead"/> property.
- </remarks>
- <value> The size is defined in points (1/72 inch) </value>
- <seealso cref="F:ZedGraph.ArrowObj.Default.Size"/>
- </member>
- <member name="P:ZedGraph.ArrowObj.IsArrowHead">
- <summary>
- Determines whether or not to draw an arrowhead
- </summary>
- <value> true to show the arrowhead, false to show the line segment
- only</value>
- <seealso cref="F:ZedGraph.ArrowObj.Default.IsArrowHead"/>
- </member>
- <member name="T:ZedGraph.ArrowObj.Default">
- <summary>
- A simple struct that defines the
- default property values for the <see cref="T:ZedGraph.ArrowObj"/> class.
- </summary>
- </member>
- <member name="F:ZedGraph.ArrowObj.Default.Size">
- <summary>
- The default size for the <see cref="T:ZedGraph.ArrowObj"/> item arrowhead
- (<see cref="P:ZedGraph.ArrowObj.Size"/> property). Units are in points (1/72 inch).
- </summary>
- </member>
- <member name="F:ZedGraph.ArrowObj.Default.IsArrowHead">
- <summary>
- The default display mode for the <see cref="T:ZedGraph.ArrowObj"/> item arrowhead
- (<see cref="P:ZedGraph.ArrowObj.IsArrowHead"/> property). true to show the
- arrowhead, false to hide it.
- </summary>
- </member>
- <member name="T:ZedGraph.YAxis">
- <summary>
- <see cref="T:ZedGraph.YAxis"/> inherits from <see cref="T:ZedGraph.Axis"/>, and defines the
- special characteristics of a vertical axis, specifically located on
- the right side of the <see cref="P:ZedGraph.Chart.Rect"/> of the <see cref="T:ZedGraph.GraphPane"/>
- object
- </summary>
-
- <author> John Champion </author>
- <version> $Revision: 3.16 $ $Date: 2007-04-16 00:03:06 $ </version>
- </member>
- <member name="F:ZedGraph.YAxis.schema2">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="M:ZedGraph.YAxis.#ctor">
- <summary>
- Default constructor that sets all <see cref="T:ZedGraph.YAxis"/> properties to
- default values as defined in the <see cref="T:ZedGraph.YAxis.Default"/> class
- </summary>
- </member>
- <member name="M:ZedGraph.YAxis.#ctor(System.String)">
- <summary>
- Default constructor that sets all <see cref="T:ZedGraph.YAxis"/> properties to
- default values as defined in the <see cref="T:ZedGraph.YAxis.Default"/> class, except
- for the axis title
- </summary>
- <param name="title">The <see cref="P:ZedGraph.Axis.Title"/> for this axis</param>
- </member>
- <member name="M:ZedGraph.YAxis.#ctor(ZedGraph.YAxis)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The YAxis object from which to copy</param>
- </member>
- <member name="M:ZedGraph.YAxis.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.YAxis.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.YAxis.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.YAxis.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.YAxis.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.YAxis.SetTransformMatrix(System.Drawing.Graphics,ZedGraph.GraphPane,System.Single)">
- <summary>
- Setup the Transform Matrix to handle drawing of this <see cref="T:ZedGraph.YAxis"/>
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.YAxis.IsPrimary(ZedGraph.GraphPane)">
- <summary>
- Determines if this <see cref="T:ZedGraph.Axis"/> object is a "primary" one.
- </summary>
- <remarks>
- The primary axes are the <see cref="T:ZedGraph.XAxis"/> (always), the first
- <see cref="T:ZedGraph.YAxis"/> in the <see cref="P:ZedGraph.GraphPane.YAxisList"/>
- (<see cref="P:ZedGraph.CurveItem.YAxisIndex"/> = 0), and the first
- <see cref="T:ZedGraph.Y2Axis"/> in the <see cref="P:ZedGraph.GraphPane.Y2AxisList"/>
- (<see cref="P:ZedGraph.CurveItem.YAxisIndex"/> = 0). Note that
- <see cref="P:ZedGraph.GraphPane.YAxis"/> and <see cref="P:ZedGraph.GraphPane.Y2Axis"/>
- always reference the primary axes.
- </remarks>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <returns>true for a primary <see cref="T:ZedGraph.Axis"/>, false otherwise</returns>
- </member>
- <member name="M:ZedGraph.YAxis.CalcCrossShift(ZedGraph.GraphPane)">
- <summary>
- Calculate the "shift" size, in pixels, in order to shift the axis from its default
- location to the value specified by <see cref="P:ZedGraph.Axis.Cross"/>.
- </summary>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <returns>The shift amount measured in pixels</returns>
- </member>
- <member name="M:ZedGraph.YAxis.GetCrossAxis(ZedGraph.GraphPane)">
- <summary>
- Gets the "Cross" axis that corresponds to this axis.
- </summary>
- <remarks>
- The cross axis is the axis which determines the of this Axis when the
- <see cref="P:ZedGraph.Axis.Cross">Axis.Cross</see> property is used. The
- cross axis for any <see cref="T:ZedGraph.XAxis"/> or <see cref="T:ZedGraph.X2Axis"/>
- is always the primary <see cref="T:ZedGraph.YAxis"/>, and
- the cross axis for any <see cref="T:ZedGraph.YAxis"/> or <see cref="T:ZedGraph.Y2Axis"/> is
- always the primary <see cref="T:ZedGraph.XAxis"/>.
- </remarks>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- </member>
- <member name="T:ZedGraph.YAxis.Default">
- <summary>
- A simple struct that defines the
- default property values for the <see cref="T:ZedGraph.YAxis"/> class.
- </summary>
- </member>
- <member name="F:ZedGraph.YAxis.Default.IsVisible">
- <summary>
- The default display mode for the <see cref="T:ZedGraph.YAxis"/>
- (<see cref="P:ZedGraph.Axis.IsVisible"/> property). true to display the scale
- values, title, tic marks, false to hide the axis entirely.
- </summary>
- </member>
- <member name="F:ZedGraph.YAxis.Default.IsZeroLine">
- <summary>
- Determines if a line will be drawn at the zero value for the
- <see cref="T:ZedGraph.YAxis"/>, that is, a line that
- divides the negative values from positive values.
- <seealso cref="P:ZedGraph.MajorGrid.IsZeroLine"/>.
- </summary>
- </member>
- <member name="T:ZedGraph.PointPairList">
- <summary>
- A collection class containing a list of <see cref="T:ZedGraph.PointPair"/> objects
- that define the set of points to be displayed on the curve.
- </summary>
- <seealso cref="T:ZedGraph.BasicArrayPointList"/>
- <seealso cref="T:ZedGraph.IPointList"/>
-
- <author> Jerry Vos based on code by John Champion
- modified by John Champion</author>
- <version> $Revision: 3.37 $ $Date: 2007-06-29 15:39:07 $ </version>
- </member>
- <member name="F:ZedGraph.PointPairList._sorted">
- <summary>Private field to maintain the sort status of this
- <see cref="T:ZedGraph.PointPairList"/>. Use the public property
- <see cref="P:ZedGraph.PointPairList.Sorted"/> to access this value.
- </summary>
- </member>
- <member name="M:ZedGraph.PointPairList.#ctor">
- <summary>
- Default constructor for the collection class
- </summary>
- </member>
- <member name="M:ZedGraph.PointPairList.#ctor(System.Double[],System.Double[])">
- <summary>
- Constructor to initialize the PointPairList from two arrays of
- type double.
- </summary>
- </member>
- <member name="M:ZedGraph.PointPairList.#ctor(ZedGraph.IPointList)">
- <summary>
- Constructor to initialize the PointPairList from an IPointList
- </summary>
- </member>
- <member name="M:ZedGraph.PointPairList.#ctor(System.Double[],System.Double[],System.Double[])">
- <summary>
- Constructor to initialize the PointPairList from three arrays of
- type double.
- </summary>
- </member>
- <member name="M:ZedGraph.PointPairList.#ctor(ZedGraph.PointPairList)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The PointPairList from which to copy</param>
- </member>
- <member name="M:ZedGraph.PointPairList.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.PointPairList.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.PointPairList.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.PointPairList.Add(ZedGraph.PointPair)">
- <summary>
- Add a <see cref="T:ZedGraph.PointPair"/> object to the collection at the end of the list.
- </summary>
- <param name="point">The <see cref="T:ZedGraph.PointPair"/> object to
- be added</param>
- <returns>The zero-based ordinal index where the point was added in the list.</returns>
- </member>
- <member name="M:ZedGraph.PointPairList.Add(ZedGraph.PointPairList)">
- <summary>
- Add a <see cref="T:ZedGraph.PointPairList"/> object to the collection at the end of the list.
- </summary>
- <param name="pointList">A reference to the <see cref="T:ZedGraph.PointPairList"/> object to
- be added</param>
- <returns>The zero-based ordinal index where the last point was added in the list,
- or -1 if no points were added.</returns>
- </member>
- <member name="M:ZedGraph.PointPairList.Add(System.Double[],System.Double[])">
- <summary>
- Add a set of points to the PointPairList from two arrays of type double.
- If either array is null, then a set of ordinal values is automatically
- generated in its place (see <see cref="F:ZedGraph.AxisType.Ordinal"/>.
- If the arrays are of different size, then the larger array prevails and the
- smaller array is padded with <see cref="F:ZedGraph.PointPairBase.Missing"/> values.
- </summary>
- <param name="x">A double[] array of X values</param>
- <param name="y">A double[] array of Y values</param>
- <returns>The zero-based ordinal index where the last point was added in the list,
- or -1 if no points were added.</returns>
- </member>
- <member name="M:ZedGraph.PointPairList.Add(System.Double[],System.Double[],System.Double[])">
- <summary>
- Add a set of points to the <see cref="T:ZedGraph.PointPairList"/> from three arrays of type double.
- If the X or Y array is null, then a set of ordinal values is automatically
- generated in its place (see <see cref="F:ZedGraph.AxisType.Ordinal"/>. If the <see paramref="baseVal"/>
- is null, then it is set to zero.
- If the arrays are of different size, then the larger array prevails and the
- smaller array is padded with <see cref="F:ZedGraph.PointPairBase.Missing"/> values.
- </summary>
- <param name="x">A double[] array of X values</param>
- <param name="y">A double[] array of Y values</param>
- <param name="z">A double[] array of Z or lower-dependent axis values</param>
- <returns>The zero-based ordinal index where the last point was added in the list,
- or -1 if no points were added.</returns>
- </member>
- <member name="M:ZedGraph.PointPairList.Add(System.Double,System.Double)">
- <summary>
- Add a single point to the <see cref="T:ZedGraph.PointPairList"/> from values of type double.
- </summary>
- <param name="x">The X value</param>
- <param name="y">The Y value</param>
- <returns>The zero-based ordinal index where the point was added in the list.</returns>
- </member>
- <member name="M:ZedGraph.PointPairList.Add(System.Double,System.Double,System.String)">
- <summary>
- Add a single point to the <see cref="T:ZedGraph.PointPairList"/> from values of type double.
- </summary>
- <param name="x">The X value</param>
- <param name="y">The Y value</param>
- <param name="tag">The Tag value for the PointPair</param>
- <returns>The zero-based ordinal index where the point was added in the list.</returns>
- </member>
- <member name="M:ZedGraph.PointPairList.Add(System.Double,System.Double,System.Double)">
- <summary>
- Add a single point to the <see cref="T:ZedGraph.PointPairList"/> from values of type double.
- </summary>
- <param name="x">The X value</param>
- <param name="y">The Y value</param>
- <param name="z">The Z or lower dependent axis value</param>
- <returns>The zero-based ordinal index where the point was added
- in the list.</returns>
- </member>
- <member name="M:ZedGraph.PointPairList.Add(System.Double,System.Double,System.Double,System.String)">
- <summary>
- Add a single point to the <see cref="T:ZedGraph.PointPairList"/> from values of type double.
- </summary>
- <param name="x">The X value</param>
- <param name="y">The Y value</param>
- <param name="z">The Z or lower dependent axis value</param>
- <param name="tag">The Tag value for the PointPair</param>
- <returns>The zero-based ordinal index where the point was added
- in the list.</returns>
- </member>
- <member name="M:ZedGraph.PointPairList.Insert(System.Int32,ZedGraph.PointPair)">
- <summary>
- Add a <see cref="T:ZedGraph.PointPair"/> object to the collection at the specified,
- zero-based, index location.
- </summary>
- <param name="index">
- The zero-based ordinal index where the point is to be added in the list.
- </param>
- <param name="point">
- The <see cref="T:ZedGraph.PointPair"/> object to be added.
- </param>
- </member>
- <member name="M:ZedGraph.PointPairList.Insert(System.Int32,System.Double,System.Double)">
- <summary>
- Add a single point (from values of type double ) to the <see cref="T:ZedGraph.PointPairList"/> at the specified,
- zero-based, index location.
- </summary>
- <param name="index">
- The zero-based ordinal index where the point is to be added in the list.
- </param>
- <param name="x">The X value</param>
- <param name="y">The Y value</param>
- </member>
- <member name="M:ZedGraph.PointPairList.Insert(System.Int32,System.Double,System.Double,System.Double)">
- <summary>
- Add a single point (from values of type double ) to the <see cref="T:ZedGraph.PointPairList"/> at the specified,
- zero-based, index location.
- </summary>
- <param name="index">
- The zero-based ordinal index where the point is to be added in the list.
- </param>
- <param name="x">The X value</param>
- <param name="y">The Y value</param>
- <param name="z">The Z or lower dependent axis value</param>
- </member>
- <member name="M:ZedGraph.PointPairList.IndexOfTag(System.String)">
- <summary>
- Return the zero-based position index of the
- <see cref="T:ZedGraph.PointPair"/> with the specified label <see cref="F:ZedGraph.PointPair.Tag"/>.
- </summary>
- <remarks>The <see cref="F:ZedGraph.PointPair.Tag"/> object must be of type <see cref="T:System.String"/>
- for this method to find it.</remarks>
- <param name="label">The <see cref="T:System.String"/> label that is in the
- <see cref="F:ZedGraph.PointPair.Tag"/> attribute of the item to be found.
- </param>
- <returns>The zero-based index of the specified <see cref="T:ZedGraph.PointPair"/>,
- or -1 if the <see cref="T:ZedGraph.PointPair"/> is not in the list</returns>
- </member>
- <member name="M:ZedGraph.PointPairList.Equals(System.Object)">
- <summary>
- Compare two <see cref="T:ZedGraph.PointPairList"/> objects to see if they are equal.
- </summary>
- <remarks>Equality is based on equal count of <see cref="T:ZedGraph.PointPair"/> items, and
- each individual <see cref="T:ZedGraph.PointPair"/> must be equal (as per the
- <see cref="M:ZedGraph.PointPair.Equals(System.Object)"/> method.</remarks>
- <param name="obj">The <see cref="T:ZedGraph.PointPairList"/> to be compared with for equality.</param>
- <returns>true if the <see cref="T:ZedGraph.PointPairList"/> objects are equal, false otherwise.</returns>
- </member>
- <member name="M:ZedGraph.PointPairList.GetHashCode">
- <summary>
- Return the HashCode from the base class.
- </summary>
- <returns></returns>
- </member>
- <member name="M:ZedGraph.PointPairList.Sort">
- <summary>
- Sorts the list according to the point x values. Will not sort the
- list if the list is already sorted.
- </summary>
- <returns>If the list was sorted before sort was called</returns>
- </member>
- <member name="M:ZedGraph.PointPairList.Sort(ZedGraph.SortType)">
- <summary>
- Sorts the list according to the point values . Will not sort the
- list if the list is already sorted.
- </summary>
- <param name="type"></param> The <see cref="T:ZedGraph.SortType"/>
- used to determine whether the X or Y values will be used to sort
- the list
- <returns>If the list was sorted before sort was called</returns>
- </member>
- <member name="M:ZedGraph.PointPairList.SetX(System.Double[])">
- <summary>
- Set the X values for this <see cref="T:ZedGraph.PointPairList"/> from the specified
- array of double values.
- </summary>
- <remarks>
- If <see paramref="x"/> has more values than
- this list, then the extra values will be ignored. If <see paramref="x"/>
- has less values, then the corresponding <see cref="T:ZedGraph.PointPairList"/> values
- will not be changed. That is, if the <see cref="T:ZedGraph.PointPairList"/> has 20 values
- and <see paramref="x"/> has 15 values, then the first 15 values of the
- <see cref="T:ZedGraph.PointPairList"/> will be changed, and the last 5 values will not be
- changed.
- </remarks>
- <param name="x">An array of double values that will replace the existing X
- values in the <see cref="T:ZedGraph.PointPairList"/>.</param>
- </member>
- <member name="M:ZedGraph.PointPairList.SetY(System.Double[])">
- <summary>
- Set the Y values for this <see cref="T:ZedGraph.PointPairList"/> from the specified
- array of double values.
- </summary>
- <remarks>
- If <see paramref="y"/> has more values than
- this list, then the extra values will be ignored. If <see paramref="y"/>
- has less values, then the corresponding <see cref="T:ZedGraph.PointPairList"/> values
- will not be changed. That is, if the <see cref="T:ZedGraph.PointPairList"/> has 20 values
- and <see paramref="y"/> has 15 values, then the first 15 values of the
- <see cref="T:ZedGraph.PointPairList"/> will be changed, and the last 5 values will not be
- changed.
- </remarks>
- <param name="y">An array of double values that will replace the existing Y
- values in the <see cref="T:ZedGraph.PointPairList"/>.</param>
- </member>
- <member name="M:ZedGraph.PointPairList.SetZ(System.Double[])">
- <summary>
- Set the Z values for this <see cref="T:ZedGraph.PointPairList"/> from the specified
- array of double values.
- </summary>
- <remarks>
- If <see paramref="z"/> has more values than
- this list, then the extra values will be ignored. If <see paramref="z"/>
- has less values, then the corresponding <see cref="T:ZedGraph.PointPairList"/> values
- will not be changed. That is, if the <see cref="T:ZedGraph.PointPairList"/> has 20 values
- and <see paramref="z"/> has 15 values, then the first 15 values of the
- <see cref="T:ZedGraph.PointPairList"/> will be changed, and the last 5 values will not be
- changed.
- </remarks>
- <param name="z">An array of double values that will replace the existing Z
- values in the <see cref="T:ZedGraph.PointPairList"/>.</param>
- </member>
- <member name="M:ZedGraph.PointPairList.SumY(ZedGraph.PointPairList)">
- <summary>
- Add the Y values from the specified <see cref="T:ZedGraph.PointPairList"/> object to this
- <see cref="T:ZedGraph.PointPairList"/>. If <see paramref="sumList"/> has more values than
- this list, then the extra values will be ignored. If <see paramref="sumList"/>
- has less values, the missing values are assumed to be zero.
- </summary>
- <param name="sumList">A reference to the <see cref="T:ZedGraph.PointPairList"/> object to
- be summed into the this <see cref="T:ZedGraph.PointPairList"/>.</param>
- </member>
- <member name="M:ZedGraph.PointPairList.SumX(ZedGraph.PointPairList)">
- <summary>
- Add the X values from the specified <see cref="T:ZedGraph.PointPairList"/> object to this
- <see cref="T:ZedGraph.PointPairList"/>. If <see paramref="sumList"/> has more values than
- this list, then the extra values will be ignored. If <see paramref="sumList"/>
- has less values, the missing values are assumed to be zero.
- </summary>
- <param name="sumList">A reference to the <see cref="T:ZedGraph.PointPairList"/> object to
- be summed into the this <see cref="T:ZedGraph.PointPairList"/>.</param>
- </member>
- <member name="M:ZedGraph.PointPairList.InterpolateX(System.Double)">
- <summary>
- Linearly interpolate the data to find an arbitraty Y value that corresponds to the specified X value.
- </summary>
- <remarks>
- This method uses linear interpolation with a binary search algorithm. It therefore
- requires that the x data be monotonically increasing. Missing values are not allowed. This
- method will extrapolate outside the range of the PointPairList if necessary.
- </remarks>
- <param name="xTarget">The target X value on which to interpolate</param>
- <returns>The Y value that corresponds to the <see paramref="xTarget"/> value.</returns>
- </member>
- <member name="M:ZedGraph.PointPairList.SplineInterpolateX(System.Double,System.Double)">
- <summary>
- Use Cardinal Splines to Interpolate the data to find an arbitraty Y value that corresponds to
- the specified X value.
- </summary>
- <remarks>
- This method uses cardinal spline interpolation with a binary search algorithm. It therefore
- requires that the x data be monotonically increasing. Missing values are not allowed. This
- method will not extrapolate outside the range of the PointPairList (it returns
- <see cref="F:ZedGraph.PointPairBase.Missing"/> if extrapolation would be required). WARNING: Cardinal
- spline interpolation can generate curves with non-unique X values for higher tension
- settings. That is, there may be multiple X values for the same Y value. This routine
- follows the path of the spline curve until it reaches the FIRST OCCURRENCE of the
- target X value. It does not check to see if other solutions are possible.
- </remarks>
- <param name="xTarget">The target X value on which to interpolate</param>
- <param name="tension">The tension setting that controls the curvature of the spline fit.
- Typical values are between 0 and 1, where 0 is a linear fit, and 1 is lots of "roundness".
- Values greater than 1 may give odd results.
- </param>
- <returns>The Y value that corresponds to the <see paramref="xTarget"/> value.</returns>
- </member>
- <member name="M:ZedGraph.PointPairList.InterpolateY(System.Double)">
- <summary>
- Linearly interpolate the data to find an arbitraty X value that corresponds to the specified Y value.
- </summary>
- <remarks>
- This method uses linear interpolation with a binary search algorithm. It therefore
- requires that the Y data be monotonically increasing. Missing values are not allowed. This
- method will extrapolate outside the range of the PointPairList if necessary.
- </remarks>
- <param name="yTarget">The target Y value on which to interpolate</param>
- <returns>The X value that corresponds to the <see paramref="yTarget"/> value.</returns>
- </member>
- <member name="M:ZedGraph.PointPairList.LinearRegression(ZedGraph.IPointList,System.Int32)">
- <summary>
- Use linear regression to form a least squares fit of an existing
- <see cref="T:ZedGraph.IPointList"/> instance.
- </summary>
- <remarks>The output <see cref="T:ZedGraph.PointPairList"/> will cover the
- same X range of data as the original dataset.
- </remarks>
- <param name="points">An <see cref="T:ZedGraph.IPointList"/> instance containing
- the data to be regressed.</param>
- <param name="pointCount">The number of desired points to be included
- in the resultant <see cref="T:ZedGraph.PointPairList"/>.
- </param>
- <returns>A new <see cref="T:ZedGraph.PointPairList"/> containing the resultant
- data fit.
- </returns>
- </member>
- <member name="M:ZedGraph.PointPairList.LinearRegression(ZedGraph.IPointList,System.Int32,System.Double,System.Double)">
- <summary>
- Use linear regression to form a least squares fit of an existing
- <see cref="T:ZedGraph.IPointList"/> instance.
- </summary>
- <param name="points">An <see cref="T:ZedGraph.IPointList"/> instance containing
- the data to be regressed.</param>
- <param name="pointCount">The number of desired points to be included
- in the resultant <see cref="T:ZedGraph.PointPairList"/>.
- </param>
- <param name="minX">The minimum X value of the resultant
- <see cref="T:ZedGraph.PointPairList"/>.</param>
- <param name="maxX">The maximum X value of the resultant
- <see cref="T:ZedGraph.PointPairList"/>.</param>
- <returns>A new <see cref="T:ZedGraph.PointPairList"/> containing the resultant
- data fit.
- </returns>
- <author> Brian Chappell - lazarusds
- modified by John Champion</author>
- </member>
- <member name="P:ZedGraph.PointPairList.Sorted">
- <summary>
- true if the list is currently sorted.
- </summary>
- <seealso cref="M:ZedGraph.PointPairList.Sort"/>
- </member>
- <member name="T:ZedGraph.MajorTic">
- <summary>
- Class that holds the specific properties for the major tics. Inherits from
- <see cref="T:ZedGraph.MinorTic"/>.
- </summary>
- <author> John Champion </author>
- <version> $Revision: 3.1 $ $Date: 2006-06-24 20:26:44 $ </version>
- </member>
- <member name="F:ZedGraph.MajorTic.schema2">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="M:ZedGraph.MajorTic.#ctor">
- <summary>
- Default constructor for <see cref="T:ZedGraph.MajorTic"/>.
- </summary>
- </member>
- <member name="M:ZedGraph.MajorTic.#ctor(ZedGraph.MajorTic)">
- <summary>
- Copy constructor.
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.MajorTic"/> that is to be copied.</param>
- </member>
- <member name="M:ZedGraph.MajorTic.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.MajorTic.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.MajorTic.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.MajorTic.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.MajorTic.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="P:ZedGraph.MajorTic.IsBetweenLabels">
- <summary>
- Gets or sets a property that determines whether or not the major tics will be drawn
- inbetween the labels, rather than right at the labels.
- </summary>
- <remarks>
- Note that this setting is only
- applicable if <see cref="P:ZedGraph.Axis.Type"/> = <see cref="F:ZedGraph.AxisType.Text"/>.
- </remarks>
- <value>true to place the text between the labels for text axes, false otherwise</value>
- <seealso cref="P:ZedGraph.MinorTic.IsOutside"/>
- <seealso cref="P:ZedGraph.MinorTic.IsInside"/>
- <seealso cref="P:ZedGraph.MinorTic.IsOpposite"/>
- <seealso cref="P:ZedGraph.MinorTic.IsCrossOutside"/>
- <seealso cref="P:ZedGraph.MinorTic.IsCrossInside"/>
- </member>
- <member name="T:ZedGraph.MajorTic.Default">
- <summary>
- A simple struct that defines the
- default property values for the <see cref="T:ZedGraph.MinorTic"/> class.
- </summary>
- </member>
- <member name="F:ZedGraph.MajorTic.Default.Size">
- <summary>
- The default size for the <see cref="T:ZedGraph.Axis"/> tic marks.
- (<see cref="P:ZedGraph.MinorTic.Size"/> property). Units are in points (1/72 inch).
- </summary>
- </member>
- <member name="F:ZedGraph.MajorTic.Default.PenWidth">
- <summary>
- The default pen width for drawing the <see cref="T:ZedGraph.Axis"/> tic marks.
- (<see cref="P:ZedGraph.MinorTic.PenWidth"/> property). Units are in points (1/72 inch).
- </summary>
- </member>
- <member name="F:ZedGraph.MajorTic.Default.IsOutside">
- <summary>
- The display mode for the <see cref="T:ZedGraph.Axis"/> major outside tic marks
- (<see cref="P:ZedGraph.MinorTic.IsOutside"/> property).
- The major tic spacing is controlled by <see cref="P:ZedGraph.Scale.MajorStep"/>.
- </summary>
- <value>true to show the major tic marks (outside the axis),
- false otherwise</value>
- </member>
- <member name="F:ZedGraph.MajorTic.Default.IsInside">
- <summary>
- The display mode for the <see cref="T:ZedGraph.Axis"/> major inside tic marks
- (<see cref="P:ZedGraph.MinorTic.IsInside"/> property).
- The major tic spacing is controlled by <see cref="P:ZedGraph.Scale.MajorStep"/>.
- </summary>
- <value>true to show the major tic marks (inside the axis),
- false otherwise</value>
- </member>
- <member name="F:ZedGraph.MajorTic.Default.IsOpposite">
- <summary>
- The display mode for the <see cref="T:ZedGraph.Axis"/> major opposite tic marks
- (<see cref="P:ZedGraph.MinorTic.IsOpposite"/> property).
- The major tic spacing is controlled by <see cref="P:ZedGraph.Scale.MajorStep"/>.
- </summary>
- <value>true to show the major tic marks
- (inside the axis on the opposite side),
- false otherwise</value>
- </member>
- <member name="F:ZedGraph.MajorTic.Default.IsCrossOutside">
- <summary>
- The default display mode for the <see cref="T:ZedGraph.Axis"/> major outside
- "cross" tic marks (<see cref="P:ZedGraph.MinorTic.IsCrossOutside"/> property).
- </summary>
- <remarks>
- The "cross" tics are a special, additional set of tic marks that
- always appear on the actual axis, even if it has been shifted due
- to the <see cref="P:ZedGraph.Axis.Cross"/> setting. The other tic marks are always
- fixed to the edges of the <see cref="P:ZedGraph.Chart.Rect"/>. The cross tics
- are normally not displayed, since, if <see cref="P:ZedGraph.Axis.CrossAuto"/> is true,
- they will exactly overlay the "normal" and "inside" tics. If
- <see cref="P:ZedGraph.Axis.CrossAuto"/> is false, then you will most likely want to
- enable the cross tics.
- The major tic spacing is controlled by <see cref="P:ZedGraph.Scale.MajorStep"/>.
- </remarks>
- <value>true to show the major cross tic marks, false otherwise</value>
- </member>
- <member name="F:ZedGraph.MajorTic.Default.IsCrossInside">
- <summary>
- The default display mode for the <see cref="T:ZedGraph.Axis"/> major inside
- "cross" tic marks (<see cref="P:ZedGraph.MinorTic.IsCrossInside"/> property).
- </summary>
- <remarks>
- The "cross" tics are a special, additional set of tic marks that
- always appear on the actual axis, even if it has been shifted due
- to the <see cref="P:ZedGraph.Axis.Cross"/> setting. The other tic marks are always
- fixed to the edges of the <see cref="P:ZedGraph.Chart.Rect"/>. The cross tics
- are normally not displayed, since, if <see cref="P:ZedGraph.Axis.CrossAuto"/> is true,
- they will exactly overlay the "normal" and "inside" tics. If
- <see cref="P:ZedGraph.Axis.CrossAuto"/> is false, then you will most likely want to
- enable the cross tics.
- The major tic spacing is controlled by <see cref="P:ZedGraph.Scale.MajorStep"/>.
- </remarks>
- <value>true to show the major cross tic marks, false otherwise</value>
- </member>
- <member name="F:ZedGraph.MajorTic.Default.Color">
- <summary>
- The default color for major tics (<see cref="P:ZedGraph.MinorTic.Color"/> property).
- </summary>
- </member>
- <member name="T:ZedGraph.LogScale">
- <summary>
- The LogScale class inherits from the <see cref="T:ZedGraph.Scale"/> class, and implements
- the features specific to <see cref="F:ZedGraph.AxisType.Log"/>.
- </summary>
- <remarks>
- LogScale is a non-linear axis in which the values are scaled using the base 10
- <see cref="M:System.Math.Log(System.Double)"/>
- function.
- </remarks>
-
- <author> John Champion </author>
- <version> $Revision: 1.12 $ $Date: 2007-04-16 00:03:02 $ </version>
- </member>
- <member name="F:ZedGraph.LogScale.schema2">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="M:ZedGraph.LogScale.#ctor(ZedGraph.Axis)">
- <summary>
- Default constructor that defines the owner <see cref="T:ZedGraph.Axis"/>
- (containing object) for this new object.
- </summary>
- <param name="owner">The owner, or containing object, of this instance</param>
- </member>
- <member name="M:ZedGraph.LogScale.#ctor(ZedGraph.Scale,ZedGraph.Axis)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.LogScale"/> object from which to copy</param>
- <param name="owner">The <see cref="T:ZedGraph.Axis"/> object that will own the
- new instance of <see cref="T:ZedGraph.LogScale"/></param>
- </member>
- <member name="M:ZedGraph.LogScale.Clone(ZedGraph.Axis)">
- <summary>
- Create a new clone of the current item, with a new owner assignment
- </summary>
- <param name="owner">The new <see cref="T:ZedGraph.Axis"/> instance that will be
- the owner of the new Scale</param>
- <returns>A new <see cref="T:ZedGraph.Scale"/> clone.</returns>
- </member>
- <member name="M:ZedGraph.LogScale.SetupScaleData(ZedGraph.GraphPane,ZedGraph.Axis)">
- <summary>
- Setup some temporary transform values in preparation for rendering the <see cref="T:ZedGraph.Axis"/>.
- </summary>
- <remarks>
- This method is typically called by the parent <see cref="T:ZedGraph.GraphPane"/>
- object as part of the <see cref="M:ZedGraph.GraphPane.Draw(System.Drawing.Graphics)"/> method. It is also
- called by <see cref="M:ZedGraph.GraphPane.GeneralTransform(System.Double,System.Double,ZedGraph.CoordType)"/> and
- <see cref="M:ZedGraph.GraphPane.ReverseTransform(System.Drawing.PointF,System.Double@,System.Double@)"/>
- methods to setup for coordinate transformations.
- </remarks>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="axis">
- The parent <see cref="T:ZedGraph.Axis"/> for this <see cref="T:ZedGraph.Scale"/>
- </param>
- </member>
- <member name="M:ZedGraph.LogScale.Linearize(System.Double)">
- <summary>
- Convert a value to its linear equivalent for this type of scale.
- </summary>
- <remarks>
- The default behavior is to just return the value unchanged. However,
- for <see cref="F:ZedGraph.AxisType.Log"/> and <see cref="F:ZedGraph.AxisType.Exponent"/>,
- it returns the log or power equivalent.
- </remarks>
- <param name="val">The value to be converted</param>
- </member>
- <member name="M:ZedGraph.LogScale.DeLinearize(System.Double)">
- <summary>
- Convert a value from its linear equivalent to its actual scale value
- for this type of scale.
- </summary>
- <remarks>
- The default behavior is to just return the value unchanged. However,
- for <see cref="F:ZedGraph.AxisType.Log"/> and <see cref="F:ZedGraph.AxisType.Exponent"/>,
- it returns the anti-log or inverse-power equivalent.
- </remarks>
- <param name="val">The value to be converted</param>
- </member>
- <member name="M:ZedGraph.LogScale.CalcMajorTicValue(System.Double,System.Double)">
- <summary>
- Determine the value for any major tic.
- </summary>
- <remarks>
- This method properly accounts for <see cref="P:ZedGraph.Scale.IsLog"/>, <see cref="P:ZedGraph.Scale.IsText"/>,
- and other axis format settings.
- </remarks>
- <param name="baseVal">
- The value of the first major tic (floating point double)
- </param>
- <param name="tic">
- The major tic number (0 = first major tic). For log scales, this is the actual power of 10.
- </param>
- <returns>
- The specified major tic value (floating point double).
- </returns>
- </member>
- <member name="M:ZedGraph.LogScale.CalcMinorTicValue(System.Double,System.Int32)">
- <summary>
- Determine the value for any minor tic.
- </summary>
- <remarks>
- This method properly accounts for <see cref="P:ZedGraph.Scale.IsLog"/>, <see cref="P:ZedGraph.Scale.IsText"/>,
- and other axis format settings.
- </remarks>
- <param name="baseVal">
- The value of the first major tic (floating point double). This tic value is the base
- reference for all tics (including minor ones).
- </param>
- <param name="iTic">
- The major tic number (0 = first major tic). For log scales, this is the actual power of 10.
- </param>
- <returns>
- The specified minor tic value (floating point double).
- </returns>
- </member>
- <member name="M:ZedGraph.LogScale.CalcMinorStart(System.Double)">
- <summary>
- Internal routine to determine the ordinals of the first minor tic mark
- </summary>
- <param name="baseVal">
- The value of the first major tic for the axis.
- </param>
- <returns>
- The ordinal position of the first minor tic, relative to the first major tic.
- This value can be negative (e.g., -3 means the first minor tic is 3 minor step
- increments before the first major tic.
- </returns>
- </member>
- <member name="M:ZedGraph.LogScale.CalcBaseTic">
- <summary>
- Determine the value for the first major tic.
- </summary>
- <remarks>
- This is done by finding the first possible value that is an integral multiple of
- the step size, taking into account the date/time units if appropriate.
- This method properly accounts for <see cref="P:ZedGraph.Scale.IsLog"/>, <see cref="P:ZedGraph.Scale.IsText"/>,
- and other axis format settings.
- </remarks>
- <returns>
- First major tic value (floating point double).
- </returns>
- </member>
- <member name="M:ZedGraph.LogScale.CalcNumTics">
- <summary>
- Internal routine to determine the ordinals of the first and last major axis label.
- </summary>
- <returns>
- This is the total number of major tics for this axis.
- </returns>
- </member>
- <member name="M:ZedGraph.LogScale.PickScale(ZedGraph.GraphPane,System.Drawing.Graphics,System.Single)">
- <summary>
- Select a reasonable base 10 logarithmic axis scale given a range of data values.
- </summary>
- <remarks>
- This method only applies to <see cref="F:ZedGraph.AxisType.Log"/> type axes, and it
- is called by the general <see cref="M:ZedGraph.LogScale.PickScale(ZedGraph.GraphPane,System.Drawing.Graphics,System.Single)"/> method. The scale range is chosen
- based always on powers of 10 (full log cycles). This
- method honors the <see cref="P:ZedGraph.Scale.MinAuto"/>, <see cref="P:ZedGraph.Scale.MaxAuto"/>,
- and <see cref="P:ZedGraph.Scale.MajorStepAuto"/> autorange settings.
- In the event that any of the autorange settings are false, the
- corresponding <see cref="P:ZedGraph.Scale.Min"/>, <see cref="P:ZedGraph.Scale.Max"/>, or <see cref="P:ZedGraph.Scale.MajorStep"/>
- setting is explicitly honored, and the remaining autorange settings (if any) will
- be calculated to accomodate the non-autoranged values. For log axes, the MinorStep
- value is not used.
- <para>On Exit:</para>
- <para><see cref="P:ZedGraph.Scale.Min"/> is set to scale minimum (if <see cref="P:ZedGraph.Scale.MinAuto"/> = true)</para>
- <para><see cref="P:ZedGraph.Scale.Max"/> is set to scale maximum (if <see cref="P:ZedGraph.Scale.MaxAuto"/> = true)</para>
- <para><see cref="P:ZedGraph.Scale.MajorStep"/> is set to scale step size (if <see cref="P:ZedGraph.Scale.MajorStepAuto"/> = true)</para>
- <para><see cref="P:ZedGraph.Scale.Mag"/> is set to a magnitude multiplier according to the data</para>
- <para><see cref="P:ZedGraph.Scale.Format"/> is set to the display format for the values (this controls the
- number of decimal places, whether there are thousands separators, currency types, etc.)</para>
- </remarks>
- <param name="pane">A reference to the <see cref="T:ZedGraph.GraphPane"/> object
- associated with this <see cref="T:ZedGraph.Axis"/></param>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <seealso cref="M:ZedGraph.LogScale.PickScale(ZedGraph.GraphPane,System.Drawing.Graphics,System.Single)"/>
- <seealso cref="F:ZedGraph.AxisType.Log"/>
- </member>
- <member name="M:ZedGraph.LogScale.MakeLabel(ZedGraph.GraphPane,System.Int32,System.Double)">
- <summary>
- Make a value label for an <see cref="F:ZedGraph.AxisType.Log"/> <see cref="T:ZedGraph.Axis"/>.
- </summary>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="index">
- The zero-based, ordinal index of the label to be generated. For example, a value of 2 would
- cause the third value label on the axis to be generated.
- </param>
- <param name="dVal">
- The numeric value associated with the label. This value is ignored for log (<see cref="P:ZedGraph.Scale.IsLog"/>)
- and text (<see cref="P:ZedGraph.Scale.IsText"/>) type axes.
- </param>
- <returns>The resulting value label as a <see cref="T:System.String"/></returns>
- </member>
- <member name="M:ZedGraph.LogScale.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.LogScale.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="P:ZedGraph.LogScale.Type">
- <summary>
- Return the <see cref="T:ZedGraph.AxisType"/> for this <see cref="T:ZedGraph.Scale"/>, which is
- <see cref="F:ZedGraph.AxisType.Log"/>.
- </summary>
- </member>
- <member name="P:ZedGraph.LogScale.Min">
- <summary>
- Gets or sets the minimum value for this scale.
- </summary>
- <remarks>
- The set property is specifically adapted for <see cref="F:ZedGraph.AxisType.Log"/> scales,
- in that it automatically limits the setting to values greater than zero.
- </remarks>
- </member>
- <member name="P:ZedGraph.LogScale.Max">
- <summary>
- Gets or sets the maximum value for this scale.
- </summary>
- <remarks>
- The set property is specifically adapted for <see cref="F:ZedGraph.AxisType.Log"/> scales,
- in that it automatically limits the setting to values greater than zero.
- <see cref="T:ZedGraph.XDate"/> struct.
- </remarks>
- </member>
- <member name="T:ZedGraph.JapaneseCandleStickItem">
- <summary>
- Encapsulates a Japanese CandleStick curve type that displays a vertical (or horizontal)
- line displaying the range of data values at each sample point, plus a filled bar
- signifying the opening and closing value for the sample.
- </summary>
- <remarks>For this type to work properly, your <see cref="T:ZedGraph.IPointList"/> must contain
- <see cref="T:ZedGraph.StockPt"/> objects, rather than ordinary <see cref="T:ZedGraph.PointPair"/> types.
- This is because the <see cref="T:ZedGraph.OHLCBarItem"/> type actually displays 5 data values
- but the <see cref="T:ZedGraph.PointPair"/> only stores 3 data values. The <see cref="T:ZedGraph.StockPt"/>
- stores <see cref="P:ZedGraph.StockPt.Date"/>, <see cref="F:ZedGraph.StockPt.Close"/>,
- <see cref="F:ZedGraph.StockPt.Open"/>, <see cref="P:ZedGraph.StockPt.High"/>, and
- <see cref="P:ZedGraph.StockPt.Low"/> members.
- For a JapaneseCandleStick chart, the range between opening and closing values
- is drawn as a filled bar, with the filled color different
- (<see cref="P:ZedGraph.JapaneseCandleStick.RisingFill"/>) for the case of
- <see cref="F:ZedGraph.StockPt.Close"/>
- higher than <see cref="F:ZedGraph.StockPt.Open"/>, and
- <see cref="P:ZedGraph.JapaneseCandleStick.FallingFill"/>
- for the reverse. The width of the bar is controlled
- by the <see cref="P:ZedGraph.OHLCBar.Size"/> property, which is specified in
- points (1/72nd inch), and scaled according to <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/>.
- The candlesticks are drawn horizontally or vertically depending on the
- value of <see cref="P:ZedGraph.BarSettings.Base"/>, which is a
- <see cref="T:ZedGraph.BarBase"/> enum type.</remarks>
- <author> John Champion </author>
- <version> $Revision: 3.6 $ $Date: 2007-12-31 00:23:05 $ </version>
- </member>
- <member name="F:ZedGraph.JapaneseCandleStickItem.schema2">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="F:ZedGraph.JapaneseCandleStickItem._stick">
- <summary>
- Private field that stores a reference to the <see cref="T:ZedGraph.OHLCBar"/>
- class defined for this <see cref="T:ZedGraph.OHLCBarItem"/>. Use the public
- property <see cref="T:ZedGraph.OHLCBar"/> to access this value.
- </summary>
-
- </member>
- <member name="M:ZedGraph.JapaneseCandleStickItem.IsXIndependent(ZedGraph.GraphPane)">
- <summary>
- Gets a flag indicating if the X axis is the independent axis for this <see cref="T:ZedGraph.CurveItem"/>
- </summary>
- <param name="pane">The parent <see cref="T:ZedGraph.GraphPane"/> of this <see cref="T:ZedGraph.CurveItem"/>.
- </param>
- <value>true if the X axis is independent, false otherwise</value>
- </member>
- <member name="M:ZedGraph.JapaneseCandleStickItem.IsZIncluded(ZedGraph.GraphPane)">
- <summary>
- Gets a flag indicating if the Z data range should be included in the axis scaling calculations.
- </summary>
- <remarks>
- IsZIncluded is true for <see cref="T:ZedGraph.JapaneseCandleStickItem"/> objects, since the Y and Z
- values are defined as the High and Low values for the day.</remarks>
- <param name="pane">The parent <see cref="T:ZedGraph.GraphPane"/> of this <see cref="T:ZedGraph.CurveItem"/>.
- </param>
- <value>true if the Z data are included, false otherwise</value>
- </member>
- <member name="M:ZedGraph.JapaneseCandleStickItem.#ctor(System.String)">
- <summary>
- Create a new <see cref="T:ZedGraph.OHLCBarItem"/>, specifying only the legend label.
- </summary>
- <param name="label">The label that will appear in the legend.</param>
- </member>
- <member name="M:ZedGraph.JapaneseCandleStickItem.#ctor(System.String,ZedGraph.IPointList)">
- <summary>
- Create a new <see cref="T:ZedGraph.JapaneseCandleStickItem"/> using the specified properties.
- </summary>
- <param name="label">The label that will appear in the legend.</param>
- <param name="points">An <see cref="T:ZedGraph.IPointList"/> of double precision values that define
- the Date, Close, Open, High, and Low values for the curve. Note that this
- <see cref="T:ZedGraph.IPointList"/> should contain <see cref="T:ZedGraph.StockPt"/> items rather
- than <see cref="T:ZedGraph.PointPair"/> items.
- </param>
- </member>
- <member name="M:ZedGraph.JapaneseCandleStickItem.#ctor(ZedGraph.JapaneseCandleStickItem)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.JapaneseCandleStickItem"/> object from which to copy</param>
- </member>
- <member name="M:ZedGraph.JapaneseCandleStickItem.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.JapaneseCandleStickItem.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.JapaneseCandleStickItem.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.JapaneseCandleStickItem.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.JapaneseCandleStickItem.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.JapaneseCandleStickItem.Draw(System.Drawing.Graphics,ZedGraph.GraphPane,System.Int32,System.Single)">
- <summary>
- Do all rendering associated with this <see cref="T:ZedGraph.OHLCBarItem"/> to the specified
- <see cref="T:System.Drawing.Graphics"/> device. This method is normally only
- called by the Draw method of the parent <see cref="T:ZedGraph.CurveList"/>
- collection object.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="pos">The ordinal position of the current <see cref="T:ZedGraph.OHLCBarItem"/>
- curve.</param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.JapaneseCandleStickItem.DrawLegendKey(System.Drawing.Graphics,ZedGraph.GraphPane,System.Drawing.RectangleF,System.Single)">
- <summary>
- Draw a legend key entry for this <see cref="T:ZedGraph.OHLCBarItem"/> at the specified location
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="rect">The <see cref="T:System.Drawing.RectangleF"/> struct that specifies the
- location for the legend key</param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.JapaneseCandleStickItem.GetCoords(ZedGraph.GraphPane,System.Int32,System.String@)">
- <summary>
- Determine the coords for the rectangle associated with a specified point for
- this <see cref="T:ZedGraph.CurveItem"/>
- </summary>
- <param name="pane">The <see cref="T:ZedGraph.GraphPane"/> to which this curve belongs</param>
- <param name="i">The index of the point of interest</param>
- <param name="coords">A list of coordinates that represents the "rect" for
- this point (used in an html AREA tag)</param>
- <returns>true if it's a valid point, false otherwise</returns>
- </member>
- <member name="P:ZedGraph.JapaneseCandleStickItem.Stick">
- <summary>
- Gets a reference to the <see cref="T:ZedGraph.JapaneseCandleStick"/> class defined
- for this <see cref="T:ZedGraph.JapaneseCandleStickItem"/>.
- </summary>
- </member>
- <member name="T:ZedGraph.DateAsOrdinalScale">
- <summary>
- The DateAsOrdinalScale class inherits from the <see cref="T:ZedGraph.Scale"/> class, and implements
- the features specific to <see cref="F:ZedGraph.AxisType.DateAsOrdinal"/>.
- </summary>
- <remarks>DateAsOrdinalScale is an ordinal axis that will have labels formatted with dates from the
- actual data values of the first <see cref="T:ZedGraph.CurveItem"/> in the <see cref="T:ZedGraph.CurveList"/>.
- Although the tics are labeled with real data values, the actual points will be
- evenly-spaced in spite of the data values. For example, if the X values of the first curve
- are 1, 5, and 100, then the tic labels will show 1, 5, and 100, but they will be equal
- distance from each other.
- </remarks>
-
- <author> John Champion </author>
- <version> $Revision: 1.13 $ $Date: 2007-11-28 02:38:22 $ </version>
- </member>
- <member name="F:ZedGraph.DateAsOrdinalScale.schema2">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="M:ZedGraph.DateAsOrdinalScale.#ctor(ZedGraph.Axis)">
- <summary>
- Default constructor that defines the owner <see cref="T:ZedGraph.Axis"/>
- (containing object) for this new object.
- </summary>
- <param name="owner">The owner, or containing object, of this instance</param>
- </member>
- <member name="M:ZedGraph.DateAsOrdinalScale.#ctor(ZedGraph.Scale,ZedGraph.Axis)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.DateAsOrdinalScale"/> object from which to copy</param>
- <param name="owner">The <see cref="T:ZedGraph.Axis"/> object that will own the
- new instance of <see cref="T:ZedGraph.DateAsOrdinalScale"/></param>
- </member>
- <member name="M:ZedGraph.DateAsOrdinalScale.Clone(ZedGraph.Axis)">
- <summary>
- Create a new clone of the current item, with a new owner assignment
- </summary>
- <param name="owner">The new <see cref="T:ZedGraph.Axis"/> instance that will be
- the owner of the new Scale</param>
- <returns>A new <see cref="T:ZedGraph.Scale"/> clone.</returns>
- </member>
- <member name="M:ZedGraph.DateAsOrdinalScale.PickScale(ZedGraph.GraphPane,System.Drawing.Graphics,System.Single)">
- <summary>
- Select a reasonable ordinal axis scale given a range of data values, with the expectation that
- dates will be displayed.
- </summary>
- <remarks>
- This method only applies to <see cref="F:ZedGraph.AxisType.DateAsOrdinal"/> type axes, and it
- is called by the general <see cref="M:ZedGraph.DateAsOrdinalScale.PickScale(ZedGraph.GraphPane,System.Drawing.Graphics,System.Single)"/> method. For this type,
- the first curve is the "master", which contains the dates to be applied.
- <para>On Exit:</para>
- <para><see cref="P:ZedGraph.Scale.Min"/> is set to scale minimum (if <see cref="P:ZedGraph.Scale.MinAuto"/> = true)</para>
- <para><see cref="P:ZedGraph.Scale.Max"/> is set to scale maximum (if <see cref="P:ZedGraph.Scale.MaxAuto"/> = true)</para>
- <para><see cref="P:ZedGraph.Scale.MajorStep"/> is set to scale step size (if <see cref="P:ZedGraph.Scale.MajorStepAuto"/> = true)</para>
- <para><see cref="P:ZedGraph.Scale.MinorStep"/> is set to scale minor step size (if <see cref="P:ZedGraph.Scale.MinorStepAuto"/> = true)</para>
- <para><see cref="P:ZedGraph.Scale.Mag"/> is set to a magnitude multiplier according to the data</para>
- <para><see cref="P:ZedGraph.Scale.Format"/> is set to the display format for the values (this controls the
- number of decimal places, whether there are thousands separators, currency types, etc.)</para>
- </remarks>
- <param name="pane">A reference to the <see cref="T:ZedGraph.GraphPane"/> object
- associated with this <see cref="T:ZedGraph.Axis"/></param>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <seealso cref="M:ZedGraph.DateAsOrdinalScale.PickScale(ZedGraph.GraphPane,System.Drawing.Graphics,System.Single)"/>
- <seealso cref="F:ZedGraph.AxisType.Ordinal"/>
- </member>
- <member name="M:ZedGraph.DateAsOrdinalScale.MakeLabel(ZedGraph.GraphPane,System.Int32,System.Double)">
- <summary>
- Make a value label for an <see cref="F:ZedGraph.AxisType.DateAsOrdinal"/> <see cref="T:ZedGraph.Axis"/>.
- </summary>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="index">
- The zero-based, ordinal index of the label to be generated. For example, a value of 2 would
- cause the third value label on the axis to be generated.
- </param>
- <param name="dVal">
- The numeric value associated with the label. This value is ignored for log
- (<see cref="P:ZedGraph.Scale.IsLog"/>)
- and text (<see cref="P:ZedGraph.Scale.IsText"/>) type axes.
- </param>
- <returns>The resulting value label as a <see cref="T:System.String"/></returns>
- </member>
- <member name="M:ZedGraph.DateAsOrdinalScale.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.DateAsOrdinalScale.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="P:ZedGraph.DateAsOrdinalScale.Type">
- <summary>
- Return the <see cref="T:ZedGraph.AxisType"/> for this <see cref="T:ZedGraph.Scale"/>, which is
- <see cref="F:ZedGraph.AxisType.DateAsOrdinal"/>.
- </summary>
- </member>
- <member name="P:ZedGraph.DateAsOrdinalScale.Min">
- <summary>
- Gets or sets the minimum value for this scale.
- </summary>
- <remarks>
- The set property is specifically adapted for <see cref="F:ZedGraph.AxisType.DateAsOrdinal"/> scales,
- in that it automatically limits the value to the range of valid dates for the
- <see cref="T:ZedGraph.XDate"/> struct.
- </remarks>
- </member>
- <member name="P:ZedGraph.DateAsOrdinalScale.Max">
- <summary>
- Gets or sets the maximum value for this scale.
- </summary>
- <remarks>
- The set property is specifically adapted for <see cref="F:ZedGraph.AxisType.DateAsOrdinal"/> scales,
- in that it automatically limits the value to the range of valid dates for the
- <see cref="T:ZedGraph.XDate"/> struct.
- </remarks>
- </member>
- <member name="T:ZedGraph.CollectionPlus">
- <summary>
- A collection base class containing basic extra functionality to be inherited
- by <see cref="T:ZedGraph.CurveList"/>, <see cref="T:ZedGraph.IPointList"/>,
- <see cref="T:ZedGraph.GraphObjList"/>.
- </summary>
- <remarks>The methods in this collection operate on basic
- <see cref="T:System.Object"/> types. Therefore, in order to make sure that
- the derived classes remain strongly-typed, there are no Add() or
- Insert() methods here, and no methods that return an object.
- Only Remove(), Move(), IndexOf(), etc. methods are included.</remarks>
-
- <author> John Champion</author>
- <version> $Revision: 3.8 $ $Date: 2006-06-24 20:26:43 $ </version>
- </member>
- <member name="M:ZedGraph.CollectionPlus.#ctor">
- <summary>
- Default Constructor
- </summary>
- </member>
- <member name="M:ZedGraph.CollectionPlus.IndexOf(System.Object)">
- <summary>
- Return the zero-based position index of the specified object
- in the collection.
- </summary>
- <param name="item">A reference to the object that is to be found.
- </param>
- <returns>The zero-based index of the specified object, or -1 if the
- object is not in the list</returns>
- <seealso cref="M:System.Collections.IList.IndexOf(System.Object)"/>
- </member>
- <member name="M:ZedGraph.CollectionPlus.Remove(System.Int32)">
- <summary>
- Remove an object from the collection at the specified ordinal location.
- </summary>
- <param name="index">
- An ordinal position in the list at which the object to be removed
- is located.
- </param>
- <seealso cref="M:System.Collections.IList.Remove(System.Object)"/>
- </member>
- <member name="M:ZedGraph.CollectionPlus.Remove(System.Object)">
- <summary>
- Remove an object from the collection based on an object reference.
- </summary>
- <param name="item">A reference to the object that is to be
- removed.</param>
- <seealso cref="M:System.Collections.IList.Remove(System.Object)"/>
- </member>
- <member name="M:ZedGraph.CollectionPlus.Move(System.Int32,System.Int32)">
- <summary>
- Move the position of the object at the specified index
- to the new relative position in the list.</summary>
- <remarks>For Graphic type objects, this method controls the
- Z-Order of the items. Objects at the beginning of the list
- appear in front of objects at the end of the list.</remarks>
- <param name="index">The zero-based index of the object
- to be moved.</param>
- <param name="relativePos">The relative number of positions to move
- the object. A value of -1 will move the
- object one position earlier in the list, a value
- of 1 will move it one position later. To move an item to the
- beginning of the list, use a large negative value (such as -999).
- To move it to the end of the list, use a large positive value.
- </param>
- <returns>The new position for the object, or -1 if the object
- was not found.</returns>
- </member>
- <member name="T:ZedGraph.PointPair4">
- <summary>
- The basic <see cref="T:ZedGraph.PointPair"/> class holds three data values (X, Y, Z). This
- class extends the basic PointPair to contain four data values (X, Y, Z, T).
- </summary>
-
- <author> John Champion </author>
- <version> $Revision: 3.3 $ $Date: 2007-03-17 18:43:44 $ </version>
- </member>
- <member name="F:ZedGraph.PointPair4.schema3">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="F:ZedGraph.PointPair4.T">
- <summary>
- This PointPair4's T coordinate.
- </summary>
- </member>
- <member name="M:ZedGraph.PointPair4.#ctor">
- <summary>
- Default Constructor
- </summary>
- </member>
- <member name="M:ZedGraph.PointPair4.#ctor(System.Double,System.Double,System.Double,System.Double)">
- <summary>
- Creates a point pair with the specified X, Y, Z, and T value.
- </summary>
- <param name="x">This pair's x coordinate.</param>
- <param name="y">This pair's y coordinate.</param>
- <param name="z">This pair's z coordinate.</param>
- <param name="t">This pair's t coordinate.</param>
- </member>
- <member name="M:ZedGraph.PointPair4.#ctor(System.Double,System.Double,System.Double,System.Double,System.String)">
- <summary>
- Creates a point pair with the specified X, Y, base value, and
- label (<see cref="F:ZedGraph.PointPair.Tag"/>).
- </summary>
- <param name="x">This pair's x coordinate.</param>
- <param name="y">This pair's y coordinate.</param>
- <param name="z">This pair's z coordinate.</param>
- <param name="t">This pair's t coordinate.</param>
- <param name="label">This pair's string label (<see cref="F:ZedGraph.PointPair.Tag"/>)</param>
- </member>
- <member name="M:ZedGraph.PointPair4.#ctor(ZedGraph.PointPair4)">
- <summary>
- The PointPair4 copy constructor.
- </summary>
- <param name="rhs">The basis for the copy.</param>
- </member>
- <member name="M:ZedGraph.PointPair4.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.PointPair4.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.PointPair4.ToString(System.Boolean)">
- <summary>
- Format this PointPair4 value using the default format. Example: "( 12.345, -16.876 )".
- The two double values are formatted with the "g" format type.
- </summary>
- <param name="isShowZT">true to show the third "Z" and fourth "T" value coordinates</param>
- <returns>A string representation of the PointPair4</returns>
- </member>
- <member name="M:ZedGraph.PointPair4.ToString(System.String,System.Boolean)">
- <summary>
- Format this PointPair value using a general format string.
- Example: a format string of "e2" would give "( 1.23e+001, -1.69e+001 )".
- If <see paramref="isShowZ"/>
- is true, then the third "Z" coordinate is also shown.
- </summary>
- <param name="format">A format string that will be used to format each of
- the two double type values (see <see cref="M:System.Double.ToString"/>).</param>
- <returns>A string representation of the PointPair</returns>
- <param name="isShowZT">true to show the third "Z" or low dependent value coordinate</param>
- </member>
- <member name="M:ZedGraph.PointPair4.ToString(System.String,System.String,System.String,System.String)">
- <summary>
- Format this PointPair value using different general format strings for the X, Y, and Z values.
- Example: a format string of "e2" would give "( 1.23e+001, -1.69e+001 )".
- </summary>
- <param name="formatX">A format string that will be used to format the X
- double type value (see <see cref="M:System.Double.ToString"/>).</param>
- <param name="formatY">A format string that will be used to format the Y
- double type value (see <see cref="M:System.Double.ToString"/>).</param>
- <param name="formatZ">A format string that will be used to format the Z
- double type value (see <see cref="M:System.Double.ToString"/>).</param>
- <param name="formatT">A format string that will be used to format the T
- double type value (see <see cref="M:System.Double.ToString"/>).</param>
- <returns>A string representation of the PointPair</returns>
- </member>
- <member name="P:ZedGraph.PointPair4.IsInvalid4D">
- <summary>
- Readonly value that determines if either the X, Y, Z, or T
- coordinate in this PointPair4 is an invalid (not plotable) value.
- It is considered invalid if it is missing (equal to System.Double.Max),
- Infinity, or NaN.
- </summary>
- <returns>true if any value is invalid</returns>
- </member>
- <member name="T:ZedGraph.LineItem">
- <summary>
- Encapsulates a curve type that is displayed as a line and/or a set of
- symbols at each point.
- </summary>
-
- <author> John Champion </author>
- <version> $Revision: 3.22 $ $Date: 2007-08-10 16:22:54 $ </version>
- </member>
- <member name="F:ZedGraph.LineItem.schema2">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="F:ZedGraph.LineItem._symbol">
- <summary>
- Private field that stores a reference to the <see cref="T:ZedGraph.Symbol"/>
- class defined for this <see cref="T:ZedGraph.LineItem"/>. Use the public
- property <see cref="P:ZedGraph.LineItem.Symbol"/> to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.LineItem._line">
- <summary>
- Private field that stores a reference to the <see cref="T:ZedGraph.Line"/>
- class defined for this <see cref="T:ZedGraph.LineItem"/>. Use the public
- property <see cref="P:ZedGraph.LineItem.Line"/> to access this value.
- </summary>
- </member>
- <member name="M:ZedGraph.LineItem.IsZIncluded(ZedGraph.GraphPane)">
- <summary>
- Gets a flag indicating if the Z data range should be included in the axis scaling calculations.
- </summary>
- <param name="pane">The parent <see cref="T:ZedGraph.GraphPane"/> of this <see cref="T:ZedGraph.CurveItem"/>.
- </param>
- <value>true if the Z data are included, false otherwise</value>
- </member>
- <member name="M:ZedGraph.LineItem.IsXIndependent(ZedGraph.GraphPane)">
- <summary>
- Gets a flag indicating if the X axis is the independent axis for this <see cref="T:ZedGraph.CurveItem"/>
- </summary>
- <param name="pane">The parent <see cref="T:ZedGraph.GraphPane"/> of this <see cref="T:ZedGraph.CurveItem"/>.
- </param>
- <value>true if the X axis is independent, false otherwise</value>
- </member>
- <member name="M:ZedGraph.LineItem.#ctor(System.String)">
- <summary>
- Create a new <see cref="T:ZedGraph.LineItem"/>, specifying only the legend <see cref="P:ZedGraph.CurveItem.Label"/>.
- </summary>
- <param name="label">The _label that will appear in the legend.</param>
- </member>
- <member name="M:ZedGraph.LineItem.#ctor(System.String,System.Double[],System.Double[],System.Drawing.Color,ZedGraph.SymbolType,System.Single)">
- <summary>
- Create a new <see cref="T:ZedGraph.LineItem"/> using the specified properties.
- </summary>
- <param name="label">The _label that will appear in the legend.</param>
- <param name="x">An array of double precision values that define
- the independent (X axis) values for this curve</param>
- <param name="y">An array of double precision values that define
- the dependent (Y axis) values for this curve</param>
- <param name="color">A <see cref="T:System.Drawing.Color"/> value that will be applied to
- the <see cref="P:ZedGraph.LineItem.Line"/> and <see cref="P:ZedGraph.LineItem.Symbol"/> properties.
- </param>
- <param name="symbolType">A <see cref="T:ZedGraph.SymbolType"/> enum specifying the
- type of symbol to use for this <see cref="T:ZedGraph.LineItem"/>. Use <see cref="F:ZedGraph.SymbolType.None"/>
- to hide the symbols.</param>
- <param name="lineWidth">The width (in points) to be used for the <see cref="P:ZedGraph.LineItem.Line"/>. This
- width is scaled based on <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/>. Use a value of zero to
- hide the line (see <see cref="P:ZedGraph.LineBase.IsVisible"/>).</param>
- </member>
- <member name="M:ZedGraph.LineItem.#ctor(System.String,System.Double[],System.Double[],System.Drawing.Color,ZedGraph.SymbolType)">
- <summary>
- Create a new <see cref="T:ZedGraph.LineItem"/> using the specified properties.
- </summary>
- <param name="label">The _label that will appear in the legend.</param>
- <param name="x">An array of double precision values that define
- the independent (X axis) values for this curve</param>
- <param name="y">An array of double precision values that define
- the dependent (Y axis) values for this curve</param>
- <param name="color">A <see cref="T:System.Drawing.Color"/> value that will be applied to
- the <see cref="P:ZedGraph.LineItem.Line"/> and <see cref="P:ZedGraph.LineItem.Symbol"/> properties.
- </param>
- <param name="symbolType">A <see cref="T:ZedGraph.SymbolType"/> enum specifying the
- type of symbol to use for this <see cref="T:ZedGraph.LineItem"/>. Use <see cref="F:ZedGraph.SymbolType.None"/>
- to hide the symbols.</param>
- </member>
- <member name="M:ZedGraph.LineItem.#ctor(System.String,ZedGraph.IPointList,System.Drawing.Color,ZedGraph.SymbolType,System.Single)">
- <summary>
- Create a new <see cref="T:ZedGraph.LineItem"/> using the specified properties.
- </summary>
- <param name="label">The _label that will appear in the legend.</param>
- <param name="points">A <see cref="T:ZedGraph.IPointList"/> of double precision value pairs that define
- the X and Y values for this curve</param>
- <param name="color">A <see cref="T:System.Drawing.Color"/> value that will be applied to
- the <see cref="P:ZedGraph.LineItem.Line"/> and <see cref="P:ZedGraph.LineItem.Symbol"/> properties.
- </param>
- <param name="symbolType">A <see cref="T:ZedGraph.SymbolType"/> enum specifying the
- type of symbol to use for this <see cref="T:ZedGraph.LineItem"/>. Use <see cref="F:ZedGraph.SymbolType.None"/>
- to hide the symbols.</param>
- <param name="lineWidth">The width (in points) to be used for the <see cref="P:ZedGraph.LineItem.Line"/>. This
- width is scaled based on <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/>. Use a value of zero to
- hide the line (see <see cref="P:ZedGraph.LineBase.IsVisible"/>).</param>
- </member>
- <member name="M:ZedGraph.LineItem.#ctor(System.String,ZedGraph.IPointList,System.Drawing.Color,ZedGraph.SymbolType)">
- <summary>
- Create a new <see cref="T:ZedGraph.LineItem"/> using the specified properties.
- </summary>
- <param name="label">The _label that will appear in the legend.</param>
- <param name="points">A <see cref="T:ZedGraph.IPointList"/> of double precision value pairs that define
- the X and Y values for this curve</param>
- <param name="color">A <see cref="T:System.Drawing.Color"/> value that will be applied to
- the <see cref="P:ZedGraph.LineItem.Line"/> and <see cref="P:ZedGraph.LineItem.Symbol"/> properties.
- </param>
- <param name="symbolType">A <see cref="T:ZedGraph.SymbolType"/> enum specifying the
- type of symbol to use for this <see cref="T:ZedGraph.LineItem"/>. Use <see cref="F:ZedGraph.SymbolType.None"/>
- to hide the symbols.</param>
- </member>
- <member name="M:ZedGraph.LineItem.#ctor(ZedGraph.LineItem)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.LineItem"/> object from which to copy</param>
- </member>
- <member name="M:ZedGraph.LineItem.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.LineItem.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.LineItem.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.LineItem.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.LineItem.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.LineItem.Draw(System.Drawing.Graphics,ZedGraph.GraphPane,System.Int32,System.Single)">
- <summary>
- Do all rendering associated with this <see cref="T:ZedGraph.LineItem"/> to the specified
- <see cref="T:System.Drawing.Graphics"/> device. This method is normally only
- called by the Draw method of the parent <see cref="T:ZedGraph.CurveList"/>
- collection object.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="pos">The ordinal position of the current <see cref="T:ZedGraph.Bar"/>
- curve.</param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.LineItem.DrawLegendKey(System.Drawing.Graphics,ZedGraph.GraphPane,System.Drawing.RectangleF,System.Single)">
- <summary>
- Draw a legend key entry for this <see cref="T:ZedGraph.LineItem"/> at the specified location
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.GraphPane"/> object that is the parent or
- owner of this object.
- </param>
- <param name="rect">The <see cref="T:System.Drawing.RectangleF"/> struct that specifies the
- location for the legend key</param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.LineItem.MakeUnique(ZedGraph.ColorSymbolRotator)">
- <summary>
- Loads some pseudo unique colors/symbols into this LineItem. This
- is mainly useful for differentiating a set of new LineItems without
- having to pick your own colors/symbols.
- <seealso cref="M:ZedGraph.CurveItem.MakeUnique(ZedGraph.ColorSymbolRotator)"/>
- </summary>
- <param name="rotator">
- The <see cref="T:ZedGraph.ColorSymbolRotator"/> that is used to pick the color
- and symbol for this method call.
- </param>
- </member>
- <member name="M:ZedGraph.LineItem.GetCoords(ZedGraph.GraphPane,System.Int32,System.String@)">
- <summary>
- Determine the coords for the rectangle associated with a specified point for
- this <see cref="T:ZedGraph.CurveItem"/>
- </summary>
- <param name="pane">The <see cref="T:ZedGraph.GraphPane"/> to which this curve belongs</param>
- <param name="i">The index of the point of interest</param>
- <param name="coords">A list of coordinates that represents the "rect" for
- this point (used in an html AREA tag)</param>
- <returns>true if it's a valid point, false otherwise</returns>
- </member>
- <member name="P:ZedGraph.LineItem.Symbol">
- <summary>
- Gets or sets the <see cref="T:ZedGraph.Symbol"/> class instance defined
- for this <see cref="T:ZedGraph.LineItem"/>.
- </summary>
- </member>
- <member name="P:ZedGraph.LineItem.Line">
- <summary>
- Gets or sets the <see cref="T:ZedGraph.Line"/> class instance defined
- for this <see cref="T:ZedGraph.LineItem"/>.
- </summary>
- </member>
- <member name="T:ZedGraph.Legend">
- <summary>
- This class encapsulates the chart <see cref="T:ZedGraph.Legend"/> that is displayed
- in the <see cref="T:ZedGraph.GraphPane"/>
- </summary>
-
- <author> John Champion </author>
- <version> $Revision: 3.41 $ $Date: 2007-08-11 19:24:55 $ </version>
- </member>
- <member name="F:ZedGraph.Legend.schema">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="F:ZedGraph.Legend._rect">
- <summary> Private field to hold the bounding rectangle around the legend.
- This bounding rectangle varies with the number of legend entries, font sizes,
- etc., and is re-calculated by <see cref="M:ZedGraph.Legend.CalcRect(System.Drawing.Graphics,ZedGraph.PaneBase,System.Single,System.Drawing.RectangleF@)"/> at each redraw.
- Use the public readonly property <see cref="P:ZedGraph.Legend.Rect"/> to access this
- rectangle.
- </summary>
- </member>
- <member name="F:ZedGraph.Legend._position">
- <summary>Private field to hold the legend location setting. This field
- contains the <see cref="T:ZedGraph.LegendPos"/> enum type to specify the area of
- the graph where the legend will be positioned. Use the public property
- <see cref="T:ZedGraph.LegendPos"/> to access this value.
- </summary>
- <seealso cref="F:ZedGraph.Legend.Default.Position"/>
- </member>
- <member name="F:ZedGraph.Legend._isHStack">
- <summary>
- Private field to enable/disable horizontal stacking of the legend entries.
- If this value is false, then the legend entries will always be a single column.
- Use the public property <see cref="P:ZedGraph.Legend.IsHStack"/> to access this value.
- </summary>
- <seealso cref="F:ZedGraph.Legend.Default.IsHStack"/>
- </member>
- <member name="F:ZedGraph.Legend._isVisible">
- <summary>
- Private field to enable/disable drawing of the entire legend.
- If this value is false, then the legend will not be drawn.
- Use the public property <see cref="P:ZedGraph.Legend.IsVisible"/> to access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.Legend._fill">
- <summary>
- Private field that stores the <see cref="T:ZedGraph.Fill"/> data for this
- <see cref="T:ZedGraph.Legend"/>. Use the public property <see cref="P:ZedGraph.Legend.Fill"/> to
- access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.Legend._border">
- <summary>
- Private field that stores the <see cref="T:ZedGraph.Border"/> data for this
- <see cref="T:ZedGraph.Legend"/>. Use the public property <see cref="P:ZedGraph.Legend.Border"/> to
- access this value.
- </summary>
- </member>
- <member name="F:ZedGraph.Legend._fontSpec">
- <summary>
- Private field to maintain the <see cref="P:ZedGraph.Legend.FontSpec"/> class that
- maintains font attributes for the entries in this legend. Use
- the <see cref="P:ZedGraph.Legend.FontSpec"/> property to access this class.
- </summary>
- </member>
- <member name="F:ZedGraph.Legend._location">
- <summary>
- Private field to maintain the <see cref="T:ZedGraph.Legend"/> location. This object
- is only applicable if the <see cref="P:ZedGraph.Legend.Position"/> property is set to
- <see cref="F:ZedGraph.LegendPos.Float"/>.
- </summary>
- </member>
- <member name="F:ZedGraph.Legend._hStack">
- <summary>
- Private temporary field to maintain the number of columns (horizontal stacking) to be used
- for drawing the <see cref="T:ZedGraph.Legend"/>. This value is only valid during a draw operation.
- </summary>
- </member>
- <member name="F:ZedGraph.Legend._legendItemWidth">
- <summary>
- Private temporary field to maintain the width of each column in the
- <see cref="T:ZedGraph.Legend"/>. This value is only valid during a draw operation.
- </summary>
- </member>
- <member name="F:ZedGraph.Legend._legendItemHeight">
- <summary>
- Private temporary field to maintain the height of each row in the
- <see cref="T:ZedGraph.Legend"/>. This value is only valid during a draw operation.
- </summary>
- </member>
- <member name="F:ZedGraph.Legend._gap">
- <summary>
- Private field to store the gap between the legend and the chart rectangle.
- </summary>
- </member>
- <member name="F:ZedGraph.Legend._isReverse">
- <summary>
- Private field to select output order of legend entries.
- </summary>
- </member>
- <member name="F:ZedGraph.Legend._tmpSize">
- <summary>
- Private temporary field to maintain the characteristic "gap" for the legend.
- This is normal the height of the largest font in the legend.
- This value is only valid during a draw operation.
- </summary>
- </member>
- <member name="F:ZedGraph.Legend._isShowLegendSymbols">
- <summary>
- Private field to enable/diable drawing the line and symbol samples in the
- legend.
- </summary>
- </member>
- <member name="M:ZedGraph.Legend.#ctor">
- <summary>
- Default constructor that sets all <see cref="T:ZedGraph.Legend"/> properties to default
- values as defined in the <see cref="T:ZedGraph.Legend.Default"/> class.
- </summary>
- </member>
- <member name="M:ZedGraph.Legend.#ctor(ZedGraph.Legend)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The XAxis object from which to copy</param>
- </member>
- <member name="M:ZedGraph.Legend.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.Legend.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.Legend.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.Legend.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.Legend.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.Legend.Draw(System.Drawing.Graphics,ZedGraph.PaneBase,System.Single)">
- <summary>
- Render the <see cref="T:ZedGraph.Legend"/> to the specified <see cref="T:System.Drawing.Graphics"/> device.
- </summary>
- <remarks>
- This method is normally only called by the Draw method
- of the parent <see cref="T:ZedGraph.GraphPane"/> object.
- </remarks>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.PaneBase"/> object that is the parent or
- owner of this object.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- </member>
- <member name="M:ZedGraph.Legend.FindPoint(System.Drawing.PointF,ZedGraph.PaneBase,System.Single,System.Int32@)">
- <summary>
- Determine if a mouse point is within the legend, and if so, which legend
- entry (<see cref="T:ZedGraph.CurveItem"/>) is nearest.
- </summary>
- <param name="mousePt">The screen point, in pixel coordinates.</param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.PaneBase"/> object that is the parent or
- owner of this object.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <param name="index">The index number of the <see cref="T:ZedGraph.CurveItem"/> legend
- entry that is under the mouse point. The <see cref="T:ZedGraph.CurveItem"/> object is
- accessible via <see cref="P:ZedGraph.GraphPane.CurveList">CurveList[index]</see>.
- </param>
- <returns>true if the mouse point is within the <see cref="T:ZedGraph.Legend"/> bounding
- box, false otherwise.</returns>
- <seealso cref="M:ZedGraph.GraphPane.FindNearestObject(System.Drawing.PointF,System.Drawing.Graphics,System.Object@,System.Int32@)"/>
- </member>
- <member name="M:ZedGraph.Legend.CalcRect(System.Drawing.Graphics,ZedGraph.PaneBase,System.Single,System.Drawing.RectangleF@)">
- <summary>
- Calculate the <see cref="T:ZedGraph.Legend"/> rectangle (<see cref="P:ZedGraph.Legend.Rect"/>),
- taking into account the number of required legend
- entries, and the legend drawing preferences.
- </summary>
- <remarks>Adjust the size of the
- <see cref="P:ZedGraph.Chart.Rect"/> for the parent <see cref="T:ZedGraph.GraphPane"/> to accomodate the
- space required by the legend.
- </remarks>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="pane">
- A reference to the <see cref="T:ZedGraph.PaneBase"/> object that is the parent or
- owner of this object.
- </param>
- <param name="scaleFactor">
- The scaling factor to be used for rendering objects. This is calculated and
- passed down by the parent <see cref="T:ZedGraph.GraphPane"/> object using the
- <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
- font sizes, etc. according to the actual size of the graph.
- </param>
- <param name="tChartRect">
- The rectangle that contains the area bounded by the axes, in pixel units.
- <seealso cref="P:ZedGraph.Chart.Rect"/>
- </param>
- </member>
- <member name="P:ZedGraph.Legend.Rect">
- <summary>
- Get the bounding rectangle for the <see cref="T:ZedGraph.Legend"/> in screen coordinates
- </summary>
- <value>A screen rectangle in pixel units</value>
- </member>
- <member name="P:ZedGraph.Legend.FontSpec">
- <summary>
- Access to the <see cref="T:ZedGraph.FontSpec"/> class used to render
- the <see cref="T:ZedGraph.Legend"/> entries
- </summary>
- <value>A reference to a <see cref="T:ZedGraph.Legend"/> object</value>
- <seealso cref="F:ZedGraph.Legend.Default.FontColor"/>
- <seealso cref="F:ZedGraph.Legend.Default.FontBold"/>
- <seealso cref="F:ZedGraph.Legend.Default.FontItalic"/>
- <seealso cref="F:ZedGraph.Legend.Default.FontUnderline"/>
- <seealso cref="F:ZedGraph.Legend.Default.FontFamily"/>
- <seealso cref="F:ZedGraph.Legend.Default.FontSize"/>
- </member>
- <member name="P:ZedGraph.Legend.IsVisible">
- <summary>
- Gets or sets a property that shows or hides the <see cref="T:ZedGraph.Legend"/> entirely
- </summary>
- <value> true to show the <see cref="T:ZedGraph.Legend"/>, false to hide it </value>
- <seealso cref="F:ZedGraph.Legend.Default.IsVisible"/>
- </member>
- <member name="P:ZedGraph.Legend.Border">
- <summary>
- The <see cref="P:ZedGraph.Legend.Border"/> class used to draw the border border around this <see cref="T:ZedGraph.Legend"/>.
- </summary>
- </member>
- <member name="P:ZedGraph.Legend.Fill">
- <summary>
- Gets or sets the <see cref="T:ZedGraph.Fill"/> data for this
- <see cref="T:ZedGraph.Legend"/> background.
- </summary>
- </member>
- <member name="P:ZedGraph.Legend.IsHStack">
- <summary>
- Sets or gets a property that allows the <see cref="T:ZedGraph.Legend"/> items to
- stack horizontally in addition to the vertical stacking
- </summary>
- <value>true to allow horizontal stacking, false otherwise
- </value>
- <seealso cref="F:ZedGraph.Legend.Default.IsHStack"/>
- </member>
- <member name="P:ZedGraph.Legend.Position">
- <summary>
- Sets or gets the location of the <see cref="T:ZedGraph.Legend"/> on the
- <see cref="T:ZedGraph.GraphPane"/> using the <see cref="T:ZedGraph.LegendPos"/> enum type
- </summary>
- <seealso cref="F:ZedGraph.Legend.Default.Position"/>
- </member>
- <member name="P:ZedGraph.Legend.Location">
- <summary>
- Gets or sets the <see cref="P:ZedGraph.Legend.Location"/> data for the <see cref="T:ZedGraph.Legend"/>.
- This property is only applicable if <see cref="P:ZedGraph.Legend.Position"/> is set
- to <see cref="F:ZedGraph.LegendPos.Float"/>.
- </summary>
- </member>
- <member name="P:ZedGraph.Legend.Gap">
- <summary>
- Gets or sets the gap size between the legend and the <see cref="P:ZedGraph.Chart.Rect"/>.
- </summary>
- <remarks>
- This is expressed as a fraction of the largest scaled character height for any
- of the fonts used in the legend. Each <see cref="T:ZedGraph.CurveItem"/> in the legend can
- optionally have its own <see cref="P:ZedGraph.Legend.FontSpec"/> specification.
- </remarks>
- </member>
- <member name="P:ZedGraph.Legend.IsReverse">
- <summary>
- Gets or sets a value that determines if the legend entries are displayed in normal order
- (matching the order in the <see cref="T:ZedGraph.CurveList"/>, or in reverse order.
- </summary>
- </member>
- <member name="P:ZedGraph.Legend.IsShowLegendSymbols">
- <summary>
- Gets or sets a value that determines whether the line and symbol keys will be displayed
- in the legend.
- </summary>
- <remarks>
- Note: If this value is set to false (so that only the curve label text is displayed
- with no legend keys), then the color of the font for the legend entry of each curve
- will automatically be set to match the <see cref="P:ZedGraph.CurveItem.Color"/> setting for that curve.
- You can override this behavior by specifying a specific font to be used for each
- individual curve with the <see cref="P:ZedGraph.Label.FontSpec">CurveItem.Label.FontSpec</see>
- property.
- </remarks>
- </member>
- <member name="T:ZedGraph.Legend.Default">
- <summary>
- A simple struct that defines the
- default property values for the <see cref="T:ZedGraph.Legend"/> class.
- </summary>
- </member>
- <member name="F:ZedGraph.Legend.Default.BorderWidth">
- <summary>
- The default pen width for the <see cref="T:ZedGraph.Legend"/> border border.
- (<see cref="P:ZedGraph.LineBase.Width"/> property). Units are in pixels.
- </summary>
- </member>
- <member name="F:ZedGraph.Legend.Default.BorderColor">
- <summary>
- The default color for the <see cref="T:ZedGraph.Legend"/> border border.
- (<see cref="P:ZedGraph.LineBase.Color"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.Legend.Default.FillColor">
- <summary>
- The default color for the <see cref="T:ZedGraph.Legend"/> background.
- (<see cref="P:ZedGraph.Fill.Color"/> property). Use of this
- color depends on the status of the <see cref="P:ZedGraph.Fill.Type"/>
- property.
- </summary>
- </member>
- <member name="F:ZedGraph.Legend.Default.FillBrush">
- <summary>
- The default custom brush for filling in this <see cref="T:ZedGraph.Legend"/>.
- </summary>
- </member>
- <member name="F:ZedGraph.Legend.Default.FillType">
- <summary>
- The default fill mode for the <see cref="T:ZedGraph.Legend"/> background.
- </summary>
- </member>
- <member name="F:ZedGraph.Legend.Default.Position">
- <summary>
- The default location for the <see cref="T:ZedGraph.Legend"/> on the graph
- (<see cref="P:ZedGraph.Legend.Location"/> property). This property is
- defined as a <see cref="T:ZedGraph.LegendPos"/> enumeration.
- </summary>
- </member>
- <member name="F:ZedGraph.Legend.Default.IsBorderVisible">
- <summary>
- The default border mode for the <see cref="T:ZedGraph.Legend"/>.
- (<see cref="P:ZedGraph.LineBase.IsVisible"/> property). true
- to draw a border around the <see cref="P:ZedGraph.Legend.Rect"/>,
- false otherwise.
- </summary>
- </member>
- <member name="F:ZedGraph.Legend.Default.IsVisible">
- <summary>
- The default display mode for the <see cref="T:ZedGraph.Legend"/>.
- (<see cref="P:ZedGraph.Legend.IsVisible"/> property). true
- to show the legend,
- false to hide it.
- </summary>
- </member>
- <member name="F:ZedGraph.Legend.Default.IsFilled">
- <summary>
- The default fill mode for the <see cref="T:ZedGraph.Legend"/> background
- (<see cref="P:ZedGraph.Fill.Type"/> property).
- true to fill-in the background with color,
- false to leave the background transparent.
- </summary>
- </member>
- <member name="F:ZedGraph.Legend.Default.IsHStack">
- <summary>
- The default horizontal stacking mode for the <see cref="T:ZedGraph.Legend"/>
- (<see cref="P:ZedGraph.Legend.IsHStack"/> property).
- true to allow horizontal legend item stacking, false to allow
- only vertical legend orientation.
- </summary>
- </member>
- <member name="F:ZedGraph.Legend.Default.FontFamily">
- <summary>
- The default font family for the <see cref="T:ZedGraph.Legend"/> entries
- (<see cref="P:ZedGraph.FontSpec.Family"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.Legend.Default.FontSize">
- <summary>
- The default font size for the <see cref="T:ZedGraph.Legend"/> entries
- (<see cref="P:ZedGraph.FontSpec.Size"/> property). Units are
- in points (1/72 inch).
- </summary>
- </member>
- <member name="F:ZedGraph.Legend.Default.FontColor">
- <summary>
- The default font color for the <see cref="T:ZedGraph.Legend"/> entries
- (<see cref="P:ZedGraph.FontSpec.FontColor"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.Legend.Default.FontBold">
- <summary>
- The default font bold mode for the <see cref="T:ZedGraph.Legend"/> entries
- (<see cref="P:ZedGraph.FontSpec.IsBold"/> property). true
- for a bold typeface, false otherwise.
- </summary>
- </member>
- <member name="F:ZedGraph.Legend.Default.FontItalic">
- <summary>
- The default font italic mode for the <see cref="T:ZedGraph.Legend"/> entries
- (<see cref="P:ZedGraph.FontSpec.IsItalic"/> property). true
- for an italic typeface, false otherwise.
- </summary>
- </member>
- <member name="F:ZedGraph.Legend.Default.FontUnderline">
- <summary>
- The default font underline mode for the <see cref="T:ZedGraph.Legend"/> entries
- (<see cref="P:ZedGraph.FontSpec.IsUnderline"/> property). true
- for an underlined typeface, false otherwise.
- </summary>
- </member>
- <member name="F:ZedGraph.Legend.Default.FontFillColor">
- <summary>
- The default color for filling in the scale text background
- (see <see cref="P:ZedGraph.Fill.Color"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.Legend.Default.FontFillBrush">
- <summary>
- The default custom brush for filling in the scale text background
- (see <see cref="P:ZedGraph.Fill.Brush"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.Legend.Default.FontFillType">
- <summary>
- The default fill mode for filling in the scale text background
- (see <see cref="P:ZedGraph.Fill.Type"/> property).
- </summary>
- </member>
- <member name="F:ZedGraph.Legend.Default.Gap">
- <summary>
- The default gap size between the legend and the <see cref="P:ZedGraph.Chart.Rect"/>.
- This is the default value of <see cref="P:ZedGraph.Legend.Gap"/>.
- </summary>
- </member>
- <member name="F:ZedGraph.Legend.Default.IsReverse">
- <summary>
- Default value for the <see cref="P:ZedGraph.Legend.IsReverse"/> property.
- </summary>
- </member>
- <member name="F:ZedGraph.Legend.Default.IsShowLegendSymbols">
- <summary>
- Default value for the <see cref="P:ZedGraph.Legend.IsShowLegendSymbols"/> property.
- </summary>
- </member>
- <member name="T:ZedGraph.HSBColor">
- <summary>
- Hue-Saturation-Brightness Color class to store a color value, and to manage conversions
- to and from RGB colors in the <see cref="T:System.Drawing.Color"/> struct.
- </summary>
- <remarks>
- This class is based on code from http://www.cs.rit.edu/~ncs/color/ by Eugene Vishnevsky.
- This struct stores the hue, saturation, brightness, and alpha values internally as
- <see cref="T:System.Byte"/> values from 0 to 255. The hue represents a fraction of the 360 degrees
- of color space available. The saturation is the color intensity, where 0 represents gray scale
- and 255 is the most colored. For the brightness, 0 represents black and 255
- represents white.
- </remarks>
- </member>
- <member name="F:ZedGraph.HSBColor.H">
- <summary>
- The color hue value, ranging from 0 to 255.
- </summary>
- <remarks>
- This property is actually a rescaling of the 360 degrees on the color wheel to 255
- possible values. Therefore, every 42.5 units is a new sector, with the following
- convention: red=0, yellow=42.5, green=85, cyan=127.5, blue=170, magenta=212.5
- </remarks>
- </member>
- <member name="F:ZedGraph.HSBColor.S">
- <summary>
- The color saturation (intensity) value, ranging from 0 (gray scale) to 255 (most colored).
- </summary>
- </member>
- <member name="F:ZedGraph.HSBColor.B">
- <summary>
- The brightness value, ranging from 0 (black) to 255 (white).
- </summary>
- </member>
- <member name="F:ZedGraph.HSBColor.A">
- <summary>
- The alpha value (opacity), ranging from 0 (transparent) to 255 (opaque).
- </summary>
- </member>
- <member name="M:ZedGraph.HSBColor.#ctor(System.Int32,System.Int32,System.Int32)">
- <summary>
- Constructor to load an <see cref="T:ZedGraph.HSBColor"/> struct from hue, saturation and
- brightness values
- </summary>
- <param name="h">The color hue value, ranging from 0 to 255</param>
- <param name="s">The color saturation (intensity) value, ranging from 0 (gray scale)
- to 255 (most colored)</param>
- <param name="b">The brightness value, ranging from 0 (black) to 255 (white)</param>
- </member>
- <member name="M:ZedGraph.HSBColor.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
- <summary>
- Constructor to load an <see cref="T:ZedGraph.HSBColor"/> struct from hue, saturation,
- brightness, and alpha values
- </summary>
- <param name="h">The color hue value, ranging from 0 to 255</param>
- <param name="s">The color saturation (intensity) value, ranging from 0 (gray scale)
- to 255 (most colored)</param>
- <param name="b">The brightness value, ranging from 0 (black) to 255 (white)</param>
- <param name="a">The alpha value (opacity), ranging from 0 (transparent) to
- 255 (opaque)</param>
- </member>
- <member name="M:ZedGraph.HSBColor.#ctor(System.Drawing.Color)">
- <summary>
- Constructor to load an <see cref="T:ZedGraph.HSBColor"/> struct from a system
- <see cref="T:System.Drawing.Color"/> struct.
- </summary>
- <param name="color">An rgb <see cref="T:System.Drawing.Color"/> struct containing the equivalent
- color you want to generate</param>
- </member>
- <member name="M:ZedGraph.HSBColor.op_Implicit(ZedGraph.HSBColor)~System.Drawing.Color">
- <summary>
- Implicit conversion operator to convert directly from an <see cref="T:ZedGraph.HSBColor"/> to
- a <see cref="T:System.Drawing.Color"/> struct.
- </summary>
- <param name="hsbColor">The <see cref="T:ZedGraph.HSBColor"/> struct to be converted</param>
- <returns>An equivalent <see cref="T:System.Drawing.Color"/> struct that can be used in the GDI+
- graphics library</returns>
- </member>
- <member name="M:ZedGraph.HSBColor.ToRGB(ZedGraph.HSBColor)">
- <summary>
- Convert an <see cref="T:ZedGraph.HSBColor"/> value to an equivalent <see cref="T:System.Drawing.Color"/> value.
- </summary>
- <remarks>
- This method is based on code from http://www.cs.rit.edu/~ncs/color/ by Eugene Vishnevsky.
- </remarks>
- <param name="hsbColor">The <see cref="T:ZedGraph.HSBColor"/> struct to be converted</param>
- <returns>An equivalent <see cref="T:System.Drawing.Color"/> struct, compatible with the GDI+ library</returns>
- </member>
- <member name="M:ZedGraph.HSBColor.ToRGB">
- <summary>
- Convert this <see cref="T:ZedGraph.HSBColor"/> value to an equivalent <see cref="T:System.Drawing.Color"/> value.
- </summary>
- <remarks>
- This method is based on code from http://www.cs.rit.edu/~ncs/color/ by Eugene Vishnevsky.
- </remarks>
- <returns>An equivalent <see cref="T:System.Drawing.Color"/> struct, compatible with the GDI+ library</returns>
- </member>
- <member name="M:ZedGraph.HSBColor.FromRGB">
- <summary>
- Convert a <see cref="T:System.Drawing.Color"/> value to an equivalent <see cref="T:ZedGraph.HSBColor"/> value.
- </summary>
- <remarks>
- This method is based on code from http://www.cs.rit.edu/~ncs/color/ by Eugene Vishnevsky.
- </remarks>
- <returns>An equivalent <see cref="T:ZedGraph.HSBColor"/> struct</returns>
- </member>
- <member name="M:ZedGraph.HSBColor.FromRGB(System.Drawing.Color)">
- <summary>
- Convert a <see cref="T:System.Drawing.Color"/> value to an equivalent <see cref="T:ZedGraph.HSBColor"/> value.
- </summary>
- <remarks>
- This method is based on code from http://www.cs.rit.edu/~ncs/color/ by Eugene Vishnevsky.
- </remarks>
- <param name="rgbColor">The <see cref="T:System.Drawing.Color"/> struct to be converted</param>
- <returns>An equivalent <see cref="T:ZedGraph.HSBColor"/> struct</returns>
- </member>
- <member name="T:ZedGraph.StickItem">
- <summary>
- Encapsulates a curve type that is displayed as a series of vertical "sticks",
- one at each defined point.
- </summary>
- <remarks>
- The sticks run from the zero value of the Y axis, to the Y point defined in each
- <see cref="T:ZedGraph.PointPair"/> of the <see cref="T:ZedGraph.IPointList"/> (see <see cref="P:ZedGraph.CurveItem.Points"/>).
- The properties of the sticks are defined in the <see cref="T:ZedGraph.Line"/> property.
- Normally, the <see cref="T:ZedGraph.Symbol"/> is not visible. However, if you manually enable the
- <see cref="T:ZedGraph.Symbol"/> using the <see cref="P:ZedGraph.Symbol.IsVisible"/> property, the
- symbols will be drawn at the "Z" value from each <see cref="T:ZedGraph.PointPair"/> (see
- <see cref="F:ZedGraph.PointPair.Z"/>).
- </remarks>
-
- <author> John Champion </author>
- <version> $Revision: 1.7 $ $Date: 2007-01-25 07:56:09 $ </version>
- </member>
- <member name="F:ZedGraph.StickItem.schema3">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="M:ZedGraph.StickItem.IsZIncluded(ZedGraph.GraphPane)">
- <summary>
- Gets a flag indicating if the Z data range should be included in the axis scaling calculations.
- </summary>
- <param name="pane">The parent <see cref="T:ZedGraph.GraphPane"/> of this <see cref="T:ZedGraph.CurveItem"/>.
- </param>
- <value>true if the Z data are included, false otherwise</value>
- </member>
- <member name="M:ZedGraph.StickItem.IsXIndependent(ZedGraph.GraphPane)">
- <summary>
- Gets a flag indicating if the X axis is the independent axis for this <see cref="T:ZedGraph.CurveItem"/>
- </summary>
- <param name="pane">The parent <see cref="T:ZedGraph.GraphPane"/> of this <see cref="T:ZedGraph.CurveItem"/>.
- </param>
- <value>true if the X axis is independent, false otherwise</value>
- </member>
- <member name="M:ZedGraph.StickItem.#ctor(System.String)">
- <summary>
- Create a new <see cref="T:ZedGraph.StickItem"/>, specifying only the legend <see cref="P:ZedGraph.CurveItem.Label"/>.
- </summary>
- <param name="label">The label that will appear in the legend.</param>
- </member>
- <member name="M:ZedGraph.StickItem.#ctor(System.String,System.Double[],System.Double[],System.Drawing.Color,System.Single)">
- <summary>
- Create a new <see cref="T:ZedGraph.StickItem"/> using the specified properties.
- </summary>
- <param name="label">The label that will appear in the legend.</param>
- <param name="x">An array of double precision values that define
- the independent (X axis) values for this curve</param>
- <param name="y">An array of double precision values that define
- the dependent (Y axis) values for this curve</param>
- <param name="color">A <see cref="T:System.Drawing.Color"/> value that will be applied to
- the <see cref="T:ZedGraph.Line"/> and <see cref="T:ZedGraph.Symbol"/> properties.
- </param>
- <param name="lineWidth">The width (in points) to be used for the <see cref="T:ZedGraph.Line"/>. This
- width is scaled based on <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/>. Use a value of zero to
- hide the line (see <see cref="P:ZedGraph.LineBase.IsVisible"/>).</param>
- </member>
- <member name="M:ZedGraph.StickItem.#ctor(System.String,System.Double[],System.Double[],System.Drawing.Color)">
- <summary>
- Create a new <see cref="T:ZedGraph.StickItem"/> using the specified properties.
- </summary>
- <param name="label">The label that will appear in the legend.</param>
- <param name="x">An array of double precision values that define
- the independent (X axis) values for this curve</param>
- <param name="y">An array of double precision values that define
- the dependent (Y axis) values for this curve</param>
- <param name="color">A <see cref="T:System.Drawing.Color"/> value that will be applied to
- the <see cref="T:ZedGraph.Line"/> and <see cref="T:ZedGraph.Symbol"/> properties.
- </param>
- </member>
- <member name="M:ZedGraph.StickItem.#ctor(System.String,ZedGraph.IPointList,System.Drawing.Color)">
- <summary>
- Create a new <see cref="T:ZedGraph.StickItem"/> using the specified properties.
- </summary>
- <param name="label">The label that will appear in the legend.</param>
- <param name="points">A <see cref="T:ZedGraph.IPointList"/> of double precision value pairs that define
- the X and Y values for this curve</param>
- <param name="color">A <see cref="T:System.Drawing.Color"/> value that will be applied to
- the <see cref="T:ZedGraph.Line"/> and <see cref="T:ZedGraph.Symbol"/> properties.
- </param>
- </member>
- <member name="M:ZedGraph.StickItem.#ctor(System.String,ZedGraph.IPointList,System.Drawing.Color,System.Single)">
- <summary>
- Create a new <see cref="T:ZedGraph.StickItem"/> using the specified properties.
- </summary>
- <param name="label">The label that will appear in the legend.</param>
- <param name="points">A <see cref="T:ZedGraph.IPointList"/> of double precision value pairs that define
- the X and Y values for this curve</param>
- <param name="color">A <see cref="T:System.Drawing.Color"/> value that will be applied to
- the <see cref="T:ZedGraph.Line"/> and <see cref="T:ZedGraph.Symbol"/> properties.
- </param>
- <param name="lineWidth">The width (in points) to be used for the <see cref="T:ZedGraph.Line"/>. This
- width is scaled based on <see cref="M:ZedGraph.PaneBase.CalcScaleFactor"/>. Use a value of zero to
- hide the line (see <see cref="P:ZedGraph.LineBase.IsVisible"/>).</param>
- </member>
- <member name="M:ZedGraph.StickItem.#ctor(ZedGraph.StickItem)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The <see cref="T:ZedGraph.StickItem"/> object from which to copy</param>
- </member>
- <member name="M:ZedGraph.StickItem.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.StickItem.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.StickItem.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.StickItem.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.StickItem.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="T:ZedGraph.Fill">
- <summary>
- A class that encapsulates color-fill properties for an object. The <see cref="T:ZedGraph.Fill"/> class
- is used in <see cref="P:ZedGraph.PaneBase.Rect"/>, <see cref="P:ZedGraph.Chart.Rect"/>, <see cref="T:ZedGraph.Legend"/>,
- <see cref="T:ZedGraph.Bar"/>, and <see cref="T:ZedGraph.Line"/> objects.
- </summary>
-
- <author> John Champion </author>
- <version> $Revision: 3.22 $ $Date: 2007-01-26 09:01:49 $ </version>
- </member>
- <member name="F:ZedGraph.Fill.schema">
- <summary>
- Current schema value that defines the version of the serialized file
- </summary>
- </member>
- <member name="F:ZedGraph.Fill._color">
- <summary>
- Private field that stores the fill color. Use the public
- property <see cref="P:ZedGraph.Fill.Color"/> to access this value. This property is
- only applicable if the <see cref="P:ZedGraph.Fill.Type"/> is not <see cref="F:ZedGraph.FillType.None"/>.
- </summary>
- </member>
- <member name="F:ZedGraph.Fill._secondaryValueGradientColor">
- <summary>
- Private field that stores the secondary color for gradientByValue fills. Use the public
- property <see cref="P:ZedGraph.Fill.SecondaryValueGradientColor"/> to access this value. This property is
- only applicable if the <see cref="P:ZedGraph.Fill.Type"/> is <see cref="F:ZedGraph.FillType.GradientByX"/>,
- <see cref="F:ZedGraph.FillType.GradientByY"/>, or <see cref="F:ZedGraph.FillType.GradientByZ"/>.
- </summary>
- </member>
- <member name="F:ZedGraph.Fill._brush">
- <summary>
- Private field that stores the custom fill brush. Use the public
- property <see cref="P:ZedGraph.Fill.Brush"/> to access this value. This property is
- only applicable if the
- <see cref="P:ZedGraph.Fill.Type"/> property is set to <see cref="F:ZedGraph.FillType.Brush"/>.
- </summary>
- </member>
- <member name="F:ZedGraph.Fill._type">
- <summary>
- Private field that determines the type of color fill. Use the public
- property <see cref="P:ZedGraph.Fill.Type"/> to access this value. The fill color
- is determined by the property <see cref="P:ZedGraph.Fill.Color"/> or
- <see cref="P:ZedGraph.Fill.Brush"/>.
- </summary>
- </member>
- <member name="F:ZedGraph.Fill._isScaled">
- <summary>
- Private field that determines if the brush will be scaled to the bounding box
- of the filled object. If this value is false, then the brush will only be aligned
- with the filled object based on the <see cref="P:ZedGraph.Fill.AlignH"/> and <see cref="P:ZedGraph.Fill.AlignV"/>
- properties.
- </summary>
- </member>
- <member name="F:ZedGraph.Fill._alignH">
- <summary>
- Private field that determines how the brush will be aligned with the filled object
- in the horizontal direction. This value is a <see cref="T:ZedGraph.AlignH"/> enumeration.
- This field only applies if <see cref="P:ZedGraph.Fill.IsScaled"/> is false.
- properties.
- </summary>
- <seealso cref="P:ZedGraph.Fill.AlignH"/>
- <seealso cref="P:ZedGraph.Fill.AlignV"/>
- </member>
- <member name="F:ZedGraph.Fill._alignV">
- <summary>
- Private field that determines how the brush will be aligned with the filled object
- in the vertical direction. This value is a <see cref="T:ZedGraph.AlignV"/> enumeration.
- This field only applies if <see cref="P:ZedGraph.Fill.IsScaled"/> is false.
- properties.
- </summary>
- <seealso cref="P:ZedGraph.Fill.AlignH"/>
- <seealso cref="P:ZedGraph.Fill.AlignV"/>
- </member>
- <member name="F:ZedGraph.Fill._image">
- <summary>
- Private field that saves the image passed to the constructor.
- This is used strictly for serialization.
- </summary>
- </member>
- <member name="F:ZedGraph.Fill._wrapMode">
- <summary>
- Private field that saves the image wrapmode passed to the constructor.
- This is used strictly for serialization.
- </summary>
- </member>
- <member name="F:ZedGraph.Fill._colorList">
- <summary>
- Private field that saves the list of colors used to create the
- <see cref="T:System.Drawing.Drawing2D.LinearGradientBrush"/> in the constructor. This is used strictly
- for serialization.
- </summary>
- </member>
- <member name="F:ZedGraph.Fill._positionList">
- <summary>
- Private field that saves the list of positions used to create the
- <see cref="T:System.Drawing.Drawing2D.LinearGradientBrush"/> in the constructor. This is used strictly
- for serialization.
- </summary>
- </member>
- <member name="F:ZedGraph.Fill._angle">
- <summary>
- Private field the saves the angle of the fill. This is used strictly for serialization.
- </summary>
- </member>
- <member name="M:ZedGraph.Fill.Init">
- <summary>
- Generic initializer to default values
- </summary>
- </member>
- <member name="M:ZedGraph.Fill.#ctor">
- <summary>
- The default constructor. Initialized to no fill.
- </summary>
- </member>
- <member name="M:ZedGraph.Fill.#ctor(System.Drawing.Color,System.Drawing.Brush,ZedGraph.FillType)">
- <summary>
- Constructor that specifies the color, brush, and type for this fill.
- </summary>
- <param name="color">The color of the fill for solid fills</param>
- <param name="brush">A custom brush for fills. Can be a <see cref="T:System.Drawing.SolidBrush"/>,
- <see cref="T:System.Drawing.Drawing2D.LinearGradientBrush"/>, or <see cref="T:System.Drawing.TextureBrush"/>.</param>
- <param name="type">The <see cref="T:ZedGraph.FillType"/> for this fill.</param>
- </member>
- <member name="M:ZedGraph.Fill.#ctor(System.Drawing.Color)">
- <summary>
- Constructor that creates a solid color-fill, setting <see cref="P:ZedGraph.Fill.Type"/> to
- <see cref="F:ZedGraph.FillType.Solid"/>, and setting <see cref="P:ZedGraph.Fill.Color"/> to the
- specified color value.
- </summary>
- <param name="color">The color of the solid fill</param>
- </member>
- <member name="M:ZedGraph.Fill.#ctor(System.Drawing.Color,System.Drawing.Color,System.Single)">
- <summary>
- Constructor that creates a linear gradient color-fill, setting <see cref="P:ZedGraph.Fill.Type"/> to
- <see cref="F:ZedGraph.FillType.Brush"/> using the specified colors and angle.
- </summary>
- <param name="color1">The first color for the gradient fill</param>
- <param name="color2">The second color for the gradient fill</param>
- <param name="angle">The angle (degrees) of the gradient fill</param>
- </member>
- <member name="M:ZedGraph.Fill.#ctor(System.Drawing.Color,System.Drawing.Color)">
- <summary>
- Constructor that creates a linear gradient color-fill, setting <see cref="P:ZedGraph.Fill.Type"/> to
- <see cref="F:ZedGraph.FillType.Brush"/> using the specified colors.
- </summary>
- <param name="color1">The first color for the gradient fill</param>
- <param name="color2">The second color for the gradient fill</param>
- </member>
- <member name="M:ZedGraph.Fill.#ctor(System.Drawing.Color,System.Drawing.Color,System.Drawing.Color)">
- <summary>
- Constructor that creates a linear gradient color-fill, setting <see cref="P:ZedGraph.Fill.Type"/> to
- <see cref="F:ZedGraph.FillType.Brush"/> using the specified colors. This gradient fill
- consists of three colors.
- </summary>
- <param name="color1">The first color for the gradient fill</param>
- <param name="color2">The second color for the gradient fill</param>
- <param name="color3">The third color for the gradient fill</param>
- </member>
- <member name="M:ZedGraph.Fill.#ctor(System.Drawing.Color,System.Drawing.Color,System.Drawing.Color,System.Single)">
- <summary>
- Constructor that creates a linear gradient color-fill, setting <see cref="P:ZedGraph.Fill.Type"/> to
- <see cref="F:ZedGraph.FillType.Brush"/> using the specified colors. This gradient fill
- consists of three colors
- </summary>
- <param name="color1">The first color for the gradient fill</param>
- <param name="color2">The second color for the gradient fill</param>
- <param name="color3">The third color for the gradient fill</param>
- <param name="angle">The angle (degrees) of the gradient fill</param>
- </member>
- <member name="M:ZedGraph.Fill.#ctor(System.Drawing.Drawing2D.ColorBlend)">
- <summary>
- Constructor that creates a linear gradient multi-color-fill, setting <see cref="P:ZedGraph.Fill.Type"/> to
- <see cref="F:ZedGraph.FillType.Brush"/> using the specified colors. This gradient fill
- consists of many colors based on a <see cref="T:System.Drawing.Drawing2D.ColorBlend"/> object. The gradient
- angle is defaulted to zero.
- </summary>
- <param name="blend">The <see cref="T:System.Drawing.Drawing2D.ColorBlend"/> object that defines the colors
- and positions along the gradient.</param>
- </member>
- <member name="M:ZedGraph.Fill.#ctor(System.Drawing.Drawing2D.ColorBlend,System.Single)">
- <summary>
- Constructor that creates a linear gradient multi-color-fill, setting <see cref="P:ZedGraph.Fill.Type"/> to
- <see cref="F:ZedGraph.FillType.Brush"/> using the specified colors. This gradient fill
- consists of many colors based on a <see cref="T:System.Drawing.Drawing2D.ColorBlend"/> object, drawn at the
- specified angle (degrees).
- </summary>
- <param name="blend">The <see cref="T:System.Drawing.Drawing2D.ColorBlend"/> object that defines the colors
- and positions along the gradient.</param>
- <param name="angle">The angle (degrees) of the gradient fill</param>
- </member>
- <member name="M:ZedGraph.Fill.#ctor(System.Drawing.Color[])">
- <summary>
- Constructor that creates a linear gradient multi-color-fill, setting <see cref="P:ZedGraph.Fill.Type"/> to
- <see cref="F:ZedGraph.FillType.Brush"/> using the specified colors. This gradient fill
- consists of many colors based on an array of <see cref="P:ZedGraph.Fill.Color"/> objects, drawn at an
- angle of zero (degrees). The <see paramref="colors"/> array is used to create
- a <see cref="T:System.Drawing.Drawing2D.ColorBlend"/> object assuming a even linear distribution of the colors
- across the gradient.
- </summary>
- <param name="colors">The array of <see cref="P:ZedGraph.Fill.Color"/> objects that defines the colors
- along the gradient.</param>
- </member>
- <member name="M:ZedGraph.Fill.#ctor(System.Drawing.Color[],System.Single)">
- <summary>
- Constructor that creates a linear gradient multi-color-fill, setting <see cref="P:ZedGraph.Fill.Type"/> to
- <see cref="F:ZedGraph.FillType.Brush"/> using the specified colors. This gradient fill
- consists of many colors based on an array of <see cref="P:ZedGraph.Fill.Color"/> objects, drawn at the
- specified angle (degrees). The <see paramref="colors"/> array is used to create
- a <see cref="T:System.Drawing.Drawing2D.ColorBlend"/> object assuming a even linear distribution of the colors
- across the gradient.
- </summary>
- <param name="colors">The array of <see cref="P:ZedGraph.Fill.Color"/> objects that defines the colors
- along the gradient.</param>
- <param name="angle">The angle (degrees) of the gradient fill</param>
- </member>
- <member name="M:ZedGraph.Fill.#ctor(System.Drawing.Color[],System.Single[])">
- <summary>
- Constructor that creates a linear gradient multi-color-fill, setting <see cref="P:ZedGraph.Fill.Type"/> to
- <see cref="F:ZedGraph.FillType.Brush"/> using the specified colors. This gradient fill
- consists of many colors based on an array of <see cref="P:ZedGraph.Fill.Color"/> objects, drawn at the
- an angle of zero (degrees). The <see paramref="colors"/> array is used to create
- a <see cref="T:System.Drawing.Drawing2D.ColorBlend"/> object assuming a even linear distribution of the colors
- across the gradient.
- </summary>
- <param name="colors">The array of <see cref="P:ZedGraph.Fill.Color"/> objects that defines the colors
- along the gradient.</param>
- <param name="positions">The array of floating point values that defines the color
- positions along the gradient. Values should range from 0 to 1.</param>
- </member>
- <member name="M:ZedGraph.Fill.#ctor(System.Drawing.Color[],System.Single[],System.Single)">
- <summary>
- Constructor that creates a linear gradient multi-color-fill, setting <see cref="P:ZedGraph.Fill.Type"/> to
- <see cref="F:ZedGraph.FillType.Brush"/> using the specified colors. This gradient fill
- consists of many colors based on an array of <see cref="P:ZedGraph.Fill.Color"/> objects, drawn at the
- specified angle (degrees). The <see paramref="colors"/> array is used to create
- a <see cref="T:System.Drawing.Drawing2D.ColorBlend"/> object assuming a even linear distribution of the colors
- across the gradient.
- </summary>
- <param name="colors">The array of <see cref="P:ZedGraph.Fill.Color"/> objects that defines the colors
- along the gradient.</param>
- <param name="positions">The array of floating point values that defines the color
- positions along the gradient. Values should range from 0 to 1.</param>
- <param name="angle">The angle (degrees) of the gradient fill</param>
- </member>
- <member name="M:ZedGraph.Fill.#ctor(System.Drawing.Image,System.Drawing.Drawing2D.WrapMode)">
- <summary>
- Constructor that creates a texture fill, setting <see cref="P:ZedGraph.Fill.Type"/> to
- <see cref="F:ZedGraph.FillType.Brush"/> and using the specified image.
- </summary>
- <param name="image">The <see cref="T:System.Drawing.Image"/> to use for filling</param>
- <param name="wrapMode">The <see cref="T:System.Drawing.Drawing2D.WrapMode"/> class that controls the image wrapping properties</param>
- </member>
- <member name="M:ZedGraph.Fill.#ctor(System.Drawing.Brush)">
- <summary>
- Constructor that creates a <see cref="P:ZedGraph.Fill.Brush"/> fill, using a user-supplied, custom
- <see cref="P:ZedGraph.Fill.Brush"/>. The brush will be scaled to fit the destination screen object
- unless you manually change <see cref="P:ZedGraph.Fill.IsScaled"/> to false;
- </summary>
- <param name="brush">The <see cref="P:ZedGraph.Fill.Brush"/> to use for fancy fills. Typically, this would
- be a <see cref="T:System.Drawing.Drawing2D.LinearGradientBrush"/> or a <see cref="T:System.Drawing.TextureBrush"/> class</param>
- </member>
- <member name="M:ZedGraph.Fill.#ctor(System.Drawing.Brush,System.Boolean)">
- <summary>
- Constructor that creates a <see cref="P:ZedGraph.Fill.Brush"/> fill, using a user-supplied, custom
- <see cref="P:ZedGraph.Fill.Brush"/>. The brush will be scaled to fit the destination screen object
- according to the <see paramref="isScaled"/> parameter.
- </summary>
- <param name="brush">The <see cref="P:ZedGraph.Fill.Brush"/> to use for fancy fills. Typically, this would
- be a <see cref="T:System.Drawing.Drawing2D.LinearGradientBrush"/> or a <see cref="T:System.Drawing.TextureBrush"/> class</param>
- <param name="isScaled">Determines if the brush will be scaled to fit the bounding box
- of the destination object. true to scale it, false to leave it unscaled</param>
- </member>
- <member name="M:ZedGraph.Fill.#ctor(System.Drawing.Brush,ZedGraph.AlignH,ZedGraph.AlignV)">
- <summary>
- Constructor that creates a <see cref="P:ZedGraph.Fill.Brush"/> fill, using a user-supplied, custom
- <see cref="P:ZedGraph.Fill.Brush"/>. This constructor will make the brush unscaled (see <see cref="P:ZedGraph.Fill.IsScaled"/>),
- but it provides <see paramref="alignH"/> and <see paramref="alignV"/> parameters to control
- alignment of the brush with respect to the filled object.
- </summary>
- <param name="brush">The <see cref="P:ZedGraph.Fill.Brush"/> to use for fancy fills. Typically, this would
- be a <see cref="T:System.Drawing.Drawing2D.LinearGradientBrush"/> or a <see cref="T:System.Drawing.TextureBrush"/> class</param>
- <param name="alignH">Controls the horizontal alignment of the brush within the filled object
- (see <see cref="P:ZedGraph.Fill.AlignH"/></param>
- <param name="alignV">Controls the vertical alignment of the brush within the filled object
- (see <see cref="P:ZedGraph.Fill.AlignV"/></param>
- </member>
- <member name="M:ZedGraph.Fill.#ctor(ZedGraph.Fill)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The Fill object from which to copy</param>
- </member>
- <member name="M:ZedGraph.Fill.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.Fill.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.Fill.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="M:ZedGraph.Fill.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Constructor for deserializing objects
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data
- </param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data
- </param>
- </member>
- <member name="M:ZedGraph.Fill.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance with the data needed to serialize the target object
- </summary>
- <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> instance that defines the serialized data</param>
- <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> instance that contains the serialized data</param>
- </member>
- <member name="M:ZedGraph.Fill.MakeBrush(System.Drawing.RectangleF)">
- <summary>
- Create a fill brush using current properties. This method will construct a brush based on the
- settings of <see cref="P:ZedGraph.Fill.Type"/>, <see cref="P:ZedGraph.Fill.Color"/>
- and <see cref="P:ZedGraph.Fill.Brush"/>. If
- <see cref="P:ZedGraph.Fill.Type"/> is set to <see cref="F:ZedGraph.FillType.Brush"/> and
- <see cref="P:ZedGraph.Fill.Brush"/>
- is null, then a <see cref="T:System.Drawing.Drawing2D.LinearGradientBrush"/> will be created between the colors of
- <see cref="P:System.Drawing.Color.White"/> and <see cref="P:ZedGraph.Fill.Color"/>.
- </summary>
- <param name="rect">A rectangle that bounds the object to be filled. This determines
- the start and end of the gradient fill.</param>
- <returns>A <see cref="T:System.Drawing.Brush"/> class representing the fill brush</returns>
- </member>
- <member name="M:ZedGraph.Fill.MakeBrush(System.Drawing.RectangleF,ZedGraph.PointPair)">
- <summary>
- Create a fill brush using current properties. This method will construct a brush based on the
- settings of <see cref="P:ZedGraph.Fill.Type"/>, <see cref="P:ZedGraph.Fill.Color"/>
- and <see cref="P:ZedGraph.Fill.Brush"/>. If
- <see cref="P:ZedGraph.Fill.Type"/> is set to <see cref="F:ZedGraph.FillType.Brush"/> and
- <see cref="P:ZedGraph.Fill.Brush"/>
- is null, then a <see cref="T:System.Drawing.Drawing2D.LinearGradientBrush"/> will be created between the colors of
- <see cref="P:System.Drawing.Color.White"/> and <see cref="P:ZedGraph.Fill.Color"/>.
- </summary>
- <param name="rect">A rectangle that bounds the object to be filled. This determines
- the start and end of the gradient fill.</param>
- <param name="dataValue">The data value to be used for a value-based
- color gradient. This is only applicable for <see cref="F:ZedGraph.FillType.GradientByX"/>,
- <see cref="F:ZedGraph.FillType.GradientByY"/> or <see cref="F:ZedGraph.FillType.GradientByZ"/>.</param>
- <returns>A <see cref="T:System.Drawing.Brush"/> class representing the fill brush</returns>
- </member>
- <member name="M:ZedGraph.Fill.Draw(System.Drawing.Graphics,System.Drawing.RectangleF)">
- <summary>
- Fill the background of the <see cref="T:System.Drawing.RectangleF"/> area, using the
- fill type from this <see cref="T:ZedGraph.Fill"/>.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="rect">The <see cref="T:System.Drawing.RectangleF"/> struct specifying the area
- to be filled</param>
- </member>
- <member name="M:ZedGraph.Fill.Draw(System.Drawing.Graphics,System.Drawing.RectangleF,ZedGraph.PointPair)">
- <summary>
- Fill the background of the <see cref="T:System.Drawing.RectangleF"/> area, using the
- fill type from this <see cref="T:ZedGraph.Fill"/>.
- </summary>
- <param name="g">
- A graphic device object to be drawn into. This is normally e.Graphics from the
- PaintEventArgs argument to the Paint() method.
- </param>
- <param name="rect">The <see cref="T:System.Drawing.RectangleF"/> struct specifying the area
- to be filled</param>
- <param name="pt">The data value to be used in case it's a
- <see cref="F:ZedGraph.FillType.GradientByX"/>, <see cref="F:ZedGraph.FillType.GradientByY"/>, or
- <see cref="F:ZedGraph.FillType.GradientByZ"/> <see cref="T:ZedGraph.FillType"/>.</param>
- </member>
- <member name="P:ZedGraph.Fill.Color">
- <summary>
- The fill color. This property is used as a single color to make a solid fill
- (<see cref="P:ZedGraph.Fill.Type"/> is <see cref="F:ZedGraph.FillType.Solid"/>), or it can be used in
- combination with <see cref="P:System.Drawing.Color.White"/> to make a
- <see cref="T:System.Drawing.Drawing2D.LinearGradientBrush"/>
- when <see cref="P:ZedGraph.Fill.Type"/> is <see cref="F:ZedGraph.FillType.Brush"/> and <see cref="P:ZedGraph.Fill.Brush"/>
- is null.
- </summary>
- <seealso cref="P:ZedGraph.Fill.Type"/>
- </member>
- <member name="P:ZedGraph.Fill.SecondaryValueGradientColor">
- <summary>
- Gets or sets the secondary color for gradientByValue fills.
- </summary>
- <remarks>
- This property is only applicable if the <see cref="P:ZedGraph.Fill.Type"/> is
- <see cref="F:ZedGraph.FillType.GradientByX"/>,
- <see cref="F:ZedGraph.FillType.GradientByY"/>, or
- <see cref="F:ZedGraph.FillType.GradientByZ"/>. Once the gradient-by-value logic picks
- a color, a new gradient will be created using the SecondaryValueGradientColor, the
- resulting gradient-by-value color, and the angle setting for this
- <see cref="T:ZedGraph.Fill"/>. Use a value of <see cref="F:System.Drawing.Color.Empty">Color.Empty</see> to have
- a solid-color <see cref="T:ZedGraph.Fill"/> resulting from a gradient-by-value
- <see cref="T:ZedGraph.FillType"/>.
- </remarks>
- </member>
- <member name="P:ZedGraph.Fill.Brush">
- <summary>
- The custom fill brush. This can be a <see cref="T:System.Drawing.SolidBrush"/>, a
- <see cref="T:System.Drawing.Drawing2D.LinearGradientBrush"/>, or a <see cref="T:System.Drawing.TextureBrush"/>. This property is
- only applicable if the <see cref="P:ZedGraph.Fill.Type"/> property is set
- to <see cref="F:ZedGraph.FillType.Brush"/>.
- </summary>
- </member>
- <member name="P:ZedGraph.Fill.Type">
- <summary>
- Determines the type of fill, which can be either solid
- color (<see cref="F:ZedGraph.FillType.Solid"/>) or a custom brush
- (<see cref="F:ZedGraph.FillType.Brush"/>). See <see cref="P:ZedGraph.Fill.Type"/> for
- more information.
- </summary>
- <seealso cref="P:ZedGraph.Fill.Color"/>
- </member>
- <member name="P:ZedGraph.Fill.IsVisible">
- <summary>
- This property determines the type of color fill.
- Returns true if the <see cref="P:ZedGraph.Fill.Type"/> property is either
- <see cref="F:ZedGraph.FillType.Solid"/> or
- <see cref="F:ZedGraph.FillType.Brush"/>. If set to true, this property
- will automatically set the <see cref="P:ZedGraph.Fill.Type"/> to
- <see cref="F:ZedGraph.FillType.Brush"/>. If set to false, this property
- will automatically set the <see cref="P:ZedGraph.Fill.Type"/> to
- <see cref="F:ZedGraph.FillType.None"/>. In order to get a regular
- solid-color fill, you have to manually set <see cref="P:ZedGraph.Fill.Type"/>
- to <see cref="F:ZedGraph.FillType.Solid"/>.
- </summary>
- <seealso cref="P:ZedGraph.Fill.Color"/>
- <seealso cref="P:ZedGraph.Fill.Brush"/>
- <seealso cref="P:ZedGraph.Fill.Type"/>
- </member>
- <member name="P:ZedGraph.Fill.IsScaled">
- <summary>
- Determines if the brush will be scaled to the bounding box
- of the filled object. If this value is false, then the brush will only be aligned
- with the filled object based on the <see cref="P:ZedGraph.Fill.AlignH"/> and <see cref="P:ZedGraph.Fill.AlignV"/>
- properties.
- </summary>
- </member>
- <member name="P:ZedGraph.Fill.AlignH">
- <summary>
- Determines how the brush will be aligned with the filled object
- in the horizontal direction. This value is a <see cref="T:ZedGraph.AlignH"/> enumeration.
- This field only applies if <see cref="P:ZedGraph.Fill.IsScaled"/> is false.
- </summary>
- <seealso cref="P:ZedGraph.Fill.AlignV"/>
- </member>
- <member name="P:ZedGraph.Fill.AlignV">
- <summary>
- Determines how the brush will be aligned with the filled object
- in the vertical direction. This value is a <see cref="T:ZedGraph.AlignV"/> enumeration.
- This field only applies if <see cref="P:ZedGraph.Fill.IsScaled"/> is false.
- </summary>
- <seealso cref="P:ZedGraph.Fill.AlignH"/>
- </member>
- <member name="P:ZedGraph.Fill.IsGradientValueType">
- <summary>
- Returns a boolean value indicating whether or not this fill is a "Gradient-By-Value"
- type. This is true for <see cref="F:ZedGraph.FillType.GradientByX"/>, <see cref="F:ZedGraph.FillType.GradientByY"/>,
- or <see cref="F:ZedGraph.FillType.GradientByZ"/>.
- </summary>
- <remarks>
- The gradient by value fill method allows the fill color for each point or bar to
- be based on a value for that point (either X, Y, or Z in the <see cref="T:ZedGraph.IPointList"/>.
- For example, assume a <see cref="T:ZedGraph.Fill"/> class is defined with a linear gradient ranging from
- <see cref="P:System.Drawing.Color.Blue"/> to <see cref="P:System.Drawing.Color.Red"/> and the <see cref="P:ZedGraph.Fill.Type"/>
- is set to <see cref="F:ZedGraph.FillType.GradientByY"/>. If <see cref="P:ZedGraph.Fill.RangeMin"/> is set to
- 100.0 and <see cref="P:ZedGraph.Fill.RangeMax"/> is set to 200.0, then a point that has a Y value of
- 100 or less will be colored blue, a point with a Y value of 200 or more will be
- colored red, and a point between 100 and 200 will have a color based on a linear scale
- between blue and red. Note that the fill color is always solid for any given point.
- You can use the Z value from <see cref="T:ZedGraph.IPointList"/> along with
- <see cref="F:ZedGraph.FillType.GradientByZ"/> to color individual points according to some
- property that is independent of the X,Y point pair.
- </remarks>
- <value>true if this is a Gradient-by-value type, false otherwise</value>
- <seealso cref="F:ZedGraph.FillType.GradientByX"/>
- <seealso cref="F:ZedGraph.FillType.GradientByY"/>
- <seealso cref="F:ZedGraph.FillType.GradientByZ"/>
- </member>
- <member name="P:ZedGraph.Fill.RangeMin">
- <summary>
- The minimum user-scale value for the gradient-by-value determination. This defines
- the user-scale value for the start of the gradient.
- </summary>
- <seealso cref="F:ZedGraph.FillType.GradientByX"/>
- <seealso cref="F:ZedGraph.FillType.GradientByY"/>
- <seealso cref="F:ZedGraph.FillType.GradientByZ"/>
- <seealso cref="P:ZedGraph.Fill.IsGradientValueType"/>
- <seealso cref="P:ZedGraph.Fill.RangeMax"/>
- <seealso cref="P:ZedGraph.Fill.RangeDefault"/>
- <value>A double value, in user scale unit</value>
- </member>
- <member name="P:ZedGraph.Fill.RangeMax">
- <summary>
- The maximum user-scale value for the gradient-by-value determination. This defines
- the user-scale value for the end of the gradient.
- </summary>
- <seealso cref="F:ZedGraph.FillType.GradientByX"/>
- <seealso cref="F:ZedGraph.FillType.GradientByY"/>
- <seealso cref="F:ZedGraph.FillType.GradientByZ"/>
- <seealso cref="P:ZedGraph.Fill.IsGradientValueType"/>
- <seealso cref="P:ZedGraph.Fill.RangeMin"/>
- <seealso cref="P:ZedGraph.Fill.RangeDefault"/>
- <value>A double value, in user scale unit</value>
- </member>
- <member name="P:ZedGraph.Fill.RangeDefault">
- <summary>
- The default user-scale value for the gradient-by-value determination. This defines the
- value that will be used when there is no point value available, or the actual point value
- is invalid.
- </summary>
- <remarks>
- Note that this value, when defined, will determine the color that is used in the legend.
- If this value is set to double.MaxValue, then it remains "undefined." In this case, the
- legend symbols will actually be filled with a color gradient representing the range of
- colors.
- </remarks>
- <seealso cref="F:ZedGraph.FillType.GradientByX"/>
- <seealso cref="F:ZedGraph.FillType.GradientByY"/>
- <seealso cref="F:ZedGraph.FillType.GradientByZ"/>
- <seealso cref="P:ZedGraph.Fill.IsGradientValueType"/>
- <seealso cref="P:ZedGraph.Fill.RangeMin"/>
- <seealso cref="P:ZedGraph.Fill.RangeMax"/>
- <value>A double value, in user scale unit</value>
- </member>
- <member name="T:ZedGraph.Fill.Default">
- <summary>
- A simple struct that defines the
- default property values for the <see cref="T:ZedGraph.Fill"/> class.
- </summary>
- </member>
- <member name="F:ZedGraph.Fill.Default.IsScaled">
- <summary>
- The default scaling mode for <see cref="P:ZedGraph.Fill.Brush"/> fills.
- This is the default value for the <see cref="P:ZedGraph.Fill.IsScaled"/> property.
- </summary>
- </member>
- <member name="F:ZedGraph.Fill.Default.AlignH">
- <summary>
- The default horizontal alignment for <see cref="P:ZedGraph.Fill.Brush"/> fills.
- This is the default value for the <see cref="P:ZedGraph.Fill.AlignH"/> property.
- </summary>
- </member>
- <member name="F:ZedGraph.Fill.Default.AlignV">
- <summary>
- The default vertical alignment for <see cref="P:ZedGraph.Fill.Brush"/> fills.
- This is the default value for the <see cref="P:ZedGraph.Fill.AlignV"/> property.
- </summary>
- </member>
- <member name="T:ZedGraph.BasicArrayPointList">
- <summary>
- A data collection class for ZedGraph, provided as an alternative to <see cref="T:ZedGraph.PointPairList"/>.
- </summary>
- <remarks>
- The data storage class for ZedGraph can be any type, so long as it uses the <see cref="T:ZedGraph.IPointList"/>
- interface. This class, albeit simple, is a demonstration of implementing the <see cref="T:ZedGraph.IPointList"/>
- interface to provide a simple data collection using only two arrays. The <see cref="T:ZedGraph.IPointList"/>
- interface can also be used as a layer between ZedGraph and a database, for example.
- </remarks>
- <seealso cref="T:ZedGraph.PointPairList"/>
- <seealso cref="T:ZedGraph.IPointList"/>
-
- <author> John Champion</author>
- <version> $Revision: 3.4 $ $Date: 2007-02-18 05:51:53 $ </version>
- </member>
- <member name="F:ZedGraph.BasicArrayPointList.x">
- <summary>
- Instance of an array of x values
- </summary>
- </member>
- <member name="F:ZedGraph.BasicArrayPointList.y">
- <summary>
- Instance of an array of x values
- </summary>
- </member>
- <member name="M:ZedGraph.BasicArrayPointList.#ctor(System.Double[],System.Double[])">
- <summary>
- Constructor to initialize the PointPairList from two arrays of
- type double.
- </summary>
- </member>
- <member name="M:ZedGraph.BasicArrayPointList.#ctor(ZedGraph.BasicArrayPointList)">
- <summary>
- The Copy Constructor
- </summary>
- <param name="rhs">The PointPairList from which to copy</param>
- </member>
- <member name="M:ZedGraph.BasicArrayPointList.System#ICloneable#Clone">
- <summary>
- Implement the <see cref="T:System.ICloneable"/> interface in a typesafe manner by just
- calling the typed version of <see cref="M:ZedGraph.BasicArrayPointList.Clone"/>
- </summary>
- <returns>A deep copy of this object</returns>
- </member>
- <member name="M:ZedGraph.BasicArrayPointList.Clone">
- <summary>
- Typesafe, deep-copy clone method.
- </summary>
- <returns>A new, independent copy of this class</returns>
- </member>
- <member name="P:ZedGraph.BasicArrayPointList.Item(System.Int32)">
- <summary>
- Indexer to access the specified <see cref="T:ZedGraph.PointPair"/> object by
- its ordinal position in the list.
- </summary>
- <remarks>
- Returns <see cref="F:ZedGraph.PointPairBase.Missing"/> for any value of <see paramref="index"/>
- that is outside of its corresponding array bounds.
- </remarks>
- <param name="index">The ordinal position (zero-based) of the
- <see cref="T:ZedGraph.PointPair"/> object to be accessed.</param>
- <value>A <see cref="T:ZedGraph.PointPair"/> object reference.</value>
- </member>
- <member name="P:ZedGraph.BasicArrayPointList.Count">
- <summary>
- Returns the number of points available in the arrays. Count will be the greater
- of the lengths of the X and Y arrays.
- </summary>
- </member>
- </members>
-</doc>
diff --git a/MES_Wind/bin/Debug/cs/DotSpatial.Projections.Forms.resources.dll b/MES_Wind/bin/Debug/cs/DotSpatial.Projections.Forms.resources.dll
deleted file mode 100644
index 4aa8c9ab198b293f63fd9809902e56e3d9474275..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/cs/DotSpatial.Projections.Forms.resources.dll and /dev/null differ
diff --git a/MES_Wind/bin/Debug/cs/DotSpatial.Symbology.Forms.resources.dll b/MES_Wind/bin/Debug/cs/DotSpatial.Symbology.Forms.resources.dll
deleted file mode 100644
index 772a73133da089aaf443f367f634de3cbeb5d42c..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/cs/DotSpatial.Symbology.Forms.resources.dll and /dev/null differ
diff --git a/MES_Wind/bin/Debug/de-DE/DotSpatial.Controls.resources.dll b/MES_Wind/bin/Debug/de-DE/DotSpatial.Controls.resources.dll
deleted file mode 100644
index c93d56db94a226b23cb6e26f5d8871a94f275b7d..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/de-DE/DotSpatial.Controls.resources.dll and /dev/null differ
diff --git a/MES_Wind/bin/Debug/de-DE/DotSpatial.Projections.Forms.resources.dll b/MES_Wind/bin/Debug/de-DE/DotSpatial.Projections.Forms.resources.dll
deleted file mode 100644
index 874f7925fd65cb27fb3831498b61010ae9451638..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/de-DE/DotSpatial.Projections.Forms.resources.dll and /dev/null differ
diff --git a/MES_Wind/bin/Debug/de-DE/DotSpatial.Symbology.Forms.resources.dll b/MES_Wind/bin/Debug/de-DE/DotSpatial.Symbology.Forms.resources.dll
deleted file mode 100644
index 0410ff2a6d57d3fe2e3814dc655ae20ac780ab56..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/de-DE/DotSpatial.Symbology.Forms.resources.dll and /dev/null differ
diff --git a/MES_Wind/bin/Debug/de-DE/DotSpatial.Symbology.resources.dll b/MES_Wind/bin/Debug/de-DE/DotSpatial.Symbology.resources.dll
deleted file mode 100644
index 9d34dff96e34c1022926daba68ce67109085f5e2..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/de-DE/DotSpatial.Symbology.resources.dll and /dev/null differ
diff --git a/MES_Wind/bin/Debug/de/DotSpatial.Projections.Forms.resources.dll b/MES_Wind/bin/Debug/de/DotSpatial.Projections.Forms.resources.dll
deleted file mode 100644
index ab35517b4e0b94e2fa68489e618fc9800d229c01..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/de/DotSpatial.Projections.Forms.resources.dll and /dev/null differ
diff --git a/MES_Wind/bin/Debug/de/ZedGraph.resources.dll b/MES_Wind/bin/Debug/de/ZedGraph.resources.dll
deleted file mode 100644
index b85870409c1a45376c47bf28b47e5a4f1a788a43..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/de/ZedGraph.resources.dll and /dev/null differ
diff --git a/MES_Wind/bin/Debug/el/DotSpatial.Projections.Forms.resources.dll b/MES_Wind/bin/Debug/el/DotSpatial.Projections.Forms.resources.dll
deleted file mode 100644
index 7362cc22c02f25be24685419c6ac7eaf35006683..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/el/DotSpatial.Projections.Forms.resources.dll and /dev/null differ
diff --git a/MES_Wind/bin/Debug/en-US/DotSpatial.Symbology.Forms.resources.dll b/MES_Wind/bin/Debug/en-US/DotSpatial.Symbology.Forms.resources.dll
deleted file mode 100644
index 7820cc2557b6fd8ec1c3f1df567d0b832ccf6c9c..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/en-US/DotSpatial.Symbology.Forms.resources.dll and /dev/null differ
diff --git a/MES_Wind/bin/Debug/es/ZedGraph.resources.dll b/MES_Wind/bin/Debug/es/ZedGraph.resources.dll
deleted file mode 100644
index c9a08096e63aab70566df641ff16acd3b76b153c..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/es/ZedGraph.resources.dll and /dev/null differ
diff --git a/MES_Wind/bin/Debug/fr/ZedGraph.resources.dll b/MES_Wind/bin/Debug/fr/ZedGraph.resources.dll
deleted file mode 100644
index c30033239abcdeb9535c678c2381c5c90bb58b2b..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/fr/ZedGraph.resources.dll and /dev/null differ
diff --git a/MES_Wind/bin/Debug/hu/ZedGraph.resources.dll b/MES_Wind/bin/Debug/hu/ZedGraph.resources.dll
deleted file mode 100644
index a273f59e5c0c0e362f8f600e292f55a65fa947cc..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/hu/ZedGraph.resources.dll and /dev/null differ
diff --git a/MES_Wind/bin/Debug/it-IT/DotSpatial.Controls.resources.dll b/MES_Wind/bin/Debug/it-IT/DotSpatial.Controls.resources.dll
deleted file mode 100644
index 3bac17262bdac7e961639388a90b1590ef14ade4..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/it-IT/DotSpatial.Controls.resources.dll and /dev/null differ
diff --git a/MES_Wind/bin/Debug/it-IT/DotSpatial.Projections.Forms.resources.dll b/MES_Wind/bin/Debug/it-IT/DotSpatial.Projections.Forms.resources.dll
deleted file mode 100644
index c9a0fb1e2046b24662c6cbad82f13abd349a6a35..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/it-IT/DotSpatial.Projections.Forms.resources.dll and /dev/null differ
diff --git a/MES_Wind/bin/Debug/it-IT/DotSpatial.Symbology.Forms.resources.dll b/MES_Wind/bin/Debug/it-IT/DotSpatial.Symbology.Forms.resources.dll
deleted file mode 100644
index f2450455a732dc2ec4a668869a30a92bfa3c6541..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/it-IT/DotSpatial.Symbology.Forms.resources.dll and /dev/null differ
diff --git a/MES_Wind/bin/Debug/it/DotSpatial.Symbology.Forms.resources.dll b/MES_Wind/bin/Debug/it/DotSpatial.Symbology.Forms.resources.dll
deleted file mode 100644
index 76dab8cafd2e11911f5c96ae5e5085a3a44317b1..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/it/DotSpatial.Symbology.Forms.resources.dll and /dev/null differ
diff --git a/MES_Wind/bin/Debug/it/ZedGraph.resources.dll b/MES_Wind/bin/Debug/it/ZedGraph.resources.dll
deleted file mode 100644
index 76bbede27c7864989f25fbc93482c2f8d1822404..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/it/ZedGraph.resources.dll and /dev/null differ
diff --git a/MES_Wind/bin/Debug/ja-JP/DotSpatial.Projections.Forms.resources.dll b/MES_Wind/bin/Debug/ja-JP/DotSpatial.Projections.Forms.resources.dll
deleted file mode 100644
index e600ff8e619101f537d727ad095aa9f188b81e09..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/ja-JP/DotSpatial.Projections.Forms.resources.dll and /dev/null differ
diff --git a/MES_Wind/bin/Debug/ja/ZedGraph.resources.dll b/MES_Wind/bin/Debug/ja/ZedGraph.resources.dll
deleted file mode 100644
index 0f30bd40949d52a0d1cd0e422f6e68d9ede93cb9..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/ja/ZedGraph.resources.dll and /dev/null differ
diff --git a/MES_Wind/bin/Debug/lt/DotSpatial.Projections.Forms.resources.dll b/MES_Wind/bin/Debug/lt/DotSpatial.Projections.Forms.resources.dll
deleted file mode 100644
index 71b1802adc5601514544df59963bdaf610de58eb..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/lt/DotSpatial.Projections.Forms.resources.dll and /dev/null differ
diff --git a/MES_Wind/bin/Debug/nl/DotSpatial.Projections.Forms.resources.dll b/MES_Wind/bin/Debug/nl/DotSpatial.Projections.Forms.resources.dll
deleted file mode 100644
index 2c4eab664ff3fb6b25f5b29ce042d55b4095b011..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/nl/DotSpatial.Projections.Forms.resources.dll and /dev/null differ
diff --git a/MES_Wind/bin/Debug/pt-BR/DotSpatial.Controls.resources.dll b/MES_Wind/bin/Debug/pt-BR/DotSpatial.Controls.resources.dll
deleted file mode 100644
index fe3d2ccca3a65043cb9463c638741e0511c5c6e3..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/pt-BR/DotSpatial.Controls.resources.dll and /dev/null differ
diff --git a/MES_Wind/bin/Debug/pt-BR/DotSpatial.Projections.Forms.resources.dll b/MES_Wind/bin/Debug/pt-BR/DotSpatial.Projections.Forms.resources.dll
deleted file mode 100644
index d0b36876e097ce8e80b2cda034ba3747f309727d..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/pt-BR/DotSpatial.Projections.Forms.resources.dll and /dev/null differ
diff --git a/MES_Wind/bin/Debug/pt-BR/DotSpatial.Symbology.Forms.resources.dll b/MES_Wind/bin/Debug/pt-BR/DotSpatial.Symbology.Forms.resources.dll
deleted file mode 100644
index 2f1a7b1d4d7fe1e47c822571274bbb988257978f..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/pt-BR/DotSpatial.Symbology.Forms.resources.dll and /dev/null differ
diff --git a/MES_Wind/bin/Debug/pt/DotSpatial.Projections.Forms.resources.dll b/MES_Wind/bin/Debug/pt/DotSpatial.Projections.Forms.resources.dll
deleted file mode 100644
index 549f862b900c5ed6a459c8b395b25afd112e30f6..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/pt/DotSpatial.Projections.Forms.resources.dll and /dev/null differ
diff --git a/MES_Wind/bin/Debug/pt/ZedGraph.resources.dll b/MES_Wind/bin/Debug/pt/ZedGraph.resources.dll
deleted file mode 100644
index 9fb74df8476b95303b29fe4a92ee95d359214ec7..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/pt/ZedGraph.resources.dll and /dev/null differ
diff --git a/MES_Wind/bin/Debug/ro/DotSpatial.Projections.Forms.resources.dll b/MES_Wind/bin/Debug/ro/DotSpatial.Projections.Forms.resources.dll
deleted file mode 100644
index 57d5c81ed966c5521db77d5eb780957dcbb8c9ac..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/ro/DotSpatial.Projections.Forms.resources.dll and /dev/null differ
diff --git a/MES_Wind/bin/Debug/ru/ZedGraph.resources.dll b/MES_Wind/bin/Debug/ru/ZedGraph.resources.dll
deleted file mode 100644
index 2278d522946fd1cd14c9edfcfa759bc448eacdf2..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/ru/ZedGraph.resources.dll and /dev/null differ
diff --git a/MES_Wind/bin/Debug/sk/ZedGraph.resources.dll b/MES_Wind/bin/Debug/sk/ZedGraph.resources.dll
deleted file mode 100644
index dcab827cd7571f2d3a8ab11097b11db2e64454fd..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/sk/ZedGraph.resources.dll and /dev/null differ
diff --git a/MES_Wind/bin/Debug/sv/ZedGraph.resources.dll b/MES_Wind/bin/Debug/sv/ZedGraph.resources.dll
deleted file mode 100644
index 82d21c8befe9790b827df438060eba04fdb180ef..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/sv/ZedGraph.resources.dll and /dev/null differ
diff --git a/MES_Wind/bin/Debug/th/DotSpatial.Projections.Forms.resources.dll b/MES_Wind/bin/Debug/th/DotSpatial.Projections.Forms.resources.dll
deleted file mode 100644
index 4ad9ed7a77ba9bd90ce47abc0c482beafadec3ed..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/th/DotSpatial.Projections.Forms.resources.dll and /dev/null differ
diff --git a/MES_Wind/bin/Debug/tr/ZedGraph.resources.dll b/MES_Wind/bin/Debug/tr/ZedGraph.resources.dll
deleted file mode 100644
index ed4662023e5caf5bbd12ea59dff599651a72ba6b..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/tr/ZedGraph.resources.dll and /dev/null differ
diff --git a/MES_Wind/bin/Debug/vi-VN/DotSpatial.Projections.Forms.resources.dll b/MES_Wind/bin/Debug/vi-VN/DotSpatial.Projections.Forms.resources.dll
deleted file mode 100644
index da8a7551061d59aade3604c5bb792f3061b5b226..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/vi-VN/DotSpatial.Projections.Forms.resources.dll and /dev/null differ
diff --git a/MES_Wind/bin/Debug/zh-CN/DotSpatial.Controls.resources.dll b/MES_Wind/bin/Debug/zh-CN/DotSpatial.Controls.resources.dll
deleted file mode 100644
index b9c35781b34f5226e55f1d8e48c782143af4224c..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/zh-CN/DotSpatial.Controls.resources.dll and /dev/null differ
diff --git a/MES_Wind/bin/Debug/zh-CN/DotSpatial.Data.Forms.resources.dll b/MES_Wind/bin/Debug/zh-CN/DotSpatial.Data.Forms.resources.dll
deleted file mode 100644
index 9fe42dca70fbcbda8acb970f06217c69986a0c26..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/zh-CN/DotSpatial.Data.Forms.resources.dll and /dev/null differ
diff --git a/MES_Wind/bin/Debug/zh-CN/DotSpatial.Modeling.Forms.resources.dll b/MES_Wind/bin/Debug/zh-CN/DotSpatial.Modeling.Forms.resources.dll
deleted file mode 100644
index 7a3a322201a141e4ed0c6546bd33ea18a98813b5..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/zh-CN/DotSpatial.Modeling.Forms.resources.dll and /dev/null differ
diff --git a/MES_Wind/bin/Debug/zh-CN/DotSpatial.Projections.Forms.resources.dll b/MES_Wind/bin/Debug/zh-CN/DotSpatial.Projections.Forms.resources.dll
deleted file mode 100644
index 5e30d7d271f6a73cdc7e3e3048d6d4e1acddb69f..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/zh-CN/DotSpatial.Projections.Forms.resources.dll and /dev/null differ
diff --git a/MES_Wind/bin/Debug/zh-CN/DotSpatial.Symbology.Forms.resources.dll b/MES_Wind/bin/Debug/zh-CN/DotSpatial.Symbology.Forms.resources.dll
deleted file mode 100644
index 36a1a71cbbcebd7b559756a853c940ad7788b103..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/zh-CN/DotSpatial.Symbology.Forms.resources.dll and /dev/null differ
diff --git a/MES_Wind/bin/Debug/zh-CN/ZedGraph.resources.dll b/MES_Wind/bin/Debug/zh-CN/ZedGraph.resources.dll
deleted file mode 100644
index 3f51e8396f167e5bb8de2855f43eead5f4b4490c..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/zh-CN/ZedGraph.resources.dll and /dev/null differ
diff --git a/MES_Wind/bin/Debug/zh-MO/DotSpatial.Modeling.Forms.resources.dll b/MES_Wind/bin/Debug/zh-MO/DotSpatial.Modeling.Forms.resources.dll
deleted file mode 100644
index 2cdb0126ffd9288eb4a2a5435e4058c2864d2d21..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/zh-MO/DotSpatial.Modeling.Forms.resources.dll and /dev/null differ
diff --git a/MES_Wind/bin/Debug/zh-tw/ZedGraph.resources.dll b/MES_Wind/bin/Debug/zh-tw/ZedGraph.resources.dll
deleted file mode 100644
index ba82c6e001a5db49e55a0bdb5111356cb59f60ec..0000000000000000000000000000000000000000
Binary files a/MES_Wind/bin/Debug/zh-tw/ZedGraph.resources.dll and /dev/null differ
diff --git a/MES_Wind/frmMain.cs b/MES_Wind/frmMain.cs
index 8f75115c93d533202d10ebb3f835c42ddd5cdb74..38dcbe59503fcdd7f6e29cba2c5b0756458f9435 100644
--- a/MES_Wind/frmMain.cs
+++ b/MES_Wind/frmMain.cs
@@ -11,6 +11,7 @@ using DotSpatial.Controls;
using DotSpatial.Topology;
using DotSpatial.Serialization;
using DotSpatial.Data;
+using DotSpatial.Symbology;
@@ -130,6 +131,109 @@ namespace MES_Wind
Coordinate chkcords = new Coordinate();
return points;
}
+ public IFeatureSet main_layer_function(IMapLineLayer pwlines, IFeatureSet pwlineSet, IMapRasterLayer u_raster,
+ IMapRasterLayer v_raster, IMapRasterLayer clim10_raster, IMapRasterLayer clim5_raster)
+ {
+ IFeatureSet result_layer = new FeatureSet(FeatureType.Line);
+ List<CheckPoint> fullCheckList = new List<CheckPoint>();
+ foreach (IFeature feature in pwlineSet.Features)
+ {
+ List<CheckPoint> lineCheckList = new List<CheckPoint>();
+ //get associated attributes
+ DataRow featureData = feature.DataRow;
+ int id = int.Parse(featureData["PW_ID"].ToString());
+ int year = int.Parse(featureData["Year"].ToString());
+ double height = double.Parse(featureData["height_m"].ToString());
+ int power = int.Parse(featureData["Power"].ToString());
+ LineString linestr = feature.BasicGeometry as LineString;
+ if (linestr != null)
+ { // case if powerline consists of one line
+ // get coordinates list
+ IList<Coordinate> points = linestr.Coordinates;
+
+
+ // cycle throw all points in line
+ for (int i = 1; i < points.Count; i++)
+ {
+ List<CheckPoint> segmentCheckList = new List<CheckPoint>();
+ double x1 = points[i - 1].X;
+ double y1 = points[i - 1].Y;
+ double x2 = points[i].X;
+ double y2 = points[i].Y;
+ if (power > 5 && power < 330)
+ {
+ segmentCheckList = CalcBrkPoint(x1, y1, x2, y2, distThreshold, u_raster, v_raster, clim10_raster, height);
+ }
+ else
+ {
+ segmentCheckList = CalcBrkPoint(x1, y1, x2, y2, distThreshold, u_raster, v_raster, clim5_raster, height);
+ }
+ lineCheckList.AddRange(segmentCheckList);
+ }
+ bool linechek = false;
+ foreach (CheckPoint chkpnt in lineCheckList)
+ {
+ if (chkpnt.Ifbroken == true)
+ { linechek = true; }
+ }
+ if (linechek == true)
+ {
+ IFeature lineFeature = result_layer.AddFeature(linestr);
+ }
+ fullCheckList.AddRange(lineCheckList);
+
+ }
+ else
+ {//case if powerline is multiline
+ MultiLineString multiline = feature.BasicGeometry as MultiLineString;
+ if (multiline != null)
+ {
+
+ foreach (IGeometry line in multiline.Geometries)
+ {
+ IList<Coordinate> points = line.Coordinates;
+ for (int i = 1; i < points.Count; i++)
+ {
+ List<CheckPoint> segmentCheckList = new List<CheckPoint>();
+ double x1 = points[i - 1].X;
+ double y1 = points[i - 1].Y;
+ double x2 = points[i].X;
+ double y2 = points[i].Y;
+ if (power > 5 && power < 330)
+ {
+ segmentCheckList = CalcBrkPoint(x1, y1, x2, y2, distThreshold, u_raster, v_raster, clim10_raster, height);
+ }
+ else
+ {
+ segmentCheckList = CalcBrkPoint(x1, y1, x2, y2, distThreshold, u_raster, v_raster, clim5_raster, height);
+ }
+ bool linechek = false;
+ foreach (CheckPoint chkpnt in lineCheckList)
+ {
+ if (chkpnt.Ifbroken == true)
+ { linechek = true; }
+ }
+ if (linechek == true)
+ {
+ IFeature lineFeature = result_layer.AddFeature(linestr);
+ }
+ lineCheckList.AddRange(segmentCheckList);
+ }
+
+
+ fullCheckList.AddRange(lineCheckList);
+
+ }
+
+ MessageBox.Show("Works");
+ }
+
+
+ }
+ }
+
+ return result_layer;
+ }
public double interpol(Coordinate coords, IMapRasterLayer raster)
{
const bool normalX = true;
@@ -201,6 +305,7 @@ namespace MES_Wind
map1.AddLayer(file_path + "clim5_test.asc");
map1.AddLayer(file_path + "clim10_test.asc");
map1.AddLayer(file_path + "powerlines.shp");
+ map1.AddLayer(file_path + "powerstations.shp");
map1.ZoomToMaxExtent();
}
@@ -252,7 +357,7 @@ namespace MES_Wind
return;
}
- //use the first raster layer in the map
+ //this makes raster layers list in map1 ordered!
u_rasterLayer = map1.GetRasterLayers()[0];
v_rasterLayer = map1.GetRasterLayers()[1];
clim5_rasterLayer = map1.GetRasterLayers()[2];
@@ -268,85 +373,20 @@ namespace MES_Wind
pwlLayer = map1.GetLineLayers()[0];
//copy line layer FeatureSet
IFeatureSet pwlineSet = pwlLayer.DataSet;
+ //get the powerstations layer
+ IMapPointLayer pwstLayer = default(IMapPointLayer);
+ pwstLayer = map1.GetPointLayers()[0];
+
// new FeatureSet for resulting broken powerlines
//IFeatureSet brklineSet = new FeatureSet(FeatureType.Line);
//DataTable dt = pwlineSet.DataTable;
- List<CheckPoint> fullCheckList = new List<CheckPoint>();
- foreach (IFeature feature in pwlineSet.Features)
- {
- List<CheckPoint> lineCheckList = new List<CheckPoint>();
- //get associated attributes
- DataRow featureData = feature.DataRow;
- int id = int.Parse(featureData["PW_ID"].ToString());
- int year = int.Parse(featureData["Year"].ToString());
- double height = double.Parse(featureData["height_m"].ToString());
- int power = int.Parse(featureData["Power"].ToString());
- LineString linestr = feature.BasicGeometry as LineString;
- if (linestr != null)
- { // case if powerline consists of one line
- // get coordinates list
- IList<Coordinate> points = linestr.Coordinates;
-
-
- // cycle throw all points in line
- for (int i=1; i< points.Count; i++)
- {
- List<CheckPoint> segmentCheckList = new List<CheckPoint>();
- double x1 = points[i - 1].X;
- double y1 = points[i - 1].Y;
- double x2 = points[i].X;
- double y2 = points[i].Y;
- if (power > 5 && power <330)
- {
- segmentCheckList = CalcBrkPoint(x1, y1, x2, y2, distThreshold, u_rasterLayer, v_rasterLayer, clim10_rasterLayer, height);
- }
- else
- {
- segmentCheckList = CalcBrkPoint(x1, y1, x2, y2, distThreshold, u_rasterLayer, v_rasterLayer, clim5_rasterLayer, height);
- }
- lineCheckList.AddRange(segmentCheckList);
- }
-
- fullCheckList.AddRange(lineCheckList);
-
- }
- else
- {//case if powerline is multiline
- MultiLineString multiline = feature.BasicGeometry as MultiLineString;
- if ( multiline != null){
-
- foreach (IGeometry line in multiline.Geometries)
- {
- IList<Coordinate> points = line.Coordinates;
- for (int i = 1; i < points.Count; i++)
- {
- List<CheckPoint> segmentCheckList = new List<CheckPoint>();
- double x1 = points[i - 1].X;
- double y1 = points[i - 1].Y;
- double x2 = points[i].X;
- double y2 = points[i].Y;
- if (power > 5 && power < 330)
- {
- segmentCheckList = CalcBrkPoint(x1, y1, x2, y2, distThreshold, u_rasterLayer, v_rasterLayer, clim10_rasterLayer, height);
- }
- else
- {
- segmentCheckList = CalcBrkPoint(x1, y1, x2, y2, distThreshold, u_rasterLayer, v_rasterLayer, clim5_rasterLayer, height);
- }
- lineCheckList.AddRange(segmentCheckList);
- }
-
- fullCheckList.AddRange(lineCheckList);
-
- }
-
- MessageBox.Show("Works");
- }
-
+ IFeatureSet brk_info = new FeatureSet(FeatureType.Line);
+ brk_info = main_layer_function(pwlLayer, pwlineSet, u_rasterLayer, v_rasterLayer, clim10_rasterLayer, clim5_rasterLayer);
- }
- }
-
+ IMapLineLayer brk_info_layer = (MapLineLayer)map1.Layers.Add(brk_info);
+ LineSymbolizer symbol = new LineSymbolizer(Color.Red, 3);
+ brk_info_layer.Symbolizer = symbol;
+ brk_info_layer.LegendText = "Broken powerlines";
}
catch (Exception ex)
diff --git a/MES_Wind/obj/Debug/MES_Wind.csproj.FileListAbsolute.txt b/MES_Wind/obj/Debug/MES_Wind.csproj.FileListAbsolute.txt
index c8f0acb02b9bb2c1d466333dc625a07837827ccc..00605e018c44ee117b48e641601fc9e7ae653c68 100644
--- a/MES_Wind/obj/Debug/MES_Wind.csproj.FileListAbsolute.txt
+++ b/MES_Wind/obj/Debug/MES_Wind.csproj.FileListAbsolute.txt
@@ -192,83 +192,6 @@ C:\MES_Wind\MES_Wind\obj\Debug\MES_Wind.exe
C:\MES_Wind\MES_Wind\obj\Debug\MES_Wind.pdb
C:\MES_Wind\MES_Wind\bin\Debug\MES_Wind.exe
C:\MES_Wind\MES_Wind\bin\Debug\MES_Wind.pdb
-C:\MES_Wind\MES_Wind\bin\Debug\DotSpatial.Analysis.pdb
-C:\MES_Wind\MES_Wind\bin\Debug\DotSpatial.Analysis.xml
-C:\MES_Wind\MES_Wind\bin\Debug\DotSpatial.Compatibility.pdb
-C:\MES_Wind\MES_Wind\bin\Debug\DotSpatial.Compatibility.xml
-C:\MES_Wind\MES_Wind\bin\Debug\DotSpatial.Controls.pdb
-C:\MES_Wind\MES_Wind\bin\Debug\DotSpatial.Controls.xml
-C:\MES_Wind\MES_Wind\bin\Debug\DotSpatial.Data.pdb
-C:\MES_Wind\MES_Wind\bin\Debug\DotSpatial.Data.xml
-C:\MES_Wind\MES_Wind\bin\Debug\DotSpatial.Data.Forms.pdb
-C:\MES_Wind\MES_Wind\bin\Debug\DotSpatial.Data.Forms.xml
-C:\MES_Wind\MES_Wind\bin\Debug\DotSpatial.Extensions.pdb
-C:\MES_Wind\MES_Wind\bin\Debug\DotSpatial.Extensions.xml
-C:\MES_Wind\MES_Wind\bin\Debug\DotSpatial.Modeling.Forms.pdb
-C:\MES_Wind\MES_Wind\bin\Debug\DotSpatial.Modeling.Forms.xml
-C:\MES_Wind\MES_Wind\bin\Debug\DotSpatial.Mono.pdb
-C:\MES_Wind\MES_Wind\bin\Debug\DotSpatial.Mono.xml
-C:\MES_Wind\MES_Wind\bin\Debug\DotSpatial.Positioning.pdb
-C:\MES_Wind\MES_Wind\bin\Debug\DotSpatial.Positioning.xml
-C:\MES_Wind\MES_Wind\bin\Debug\DotSpatial.Positioning.Design.pdb
-C:\MES_Wind\MES_Wind\bin\Debug\DotSpatial.Positioning.Design.xml
-C:\MES_Wind\MES_Wind\bin\Debug\DotSpatial.Positioning.Forms.pdb
-C:\MES_Wind\MES_Wind\bin\Debug\DotSpatial.Positioning.Forms.xml
-C:\MES_Wind\MES_Wind\bin\Debug\DotSpatial.Projections.pdb
-C:\MES_Wind\MES_Wind\bin\Debug\DotSpatial.Projections.xml
-C:\MES_Wind\MES_Wind\bin\Debug\DotSpatial.Projections.Forms.pdb
-C:\MES_Wind\MES_Wind\bin\Debug\DotSpatial.Projections.Forms.xml
-C:\MES_Wind\MES_Wind\bin\Debug\DotSpatial.Serialization.pdb
-C:\MES_Wind\MES_Wind\bin\Debug\DotSpatial.Serialization.xml
-C:\MES_Wind\MES_Wind\bin\Debug\DotSpatial.Symbology.pdb
-C:\MES_Wind\MES_Wind\bin\Debug\DotSpatial.Symbology.xml
-C:\MES_Wind\MES_Wind\bin\Debug\DotSpatial.Symbology.Forms.pdb
-C:\MES_Wind\MES_Wind\bin\Debug\DotSpatial.Symbology.Forms.xml
-C:\MES_Wind\MES_Wind\bin\Debug\DotSpatial.Topology.pdb
-C:\MES_Wind\MES_Wind\bin\Debug\DotSpatial.Topology.xml
-C:\MES_Wind\MES_Wind\bin\Debug\ZedGraph.xml
-C:\MES_Wind\MES_Wind\bin\Debug\de-DE\DotSpatial.Controls.resources.dll
-C:\MES_Wind\MES_Wind\bin\Debug\it-IT\DotSpatial.Controls.resources.dll
-C:\MES_Wind\MES_Wind\bin\Debug\pt-BR\DotSpatial.Controls.resources.dll
-C:\MES_Wind\MES_Wind\bin\Debug\zh-CN\DotSpatial.Controls.resources.dll
-C:\MES_Wind\MES_Wind\bin\Debug\zh-CN\DotSpatial.Data.Forms.resources.dll
-C:\MES_Wind\MES_Wind\bin\Debug\zh-CN\DotSpatial.Modeling.Forms.resources.dll
-C:\MES_Wind\MES_Wind\bin\Debug\zh-MO\DotSpatial.Modeling.Forms.resources.dll
-C:\MES_Wind\MES_Wind\bin\Debug\cs\DotSpatial.Projections.Forms.resources.dll
-C:\MES_Wind\MES_Wind\bin\Debug\de\DotSpatial.Projections.Forms.resources.dll
-C:\MES_Wind\MES_Wind\bin\Debug\de-DE\DotSpatial.Projections.Forms.resources.dll
-C:\MES_Wind\MES_Wind\bin\Debug\el\DotSpatial.Projections.Forms.resources.dll
-C:\MES_Wind\MES_Wind\bin\Debug\it-IT\DotSpatial.Projections.Forms.resources.dll
-C:\MES_Wind\MES_Wind\bin\Debug\ja-JP\DotSpatial.Projections.Forms.resources.dll
-C:\MES_Wind\MES_Wind\bin\Debug\lt\DotSpatial.Projections.Forms.resources.dll
-C:\MES_Wind\MES_Wind\bin\Debug\nl\DotSpatial.Projections.Forms.resources.dll
-C:\MES_Wind\MES_Wind\bin\Debug\pt\DotSpatial.Projections.Forms.resources.dll
-C:\MES_Wind\MES_Wind\bin\Debug\pt-BR\DotSpatial.Projections.Forms.resources.dll
-C:\MES_Wind\MES_Wind\bin\Debug\ro\DotSpatial.Projections.Forms.resources.dll
-C:\MES_Wind\MES_Wind\bin\Debug\th\DotSpatial.Projections.Forms.resources.dll
-C:\MES_Wind\MES_Wind\bin\Debug\vi-VN\DotSpatial.Projections.Forms.resources.dll
-C:\MES_Wind\MES_Wind\bin\Debug\zh-CN\DotSpatial.Projections.Forms.resources.dll
-C:\MES_Wind\MES_Wind\bin\Debug\de-DE\DotSpatial.Symbology.resources.dll
-C:\MES_Wind\MES_Wind\bin\Debug\cs\DotSpatial.Symbology.Forms.resources.dll
-C:\MES_Wind\MES_Wind\bin\Debug\de-DE\DotSpatial.Symbology.Forms.resources.dll
-C:\MES_Wind\MES_Wind\bin\Debug\en-US\DotSpatial.Symbology.Forms.resources.dll
-C:\MES_Wind\MES_Wind\bin\Debug\it\DotSpatial.Symbology.Forms.resources.dll
-C:\MES_Wind\MES_Wind\bin\Debug\it-IT\DotSpatial.Symbology.Forms.resources.dll
-C:\MES_Wind\MES_Wind\bin\Debug\pt-BR\DotSpatial.Symbology.Forms.resources.dll
-C:\MES_Wind\MES_Wind\bin\Debug\zh-CN\DotSpatial.Symbology.Forms.resources.dll
-C:\MES_Wind\MES_Wind\bin\Debug\de\ZedGraph.resources.dll
-C:\MES_Wind\MES_Wind\bin\Debug\es\ZedGraph.resources.dll
-C:\MES_Wind\MES_Wind\bin\Debug\fr\ZedGraph.resources.dll
-C:\MES_Wind\MES_Wind\bin\Debug\hu\ZedGraph.resources.dll
-C:\MES_Wind\MES_Wind\bin\Debug\it\ZedGraph.resources.dll
-C:\MES_Wind\MES_Wind\bin\Debug\ja\ZedGraph.resources.dll
-C:\MES_Wind\MES_Wind\bin\Debug\pt\ZedGraph.resources.dll
-C:\MES_Wind\MES_Wind\bin\Debug\ru\ZedGraph.resources.dll
-C:\MES_Wind\MES_Wind\bin\Debug\sk\ZedGraph.resources.dll
-C:\MES_Wind\MES_Wind\bin\Debug\sv\ZedGraph.resources.dll
-C:\MES_Wind\MES_Wind\bin\Debug\tr\ZedGraph.resources.dll
-C:\MES_Wind\MES_Wind\bin\Debug\zh-CN\ZedGraph.resources.dll
-C:\MES_Wind\MES_Wind\bin\Debug\zh-tw\ZedGraph.resources.dll
C:\MES_Wind\MES_Wind\obj\Debug\MES_Wind.csprojResolveAssemblyReference.cache
C:\MES_Wind\MES_Wind\obj\Debug\MES_Wind.frmGraph.resources
C:\MES_Wind\MES_Wind\obj\Debug\MES_Wind.frmMain.resources
diff --git a/MES_Wind/obj/Debug/MES_Wind.csproj.GenerateResource.Cache b/MES_Wind/obj/Debug/MES_Wind.csproj.GenerateResource.Cache
index 2519674b69188d02cab962f1e4ea362abfbc3dc7..7e8a413adde39d610f6540a1d4a8fbcedc8d5e1e 100644
Binary files a/MES_Wind/obj/Debug/MES_Wind.csproj.GenerateResource.Cache and b/MES_Wind/obj/Debug/MES_Wind.csproj.GenerateResource.Cache differ
diff --git a/MES_Wind/obj/Debug/MES_Wind.csprojResolveAssemblyReference.cache b/MES_Wind/obj/Debug/MES_Wind.csprojResolveAssemblyReference.cache
index d5f6c22ffb8e82ddfda4a47b3fdfe5c6b7bea630..35f0efc2ce43e46933eeb8903a2bc17f70297baf 100644
Binary files a/MES_Wind/obj/Debug/MES_Wind.csprojResolveAssemblyReference.cache and b/MES_Wind/obj/Debug/MES_Wind.csprojResolveAssemblyReference.cache differ